Actions
GET
v1/containers/{containerId}/workflows/{associationType}/{associationId}/actions
List the actions that can execute on the specified item according to the item’s current state.
Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/cost/v1/containers/:containerId/workflows/:associationType/:associationId/actions |
| Authentication Context | user context required |
| Required OAuth Scopes | data:read |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is obtained via a three-legged OAuth flow. |
| region string | The region where the project data resides, to which this request is routed.
This header is optional because the request is automatically routed to a target region based on the project ID or container ID. Using the header, though, can save lookup time on each API call. For information about verifying the region the data resides in, see the Working with BIM 360 Services in Different Regions section on the API Basics page. Possible values: |
* Required
Request
URI Parameters
| containerId string: UUID | The ID of the cost container for the project. Each project is assigned a container that stores all of the cost data for the project.
To find the container ID, see the Retrieve a Cost Container ID tutorial. In ACC projects, the container ID is the same as the project ID. To obtain a project ID, use GET projects. |
| associationId string: UUID | The object ID of the item is associated to. For example, the ID of a budget, contract or cost item. |
| associationType enum:string | The type of the item with which the actions are associated. Possible values: FormInstance, CostItem, OCO, PCO, RCO, RFQ, SCO, Expense, Contract, CostPayment, BudgetPayment, BudgetTransfer, MainContract. |
Response
HTTP Status Code Summary
| 200 OK | Success |
| 400 Bad Request | The parameters are invalid. |
| 401 Unauthorized | The provided bearer token is invalid. |
| 403 Forbidden | Forbidden. The user or service represented by the bearer token does not have permission to perform this operation. |
| 404 Not Found | The resource or endpoint cannot be found. |
| 409 Conflict | The request could not be completed due to a conflict with the current state of the resource. |
| 429 Too Many Requests | Rate limit exceeded. Retry your request after a few minutes. |
| 500 Internal Server Error | An unexpected error occurred on the server. |
| 503 Service Unavailable | Service unavailable. |
Response
Body Structure (200)
Expand all
| name string | The name of the action that you can perform on the item. |
| transforms array: object | The list of changes that you can perform on the associated item. |
| key string | The name of the attribute that will be changed as a result of performing the action on the item; usually the status of the item. |
| to string | The new value assigned to the attribute after the action is performed. For example, update budgetStatus to open. |
| rules array: object | The list of conditions that are required in order to be able to perform the action. For example, you can only open a PCO’s budgetStatus and costStatus when they are in a draft state. |
| key string | The name of the attribute on the associated item that will be checked against before performing the action. |
| only array: string | The value of the attribute that will be checked against before performing the action. |
Example
Success
Request
curl -v 'https://developer.api.autodesk.com/cost/v1/containers/e94b9bc8-1775-4d76-9b1d-c613e120ccff/workflows/FormInstance/18d97ae0-9484-11e8-a7ec-7ddae203e404/actions' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
[
{
"name": "open",
"transforms": [
{
"key": "budgetStatus",
"to": "open"
}
],
"rules": [
{
"key": "budgetStatus",
"only": "['draft']"
}
]
}
]
Show More