Relationship: Sync
POST
containers/:containerId/relationships:sync
Synchronise relationships using the (optional) synchronization token passed by the caller.
Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects.
Resource Information
| Method and URI | POST https://developer.api.autodesk.com/bim360/relationship/v2/containers/:containerId/relationships:sync |
| 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 |
| x-ads-region enum: string | The region to which your request should be routed. If not set, the request is routed automatically but may incur a small latency increase.
Possible values: |
* Required
Request
URI Parameters
| containerId string: UUID | The GUID that uniquely identifies the container. |
Request
Body Structure
Expand all
| syncToken string | The token that can be used to obtain data via the synchronization endpoint. |
| filters object | An array of filters on the initial request without a sync token. |
| domains array: string | An array of domains on which to filter.
Min items: 1 Max items: 20 |
Response
HTTP Status Code Summary
| 200 OK | Success |
| 400 Bad Request | The parameters of the requested operation are invalid. |
| 401 Unauthorized | The provided bearer token is not valid. |
| 403 Forbidden | The user or service represented by the bearer token does not have permission to perform this operation. |
| 404 Not Found | The requested resource could not be found. |
| 415 Unsupported Media Type | The Content-Type header must be application/json. |
| 429 Too Many Requests | Rate limit exceeded; wait some time before retrying. The Retry-After header might provide the amount of the time to wait. |
| 500 Internal Server Error | An unknown error occurred on the server. |
Response
Body Structure (200)
Expand all
| current object | A set of current data. |
| data array: object | A set of current relationships relative to the sync token passed by the caller. |
| id string: UUID | The UUID that uniquely identifies the relationship. |
| createdOn datetime: ISO 8601 | The date and time the relationship was created. |
| isReadOnly boolean | true if this relationship is read only for the current caller.
|
| isService boolean | true if this relationship was created by a service.
|
| isDeleted boolean | true if this relationship is deleted.
|
| deletedOn datetime: ISO 8601 | The date and time the relationship was deleted. |
| entities array: object | The entities contained in the relationship.
Min items: 2 Max items: 2 |
| createdOn datetime: ISO 8601 | The date and time the entity was created. |
| domain string | The domain to which the entity belongs.
To learn more about domains and entities, see the Relationship Service Field Guide. Max length: 128 |
| type string | The type of entity.
Max length: 128 |
| id string | The unique identifier of the entity.
Max length: 512 |
| deleted object | A set of deleted data. |
| data array: object | A set of relationships that have been deleted relative to the sync token passed by the caller. |
| id string: UUID | The UUID that uniquely identifies the relationship. |
| createdOn datetime: ISO 8601 | The date and time the relationship was created. |
| isReadOnly boolean | true if this relationship is read only for the current caller.
|
| isService boolean | true if this relationship was created by a service.
|
| isDeleted boolean | true if this relationship is deleted.
|
| deletedOn datetime: ISO 8601 | The date and time the relationship was deleted. |
| entities array: object | The entities contained in the relationship.
Min items: 2 Max items: 2 |
| createdOn datetime: ISO 8601 | The date and time the entity was created. |
| domain string | The domain to which the entity belongs.
To learn more about domains and entities, see the Relationship Service Field Guide. Max length: 128 |
| type string | The type of entity.
Max length: 128 |
| id string | The unique identifier of the entity.
Max length: 512 |
| moreData boolean | If set to true, data is available for synchronization using the supplied synchronization token. |
| overwrite boolean | If set to true, the data returned by the synchronization endpoint can be used to overwrite local copies. |
| nextSyncToken string | The token that can be used to obtain data via the synchronization endpoint. If moreData is set to false, you can use this token to resume synchronization at a later point in time. |
Response
Body Structure (400)
Expand all
| type string | The error code. |
| title string | A short title for the error. |
| detail string | A more detailed, human readable description of the error, assuming that this message is not localized and is therefore EN-US. UI consumers can use the error.type value to provide a localized version of this error for presentation. |
| errors array: object | A set of specific validation errors that need to be fixed. |
| field string | The field that failed validation. |
| title string | A short title for the error. |
| detail string | A more detailed, human readable description of the error, assuming that this message is not localized and is therefore EN-US. UI consumers can use the error.type value to provide a localized version of this error for presentation. |
| type string | The error code. |
Example
Request
curl -v 'https://developer.api.autodesk.com/bim360/relationship/v2/containers/f0f4f36a-ac64-687f-b132-8efe04b22454/relationships:sync' \
-X POST \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response (200)
{
"current": {
"data": [
{
"id": "74b70bb8-8802-a1fd-f201-890375a60c8f",
"createdOn": "2015-10-21T16:32:22Z",
"isReadOnly": true,
"isService": false,
"isDeleted": false,
"entities": [
{
"domain": "autodesk-bim360-asset",
"type": "asset",
"id": "2b95ba7a-3df5-4e99-a693-9c7cc15ee8c0",
"createdOn": "2021-07-29T11:39:12+01:00"
},
{
"domain": "autodesk-bim360-documentmanagement",
"type": "documentlineage",
"id": "urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w",
"createdOn": "2021-07-29T13:39:12+01:00"
}
]
}
]
},
"deleted": {
"data": [
{
"id": "74b70bb8-8802-a1fd-f201-890375a60c8f",
"createdOn": "2015-10-21T16:32:22Z",
"isReadOnly": true,
"isService": false,
"isDeleted": false,
"entities": [
{
"domain": "autodesk-bim360-asset",
"type": "asset",
"id": "2b95ba7a-3df5-4e99-a693-9c7cc15ee8c0",
"createdOn": "2021-07-29T11:39:12+01:00"
},
{
"domain": "autodesk-bim360-documentmanagement",
"type": "documentlineage",
"id": "urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w",
"createdOn": "2021-07-29T13:39:12+01:00"
}
]
}
]
},
"moreData": true,
"overwrite": false,
"nextSyncToken": "eyAibGFzdENoZWNrZWQiOiIyMDE5LTEwLTE4VDEyOjEwOjA3Ljc5NloiIH0="
}
Show More
Response (400)
{
"type": "BadInput",
"title": "One or more input values in the request were bad",
"detail": "The following parameters are invalid: containerId",
"errors": [
{
"field": "containerId",
"title": "Invalid parameter",
"detail": "The value 'testing' is not valid.",
"type": "BadInput"
}
]
}
Show More