API Resources

ApiRootCollections

APIDescription
GET /v2/

Get links to the resource collections for assets, directories, and maps. Follow the href properties to navigate to the resources contained in the collections.

Assets

APIDescription
GET /v2/assets/{assetId}

Get an asset by its id.

GET /v2/assettypes/{assetTypeId}/assets?format={format}/

Get all assets with a particular asset type.

GET /v2/directories/{directoryId}/assets/

Get all assets contained in a directory.

GET /v2/directories/{directoryId}/assettypes/{assetTypeId}/assets/

Get all assets contained in a directory with a particular asset type.

AssetTypes

APIDescription
GET /v2/assettypes/

Get all asset types.

GET /v2/assettypes/{assetTypeId}

Get an asset type by its id.

GET /v2/directories/{directoryId}/assettypes/

Get all asset types found in a directory.

GET /v2/directories/{directoryId}/assettypes/{assetTypeId}

Get an asset type that is found in a directory by its id. The asset type resource returned will contain a link to a collection of all assets found in the directory with this asset type.

GET /v2/maps/{mapId}/assettypes/

Get all asset types found in a map.

GET /v2/maps/{mapId}/assettypes/{assetTypeId}

Get an asset type that is found in a map by its id. The asset type resource returned will contain a link to a collection of all asset views found in the map with this asset type.

AssetViews

APIDescription
GET /v2/assets/{assetId}/assetviews/

Get all asset views of an asset.

GET /v2/assetviews/{assetViewId}

Get an asset view by its id.

GET /v2/maps/{mapId}/assettypes/{assetTypeId}/assetviews/

Get all asset views found in a map with a particular asset type.

GET /v2/maps/{mapId}/assetviews/

Get all asset views found in a map.

Directories

APIDescription
GET /v2/directories/

Get all directories.

GET /v2/directories/{directoryId}

Get a directory by its id.

GET /v2/directorytypes/{directoryTypeId}/directories/

Get all directories with a particular directory type.

DirectoryTypes

APIDescription
GET /v2/directorytypes/

Get all directory types.

GET /v2/directorytypes/{directoryTypeId}

Get a directory type by its id.

Maps

APIDescription
GET /v2/directories/{directoryId}/maps/

Get all maps of a directory.

GET /v2/maps/{mapId}?format={format}&expand={expand}&config={config}

Get a map by its id. Optionally expand asset view resources in the response. Optionally flatten out resources in the response.

GET /v2/maps/{mapIds}?format={format}&expand={expand}&config={config}/

Get all maps. Optionally filter maps by a list of map ids.

GET /v2/maptypes/{mapTypeId}/maps/

Get all maps with a particular map type.

MapTypes

APIDescription
GET /v2/maptypes/

Get all map types.

GET /v2/maptypes/{mapTypeId}

Get a map type by its id.