Overview

Configuration is provided for establishing connections with Autodesk Construction Cloud service. The configuration is used in the REST Connection Manager.
Setup
Press
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
This guide provides a step-by-step walkthrough on how to create a connection to the Autodesk Construction Cloud REST API using COZYROC's REST Connection Manager using OAuth Authorization Code Flow.
Congratulations! You’ve successfully established a connection to your Autodesk Constriction Cloud instance. You’re now ready to begin integrating and working with your data.
This guide provides a step-by-step walkthrough on how to create a connection to the Autodesk Construction Cloud REST API using COZYROC's REST Connection Manager using OAuth Client Credentials Flow.
Congratulations! You’ve successfully established a connection to your Autodesk Constriction Cloud instance. You’re now ready to begin integrating and working with your data.
This guide demonstrates how to read data from the Autodesk Construction Cloud service using the COZYROC REST Source component.
Step 3: Double-click the REST Source component to open its settings. From the dropdown menu, select your Autodesk Construction Cloud connection. Then, choose the desired resource from the list available in the second dropdown below.
If necessary, you can add additional parameters in the grid at the bottom..
This guide provides a step-by-step demonstration on how to write data to the Autodesk Construction Cloud service resource using the COZYROC REST Destination component.
Step 4: Click the Mapping tab and map the input columns according to the process you are configuring.
If you need to provide input for other composite resource objects, adjust the inputs above accordingly and map the corresponding columns.
You’re all set! You have successfully learned how to write data to the Autodesk Construction Cloud resource.
Configuration
Base URL address: https://developer.api.autodesk.com.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- client_id: Required. Specify client identifier.
- client_secret: Required. Specify client secret.
- scope: Required. Specify a valid scope name, separated by a space.
- redirect_uri: Required. Specify redirect_uri.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://aps.autodesk.com/en/docs/oauth/v2/tutorials/get-3-legged-token/.
- Client Credential
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client identifier.
- client_secret: Required. Specify client secret.
- scope: Required. Specify a valid scope name, separated by a space.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://aps.autodesk.com/en/docs/oauth/v2/reference/http/gettoken-POST/.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/construction/admin/v1/accounts/{{=ACC.UI.AccountEditor.getValue(parameters)}}/projects.The action has the following user-defined parameters:
- accountId: Required. Specify the ID of the ACC account that contains the project being created or the projects being retrieved.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/admin-accounts-accountidprojects-GET/.
- [Read single] action
-
Endpoint URL address:
{{=new Uri(connection.serverHost).authority()}}/construction/admin/v1/projects/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/admin-projectsprojectId-GET/.
- [Create] action
-
Endpoint URL address:
/construction/admin/v1/accounts/{{=item.accountId}}/projects.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/admin-accounts-accountidprojects-POST/.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- startDate
Template: Date.
- endDate
Template: Date.
- type
Template: ShortText.
- classification
Template: ShortText.
- projectValue
Field components:
-
Uses template:
ShortText. - Contains the following components: value, currency.
-
Uses template:
- status
Template: ShortText.
- jobNumber
Template: ShortText.
- addressLine1
Template: ShortText.
- addressLine2
Template: ShortText.
- city
Template: ShortText.
- stateOrProvince
Template: ShortText.
- postalCode
Template: ShortText.
- country
Template: ShortText.
- latitude
Template: ShortText.
- longitude
Template: ShortText.
- timezone
Template: ShortText.
- constructionType
Template: ShortText.
- deliveryMethod
Template: ShortText.
- contractType
Template: ShortText.
- currentPhase
Template: ShortText.
- businessUnitId
Template: ShortText.
- lastSignIn
Template: DateTime.
- imageUrl
Template: LongText.
- thumbnailImageUrl
Template: LongText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- memberGroupId
Data type: DT_I4
- adminGroupId
Data type: DT_I4
- accountId
Template: ShortText.
- sheetCount
Data type: DT_I4
- products
Field components:
- An array.
-
Uses template:
Product.
- platform
Template: ShortText.
- companyCount
Data type: DT_I4
- memberCount
Data type: DT_I4
- assets
The gathered value is processed with
{{=connection.resourceManager['Asset'].getData({ parameters: ['projectId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Asset.
- users
The gathered value is processed with
{{=connection.resourceManager['Project | User'].getData({ parameters: ['projectId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ProjectUser.
- categories
The gathered value is processed with
{{=connection.resourceManager['Category'].getData({ parameters: ['projectId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Category.
- industryRoles
The value is gathered from
/hq/v2/accounts/{{=ACC.UI.AccountEditor.getValue(parameters)}}/projects/{{=item.id}}/industry_rolesaddress. The gathered value is processed with{{=response}}expression. Field components:- An array.
- Contains the following components: id, project_id, name, services, member_group_id.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: createUpdateImage.
-
Uses template:
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/construction/admin/v1/accounts/{{=ACC.UI.AccountEditor.getValue(parameters)}}/companies.The action has the following user-defined parameters:
- accountId: Required. Specify the ID of the ACC account that contains the project being created or the projects being retrieved.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/companies-GET/.
- [Read single] action
-
Endpoint URL address:
{{=new Uri(connection.serverHost).authority()}}/hq/v1/accounts/{{=ACC.UI.AccountEditor.getValue(parameters)}}/companies/{{=parameters.id}}.The action has the following user-defined parameters:
- accountId: Required. Specify the ID of the ACC account that contains the project being created or the projects being retrieved.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/companies-:company_id-GET/.
- [Read search] action
-
Endpoint URL address:
{{=new Uri(connection.serverHost).authority()}}/hq/v1/accounts/{{=ACC.UI.AccountEditor.getValue(parameters)}}/companies/search.The action has the following user-defined parameters:
- accountId: Required. Specify the ID of the ACC account that contains the project being created or the projects being retrieved.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/companies-search-GET/.
- [Create] action
-
Endpoint URL address:
{{=new Uri(connection.serverHost).authority()}}/hq/v1/accounts/{{=item.accountId}}/companies.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/companies-POST/.
- [Update] action
-
Endpoint URL address:
{{=new Uri(connection.serverHost).authority()}}/hq/v1/accounts/{{=item.accountId}}/companies/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/companies-:company_id-PATCH/.
- id
A key field. Template: ShortText.
- accountId
Template: ShortText.
- name
Template: ShortText.
- trade
Template: ShortText.
- addresses
Field components:
- An array.
- Contains the following components: type, addressLine1, addressLine2, city, stateOrProvince, postalCode, country, phone.
- websiteUrl
Template: LongText.
- description
Template: LongText.
- erpId
Data type: DT_I4
- taxId
Data type: DT_I4
- imageUrl
Template: LongText.
- status
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- originalName
Template: ShortText.
- projectSize
Data type: DT_I4
- userSize
Data type: DT_I4
- address_line_1
Template: ShortText.
- address_line_2
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: createUpdateImage.
-
Uses template:
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/hq/v1/accounts/{{=ACC.UI.AccountEditor.getValue(parameters)}}/users.
The result is extracted from:{{=response}}.The action has the following user-defined parameters:
- accountId: Required. Specify the ID of the ACC account that contains the project being created or the projects being retrieved.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/users-GET/.
- [Read single] action
-
Endpoint URL address:
/hq/v1/accounts/{{=ACC.UI.AccountEditor.getValue(parameters)}}/users/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- accountId: Required. Specify the ID of the ACC account that contains the project being created or the projects being retrieved.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/users-:user_id-GET/.
- [Create] action
-
Endpoint URL address:
/hq/v1/accounts/{{=item.account_id}}/users.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/users-POST/.
- [Update] action
-
Endpoint URL address:
/hq/v1/accounts/{{=item.account_id}}/users/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/users-:user_id-PATCH/.
- id
A key field. Template: ShortText.
- account_id
Template: ShortText.
- status
Template: ShortText.
- role
Template: ShortText.
- company_id
Template: ShortText.
- company_name
Template: ShortText.
- last_sign_in
Template: DateTime. A read-only field.
Template: ShortText.
- name
Template: ShortText.
- nickname
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- uid
Template: ShortText.
- image_url
Template: LongText.
- address_line_1
Template: ShortText.
- address_line_2
Template: ShortText.
- city
Template: ShortText.
- postal_code
Template: ShortText.
- state_or_province
Template: ShortText.
- country
Template: ShortText.
- phone
Template: ShortText.
- company
Template: ShortText.
- job_title
Template: ShortText.
- industry
Template: ShortText.
- about_me
Template: ShortText.
- default_role
Template: ShortText.
- default_role_id
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/construction/admin/v1/projects/{{=parameters.projectId}}/users.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/admin-projectsprojectId-users-GET/.
- [Read single] action
-
Endpoint URL address:
/construction/admin/v1/projects/{{=parameters.projectId}}/users/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/admin-projectsprojectId-users-userId-GET/.
- [Create] action
-
Endpoint URL address:
/v1/projects/{{=item.projectId}}/users.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/admin-projects-project-Id-users-POST/.
- [Update] action
-
Endpoint URL address:
/v1/projects/{{=item.projectId}}/users/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/admin-projects-project-Id-users-userId-PATCH/.
- [Delete] action
-
Endpoint URL address:
/v1/projects/{{=item.projectId}}/users/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/admin-projects-project-Id-users-userId-DELETE/.
The resource includes the fields from the ProjectUser template.
- projectId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hq/v1/accounts/{{=ACC.UI.AccountEditor.getValue(parameters)}}/business_units_structure.
The result is extracted from:{{=response.business_units}}.The action has the following user-defined parameters:
- accountId: Required. Specify the ID of the ACC account that contains the project being created or the projects being retrieved.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/business_units_structure-GET/.
- [Upsert] action
-
Endpoint URL address:
/hq/v1/accounts/{{=item.account_id}}/business_units_structure.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ business_units: [item] } }}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/business_units_structure-PUT/.
-
application/json:
- id
A key field. Template: ShortText.
- account_id
A key field. Template: ShortText.
- parent_id
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- path
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/construction/assets/v2/projects/{{=parameters.projectId}}/assets.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-assets-v2-GET/.
- [Create] action
-
Endpoint URL address:
/construction/assets/v2/projects/{{=parameters.projectId}}/assets:batch-create.
The result is extracted from:{{=undefined}}.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
The following request parameters will be automatically processed:
-
application/json:
{{=batch}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-assets-batch-create-POST-v2/.
- [Update] action
-
Endpoint URL address:
/construction/assets/v2/projects/{{=parameters.projectId}}/assets:batch-patch.
The result is extracted from:{{=undefined}}.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
The following request parameters will be automatically processed:
-
application/json:
{{=batch}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-assets-batch-patch-PATCH-v2/.
- [Delete] action
-
Endpoint URL address:
/construction/assets/v2/projects/{{=parameters.projectId}}/assets:batch-delete.
The result is extracted from:{{=undefined}}.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
The following request parameters will be automatically processed:
-
application/json:
{{=batch}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-assets-batch-delete-v2-POST/.
The resource includes the fields from the Asset template.
- [External]
-
The external fields URL address:
/construction/assets/v1/projects/{{=parameters.projectId}}/custom-attributes. The external fields list is extracted from:{{=ACC.getCustomFields(response.results, 'asset')}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/construction/assets/v1/projects/{{=parameters.projectId}}/categories.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-categories-GET/.
- [Create] action
-
Endpoint URL address:
/construction/assets/v1/projects/{{=item.projectId}}/categories.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-categories-POST/.
The resource includes the fields from the Category template.
- projectId
Template: ShortText.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/construction/assets/v1/projects/{{=parameters.projectId}}/status-step-sets.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-status-step-sets-GET/.
- [Create] action
-
Endpoint URL address:
/construction/assets/v1/projects/{{=item.projectId}}/status-step-sets.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-status-step-sets-POST/.
- id
A key field. Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- deletedAt
Template: DateTime. A read-only field.
- deletedBy
Template: ShortText.
- isActive
Data type: DT_BOOL
- version
Data type: DT_I4
- projectId
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- isDefault
Data type: DT_BOOL
- values
Field components:
- An array.
- Contains the following components: label, description, color, statusStepSetId, id, createdAt, createdBy, updatedAt, updatedBy, deletedAt, deletedBy, isActive, version, projectId, bucket, sortOrder.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/construction/assets/v1/projects/{{=parameters.projectId}}/asset-statuses.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-asset-statuses-GET/.
- [Create] action
-
Endpoint URL address:
/construction/assets/v1/projects/{{=item.projectId}}/asset-statuses.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-asset-statuses-POST/.
- label
A key field. Template: ShortText.
- description
Template: LongText.
- color
Template: ShortText.
- statusStepSetId
Template: ShortText.
- id
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- deletedAt
Template: DateTime. A read-only field.
- deletedBy
Template: ShortText.
- isActive
Data type: DT_BOOL
- version
Data type: DT_I4
- projectId
Template: ShortText.
- bucket
Template: ShortText.
- sortOrder
Data type: DT_I4
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/construction/assets/v1/projects/{{=parameters.projectId}}/custom-attributes.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-custom-attributes-GET/.
- [Create] action
-
Endpoint URL address:
/construction/assets/v1/projects/{{=item.projectId}}/custom-attributes.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-custom-attributes-POST/.
- [Update] action
-
Endpoint URL address:
/construction/assets/v1/projects/{{=item.projectId}}/custom-attributes/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/assets-custom-attributes-custom-attribute-id-PATCH/.
- id
A key field. Template: ShortText.
- displayName
Template: ShortText.
- description
Template: LongText.
- enumValues
Template: LongText. A composite field.
- requiredOnIngress
Data type: DT_BOOL
- maxLengthOnIngress
Data type: DT_I4
- defaultValue
Template: ShortText.
- dataType
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- deletedAt
Template: DateTime. A read-only field.
- deletedBy
Template: ShortText.
- isActive
Data type: DT_BOOL
- version
Data type: DT_I4
- projectId
Template: ShortText.
- name
Template: ShortText.
- values
Field components:
- An array.
- Contains the following components: id, createdAt, createdBy, updatedAt, updatedBy, deletedAt, deletedBy, isActive, version, projectId, customAttributeId, displayName.
Based on resource template CostManagement.
- [Read] action
-
Endpoint URL address:
/workflows/{{=parameters.associationType}}/{{=parameters.associationId}}/actions.The action has the following user-defined parameters:
- associationId: Required. Specify the object ID of the item is associated to. For example, the ID of a budget, contract or cost item.
- associationType: Required. Specify the type of the item with which the actions are associated. Possible values are FormInstance and CostItem
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-actions-GET/.
- [Create] action
-
Endpoint URL address:
/workflows/actions.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-actions-POST/.
- name
Template: ShortText.
- transforms
Field components:
- An array.
- Contains the following components: key, to.
- rules
Field components:
- An array.
- Contains the following components: key, only.
- containerId
Template: ShortText.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/cost/v1/containers/{{=parameters.containerId}}/attachments.The action has the following user-defined parameters:
- containerId: Required. Specify the id of the cost container for the project
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-attachments-GET/.
- [Create] action
-
Endpoint URL address:
/cost/v1/containers/{{=item.containerId}}/attachments.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-attachments-POST/.
- [Delete] action
-
Endpoint URL address:
/cost/v1/containers/{{=item.containerId}}/attachments/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-attachments-attachmentId-DELETE/.
- id
A key field. Template: ShortText.
- folderId
Template: ShortText.
- urn
Template: ShortText.
- pdfOssUrn
Template: ShortText.
- pdfUrn
Template: ShortText.
- type
Template: ShortText.
- name
Template: ShortText.
- replaceIfExists
Data type: DT_BOOL
- status
Template: ShortText.
- associationId
Template: ShortText.
- associationType
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- containerId
A key field. Template: ShortText.
Based on resource template CostManagement.
- [Read] action
-
Endpoint URL address:
/properties.
The result is extracted from:{{=response}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-properties-GET/.
The resource includes the fields from the Attribute template.
Based on resource template CostManagement.
- [Create] action
-
Endpoint URL address:
/property-values:batch-update.
The result is extracted from:{{=undefined}}.The following request parameters will be automatically processed:
-
application/json:
{{=batch}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-property-valuesbatch-update-POST/.
-
application/json:
- associationId
Template: ShortText.
- associationType
Template: ShortText.
- propertyDefinitionId
Template: ShortText.
- value
Template: ShortText.
- containeraId
Template: ShortText.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/budgets.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-budgets-GET/.
-
include:
- [Read single] action
-
Endpoint URL address:
/budgets/{{=parameters.id}}.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-budgets-budgetId-GET/.
-
include:
- [Create] action
-
Endpoint URL address:
/budgets.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-budgets-POST/.
- [Update] action
-
Endpoint URL address:
/budgets/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-budgets-budgetId-PATCH/.
- [Delete] action
-
Endpoint URL address:
/budgets/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-budgets-budgetId-DELETE/.
The resource includes the fields from the Budget template.
- compounded
Template: Compound.
- mainContract
Template: MainContract.
- contract
Field components:
- An array.
-
Uses template:
Contract.
- attributes
Field components:
- An array.
-
Uses template:
Attribute.
- segments
Field components:
- An array.
-
Uses template:
BudgetCodeSegment.
- mainContractItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, mainContractId.
-
Uses template:
- codeSegmentValues
Template: NameToValue.
- codeSegmentValues
Template: NameToValue.
- segmentCodeMap
Template: NameToValue.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: linkBudgetContract.
-
Uses template:
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/cost/v1/containers/{{=parameters.containerId}}/segment-values.The action has the following user-defined parameters:
- containerId: Required. Specify the id of the cost container for the project
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-segment-values-GET/.
- id
A key field. Template: ShortText.
- segmentId
Template: ShortText.
- parentId
Template: ShortText.
- code
Template: ShortText.
- originalCode
Template: ShortText.
- description
Template: LongText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- containerId
A key field. Template: ShortText.
- values
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Budget | Code Segment Value | Value'].getData({ parameters: ['containerId=' + parameters.containerId, 'segmentId=' + item.segmentId] })}}expression. Field components:- An array.
-
Uses template:
BudgetCodeSegmentValue.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/segments/{{=parameters.segmentId}}/values.The action has the following user-defined parameters:
- segmentId: Required. Specify the segment identifier.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-values-GET/.
- [Read single] action
-
Endpoint URL address:
/segments/{{=parameters.segmentId}}/values/{{=parameters.id}}.The action has the following user-defined parameters:
- segmentId: Required. Specify the segment identifier.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-segments-segmentId-GET/.
- [Create] action
-
Endpoint URL address:
/segments/{{=item.segmentId}}/values.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-values-POST/.
- [Update] action
-
Endpoint URL address:
/segments/{{=item.segmentId}}/values/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-values-valueId-PATCH/.
- [Delete] action
-
Endpoint URL address:
/segments/{{=item.segmentId}}/values/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-values-valueId-DELETE/.
The resource includes the fields from the BudgetCodeSegmentValue template.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/segments.The action has the following user-defined parameters:
- templateId: Required. Specify the template identifier.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-templates-templateId-segments-GET/.
- [Read single] action
-
Endpoint URL address:
/templates/{{=parameters.templateId}}/segments/{{=parameters.id}}.The action has the following user-defined parameters:
- templateId: Required. Specify the template identifier.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-segments-segmentId-GET/.
- [Create] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/segments.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-values-POST/.
- [Update] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/segments/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-segments-segmentId-PATCH/.
- [Delete] action
-
Endpoint URL address:
/templates/{{=item.templateId}}/segments/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-segments-segmentId-DELETE/.
The resource includes the fields from the BudgetCodeSegment template.
Based on resource template CostManagement.
- [Read] action
-
Endpoint URL address:
/templates.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-templates-GET/.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- locked
Data type: DT_BOOL
- integrationState
Template: ShortText.
- integrationStateChangedAt
Template: ShortText.
- integrationStateChangedBy
Template: ShortText.
- segments
Field components:
- An array.
-
Uses template:
BudgetCodeSegment.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/change-orders/{{=parameters.changeOrder}}.The action has the following user-defined parameters:
- changeOrder: Required. Specify the change order type
The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-change-orders-changeOrder-GET/.
- [Read single] action
-
Endpoint URL address:
/change-orders/{{=parameters.changeOrder}}/{{=parameters.id}}.The action has the following user-defined parameters:
- changeOrder: Required. Specify the change order type.
The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-change-orders-changeOrder-id-GET/.
- [Create] action
-
Endpoint URL address:
/change-orders/{{=item.type}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-change-orders-changeOrder-POST/.
- [Update] action
-
Endpoint URL address:
/change-orders/{{=item.type}}/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-change-orders-changeOrder-id-PATCH/.
- [Delete] action
-
Endpoint URL address:
/change-orders/{{=item.type}}/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-change-orders-changeOrder-id-DELETE/.
The resource includes the fields from the ChangeOrder template.
- attributes
Field components:
- An array.
-
Uses template:
Attribute.
- costItems
Field components:
- An array.
-
Uses template:
CostItem.
Based on resource template CostManagement.
- [Read] action
-
Endpoint URL address:
/change-orders.
The result is extracted from:{{=response}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-change-orders-GET/.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- actAs
Template: ShortText.
- position
Template: ShortText.
- workflowType
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/contracts.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-contracts-GET/.
-
include:
- [Read single] action
-
Endpoint URL address:
/contracts/{{=parameters.id}}.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-contracts-contractId-GET/.
-
include:
- [Create] action
-
Endpoint URL address:
/contracts.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-contracts-POST/.
- [Update] action
-
Endpoint URL address:
/contracts/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-contracts-contractId-PATCH/.
- [Delete] action
-
Endpoint URL address:
/contracts/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-contracts-contractId-DELETE/.
The resource includes the fields from the Contract template.
- compounded
Template: Compound.
- budgets
Field components:
- An array.
- Contains the following components: id, mainContractId.
- scheduleOfValues
Field components:
- An array.
-
Uses template:
ScheduleOfValue.
- attributes
Field components:
- An array.
-
Uses template:
Attribute.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/cost-items.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-cost-items-GET/.
-
include:
- [Read single] action
-
Endpoint URL address:
/cost-items/{{=parameters.id}}.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-cost-items-costItemId-GET/.
-
include:
- [Create] action
-
Endpoint URL address:
/cost-items.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-cost-items-POST/.
- [Update] action
-
Endpoint URL address:
/cost-items/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-cost-items-costItemId-PATCH/.
- [Delete] action
-
Endpoint URL address:
/cost-items/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-cost-items-costItemId-DELETE/.
The resource includes the fields from the CostItem template.
- budget
Template: Budget.
- subCostItems
Field components:
- An array.
-
Uses template:
CostItem.
- attributes
Field components:
- An array.
-
Uses template:
Attribute.
- changeOrders
Field components:
- An array.
-
Uses template:
ChangeOrder.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/expenses.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-GET/.
-
include:
- [Read single] action
-
Endpoint URL address:
/expenses/{{=parameters.id}}.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-id-GET/.
-
include:
- [Create] action
-
Endpoint URL address:
/expenses.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-POST/.
- [Update] action
-
Endpoint URL address:
/expenses/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-id-PATCH/.
- [Delete] action
-
Endpoint URL address:
/expenses/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-id-DELETE/.
- id
A key field. Template: ShortText.
- mainContract
Template: MainContract.
- supplierId
Template: ShortText.
- supplierCompanyUid
Template: ShortText.
- supplierName
Template: ShortText.
- mainContractId
Template: ShortText.
- budgetPaymentId
Template: ShortText.
- number
Data type: DT_I4
- name
Template: ShortText.
- description
Template: LongText.
- note
Template: LongText.
- term
Template: ShortText.
- referenceNumber
Data type: DT_I4
- type
Template: ShortText.
- scope
Template: ShortText.
- creatorId
Template: ShortText.
- changedBy
Template: ShortText.
- purchasedBy
Template: ShortText.
- status
Template: ShortText.
- amount
Data type: DT_R8
- paymentDue
Template: DateTime. A read-only field.
- issuedAt
Template: DateTime. A read-only field.
- receivedAt
Template: DateTime. A read-only field.
- approvedAt
Template: DateTime. A read-only field.
- paidAt
Template: DateTime. A read-only field.
- forecastDistributionAt
Template: DateTime. A read-only field.
- paymentType
Template: ShortText.
- paymentReference
Template: ShortText.
- externalId
Template: ShortText.
- externalSystem
Template: ShortText.
- externalMessage
Template: ShortText.
- lastSyncTime
Template: ShortText.
- integrationState
Template: ShortText.
- integrationStateChangedAt
Template: DateTime. A read-only field.
- integrationStateChangedBy
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- attributes
Field components:
- An array.
-
Uses template:
Attribute.
- expenseItems
Field components:
- An array.
-
Uses template:
ExpenseItem.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/expenses/{{=parameters.expenseId}}/items.The action has the following user-defined parameters:
- expenseId: Required. Specify a list of the object IDs of the expenses whose items you want to retrieve, separated by commas.
The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-GET/.
- [Read single] action
-
Endpoint URL address:
/expenses/{{=parameters.expenseId}}/items/{{=parameters.id}}.The action has the following user-defined parameters:
- expenseId: Required. Specify a list of the object IDs of the expenses whose items you want to retrieve, separated by commas.
The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-expenseId-items-id-GET/.
- [Create] action
-
Endpoint URL address:
/expenses/{{=item.expenseId}}/items.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-expenseId-items-POST/.
- [Update] action
-
Endpoint URL address:
/expenses/{{=item.expenseId}}/items/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-expenseId-items-id-PATCH/.
- [Delete] action
-
Endpoint URL address:
/expenses/{{=item.expenseId}}/items/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-expenseId-items-id-PATCH/.
The resource includes the fields from the ExpenseItem template.
- attributes
Field components:
- An array.
-
Uses template:
Attribute.
- budget
Template: Budget.
- contract
Template: Contract.
- expenseId
A key field. Template: ShortText.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/main-contracts.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-main-contracts-mainContractId-items-GET/.
-
include:
- [Read single] action
-
Endpoint URL address:
/main-contracts/{{=parameters.id}}.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-main-contracts-id-GET/.
-
include:
- [Create] action
-
Endpoint URL address:
/main-contracts.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-main-contracts-POST/.
- [Update] action
-
Endpoint URL address:
/main-contracts/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-main-contracts-id-PATCH/.
- [Delete] action
-
Endpoint URL address:
/main-contracts/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-main-contracts-id-DELETE/.
The resource includes the fields from the MainContract template.
- attributes
Field components:
- An array.
-
Uses template:
Attribute.
- mainContractItems
Template: ContractItem.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/main-contracts/{{=parameters.mainContractId}}/items.The action has the following user-defined parameters:
- mainContractId: Required. Specify the main contract identifier.
The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-GET/.
- [Read single] action
-
Endpoint URL address:
/main-contracts/{{=parameters.mainContractId}}/items/{{=parameters.id}}.The action has the following user-defined parameters:
- mainContractId: Required. Specify the main contract identifier.
The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-expenseId-items-id-GET/.
- [Create] action
-
Endpoint URL address:
/main-contracts/{{=item.mainContractId}}/items.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-expenseId-items-POST/.
- [Update] action
-
Endpoint URL address:
/main-contracts/{{=item.mainContractId}}/items/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-expenseId-items-id-PATCH/.
- [Delete] action
-
Endpoint URL address:
/main-contracts/{{=item.mainContractId}}/items/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-expenseId-items-id-PATCH/.
The resource includes the fields from the ContractItem template.
- budget
Template: Budget.
- mainContract
Template: Contract.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/payments.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-payments-GET/.
-
include:
- [Read single] action
-
Endpoint URL address:
/payments/{{=parameters.id}}.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-main-contracts-id-GET/.
-
include:
- id
A key field. Template: ShortText.
- billingPeriodId
Template: ShortText.
- previousPaymentId
Template: ShortText.
- associationId
Template: ShortText.
- mainContractId
Template: ShortText.
- budgetPaymentId
Template: ShortText.
- associationType
Template: ShortText.
- startDate
Template: Date.
- endDate
Template: Date.
- dueDate
Template: Date.
- number
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- note
Template: ShortText.
- approvedAt
Template: DateTime.
- calculatedAt
Template: DateTime.
- calculatedBy
Template: ShortText.
- companyId
Template: ShortText.
- companyUid
Template: ShortText.
- contactId
Template: ShortText.
- creatorId
Template: ShortText.
- status
Template: ShortText.
- paidAt
Template: DateTime.
- forecastDistributionAt
Template: ShortText.
- submittedAt
Template: ShortText.
- contractAmount
Data type: DT_R8
- originalAmount
Data type: DT_R8
- amount
Data type: DT_R8
- previousAmount
Data type: DT_R8
- currentCompletedWorkRetentionPercent
Data type: DT_R8
- completedWorkRetainedPercent
Data type: DT_R8
- completedWorkRetention
Data type: DT_R8
- completedWorkGrossRetentionPercent
Data type: DT_R8
- currentMaterialsRetentionPercent
Data type: DT_R8
- materialsOnStoreRetention
Data type: DT_R8
- materialsRetention
Data type: DT_R8
- materialsGrossRetentionPercent
Data type: DT_R8
- materialsRetainedPercent
Data type: DT_R8
- totalGrossRetentionPercent
Data type: DT_R8
- totalRetainedPercent
Data type: DT_R8
- previousRetention
Data type: DT_R8
- netRetention
Data type: DT_R8
- materialsOnStore
Data type: DT_R8
- previousMaterialsOnStore
Data type: DT_R8
- materialsBilled
Data type: DT_R8
- previousMaterialsBilled
Data type: DT_R8
- netMaterialsOnStore
Data type: DT_R8
- approvedChangeOrders
Data type: DT_R8
- previousApprovedChangeOrders
Data type: DT_R8
- netAmount
Data type: DT_R8
- advanceAmount
Data type: DT_R8
- advancePercent
Data type: DT_R8
- previousAdvanceAmount
Data type: DT_R8
- previousAdvanceAmountForeignCurrency
Data type: DT_R8
- recoupmentAmount
Data type: DT_R8
- recoupmentPercentOfCompletedWork
Data type: DT_R8
- previousRecoupmentAmount
Data type: DT_R8
- previousRecoupmentAmountForeignCurrency
Data type: DT_R8
- aggregateBy
Template: ShortText.
- hasItemRejected
Data type: DT_BOOL
- hasItemReviewed
Data type: DT_BOOL
- exchangeRate
Data type: DT_R8
- previousExchangeRate
Data type: DT_R8
- previousAmountForeignCurrency
Data type: DT_R8
- previousClaimedAmountForeignCurrency
Data type: DT_R8
- contractAmountForeignCurrency
Data type: DT_R8
- originalAmountForeignCurrency
Data type: DT_R8
- approvedChangeOrdersForeignCurrency
Data type: DT_R8
- previousApprovedChangeOrdersForeignCurrency
Data type: DT_R8
- completedWorkRetentionForeignCurrency
Data type: DT_R8
- materialsRetentionForeignCurrency
Data type: DT_R8
- previousRetentionForeignCurrency
Data type: DT_R8
- previousMaterialsBilledForeignCurrency
Data type: DT_R8
- recipients
Field components:
- An array.
- Contains the following components: id, isDefault.
- attributes
Field components:
- An array.
-
Uses template:
Attribute.
- netAmountForeignCurrency
Data type: DT_R8
- claimedAmount
Data type: DT_R8
- previousClaimedAmount
Data type: DT_R8
- architectCompanyId
Template: ShortText.
- architectCompanyUid
Template: ShortText.
- architectContactId
Template: ShortText.
- additionalCollaborators
Field components:
- An array.
-
Uses template:
AdditionalCollaborator.
- integrationState
Template: ShortText.
- integrationStateChangedAt
Template: DateTime.
- integrationStateChangedBy
Template: ShortText.
- externalId
Template: ShortText.
- externalSystem
Template: ShortText.
- externalMessage
Template: ShortText.
- lastSyncTime
Template: DateTime.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- items
The gathered value is processed with
{{=connection.resourceManager['Payment | Item'].getData({ query: ['filter[paymentId]=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
PaymentItem.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/payment-items.The action has the following user-defined parameters:
- paymentId: Specify payment identifier if not specifying associationId.
- associationId: Specify the object ID of the item is associated to if not specifying payment identifier.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-expenses-GET/.
The resource includes the fields from the PaymentItem template.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/schedule-of-values.
The result is extracted from:{{=response}}.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-schedule-of-values-GET/.
-
include:
- [Read single] action
-
Endpoint URL address:
/schedule-of-values/{{=parameters.id}}.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-schedule-of-values-id-GET/.
-
include:
- [Create] action
-
Endpoint URL address:
/schedule-of-values.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-schedule-of-values-POST/.
- [Update] action
-
Endpoint URL address:
/schedule-of-values/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-schedule-of-values-id-PATCH/.
- [Delete] action
-
Endpoint URL address:
/schedule-of-values/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-schedule-of-values-id-DELETE/.
The resource includes the fields from the ScheduleOfValue template.
- attributes
Field components:
- An array.
-
Uses template:
Attribute.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/taxes.The action has the following user-defined parameters:
- associationId: Required. Specify the object ID of the item is associated to. For example, ID of the budget.
- associationType: Required. Specify the the category of the object the tax is associated with..
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-taxes-GET/.
- id
A key field. Template: ShortText.
- containerId
Template: ShortText.
- name
Template: ShortText.
- taxFormulaId
Template: ShortText.
- associationId
Template: ShortText.
- associationType
Template: ShortText.
- needUpdate
Data type: DT_BOOL
- options
Field components:
- Contains the following components: isTaxBeforeRetention.
- summary
Field components:
- An array.
- Contains the following components: name, amount, type, rate.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/project/v1/hubs.
The result is extracted from:{{=response.data}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-taxes-GET/.
- id
A key field. Template: ShortText.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/time-sheets.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-time-sheets-GET/.
- [Read single] action
-
Endpoint URL address:
/time-sheets/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-time-sheets-id-GET/.
- [Create] action
-
Endpoint URL address:
/time-sheets.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-time-sheets-POST/.
- [Update] action
-
Endpoint URL address:
/time-sheets/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-time-sheets-id-PATCH/.
- [Delete] action
-
Endpoint URL address:
/time-sheets/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-time-sheets-id-DELETE/.
- id
A key field. Template: ShortText.
- containerId
Template: ShortText.
- trackingItemInstanceId
Template: ShortText.
- startDate
Template: Date.
- endDate
Template: Date.
- inputQuantity
Data type: DT_R8
- inputUnit
Template: ShortText.
- outputQuantity
Data type: DT_R8
- outputUnit
Template: ShortText.
- creatorId
Template: ShortText.
- changedBy
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/performance-tracking-items.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-performance-tracking-items-GET/.
- [Read single] action
-
Endpoint URL address:
/performance-tracking-items/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-performance-tracking-items-id-GET/.
- [Create] action
-
Endpoint URL address:
/performance-tracking-items.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-performance-tracking-items-POST/.
- [Delete] action
-
Endpoint URL address:
/performance-tracking-items/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-performance-tracking-items-id-DELETE/.
- id
A key field. Template: ShortText.
- containerId
Template: ShortText.
- budgetId
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- code
Template: ShortText.
- quantity
Data type: DT_I4
- unit
Template: ShortText.
- unitPrice
Data type: DT_R8
- originalAmount
Data type: DT_R8
- plannedStartDate
Template: ShortText.
- plannedEndDate
Template: ShortText.
- locations
Template: LongText. A composite field.
- locationPaths
Template: LongText. A composite field.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/performance-tracking-item-instances.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-performance-tracking-items-GET/.
- [Read single] action
-
Endpoint URL address:
/performance-tracking-item-instances/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-performance-tracking-item-instances-id-GET/.
- [Create] action
-
Endpoint URL address:
/performance-tracking-item-instances.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-performance-tracking-item-instances-POST/.
- [Update] action
-
Endpoint URL address:
/performance-tracking-item-instances/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-performance-tracking-item-instances-id-PATCH/.
- [Delete] action
-
Endpoint URL address:
/performance-tracking-item-instances/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-performance-tracking-item-instances-id-DELETE/.
- id
A key field. Template: ShortText.
- containerId
Template: ShortText.
- number
Template: ShortText.
- name
Template: ShortText.
- budgetId
Template: ShortText.
- budgetCode
Template: ShortText.
- inputUnit
Template: ShortText.
- inputQuantity
Data type: DT_R8
- inputUnitPrice
Data type: DT_R8
- outputUnit
Template: ShortText.
- outputQuantity
Data type: DT_R8
- outputUnitPrice
Data type: DT_R8
- trackedInputQuantity
Data type: DT_R8
- trackedOutputQuantity
Data type: DT_R8
- adjustedOutputQuantity
Data type: DT_R8
- performanceRatio
Data type: DT_R8
- creatorId
Template: ShortText.
- changedBy
Template: ShortText.
- locations
Template: LongText. A composite field.
- locationPaths
Template: LongText. A composite field.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template CostManagementPaging.
- [Read] action
-
Endpoint URL address:
/documents.
The result is extracted from:{{=response}}.The action has the following user-defined parameters:
- associationId: Required. Specify the object ID of the item is associated to. (e.g) id of budget, contract or cost item.
- associationType: Required. Specify the type of the item is associated to. Possible values Budget, Contract, CostItem, FormInstance, Payment, BudgetPayment, Expense, OCO, SCO.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/cost-documents-GET/.
- id
A key field. Template: ShortText.
- recipientId
Template: ShortText.
- signedBy
Template: ShortText.
- urn
Template: ShortText.
- pdfUrn
Template: ShortText.
- status
Template: ShortText.
- jobId
Data type: DT_I4
- errorInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: code, message, detail.
-
Uses template:
- associationId
Template: ShortText.
- associationType
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template DataConnector.
- [Read] action
-
Endpoint URL address:
/requests.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/data-connector-requests-GET/.
- [Read single] action
-
Endpoint URL address:
/requests/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/data-connector-requests-requestId-GET/.
- [Create] action
-
Endpoint URL address:
/requests.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/data-connector-requests-POST/.
- [Update] action
-
Endpoint URL address:
/requests/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/data-connector-requests-requestId-PATCH/.
- [Delete] action
-
Endpoint URL address:
/requests/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/data-connector-requests-requestId-DELETE/.
- id
A key field. Template: ShortText.
- description
Template: LongText.
- isActive
Data type: DT_BOOL
- accountId
Template: ShortText.
- projectId
Template: ShortText.
- createdBy
Template: ShortText.
- createdByEmail
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- scheduleInterval
Template: ShortText.
- reoccuringInterval
Template: ShortText.
- effectiveFrom
Template: DateTime.
- effectiveTo
Template: DateTime.
- lastQueuedAt
Template: DateTime.
- serviceGroups
Template: ShortText.
- callbackUrl
Template: ShortText.
- sendEmail
Data type: DT_BOOL
- startDate
Template: DateTime.
- endDate
Template: DateTime.
Based on resource template DataConnector.
- [Read] action
-
Endpoint URL address:
/jobs.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/data-connector-jobs-GET/.
- [Read single] action
-
Endpoint URL address:
/jobs/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/data-connector-jobs-jobId-GET/.
- [Delete] action
-
Endpoint URL address:
/jobs/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/data-connector-jobs-jobId-DELETE/.
- id
A key field. Template: ShortText.
- requestId
Template: ShortText.
- accountId
Template: ShortText.
- projectId
Template: ShortText.
- createdBy
Template: ShortText.
- createdByEmail
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- status
Template: ShortText.
- completionStatus
Template: ShortText.
- startedAt
Template: DateTime.
- completedAt
Template: DateTime.
- sendEmail
Data type: DT_BOOL
- progress
Template: ShortText.
- lastDownloadedBy
Template: ShortText.
- lastDownloadedAt
Template: DateTime.
- startDate
Template: DateTime.
- endDate
Template: DateTime.
- request
Template: Request. The gathered value is processed with
{{=connection.resourceManager['Request'].getData({ endpoint: 'single', parameters: ['requestId=' + item.requestId] })}}expression.
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=ACC.exportFile(parameters)}}.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
- fileVersions: Required. Specify A comma separated array list of file version URNs.
- options: Optional. Specify the criteria for the markups and links to include with the exported files.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/v1-files-export-pdf-files-POST/.
- file
Data type: DT_IMAGE
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/construction/forms/v1/projects/{{=parameters.projectId}}/forms.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/forms-forms-GET/.
- [Create] action
-
Endpoint URL address:
/construction/forms/v1/projects/{{=item.projectId}}/form-templates/{{=item.templateId}}/forms.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/forms-forms-POST/.
- [Update] action
-
Endpoint URL address:
/construction/forms/v1/projects/{{=item.projectId}}/form-templates/{{=item.templateId}}/forms/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/forms-forms-formId-PATCH/.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- projectId
A key field. Template: ShortText.
- formNum
Data type: DT_I4
- name
Template: ShortText.
- formDate
Template: Date.
- assigneeId
Template: ShortText.
- assigneeType
Template: ShortText.
- locationId
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- notes
Template: LongText.
- description
Template: LongText.
- formTemplate
Field components:
-
Uses template:
ShortText. - Contains the following components: status, id, projectId, name, templateType.
-
Uses template:
- pdfValues
Field components:
- An array.
- Contains the following components: name, value.
- pdfUrl
Template: ShortText.
- weather
Field components:
-
Uses template:
ShortText. - Contains the following components: summaryKey, precipitationAccumulation, precipitationAccumulationUnit, temperatureMin, temperatureMax, temperatureUnit, humidity, windSpeed, windGust, speedUnit, windBearing, hourlyWeather, provider.
-
Uses template:
- tabularValues
Field components:
- Contains the following components: worklogEntries, materialsEntries, equipmentEntries.
- customValues
Template: LongText. A composite field.
- lastReopenedBy
Template: ShortText.
- lastSubmitterSignature
Template: ShortText.
- userCreatedAt
Template: DateTime. A read-only field.
- createdAt
Template: DateTime. A read-only field.
- templateId
A key field. Template: ShortText.
Based on resource template Issue.
- [Read] action
-
Endpoint URL address:
/issues.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/issues-issues-GET/.
- [Read single] action
-
Endpoint URL address:
/issues/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/issues-issues-issueId-GET/.
- [Create] action
-
Endpoint URL address:
/issues.The following request parameters will be automatically processed:
-
application/json:
{{=_.omit(item, 'custom')}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/issues-issues-POST/.
-
application/json:
- [Update] action
-
Endpoint URL address:
/issues/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=_.omit(item, 'custom')}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/issues-issues-issueId-PATCH/.
-
application/json:
- id
A key field. Template: ShortText.
- projectId
Template: ShortText.
- containerId
Template: ShortText.
- deleted
Data type: DT_BOOL
- deletedAt
Template: DateTime. A read-only field.
- deletedBy
Template: ShortText.
- displayId
Data type: DT_I4
- title
Template: ShortText.
- description
Template: LongText.
- snapshotUrn
Template: ShortText.
- issueTypeId
Template: ShortText.
- issueSubtypeId
Template: ShortText.
- status
Template: ShortText.
- assignedTo
Template: ShortText.
- assignedToType
Template: ShortText.
- dueDate
Template: Date.
- startDate
Template: Date.
- locationId
Template: ShortText.
- locationDetails
Template: ShortText.
- linkedDocuments
Field components:
- An array.
- Contains the following components: type, urn, createdBy, createdAt, createdAtVersion, closedBy, closedAt, closedAtVersion, details.
- links
Template: LongText. A composite field.
- ownerId
Template: ShortText.
- rootCauseId
Template: ShortText.
- officialResponse
Template: LongText. A composite field.
- issueTemplateId
Template: ShortText.
- permittedStatuses
Template: LongText. A composite field.
- permittedAttributes
Template: LongText. A composite field.
- published
Data type: DT_BOOL
- permittedActions
Template: LongText. A composite field.
- commentCount
Data type: DT_I4
- attachmentCount
Template: ShortText.
- openedBy
Template: ShortText.
- openedAt
Template: DateTime. A read-only field.
- closedBy
Template: ShortText.
- closedAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- watchers
Template: LongText. A composite field.
- customAttributes
Field components:
- An array.
- Contains the following components: attributeDefinitionId, value, type, title.
- gpsCoordinates
Field components:
-
Uses template:
ShortText. - Contains the following components: latitude, longitude.
-
Uses template:
- snapshotHasMarkups
Data type: DT_BOOL
- comments
The gathered value is processed with
{{=connection.resourceManager['Issue | Comment'].getData({ parameters: ['projectId=' + parameters.projectId, 'issueId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
IssueComment.
- attachments
The gathered value is processed with
{{=connection.resourceManager['Issue | Attachment'].getData({ parameters: ['containerId=' + item.containerId, 'issueId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
IssueComment.
- [External]
-
The external fields URL address:
/issue-attribute-definitions. The external fields list is extracted from:{{=ACC.getCustomFields(response.results, 'issue')}}.
Based on resource template Issue.
- [Read] action
-
Endpoint URL address:
/issue-types.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/issues-issues-GET/.
-
include:
- id
A key field. Template: ShortText.
- containerId
Template: ShortText.
- title
Template: ShortText.
- isActive
Data type: DT_BOOL
- orderIndex
Data type: DT_I4
- permittedActions
Template: LongText. A composite field.
- permittedAttributes
Template: LongText. A composite field.
- subtypes
Field components:
- An array.
- Contains the following components: id, issueTypeId, title, code, isActive, orderIndex, isReadOnly, permittedActions, permittedAttributes, createdBy, createdAt, updatedBy, updatedAt, deletedBy, deletedAt.
- statusSet
Template: ShortText.
- createdBy
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- deletedBy
Template: ShortText.
- deletedAt
Template: DateTime. A read-only field.
- projectId
Template: ShortText.
Based on resource template Issue.
- [Read] action
-
Endpoint URL address:
/issue-attribute-definitions.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/issues-issue-attribute-definitions-GET/.
- id
A key field. Template: ShortText.
- containerId
Template: ShortText.
- title
Template: ShortText.
- description
Template: LongText.
- dataType
Template: ShortText.
- metadata
Field components:
- Contains the following components: list.
- permittedActions
Template: LongText. A composite field.
- permittedAttributes
Template: LongText. A composite field.
- createdAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- deletedAt
Template: DateTime. A read-only field.
- deletedBy
Template: ShortText.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/issues/v2/containers/{{=parameters.containerId}}/issues/{{=parameters.issueId}}/attachments.The action has the following user-defined parameters:
- containerId: Required. Specify the id of the cost container for the project.
- issueId: Required. Specify the identifier of the issue.
Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/issues-v2-attachments-GET/.
- [Create] action
-
Endpoint URL address:
/issues/v2/containers/{{=item.containerId}}/{{=item.issueId}}/attachments.Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/issues-v2-attachments-POST/.
- [Update] action
-
Endpoint URL address:
/issues/v2/containers/{{=item.containerId}}/{{=item.issueId}}/attachments/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/issues-v2-attachments-attachmentId-POST/.
- id
A key field. Template: ShortText.
- issueId
A key field. Template: ShortText.
- name
Template: ShortText.
- urn
Template: ShortText.
- createdBy
Template: ShortText.
- updatedBy
Template: ShortText.
- deletedBy
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- deletedAt
Template: ShortText.
- markupMetadata
Template: LongText. A composite field.
- attachmentType
Template: ShortText.
- status
Template: ShortText.
- clientCreatedAt
Template: ShortText.
- clientUpdatedAt
Template: ShortText.
- urnType
Template: ShortText.
- wipUrn
Template: LongText. A composite field.
- permittedActions
Template: LongText. A composite field.
- permittedAttributes
Template: LongText. A composite field.
- urnVersion
Data type: DT_I4
- containerId
A key field. Template: ShortText.
Based on resource template Issue.
- [Read] action
-
Endpoint URL address:
/issue-root-cause-categories.The following request parameters will be automatically processed:
-
include:
{{=ACC.getExpandableFields(parameters)}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/issues-issue-root-cause-categories-GET/.
-
include:
- id
A key field. Template: ShortText.
- title
Template: ShortText.
- isActive
Data type: DT_BOOL
- permittedActions
Template: LongText. A composite field.
- permittedAttributes
Template: LongText. A composite field.
- rootCauses
Field components:
- An array.
- Contains the following components: id, rootCauseCategoryId, title, isActive, permittedActions, permittedAttributes, createdAt, createdBy, updatedAt, updatedBy, deletedAt, deletedBy.
- createdAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- deletedAt
Template: DateTime. A read-only field.
- deletedBy
Template: ShortText.
Based on resource template Issue.
- [Read] action
-
Endpoint URL address:
/issues/{{=parameters.issueId}}/comments.The action has the following user-defined parameters:
- issueId: Required. Specify the unique identifier of a issue.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/issues-comments-GET/.
- [Create] action
-
Endpoint URL address:
/issues/{{=item.issueId}}/comments.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/issues-comments-POST/.
The resource includes the fields from the IssueComment template.
- issueId
A key field. Template: ShortText.
- projectId
Template: ShortText.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/construction/locations/v2/projects/{{=parameters.projectId}}/trees/{{=parameters.treeId}}/nodes.The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
- treeId: Required. Specify the unique identifier of a tree.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/locations-nodes-GET/.
- [Create] action
-
Endpoint URL address:
/construction/locations/v2/projects/{{=item.projectId}}/trees/{{=item.treeId}}/nodes.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/locations-nodes-POST/.
- [Update] action
-
Endpoint URL address:
/construction/locations/v2/projects/{{=item.projectId}}/trees/{{=item.treeId}}/nodes/{{=item.id}}.
The action uses PATCH method.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/locations-nodesnodeid-PATCH/.
- [Delete] action
-
Endpoint URL address:
/construction/locations/v2/projects/{{=item.projectId}}/trees/{{=item.treeId}}/nodes/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/locations-nodesnodeid-DELETE/.
The resource includes the fields from the IssueComment template.
- projectId
A key field. Template: ShortText.
- treeId
A key field. Template: ShortText.
Based on resource template Sheet.
- [Read] action
-
Endpoint URL address:
/sheets.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/sheets-sheets-GET/.
- [Update] action
-
Endpoint URL address:
/sheets:batch-update.
The action uses POST method.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/sheets-sheetsbatch-update-POST/.
- [Delete] action
-
Endpoint URL address:
/sheets:batch-delete.
The action uses POST method.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/sheets-sheetsbatch-delete-POST/.
- id
A key field. Template: ShortText.
- number
Template: ShortText.
- versionSet
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, issuanceDate, deleted.
-
Uses template:
- createdAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- createdByName
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- updatedByName
Template: ShortText.
- title
Template: ShortText.
- uploadFileName
Template: ShortText.
- uploadId
Template: ShortText.
- tags
Template: LongText. A composite field.
- paperSize
Template: LongText. A composite field.
- isCurrent
Data type: DT_BOOL
- deleted
Data type: DT_BOOL
- deletedAt
Template: DateTime. A read-only field.
- deletedBy
Template: ShortText.
- deletedByName
Template: ShortText.
- viewable
Field components:
-
Uses template:
ShortText. - Contains the following components: urn, guid.
-
Uses template:
- collection
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- ids
Template: LongText. A composite field.
- updates
Field components:
-
Uses template:
ShortText. - Contains the following components: number, title, versionSetId, addTags, removeTags.
-
Uses template:
- projectId
Template: ShortText.
Data type: DT_IMAGE The gathered value is processed with
{{=ACC.exportSheet(parameters.projectId, item.id)}}expression.- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: restore.
-
Uses template:
Based on resource template Sheet.
- [Read] action
-
Endpoint URL address:
/version-sets.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/sheets-version-sets-GET/.
- [Create] action
-
Endpoint URL address:
/version-sets.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/sheets-version-sets-POST/.
- [Update] action
-
Endpoint URL address:
/version-sets/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/sheets-version-sets-versionSetId-PATCH/.
- [Delete] action
-
Endpoint URL address:
/version-sets:batch-delete.
The action uses POST method.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/sheets-version-setsbatch-delete-POST/.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- projectId
Template: ShortText.
- issuanceDate
Template: Date.
- createdAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- createdByName
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- updatedByName
Template: ShortText.
- collection
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- ids
Template: LongText. A composite field.
Based on resource template Sheet.
- [Read] action
-
Endpoint URL address:
/collections.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/sheets-collections-GET/.
- [Read single] action
-
Endpoint URL address:
/collections/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/sheets-collections-collectionId-GET/.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- createdByName
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- updatedByName
Template: ShortText.
Based on resource template ModelCoordination.
- [Read] action
-
Endpoint URL address:
/modelsets.
The result is extracted from:{{=response.modelSets}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-get-model-sets-GET/.
- [Read single] action
-
Endpoint URL address:
/modelsets/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-get-model-set-GET/.
- [Create] action
-
Endpoint URL address:
/modelsets.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-create-model-set-POST/.
- [Update] action
-
Endpoint URL address:
/modelsets/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-patch-model-set-name-description-PATCH/.
- modelSetId
A key field. Template: ShortText.
- containerId
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- createdBy
Template: ShortText.
- createdTime
Template: DateTime. A read-only field.
- isDisabled
Data type: DT_BOOL
- isDeleted
Data type: DT_BOOL
- modelSetType
Template: ShortText.
- folders
Field components:
- An array.
- tipVersion
Data type: DT_I4
- versions
The gathered value is processed with
{{=connection.resourceManager['Model Set | Version'].getData({ parameters: ['containerId=' + parameters.containerId, 'modelSetId=' + item.modelSetId] })}}expression. Field components:- An array.
-
Uses template:
ModelSetVersion.
- views
The gathered value is processed with
{{=connection.resourceManager['Model Set | View'].getData({ parameters: ['containerId=' + parameters.containerId, 'modelSetId=' + item.modelSetId] })}}expression. Field components:- An array.
-
Uses template:
ModelSetView.
- tests
The gathered value is processed with
{{=connection.resourceManager['Model Set | Clash Test'].getData({ parameters: ['containerId=' + parameters.containerId, 'modelSetId=' + item.modelSetId] })}}expression. Field components:- An array.
-
Uses template:
ModelSetTest.
Based on resource template ModelCoordination.
- [Read] action
-
Endpoint URL address:
/modelsets/{{=parameters.modelSetId}}/versions.
The result is extracted from:{{=response.modelSetVersions}}.The action has the following user-defined parameters:
- modelSetId: Required. Specify the GUID that uniquely identifies the model set.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-get-model-set-versions-GET/.
- [Read single] action
-
Endpoint URL address:
/modelsets/{{=parameters.modelSetId}}/versions/{{=parameters.id}}.The action has the following user-defined parameters:
- modelSetId: Required. Specify the GUID that uniquely identifies the model set.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-get-model-set-version-GET/.
- [Create] action
-
Endpoint URL address:
/modelsets/{{=item.modelSetId}}/versions.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-create-model-set-version-POST/.
The resource includes the fields from the ModelSetVersion template.
- containerId
A key field. Template: ShortText.
- modelSetId
A key field. Template: ShortText.
Based on resource template ModelCoordination.
- [Read] action
-
Endpoint URL address:
/modelsets/{{=parameters.modelSetId}}/views.
The result is extracted from:{{=response.modelSetViews}}.The action has the following user-defined parameters:
- modelSetId: Required. Specify the GUID that uniquely identifies the model set.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-get-model-set-views-GET/.
- [Read single] action
-
Endpoint URL address:
/modelsets/{{=parameters.modelSetId}}/views/{{=parameters.id}}.The action has the following user-defined parameters:
- modelSetId: Required. Specify the GUID that uniquely identifies the model set.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-get-model-set-view-GET/.
- [Create] action
-
Endpoint URL address:
/modelsets/{{=item.modelSetId}}/views.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-create-model-set-view-POST/.
- [Update] action
-
Endpoint URL address:
/modelsets/{{=item.modelSetId}}/views/{{=item.viewId}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-update-model-set-view-PATCH/.
- [Delete] action
-
Endpoint URL address:
/modelsets/{{=item.modelSetId}}/views/{{=item.viewId}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-delete-model-set-view-DELETE/.
The resource includes the fields from the ModelSetView template.
- containerId
A key field. Template: ShortText.
- modelSetId
A key field. Template: ShortText.
Based on resource template ModelCoordination.
- [Read] action
-
Endpoint URL address:
/modelsets/{{=parameters.modelSetId}}/tests.
The result is extracted from:{{=response.tests}}.The action has the following user-defined parameters:
- modelSetId: Required. Specify the GUID that uniquely identifies the model set.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-modelset-service-v3-get-model-set-view-GET/.
- [Read single] action
-
Endpoint URL address:
/tests/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-clash-service-v3-get-clash-test-GET/.
The resource includes the fields from the ModelSetTest template.
Based on resource template ModelCoordination.
- [Read closed] action
-
Endpoint URL address:
/modelsets/{{=parameters.modelSetId}}/clashes/closed.
The result is extracted from:{{=response.groups}}.
The result is paginated.The action has the following user-defined parameters:
- modelSetId: Required. Specify the GUID that uniquely identifies the model set.
The following request parameters will be automatically processed:
-
continuationToken:
{{=parameters.iterator}} -
pageLimit:
{{=parameters.batchSize}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-clash-service-v3-search-container-model-set-closed-clash-groups-GET/.
- [Read assigned] action
-
Endpoint URL address:
/modelsets/{{=parameters.modelSetId}}/clashes/assigned.
The result is extracted from:{{=response.groups}}.
The result is paginated.The action has the following user-defined parameters:
- modelSetId: Required. Specify the GUID that uniquely identifies the model set.
The following request parameters will be automatically processed:
-
continuationToken:
{{=parameters.iterator}} -
pageLimit:
{{=parameters.batchSize}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-clash-service-v3-search-container-issue-clash-groups-GET/.
- [Read shared] action
-
Endpoint URL address:
/modelsets/{{=parameters.modelSetId}}/clashes/grouped.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- modelSetId: Required. Specify the GUID that uniquely identifies the model set.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/mc-clash-service-v3-get-grouped-clashes-GET/.
- id
A key field. Template: ShortText.
- clashTestId
Template: ShortText.
- title
Template: ShortText.
- description
Template: LongText.
- reason
Template: ShortText.
- issueId
Template: ShortText.
- screenShots
Template: LongText. A composite field.
- createdBy
Template: ShortText.
- createdOn
Template: DateTime. A read-only field.
- clashes
Template: LongText. A composite field.
Based on resource template Submittal.
- [Read] action
-
Endpoint URL address:
/items.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-items-GET/.
- [Read single] action
-
Endpoint URL address:
/items/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-items-id-GET/.
- [Create] action
-
Endpoint URL address:
/items.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-items-POST/.
- id
A key field. Template: ShortText.
- identifier
Data type: DT_I4
- customIdentifier
Template: ShortText.
- projectId
Template: ShortText.
- customIdentifierHumanReadable
Template: ShortText.
- typeId
Template: ShortText.
- specId
Template: ShortText.
- specIdentifier
Template: ShortText.
- specTitle
Template: ShortText.
- subsection
Template: ShortText.
- title
Template: ShortText.
- description
Template: LongText.
- priority
Template: ShortText.
- revision
Data type: DT_I4
- stateId
Template: ShortText.
- statusId
Template: ShortText.
- ballInCourtUsers
Template: LongText. A composite field.
- ballInCourtCompanies
Template: LongText. A composite field.
- ballInCourtRoles
Template: LongText. A composite field.
- ballInCourtType
Template: ShortText.
- manager
Template: ShortText.
- managerType
Template: ShortText.
- subcontractor
Template: ShortText.
- subcontractorType
Template: ShortText.
- watchers
Field components:
- An array.
- Contains the following components: id, userType.
- dueDate
Template: Date.
- requiredOnJobDate
Template: Date.
- leadTime
Data type: DT_I4
- requiredDate
Template: Date.
- requiredApprovalDate
Template: Date.
- submitterDueDate
Template: Date.
- sentToSubmitter
Template: DateTime.
- receivedFromSubmitter
Template: DateTime.
- submittedBy
Template: ShortText.
- managerDueDate
Template: Date.
- sentToReview
Template: ShortText.
- sentToReviewBy
Template: ShortText.
- receivedFromReview
Template: ShortText.
- publishedDate
Template: Date.
- publishedBy
Template: ShortText.
- responseId
Template: ShortText.
- responseComment
Template: LongText.
- respondedAt
Template: DateTime. A read-only field.
- respondedBy
Template: ShortText.
- packageId
Template: ShortText.
- packageIdentifier
Template: ShortText.
- packageTitle
Template: ShortText.
- packageSpecIdentifier
Template: ShortText.
- folderUrn
Template: ShortText.
- revisionsFoldersUrns
Field components:
- Contains the following components: 0.
- createdAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- permittedActions
Field components:
- An array.
-
Uses template:
PermittedAction.
- attachments
The gathered value is processed with
{{=connection.resourceManager['Submittal | Item | Attachment'].getData({ parameters: ['projectId=' + parameters.projectId, 'itemId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ItemAttachment.
- projectMetadata
The value is gathered from
/construction/submittals/v2/projects/{{=parameters.projectId}}/metadataaddress. The gathered value is processed with{{=response}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: id, submittalRoles, attachmentUrnTypes, itemTypes, adminMappingsSubmittalRoles, userTypes, statuses, responses, attachmentCategories, attachmentTypes, isManagerMappingDefined, noPackagesInProject, noItemsInProject, responseCategories, defaultValues, customIdentifierSequenceType.
-
Uses template:
Based on resource template Submittal.
- [Read] action
-
Endpoint URL address:
/items/{{=parameters.itemId}}/attachments.The action has the following user-defined parameters:
- itemId: Required. Specify the identifier that uniquely identifies the submittal item.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-items-itemId-attachments-GET/.
The resource includes the fields from the ItemAttachment template.
Based on resource template Submittal.
- [Read] action
-
Endpoint URL address:
/item-types.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-item-types-GET/.
- [Read single] action
-
Endpoint URL address:
/items-types/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-item-types-id-GET/.
- id
A key field. Template: ShortText.
- key
Template: ShortText.
- value
Template: ShortText.
- platformId
Template: ShortText.
- isActive
Data type: DT_BOOL
- isInUse
Data type: DT_BOOL
- createdBy
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
Based on resource template Submittal.
- [Read] action
-
Endpoint URL address:
/packages.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-packages-GET/.
- [Read single] action
-
Endpoint URL address:
/packages/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-packages-id-GET/.
- id
A key field. Template: ShortText.
- specId
Template: ShortText.
- title
Template: ShortText.
- identifier
Data type: DT_I4
- description
Template: LongText.
- specIdentifier
Template: ShortText.
- permittedActions
Field components:
- An array.
-
Uses template:
PermittedAction.
Based on resource template Submittal.
- [Read] action
-
Endpoint URL address:
/responses.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-responses-GET/.
- [Read single] action
-
Endpoint URL address:
/responses/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-responses-id-GET/.
- id
A key field. Template: ShortText.
- key
Template: ShortText.
- value
Template: ShortText.
- platformId
Template: ShortText.
- isActive
Data type: DT_BOOL
- categoryId
Template: ShortText.
- isApproval
Data type: DT_BOOL
- isInUse
Data type: DT_BOOL
- createdBy
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
Based on resource template Submittal.
- [Read] action
-
Endpoint URL address:
/settings/mappings.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-mappings-GET/.
- id
A key field. Template: ShortText.
- userType
Data type: DT_I4
- oxygenId
Template: ShortText.
- autodeskId
Template: ShortText.
- submittalsRole
Data type: DT_I4
- updatedBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
Based on resource template Submittal.
- [Read] action
-
Endpoint URL address:
/specs.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-specs-GET/.
- [Read single] action
-
Endpoint URL address:
/specs/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-responses-id-GET/.
- [Create] action
-
Endpoint URL address:
/specs.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-specs-GET/.
- id
A key field. Template: ShortText.
- title
Template: ShortText.
- identifier
Template: ShortText.
- createdBy
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- projectId
Template: ShortText.
Based on resource template TakeOff.
- [Read] action
-
Endpoint URL address:
/settings.
The result is extracted from:{{=[response]}}.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=undefined}} -
limit:
{{=undefined}}
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-settings-GET/.
-
offset:
- [Update] action
-
Endpoint URL address:
/settings.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-settings-PATCH/.
- measurementSystem
Template: ShortText.
- projectId
Template: ShortText.
Based on resource template TakeOff.
- [Read] action
-
Endpoint URL address:
/classification-systems.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-classification-systems-GET/.
- [Read single] action
-
Endpoint URL address:
/classification-systems/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-classification-systems-system_id-GET/.
- [Create] action
-
Endpoint URL address:
/classification-systems.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-classification-systems-POST/.
- [Update] action
-
Endpoint URL address:
/classification-systems/{{=item.id}}/classifications:import.
The action uses POST method.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-classification-systems-system_id-classificationsimport-POST/.
- [Delete] action
-
Endpoint URL address:
/classification-systems/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-classification-systems-system_id-DELETE/.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- projectId
Template: ShortText.
- classificationSystemName
Template: ShortText.
- classifications
Field components:
- An array.
- Contains the following components: code, parentCode, description, measurementType.
- projectId
A key field. Template: ShortText.
Based on resource template TakeOff.
- [Read] action
-
Endpoint URL address:
/packages.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-packages-GET/.
- [Read single] action
-
Endpoint URL address:
/packages/{{=parameters.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-packages-package_id-GET/.
- [Create] action
-
Endpoint URL address:
/packages.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-packages-POST/.
- [Update] action
-
Endpoint URL address:
/packages/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-packages-package_id-PATCH/.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- updatedByName
Template: ShortText.
- projectId
Template: ShortText.
- types
The gathered value is processed with
{{=connection.resourceManager['Takeoff | Type'].getData({ parameters: ['projectId=' + parameters.projectId, 'packageId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
TakeoffType.
- items
The gathered value is processed with
{{=connection.resourceManager['Takeoff | Item'].getData({ parameters: ['projectId=' + parameters.projectId, 'packageId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
TakeoffItem.
Based on resource template TakeOff.
- [Read] action
-
Endpoint URL address:
/packages/{{=parameters.packageId}}/takeoff-types.The action has the following user-defined parameters:
- packageId: Required. Specify the unique identifier of a package.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-packages-package_id-takeoff-types-GET/.
- [Read single] action
-
Endpoint URL address:
/packages/{{=parameters.packageId}}/takeoff-types/{{=parameters.id}}.The action has the following user-defined parameters:
- packageId: Required. Specify the unique identifier of a package.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-packages-package_id-takeoff-types-takeoff_type_id-GET/.
The resource includes the fields from the TakeoffType template.
Based on resource template TakeOff.
- [Read] action
-
Endpoint URL address:
/packages/{{=parameters.packageId}}/takeoff-items.The action has the following user-defined parameters:
- packageId: Required. Specify the unique identifier of a package.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-packages-package_id-takeoff-items-GET/.
- [Read single] action
-
Endpoint URL address:
/packages/{{=parameters.packageId}}/takeoff-items/{{=parameters.id}}.The action has the following user-defined parameters:
- packageId: Required. Specify the unique identifier of a package.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-packages-package_id-takeoff-items-takeoff_item_id-GET/.
The resource includes the fields from the TakeoffItem template.
Based on resource template TakeOff.
- [Read] action
-
Endpoint URL address:
/content-views.The action has the following user-defined parameters:
- packageId: Required. Specify the unique identifier of a package.
Documentation: https://aps.autodesk.com/en/docs/acc/v1/reference/http/takeoff-projects-project_id-content-views-GET/.
- id
A key field. Template: ShortText.
- type
Template: ShortText.
- view
Field components:
-
Uses template:
ShortText. - Contains the following components: sheetName, calibration.
-
Uses template:
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/bim360/rfis/v2/containers/{{=parameters.containerId}}/rfis.The action has the following user-defined parameters:
- containerId: Required. Specify the id of the cost container for the project.
Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/rfis-v2-rfis-GET/.
- [Read single] action
-
Endpoint URL address:
/bim360/rfis/v2/containers/{{=parameters.containerId}}/rfis/{{=parameters.id}}.The action has the following user-defined parameters:
- containerId: Required. Specify the id of the cost container for the project.
Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/rfis-v2-rfis-id-GET/.
- [Create] action
-
Endpoint URL address:
/bim360/rfis/v2/containers/{{=item.containerId}}/rfis.Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/rfis-v2-rfis-POST/.
- [Update] action
-
Endpoint URL address:
/bim360/rfis/v2/containers/{{=item.containerId}}/rfis/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/rfis-v2-rfis-id-PATCH/.
- id
A key field. Template: ShortText.
- customIdentifier
Template: ShortText.
- title
Template: ShortText.
- question
Template: LongText.
- virtualFolderUrn
Template: ShortText.
- status
Template: ShortText.
- assignedTo
Template: ShortText.
- managerId
Template: ShortText.
- constructionManagerId
Template: ShortText.
- architectId
Template: ShortText.
- reviewerId
Template: ShortText.
- assignedToType
Template: ShortText.
- dueDate
Template: DateTime.
- location
Field components:
-
Uses template:
LongText. - Contains the following components: description.
-
Uses template:
- linkedDocument
Template: DateTime.
- linkedDocumentVersion
Template: ShortText.
- linkedDocumentCloseVersion
Data type: DT_I4
- attachmentsCount
Data type: DT_I4
- commentsCount
Data type: DT_I4
- officialResponse
Template: ShortText.
- respondedAt
Template: DateTime.
- respondedBy
Template: ShortText.
- createdBy
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText.
- updatedAt
Template: DateTime. A read-only field.
- closedAt
Template: DateTime. A read-only field.
- closedBy
Template: ShortText.
- containerId
A key field. Template: ShortText.
- projectId
Template: ShortText.
- suggestedAnswer
Template: ShortText.
- coReviewers
Template: LongText. A composite field.
- distributionList
Template: LongText. A composite field.
- answeredAt
Template: DateTime.
- answeredBy
Template: ShortText.
- costImpact
Template: ShortText.
- scheduleImpact
Template: ShortText.
- priority
Template: ShortText.
- discipline
Template: LongText. A composite field.
- category
Template: LongText. A composite field.
- reference
Template: ShortText.
- sheetMetadata
Template: ShortText.
- pushpinAttributes
Template: ShortText.
- permittedActions
Field components:
- An array.
-
Uses template:
PermittedAction.
- comments
The gathered value is processed with
{{=connection.resourceManager['RFI | Comment'].getData({ parameters: ['containerId=' + parameters.containerId, 'rfiId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
RFIComment.
- attachments
The gathered value is processed with
{{=connection.resourceManager['RFI | Attachment'].getData({ parameters: ['containerId=' + parameters.containerId, 'rfiId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
RFIAttachment.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/bim360/rfis/v2/containers/{{=parameters.containerId}}/rfis/{{=parameters.id}}/comments.The action has the following user-defined parameters:
- containerId: Required. Specify the id of the cost container for the project.
- id: Required. Specify the id of the RFI.
Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/rfis-v2-comments-GET/.
- [Create] action
-
Endpoint URL address:
/bim360/rfis/v2/containers/{{=item.containerId}}/rfis/{{=item.rfiId}}/comments.Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/rfis-v2-comments-POST/.
The resource includes the fields from the RFIComment template.
- containerId
A key field. Template: ShortText.
Based on resource template Offset.
- [Read] action
-
Endpoint URL address:
/bim360/rfis/v2/containers/{{=parameters.containerId}}/rfis/{{=parameters.id}}/attachments.The action has the following user-defined parameters:
- containerId: Required. Specify the id of the cost container for the project.
- id: Required. Specify the id of the RFI.
Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/rfis-v2-attachments-GET/.
- [Create] action
-
Endpoint URL address:
/bim360/rfis/v2/containers/{{=item.containerId}}/rfis/{{=item.rfiId}}/attachments.Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/rfis-v2-attachments-POST/.
- [Delete] action
-
Endpoint URL address:
/bim360/rfis/v2/containers/{{=item.containerId}}/rfis/{{=item.rfiId}}/attachments/{{=item.id}}.Documentation: https://aps.autodesk.com/en/docs/bim360/v1/reference/http/rfis-v2-attachments-attachmentId-DELETE/.
The resource includes the fields from the RFIAttachment template.
- containerId
A key field. Template: ShortText.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
limit:
{{=parameters.batchSize}}
-
_includeUserParameters:
- [Read single] action
-
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify the unique record identifier.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Upsert] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=response.results}}.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
-
offset:
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=response.results}}.
The result is paginated.The following request parameters will be automatically processed:
-
cursorState:
{{=parameters.iterator}}
-
cursorState:
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=response.results}}.
The result is paginated.The following request parameters will be automatically processed:
-
limit:
{{=undefined}} -
continuationToken:
{{=parameters.iterator}} -
pageLimit:
{{=parameters.batchSize}}
-
limit:
Based on resource template Offset.
- [Read] action
-
The action has the following user-defined parameters:
- containerId: Required. Specify the id of the cost container for the project
- containerId
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
The action has the following user-defined parameters:
- containerId: Required. Specify the id of the cost container for the project
- containerId
A key field. Template: ShortText.
Based on resource template Offset.
- [Read] action
-
The action has the following user-defined parameters:
- accountId: Required. Specify the ID of the ACC account that contains the project being created or the projects being retrieved.
Based on resource template Offset.
- [Read] action
-
The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Based on resource template Offset.
- [Read] action
-
The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Based on resource template Continuation.
- [Read] action
-
The action has the following user-defined parameters:
- containerId: Required. Specify the id of the cost container for the project.
Based on resource template Offset.
- [Read] action
-
The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
Based on resource template Offset.
- [Read] action
-
The action has the following user-defined parameters:
- projectId: Required. Specify the unique identifier of a project.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 4000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Boolean
Data type: DT_BOOL
- Number
Data type: DT_R8
- MultiSelect
The gathered value is processed with
{{=value && value.join(', ')}}expression.- NameToValue
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
- CustomAttribute
Template: NameToValue.
- AdditionalCollaborator
Field components:
-
Uses template:
ShortText. - Contains the following components: companyId, companyUid, contactIds.
-
Uses template:
- Asset
Field components:
-
Uses template:
ShortText. - Contains the following components: id, createdAt, createdBy, updatedAt, updatedBy, deletedAt, deletedBy, isActive, version, clientAssetId, categoryId, statusId, description, locationId, barcode, companyId, CustomAttributes.
-
Uses template:
- Product
Field components:
-
Uses template:
ShortText. - Contains the following components: key, access, key, status, icon, name, language.
-
Uses template:
- ProjectUser
Field components:
-
Uses template:
ShortText. - Contains the following components: id, email, name, firstName, lastName, autodeskId, analyticsId, addressLine1, addressLine2, city, stateOrProvince, postalCode, country, imageUrl, phone, jobTitle, industry, aboutMe, accessLevels, addedOn, updatedAt, companyId, companyName, roleIds, roles, status, products.
-
Uses template:
- Category
Field components:
-
Uses template:
ShortText. - Contains the following components: id, createdAt, createdBy, updatedAt, updatedBy, deletedAt, deletedBy, isActive, name, description, uid, parentId, isRoot, isLeaf, subcategoryIds.
-
Uses template:
- BudgetCodeSegmentValue
Field components:
-
Uses template:
ShortText. - Contains the following components: id, segmentId, parentId, code, originalCode, description, createdAt, updatedAt.
-
Uses template:
- Compound
Template: NameToValue.
- AdditionalContact
Field components:
-
Uses template:
ShortText. - Contains the following components: sovContactId, signatoryId, rfqRecipientId, scoSignatoryId, costPaymentApplicationContactId.
-
Uses template:
- ScheduleOfValue
Field components:
-
Uses template:
ShortText. - Contains the following components: id, parentId, contractId, budgetId, code, name, quantity, unitPrice, unit, amount, allocatedAmount, quantityPerBulk, bulkUnitPrice, bulk, associationId, associationType, exchangeRate, position, createdAt, updatedAt, externalId, externalSystem, externalMessage, lastSyncTime.
-
Uses template:
- Contract
Field components:
-
Uses template:
ShortText. - Contains the following components: id, code, name, description, companyId, companyUid, type, contactId, source, additionalContacts, signedBy, ownerId, mainContractId, completedWorkRetentionPercent, materialsRetentionPercent, retentionCap, status, subStatus, currency, exchangeRate, forecastExchanageRate, forecastExchangeRateUpdatedAt, changedBy, creatorId, awarded, originalBudget, internalAdjustment, approvedOwnerChanges, pendingOwnerChanges, approvedChangeOrders, approvedInScopeChangeOrders, pendingChangeOrders, reserves, actualCost, uncommitted, revised, projectedCost, projectedBudget, forecastFinalCost, forecastVariance, forecastCostComplete, varianceTotal, awardedAt, statusChangedAt, documentGeneratedAt, sentAt, respondedAt, responseDue, returnedAt, onsiteAt, offsiteAt, procuredAt, approvedAt, scopeOfWork, note, paymentDue, paymentDueType, budgetIds, externalId, externalSystem, externalMessage, lastSyncTime, integrationState, integrationStateChangedAt, integrationStateChangedBy, createdAt, updatedAt.
-
Uses template:
- MainContract
Field components:
-
Uses template:
ShortText. - Contains the following components: id, code, name, note, scopeOfWork, description, type, contactId, creatorId, signedBy, unit, changedBy, ownerCompanyId, contractorCompanyId, ownerCompanyUid, contractorCompanyUid, architectCompanyUid, notaryCompanyUid, notaryContactId, additionalCollaborators, status, amount, unitPrice, isPrivate, paid, createdAt, updatedAt, startDate, executedDate, plannedCompletionDate, scheduleChange, revisedCompletionDate, actualCompletionDate, closeDate, isDefault, completedWorkRetentionPercent, materialsRetentionPercent, retentionCap, paymentDue, paymentDueType, unReceived, externalId, externalSystem, externalMessage, lastSyncTime, integrationState, integrationStateChangedAt, integrationStateChangedBy.
-
Uses template:
- BudgetCodeSegment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, templateId, name, type, delimiter, delimiterChar, length, isVariableLength, position, sampleCode, isLocked, createdAt, updatedAt.
-
Uses template:
- ContractItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, budgetId, containerId, parentId, mainContractId, code, name, description, unit, unitPrice, quantity, amount, createdAt, updatedAt, isPrivate, position, externalId, externalSystem, externalMessage, lastSyncTime, integrationState, integrationStateChangedAt, integrationStateChangedBy.
-
Uses template:
- Attribute
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, type, defaultValue, position, category, defaultVisibility, builtIn, componentTemplateId, options.
-
Uses template:
- SplitNumber
Field components:
-
Uses template:
ShortText. - Contains the following components: prefix, number, postfix, isFreeModify.
-
Uses template:
- CostItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, number, splitNumber, name, description, budgetId, contractId, budgetStatus, costStatus, scope, type, isMarkup, estimated, activeBudget, activeCost, proposed, submitted, approved, committed, committedExchangeRate, inputQuantity, quantity, unit, scopeOfWork, note, proposedExchangeRate, committedExchangeRate, locations, locationPaths, externalId, externalSystem, externalMessage, lastSyncTime, integrationState, integrationStateChangedAt, integrationStateChangedBy, createdAt, updatedAt, includeMarkup, budgetTransferId, budgetTransferItemId, changedBy, creatorId, containerId, locationPaths, locations, includeMarkup, position, scheduleChange, statusChangedAt, submitted.
-
Uses template:
- ChangeOrder
Field components:
-
Uses template:
ShortText. - Contains the following components: id, number, splitNumber, name, description, type, scope, creatorId, ownerId, changedBy, markupFormulaId, appliedBy, appliedAt, budgetStatus, costStatus, estimated, proposed, submitted, approved, committed, scopeOfWork, scheduleChange, proposedRevisedCompletionDate, note, sourceId, externalId, externalSystem, externalMessage, lastSyncTime, integrationState, integrationStateChangedAt, integrationStateChangedBy, createdAt, updatedAt, properties, variableMarkupFormulaItems, companyId, companyUid, architectCompanyId, architectCompanyUid, architectContactId, additionalCollaborators, contactId, contacts, sourceType.
-
Uses template:
- Budget
Field components:
-
Uses template:
ShortText. - Contains the following components: id, parentId, code, scope, subItems, budgetCode, name, description, quantity, inputQuantity, ratio, unitPrice, unit, originalAmount, milestoneId, internalAdjustment, approvedOwnerChanges, pendingOwnerChanges, originalCommitment, approvedChangeOrders, approvedInScopeChangeOrders, pendingChangeOrders, reserves, actualQuantity, actualUnitPrice, actualCost, mainContractId, contractIds, locations, locationPaths, plannedStartDate, plannedEndDate, actualStartDate, actualEndDate, durationDays, uncommitted, revised, projectedCost, projectedBudget, forecastFinalCost, forecastVariance, forecastCostComplete, varianceTotal, externalId, externalSystem, externalMessage, lastSyncTime, integrationState, integrationStateChangedAt, integrationStateChangedBy, createdAt, updatedAt.
-
Uses template:
- ExpenseItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, budgetId, contractId, number, name, description, note, scope, quantity, unitPrice, unit, amount, aggregateBy, exchangeRate, originalExchangeRate, realizedGainOrLoss, externalId, externalSystem, externalMessage, lastSyncTime, createdAt, updatedAt, integrationState, integrationStateChangedAt, integrationStateChangedBy.
-
Uses template:
- PaymentItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, paymentId, parentId, budgetId, associationType, associationId, name, description, originalQuantity, originalUnitPrice, originalAmount, quantity, unitPrice, unit, amount, previousAmount, previousQuantity, previousUnitPrice, materialsOnStore, materialsOnStoreQuantity, materialsOnStoreUnit, materialsOnStoreUnitPrice, previousMaterialsOnStore, materialsBilled, materialsBilledQuantity, materialsBilledUnit, materialsBilledUnitPrice, previousMaterialsBilled, previousMaterialsBilledUnitPrice, previousMaterialsBilledQuantity, previousMaterialsBilledUnit, completedWorkRetention, completedWorkRetentionPercent, completedWorkReleased, materialsOnStoreRetentionPercent, materialsRetention, materialsRetentionPercent, totalRetentionPercent, materialsOnStoreReleased, materialsReleased, netAmount, advanceAmount, advancePercent, previousAdvanceAmount, previousAdvanceAmountForeignCurrency, recoupmentAmount, recoupmentPercentOfCompletedWork, previousRecoupmentAmount, previousRecoupmentAmountForeignCurrency, creatorId, changedBy, lastReviewedBy, canDelete, isPrivate, status, hasComment, aggregateBy, exchangeRate, originalExchangeRate, previousExchangeRate, previousAmountForeignCurrency, netAmountForeignCurrency, realizedGainOrLoss, claimedQuantity, claimedUnitPrice, claimedAmount, previousClaimedQuantity, previousClaimedUnitPrice, previousClaimedAmount, previousClaimedAmountForeignCurrency, previousMaterialsBilledForeignCurrency, position, createdAt, updatedAt, externalId, externalSystem, externalMessage, lastSyncTime, integrationState, integrationStateChangedAt, integrationStateChangedBy, taxSummary.
-
Uses template:
- Request
Field components:
-
Uses template:
ShortText. - Contains the following components: id, description, isActive, accountId, projectId, createdBy, createdByEmail, createdAt, updatedBy, updatedAt, scheduleInterval, reoccuringInterval, effectiveFrom, effectiveTo, lastQueuedAt, serviceGroups, callbackUrl, sendEmail, startDate, endDate.
-
Uses template:
- IssueComment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, body, createdAt, createdBy, updatedAt, deletedAt, clientCreatedAt, clientUpdatedAt, permittedActions, permittedAttributes.
-
Uses template:
- ModelSetVersion
Field components:
-
Uses template:
ShortText. - Contains the following components: version, status, containerId, createTime, documentVersions.
-
Uses template:
- ModelSetView
Field components:
-
Uses template:
ShortText. - Contains the following components: viewId, name, containerId, description, isPrivate, definition, createdBy, createdTime.
-
Uses template:
- ModelSetTest
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modelSetId, modelSetVersion, status.
-
Uses template:
- Transition
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, stateFrom, stateTo, transitionFields, mandatoryFields, actionId.
-
Uses template:
- PermittedAction
Field components:
-
Uses template:
ShortText. - Contains the following components: id, fields, mandatoryFields, transitions.
-
Uses template:
- ItemAttachment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, itemId, taskId, name, isFileUploaded, url, asyncState, uploadUrn, urn, urnVersion, revisionFolderUrn, revision, urnTypeId, categoryId, urnPage, resourceUrns, createdBy, createdAt, updatedAt, updatedBy, duplicatedFrom, permittedActions.
-
Uses template:
- TakeoffType
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, description, color, borderColor, shapeType, countMarkerSize, tool, propertyDefinitions, modelMappings, primaryQuantityDefinition, secondaryQuantityDefinitions, createdAt, updatedAt, updatedByName.
-
Uses template:
- TakeoffItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, takeoffTypeId, type, objectName, geometry, objectId, propertyValues, primaryQuantity, secondaryQuantities, contentView, locationId, createdAt, updatedAt, updatedByName.
-
Uses template:
- RFIComment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, rfiId, body, createdBy, createdAt, updatedAt.
-
Uses template:
- RFIAttachment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, rfiId, createdAt, updatedAt, createdBy, deletedAt, deletedBy, name, url, urn, urnType, attachmentType, permittedActions.
-
Uses template:
- SubmittalMetadata
Field components:
-
Uses template:
ShortText. - Contains the following components: id, key, value.
-
Uses template:
- ActionT
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.

















