Directory Management Studio REST API Documentation

Introduction

All the core contents of Directory Management Studio can be accessed via this RESTful API.

The API is discoverable:
- A request to the root of the API returns the available resource collections.
- All resources and resource collections can be navigated to by requesting the URL in their href properties.
The API only accepts GET requests and is read-only.
The API key provided to you must be sent with all requests as the value of query string parameter apikey. Example:
GET /maps/?apikey=8M7gugXU4u2G HTTP/1.1
If the Accept request header is not specified, the default media type for resources is application/json.
Unless otherwise specified via a mediaTypes array property, the API respects the following media types when specified in the Accept request header:
- application/json
- text/json
- application/xml
- text/xml
Swagger support is available at Swagger UI and Docs
For json media types, when a resource has a null value for a property, the property is not included in the response.
All date/time strings are ISO 8601 formatted with UTC time zone.

Class ApiRootCollectionsController.

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

Class AssetsController.

API	Description
GET /assets/{assetId}	Get an asset by its id.
GET /assettypes/{assetTypeId}/assets?format={format}/	Get all assets with a particular asset type.
GET /directories/{directoryId}/assets/	Get all assets contained in a directory.
GET /directories/{directoryId}/assettypes/{assetTypeId}/assets/	Get all assets contained in a directory with a particular asset type.

Class AssetTypesController.

API	Description
GET /assettypes/	Get all asset types.
GET /assettypes/{assetTypeId}	Get an asset type by its id.
GET /directories/{directoryId}/assettypes/	Get all asset types found in a directory.
GET /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 /maps/{mapId}/assettypes/	Get all asset types found in a map.
GET /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.

Class AssetViewsController.

API	Description
GET /assets/{assetId}/assetviews/	Get all asset views of an asset.
GET /assetviews/{assetViewId}	Get an asset view by its id.
GET /maps/{mapId}/assettypes/{assetTypeId}/assetviews/	Get all asset views found in a map with a particular asset type.
GET /maps/{mapId}/assetviews/	Get all asset views found in a map.

Class DirectoriesController.

API	Description
GET /directories/	Get all directories.
GET /directories/{directoryId}	Get a directory by its id.
GET /directorytypes/{directoryTypeId}/directories/	Get all directories with a particular directory type.

Class DirectoryTypesController.

API	Description
GET /directorytypes/	Get all directory types.
GET /directorytypes/{directoryTypeId}	Get a directory type by its id.

API	Description
GET /kml/{mapId}	No documentation available.
GET /kml/{mapIds}?format={format}&expand={expand}&config={config}	No documentation available.

Class MapsController.

API	Description
GET /directories/{directoryId}/maps/	Get all maps of a directory.
GET /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 /maps/{mapIds}?format={format}&expand={expand}&config={config}/	Get all maps. Optionally filter maps by a list of map ids.
GET /maptypes/{mapTypeId}/maps/	Get all maps with a particular map type.

Class MapTypesController.

API	Description
GET /maptypes/	Get all map types.
GET /maptypes/{mapTypeId}	Get a map type by its id.