asset-statuses:batch-get
Returns a specified set of statuses.
This endpoint accepts an object with an array of one or more status IDs and returns an array of statuses corresponding to each of those IDs. Invalid status IDs will simply be omitted from the response and the client is responsible for identifying missing results.
To understand the basics of asset statuses, and the Assets settings that define them, see the Assets Field Guide.
Resource Information
Method and URI | POST https://developer.api.autodesk.com/bim360/assets/v1/projects/{projectId}/asset-statuses:batch-get |
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. |
Content-Type* string | Must be application/json |
Request
URI Parameters
projectId string | The BIM 360 project ID. Must be a UUID or a project ID of the form “b.{UUID}”. |
Request
Query String Parameters
includeDeleted boolean | Whether or not soft-deleted object should be included in the response. If true , soft-deleted objects are returned. If false , they are not. The default is false . |
Request
Body Structure
ids array: string | Unique IDs of entities to fetch |
Response
HTTP Status Code Summary
200 OK | Successfully returned a batch of statuses. |
400 Bad Request | The request could not be understood by the server due to malformed syntax or missing request header |
401 Unauthorized | The request was not accepted because it lacked valid authentication credentials |
403 Forbidden | The request was not accepted because the client is authenticated, but is not authorized to access the target resource |
404 Not Found | The resource cannot be found |
429 Too Many Requests | The request was not accepted because the rate limit was exceeded due to too many requests being made. |
500 Internal Server Error | An unexpected error occurred on the server |
Response
Body Structure (200)
results array: object | Returned statuses |
label string | The display label of the status. This label appears in the Assets UI when viewing statuses. The label must be unique within this status set, but does not need to be unique within the project (in other words, the same label can be used in multiple status sets in the same project). “Uniqueness” in this context means case-insensitive. |
description string | A description of the status. |
color string | The color of the status as the status appears in the Assets UI.
This field is not restricted as it is primarily a tool for the Assets UI to use. However, there are only certain colors that the BIM 360 Assets UI knows how to operate with. Understood
color values are: Using colors other than those specified here is not disallowed, but may result in unexpected behavior in the Assets UI. |
statusStepSetId string: UUID | The ID of the status set to which the new status belongs. |
id string | The ID of the component. |
createdAt string | The time when the component was created (ISO8601 Date time format in UTC). |
createdBy string | The actor that created the component. This is an Autodesk / Oxygen ID. |
updatedAt string | The time when the component was last updated (ISO8601 Date time format in UTC). |
updatedBy string | The actor that last updated the component. This is an Autodesk / Oxygen ID. |
deletedAt string | The time when the component was deleted at (ISO8601 Date time format in UTC). |
deletedBy string | The actor that deleted the component. This is an Autodesk / Oxygen ID. |
isActive boolean | A flag indicating whether the component is active or inactive (isActive is true if-and-only-if deletedAt is empty). |
version int | A global sequence number that is incremented any time a component of this type is created, updated, or deleted. If you cache components, you can use the version value to compare the cached component to the same component online to see if the component has been updated. If the online component has a higher version value, it has been updated. |
projectId string: UUID | The BIM 360 project ID. Must be a UUID or a project ID of the form “b.{UUID}”. |
bucket string | An immutable string assigned to a status on its creation, typically created by incorporating the status’s label into a larger string that is guaranteed to be unique within a project. The bucket name remains the same for the life of the status, and doesn’t change even if the label does. The bucket value is a useful tool for semantic identification. |
sortOrder int | A value that indicates the order of a status within its status set. Each status in the set has a sort order value that indicates its order relative to other statuses in the set. A status set’s sort order values don’t necessarily start at 1, and may not be sequential. The only way to know a status’s order within a set is to compare its sort order value with the sort order values of other statuses. |
Example
Successfully returned a batch of statuses.
Request
curl -v 'https://developer.api.autodesk.com/bim360/assets/v1/projects/:projectId/asset-statuses:batch-get?includeDeleted=true' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"ids": [
"84eb6a10-dde3-475f-aaf4-b5df3aebbd0b"
]
}'
Response
{
"results": [
{
"label": "Functional-Testing",
"description": "Custom Functional Testing Status",
"color": "green",
"statusStepSetId": "6eb35939-e5fb-453a-98ed-e2e11f326e73",
"id": "b302d910-b5e3-46ba-81d8-6b6d30406e14",
"createdAt": "2020-05-01T06:00:00.000Z",
"createdBy": "LA7ZL85MU7ML",
"updatedAt": "2020-05-01T06:00:00.000Z",
"updatedBy": "LA7ZL85MU7ML",
"deletedAt": "2020-05-01T06:00:00.000Z",
"deletedBy": "LA7ZL85MU7ML",
"isActive": true,
"version": 1,
"projectId": "f74a012c-62fd-4988-ac2b-c5b4fd937724",
"bucket": "custom_functional_testing_status_1582935184385",
"sortOrder": 1
}
]
}