v1/exchanges/{exchangeId}

Retrieve exchange by providing collection and exchange ID. The API response contains the exchange ID and the collection ID which may be used to access data in the exchange.

Resource Information

Method and URI	GET https://developer.api.autodesk.com/exchange/v1/exchanges/{exchangeId}
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

URI Parameters

exchangeId string	The unique ID of the exchange

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

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

Example

The exchange container details were retrieved successfully.

Request

curl -v 'https://developer.api.autodesk.com/exchange/v1/exchanges/:exchangeId' \
  -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'

Response

{
  "createdBy": {
    "userId": "QTCWNHC87PKH",
    "serviceId": "test-client-id",
    "date": "2021-07-07T17:30:31.395476Z"
  },
  "lastModifiedBy": {
    "userId": "QTCWNHC87PKH",
    "serviceId": "test-client-id",
    "date": "2021-07-07T17:30:31.395476Z"
  },
  "id": "6c71c319-c9f3-3350-bb67-d103b401409d",
  "collection": {
    "createdBy": {
      "userId": "QTCWNHC87PKH",
      "serviceId": "test-client-id",
      "date": "2021-07-07T17:30:31.395476Z"
    },
    "lastModifiedBy": {
      "userId": "QTCWNHC87PKH",
      "serviceId": "test-client-id",
      "date": "2021-07-07T17:30:31.395476Z"
    },
    "id": "co.SpdGU41bT1eP-Tu7hLD4jQ",
    "revisionId": "1640687055590_3a6742cd-a83a-3487-86da-f121cd5ddf09",
    "attributes": {
      "name": "rootAssetId",
      "value": "ec78857a-9831-3fdf-b598-8c7214a30d33_STABLE1",
      "category": "application"
    },
    "components": {
      "id": "entityId",
      "url": "/entityType/entityId/components",
      "data": {
        "insert": {
          "autodesk.fdx:test-1.0.0": {
            "test": {
              "String": {
                "prop1": "value1",
                "prop2": "value2"
              }
            }
          }
        },
        "modify": {
          "autodesk.fdx:test-1.0.0": {
            "test": {
              "String": {
                "prop1": "value3"
              }
            }
          }
        },
        "remove": [
          "autodesk.fdx:test-1.0.0"
        ]
      }
    }
  },
  "type": "autodesk.fdx.space:exchangecontainer-1.0.0",
  "attributes": {
    "id": "976jvaa5-67c5-31e0-9b41-488cc9ff2ab4",
    "url": "/exchanges/6e21c319-c9f3-3350-bb67-d103b401409d/attributes",
    "data": [
      {
        "category": "Application",
        "name": "sourceVersionUrn",
        "value": "urn:adsk.wipqa:fs.file:vf.XV24N2BxRkmzL-iw45HUDQ?version=1"
      }
    ]
  },
  "components": {
    "id": "entityId",
    "url": "/entityType/entityId/components",
    "data": {
      "insert": {
        "autodesk.fdx:test-1.0.0": {
          "test": {
            "String": {
              "prop1": "value1",
              "prop2": "value2"
            }
          }
        }
      },
      "modify": {
        "autodesk.fdx:test-1.0.0": {
          "test": {
            "String": {
              "prop1": "value3"
            }
          }
        }
      },
      "remove": [
        "autodesk.fdx:test-1.0.0"
      ]
    }
  },
  "revisionId": "1624276905550#a631a9ee-c756-3ba5-9490-44cf6f94bbce"
}
Show More

Request

Response

Jump To

v1/exchanges/{exchangeId}

Resource Information

Request

Headers

Request

URI Parameters

Response

HTTP Status Code Summary

Response

Body Structure (200)

Example

Request

Response