Class RfisRequestBuilder.RfisRequestBuilderGetQueryParameters
Retrieves information about all the RFIs (requests for information) in a project, including details about their associated comments and attachments. To get more detailed information about a single RFI see GET rfis/:id
BIM 360</en/docs/bim360/v1/reference/http/rfis-v2-rfis-id-GET>
_ ACC</en/docs/acc/v1/reference/http/rfis-v2-rfis-id-GET>
_.You can retrieve both document-related (pusphin) RFIs and project-related RFIs.To verify whether an RFI is document-related (pusphin) or project-related, check the linkedDocument
attribute in the response. If the RFI is project-related the linkedDocument
will be assigned a null
value, if the RFI is document-related, it will be assigned an ID.RFIs are managed in the Project Management module
... include:: ../../../../_snippets/forward-compatible.rst
public class RfisRequestBuilder.RfisRequestBuilderGetQueryParameters
- Inheritance
-
RfisRequestBuilder.RfisRequestBuilderGetQueryParameters
- Inherited Members
Properties
Fields
Specify which attributes you want to appear in the response. Separate multiple values with commas. For example, fields=createdBy, question
.
[Obsolete("This property is deprecated, use FieldsAsGetFieldsQueryParameterType instead")]
[QueryParameter("fields")]
public string[]? Fields { get; set; }
Property Value
- string[]
FieldsAsGetFieldsQueryParameterType
Specify which attributes you want to appear in the response. Separate multiple values with commas. For example, fields=createdBy, question
.
[QueryParameter("fields")]
public GetFieldsQueryParameterType[]? FieldsAsGetFieldsQueryParameterType { get; set; }
Property Value
FilterassignedTo
Retrieves RFIs in the project that were assigned to the specified user. Use the user's Autodesk ID. For example, filter[assignedTo]=PER8KQPK2JRT
. To find the ID call GET users/me
BIM 360</en/docs/bim360/v1/reference/http/rfis-v2-users-me-GET/>
_ ACC</en/docs/acc/v1/reference/http/rfis-v2-users-me-GET/>
_ and check user.id
.
[QueryParameter("filter%5BassignedTo%5D")]
public string[]? FilterassignedTo { get; set; }
Property Value
- string[]
Filtercategory
Retrieves RFIs with the specified category type. For example, filter[category]=Constructability
[Obsolete("This property is deprecated, use FiltercategoryAsGetFilterCategoryQueryParameterType instead")]
[QueryParameter("filter%5Bcategory%5D")]
public string[]? Filtercategory { get; set; }
Property Value
- string[]
FiltercategoryAsGetFilterCategoryQueryParameterType
Retrieves RFIs with the specified category type. For example, filter[category]=Constructability
[QueryParameter("filter%5Bcategory%5D")]
public GetFilterCategoryQueryParameterType[]? FiltercategoryAsGetFilterCategoryQueryParameterType { get; set; }
Property Value
FilterclosedAt
Retrieves RFIs with the specified closedAt, in the following format: YYYY-MM-DDThh:mm:ss.sz, or a date range in the following format: YYYY-MM-DDThh:mm:ss.sz..YYYY-MM-DDThh:mm:ss.sz.
[QueryParameter("filter%5BclosedAt%5D")]
public string? FilterclosedAt { get; set; }
Property Value
FiltercostImpact
Retrieves RFIs with the specified cost impact value. For example, filter[costImpact]=Yes
[Obsolete("This property is deprecated, use FiltercostImpactAsGetFilterCostImpactQueryParameterType instead")]
[QueryParameter("filter%5BcostImpact%5D")]
public string[]? FiltercostImpact { get; set; }
Property Value
- string[]
FiltercostImpactAsGetFilterCostImpactQueryParameterType
Retrieves RFIs with the specified cost impact value. For example, filter[costImpact]=Yes
[QueryParameter("filter%5BcostImpact%5D")]
public GetFilterCostImpactQueryParameterType[]? FiltercostImpactAsGetFilterCostImpactQueryParameterType { get; set; }
Property Value
FiltercreatedAt
Retrieves RFIs created after the specified date, in the following format: YYYY-MM-DDThh:mm:ss.sz, or a date range in the following format: YYYY-MM-DDThh:mm:ss.sz..YYYY-MM-DDThh:mm:ss.sz.
[QueryParameter("filter%5BcreatedAt%5D")]
public string? FiltercreatedAt { get; set; }
Property Value
FiltercreatedBy
Retrieves RFIs in the project that were created by the specified user. Use the user's Autodesk ID. For example, filter[createdBy]=PER8KQPK2JRT
. To find the ID call GET users/me
BIM 360</en/docs/bim360/v1/reference/http/rfis-v2-users-me-GET/>
_ ACC</en/docs/acc/v1/reference/http/rfis-v2-users-me-GET/>
_ and check user.id
.
[QueryParameter("filter%5BcreatedBy%5D")]
public string[]? FiltercreatedBy { get; set; }
Property Value
- string[]
Filterdiscipline
Retrieves RFIs with the specified discipline type. For example, filter[discipline]=Architectural
[Obsolete("This property is deprecated, use FilterdisciplineAsGetFilterDisciplineQueryParameterType instead")]
[QueryParameter("filter%5Bdiscipline%5D")]
public string[]? Filterdiscipline { get; set; }
Property Value
- string[]
FilterdisciplineAsGetFilterDisciplineQueryParameterType
Retrieves RFIs with the specified discipline type. For example, filter[discipline]=Architectural
[QueryParameter("filter%5Bdiscipline%5D")]
public GetFilterDisciplineQueryParameterType[]? FilterdisciplineAsGetFilterDisciplineQueryParameterType { get; set; }
Property Value
FilterdueDate
Retrieves RFIs with the specified due date, in the following format: YYYY-MM-DDThh:mm:ss.sz, or a date range in the following format: YYYY-MM-DDThh:mm:ss.sz..YYYY-MM-DDThh:mm:ss.sz.
[QueryParameter("filter%5BdueDate%5D")]
public string? FilterdueDate { get; set; }
Property Value
Filterid
Retrieves a list of specified RFIs. To find the RFI IDs call GET rfis
BIM 360</en/docs/bim360/v1/reference/http/rfis-v2-rfis-GET/>
_ ACC</en/docs/acc/v1/reference/http/rfis-v2-rfis-GET/>
_ and check results.id
.
[QueryParameter("filter%5Bid%5D")]
public string[]? Filterid { get; set; }
Property Value
- string[]
FilterincludeHidden
BIM 360: Retrieves hidden RFIS. default is False. For example, filter[includeHidden]=true
ACC: Not relevant.
[QueryParameter("filter%5BincludeHidden%5D")]
public bool? FilterincludeHidden { get; set; }
Property Value
- bool?
FilterlinkedDocument
BIM 360: Retrieves pushpin RFIs that are associated with the specified document. Specify the document item ID. For example, filter[linkedDocument]=urn:adsk.wipprod:dm.lineage:tFbo9zuDTW-nPh45gnM4gA
.ACC: Not relevant.
[QueryParameter("filter%5BlinkedDocument%5D")]
public string[]? FilterlinkedDocument { get; set; }
Property Value
- string[]
FilterlinkedDocumentVersion
BIM 360: Retrieves pushpin RFIs that are associated with the specified document. Specify the document version ID. For example, filter[linkedDocument]=urn:adsk.wipprod:fs.file:7_5NcbL1Q1GSjRLJe9ffvw&filter[linkedDocumentVersion]=1
.ACC: Not relevant.
[QueryParameter("filter%5BlinkedDocumentVersion%5D")]
public int? FilterlinkedDocumentVersion { get; set; }
Property Value
- int?
Filterpriority
Retrieves RFIs with the specified priority level. For example, filter[priority]=High
[Obsolete("This property is deprecated, use FilterpriorityAsGetFilterPriorityQueryParameterType instead")]
[QueryParameter("filter%5Bpriority%5D")]
public string[]? Filterpriority { get; set; }
Property Value
- string[]
FilterpriorityAsGetFilterPriorityQueryParameterType
Retrieves RFIs with the specified priority level. For example, filter[priority]=High
[QueryParameter("filter%5Bpriority%5D")]
public GetFilterPriorityQueryParameterType[]? FilterpriorityAsGetFilterPriorityQueryParameterType { get; set; }
Property Value
Filterreference
Retrieves a list of specified RFIs. To find the RFI external IDs call GET rfis
BIM 360</en/docs/bim360/v1/reference/http/rfis-v2-rfis-GET/>
_ ACC</en/docs/acc/v1/reference/http/rfis-v2-rfis-GET/>
_ and check results.reference
.
[QueryParameter("filter%5Breference%5D")]
public string[]? Filterreference { get; set; }
Property Value
- string[]
FilterscheduleImpact
Retrieves RFIs with the specified schedule impact value. For example, filter[scheduleImpact]=Yes
[Obsolete("This property is deprecated, use FilterscheduleImpactAsGetFilterScheduleImpactQueryParameterType instead")]
[QueryParameter("filter%5BscheduleImpact%5D")]
public string[]? FilterscheduleImpact { get; set; }
Property Value
- string[]
FilterscheduleImpactAsGetFilterScheduleImpactQueryParameterType
Retrieves RFIs with the specified schedule impact value. For example, filter[scheduleImpact]=Yes
[QueryParameter("filter%5BscheduleImpact%5D")]
public GetFilterScheduleImpactQueryParameterType[]? FilterscheduleImpactAsGetFilterScheduleImpactQueryParameterType { get; set; }
Property Value
Filtersearch
Searches for a specified string in the following fields: title
, question
, and officialResponse
, and retrieves RFIs where the string is found. This includes RFIs where the string matches part of a field. For example, filter[search]=window
.
[QueryParameter("filter%5Bsearch%5D")]
public string? Filtersearch { get; set; }
Property Value
Filterstatus
Retrieves RFIs with the specified status. Possible values: draft
, submitted
, open
, rejected
, answered
, closed
& void
. For example, filter[status]=open
[Obsolete("This property is deprecated, use FilterstatusAsGetFilterStatusQueryParameterType instead")]
[QueryParameter("filter%5Bstatus%5D")]
public string[]? Filterstatus { get; set; }
Property Value
- string[]
FilterstatusAsGetFilterStatusQueryParameterType
Retrieves RFIs with the specified status. Possible values: draft
, submitted
, open
, rejected
, answered
, closed
& void
. For example, filter[status]=open
[QueryParameter("filter%5Bstatus%5D")]
public GetFilterStatusQueryParameterType[]? FilterstatusAsGetFilterStatusQueryParameterType { get; set; }
Property Value
Limit
The number of RFIs to return in the response payload. Acceptable values: 1-200. Default value: 10. For example, to limit the response to two RFIs per page, use limit=2
[QueryParameter("limit")]
public int? Limit { get; set; }
Property Value
- int?
Offset
Number of RFIs into the collection that the pagination starts on. For example, to begin the results from the fourth record, use offset=3
[QueryParameter("offset")]
public int? Offset { get; set; }
Property Value
- int?
Sort
Sort the RFIs by createdAt
, status
, dueDate
, title
, location
, updatedAt
, costImpact
, scheduleImpact
, priority
, discipline
, category
, reference
, customIdentifier
. For example, sort=status ASC
. Separate multiple values with commas. To sort in descending order add a DESC
after the sort criteria. For example, sort=status DESC
.
[Obsolete("This property is deprecated, use SortAsGetSortQueryParameterType instead")]
[QueryParameter("sort")]
public string[]? Sort { get; set; }
Property Value
- string[]
SortAsGetSortQueryParameterType
Sort the RFIs by createdAt
, status
, dueDate
, title
, location
, updatedAt
, costImpact
, scheduleImpact
, priority
, discipline
, category
, reference
, customIdentifier
. For example, sort=status ASC
. Separate multiple values with commas. To sort in descending order add a DESC
after the sort criteria. For example, sort=status DESC
.
[QueryParameter("sort")]
public GetSortQueryParameterType[]? SortAsGetSortQueryParameterType { get; set; }