Retrieve exchanges (Deprecated)
GET
v1/exchanges
Retrieve exchanges by providing exchange file URNs. You can use a query parameter to retrieve more than one exchange. The API response provides you the exchange ID and the collection ID to access the data in the exchange.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/exchange/v1/exchanges |
| Authentication Context | app only |
| Required OAuth Scopes | data:read |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is obtained via OAuth |
* Required
Request
Query String Parameters
| limit int | Allowed limit of exchanges in response. Default is 20 and max is 20. |
| cursor string | The pagination cursor returned by the server to the client. It expires in 10 minutes. |
| sort string | The sort order of the entities returned |
| filters string | Filter to use when querying exchanges (attribute.exchangeFileUrn). You can specify filters separated by semicolons. Example: attribute.exchangeFileUrn==urn:adsk.wipqa:dm.lineage:qGo3Nq2NRka2zHt7CPIsju |
Response
HTTP Status Code Summary
| 200 OK | The exchange container details were retrieved successfully. |
| 400 Bad Request | The request is invalid. |
| 401 Unauthorized | Invalid authorization header. |
| 403 Forbidden | Access denied regardless of authorization status. |
| 404 Not Found | The specified resource was not found. |
| 500 Internal Server Error | Unexpected service interruption. |
Response
Body Structure (200)
Expand all
| pagination object | The information on the pagination of the response |
| limit int | Upper limit to the paginated results |
| cursor string | Current cursor (or index) marking where you are in the paginated set |
| nextUrl string | Next URL |
| results array: object | The paginated results |
| createdBy object | The information on the user or service that last modified the entity. |
| userId string | The user ID that created / modified the entity. |
| serviceId string | The service ID that created / modified the entity. |
| date datetime: ISO 8601 | Timestamp in the following format: YYYY-MM-DDThh:mm:ss.sz. |
| lastModifiedBy object | The information on the user or service that last modified the entity. |
| userId string | The user ID that created / modified the entity. |
| serviceId string | The service ID that created / modified the entity. |
| date datetime: ISO 8601 | Timestamp in the following format: YYYY-MM-DDThh:mm:ss.sz. |
| id string | The unique ID of the exchange |
| collection object | Collection where the exchange is stored |
| createdBy object | The information on the user or service that last modified the entity. |
| userId string | The user ID that created / modified the entity. |
| serviceId string | The service ID that created / modified the entity. |
| date datetime: ISO 8601 | Timestamp in the following format: YYYY-MM-DDThh:mm:ss.sz. |
| lastModifiedBy object | The information on the user or service that last modified the entity. |
| userId string | The user ID that created / modified the entity. |
| serviceId string | The service ID that created / modified the entity. |
| date datetime: ISO 8601 | Timestamp in the following format: YYYY-MM-DDThh:mm:ss.sz. |
| id string | The unique ID of the collection |
| revisionId string | The ID of the latest revision of the asset |
| attributes object | |
| name string | The name of the attribute |
| value string | The value of the attribute |
| category string | The category of the attribute. Possible values: system, application, internal. |
| components object | All components associated with this exchange |
| id string | The unique ID of the entity |
| url string | The relative URL to get the entity’s components |
| data object | See HFDM Schema Specification 1.0 - Change Sets |
| insert object | Components to be inserted |
| * object | Components to be inserted |
| modify object | Components to be modified |
| * object | Components to be modified |
| remove array: string | Component IDs to be removed |
| type string | Type of exchange |
| attributes object | All attributes associated with this exchange |
| id string | The unique id of the attribute |
| url string | |
| data array: object | |
| name string | The name of the attribute |
| value string | The value of the attribute |
| category string | The category of the attribute. Possible values: system, application, internal. |
| components object | All components associated with this exchange |
| id string | The unique ID of the entity |
| url string | The relative URL to get the entity’s components |
| data object | See HFDM Schema Specification 1.0 - Change Sets |
| insert object | Components to be inserted |
| * object | Components to be inserted |
| modify object | Components to be modified |
| * object | Components to be modified |
| remove array: string | Component IDs to be removed |
| revisionId string | The unique ID of the revision |
| root string | The unique ID identifying the root entity within the paginated results |
Example
The exchange container details were retrieved successfully.
Request
curl -v 'https://developer.api.autodesk.com/exchange/v1/exchanges?filters=attribute.exchangeFileUrn==urn:adsk.wipqa:dm.lineage:qGo3Nq2NRka2zHt7CPIsju' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": "10",
"cursor": "46daa630-5f1c-4e46-b004-b512ff3649ac",
"nextUrl": "/v1/collections/co.l1Lf2-orRbW-3oDLHMvSxg/exchanges/3f351bac-f192-3e8a-9eae-e7f71e55d65f?cursor=46daa630-5f1c-4e46-b004-b512ff3649a"
},
"results": [
{
"createdBy": {
"userId": "GMU2LEQ6DDZC",
"serviceId": "03XuckuO3wYgf3totQU1ufs16Skxjnsj",
"date": "2021-11-10T11:39:49.683851Z"
},
"lastModifiedBy": {
"userId": "GMU2LEQ6DDZC",
"serviceId": "03XuckuO3wYgf3totQU1ufs16Skxjnsj",
"date": "2021-11-10T11:39:49.683851Z"
},
"id": "6e21c319-c9f3-3350-bb67-d103b401409d",
"collection": {
"id": "co.SpdGU41bT1eP-Tu7hLD4jQ"
},
"type": "autodesk.fdx.space:exchangecontainer-1.0.0",
"attributes": {
"id": "6e21c319-c9f3-3350-bb67-d103b401409d",
"url": "/exchanges/6e21c319-c9f3-3350-bb67-d103b401409d/attributes",
"data": [
{
"category": "application",
"name": "sourceVersionUrn",
"value": "urn:adsk.wipqa:fs.file:vf.XV94N2BxRkmzL-iw45HUDQ?version=1",
"type": "String"
},
{
"category": "application",
"name": "hostingProviderName",
"value": "ACC",
"type": "String"
},
{
"category": "application",
"name": "exchangeFileProjectUrn",
"value": "b.3667a2b3-37b9-457c-9274-122986c15e39",
"type": "String"
},
{
"category": "application",
"name": "baseSourceVersionUrn",
"value": "urn:adsk.wipqa:fs.file:vf.XV94N2BxRkmzL-iw45HUDQ?version=1",
"type": "String"
},
{
"category": "application",
"name": "exchangeFileFolderUrn",
"value": "urn:adsk.wipqa:fs.folder:co.5eNyUJniQL-5reARyBlRYQ",
"type": "String"
},
{
"category": "application",
"name": "exchangeFileName",
"value": "sng-fdxs-3e99de09-9132-4e3b-8001-20144604b8d0",
"type": "String"
},
{
"category": "application",
"name": "exchangeFileUrn",
"value": "urn:adsk.wipqa:dm.lineage:jdOK8eWWRN2oj_adpsyAhQ",
"type": "String"
},
{
"category": "application",
"name": "exchangeFileVersionUrn",
"value": "urn:adsk.wipqa:fs.file:vf.jdOK8eWWRN2oj_adpsyAhQ?version=1",
"type": "String"
}
]
},
"components": {
"id": "6e21c319-c9f3-3350-bb67-d103b401409d",
"url": "/exchanges/6e21c319-c9f3-3350-bb67-d103b401409d/components",
"data": {
"insert": {
"autodesk.fdx:contract.revitViewGeometry-1.0.0": {
"contract": {
"String": {
"viewName": "some view name",
"viewableId": "b57244e2-7d70-4703-9cce-7a12a2088f7c-0010d4ee",
"viewGuid": "ed48e8db-d608-16f7-aa66-d5d09b51b8a4"
}
}
},
"autodesk.fdx:host.acc-1.0.0": {
"host": {
"String": {
"versionUrn": "urn:adsk.wipqa:fs.file:vf.jdOK8eWWRN2oj_adpsyAhQ?version=1",
"fileName": "sng-fdxs-3e99de09-9132-4e3b-8001-20144604b8d0",
"folderUrn": "urn:adsk.wipqa:fs.folder:co.5eNyUJniQL-5reARyBlRYQ",
"projectUrn": "b.3667a2b3-37b9-457c-9274-122986c15e39",
"fileUrn": "urn:adsk.wipqa:dm.lineage:jdOK8eWWRN2oj_adpsyAhQ"
}
}
},
"autodesk.fdx:source.acc-1.0.0": {
"source": {
"String": {
"versionUrn": "urn:adsk.wipqa:fs.file:vf.XV94N2BxRkmzL-iw45HUDQ?version=1",
"folderUrn": "urn:adsk.wipqa:fs.folder:co.WihNG8y4Q8KTbNsY4wH_Iw",
"projectUrn": "b.3667a2b3-37b9-457c-9274-122986c15e39",
"fileUrn": "urn:adsk.wipqa:dm.lineage:XV94N2BxRkmzL-iw45HUDQ"
}
}
}
}
}
},
"revisionId": "1636544407007_41bfadb1-eb28-3add-8715-4e42b9b90e67"
}
]
}
Show More
