Overview

These services allow you to obtain the list of resources of a service type, and the headers (the properties of each of its resources and their characteristics).

Types of services

The API is divided into service types:

• The DAM services concern general access to DAM resources. The identifier for this type is dam. The URI of all end points for this type starts with /api/rest/dam.

• The DATA services are additional services specifically configured according to the needs for a given environment. The identifier for this type is data. The URI of all end points for this type starts with /api/rest/data.

• The PROFILE services are dedicated to the manipulation of the data of a user by himself. The identifier for this type is profil. The URI of all end points for this type starts with /api/rest/profil.

• The MASSIMPORT services are dedicated to mass data upload. The identifier for this type is massimport. The URI of all end points for this type starts with /api/rest/massimport.

• The APPSETTINGS services are dedicated to the configuration. The identifier for this type is appsettings. The URI of all end points for this type starts with /api/rest/appsettings.

Get catalog of a type of service

• verb: GET

• general form of the URI: /api/rest/{type of service}

• alias: /api/rest/{type of service}/$catalog

Exception: the legacy services

Since there is no common URI form for legacy services, there is a catalog by legacy service type. To obtain the catalog of a legacy service, you must use a URI of the following:

For example, to get the catalog of views: /api/json/catalog/view.

Get the library catalog

To get list of libraries (media resources) use /api/dam/$catalog/asset.

Parameters

filter

This parameter allows to select resources.

• You can indicate for example the name of a resource : /api/rest/dam?filter=asset to get the asset resource.

• You can also use a regular expression. For example /api/rest/dam?filter=a.* to get the list of resources whose name starts with a.

headers

The possible parameters are

• headers: the default value (a boolean) for the other header parameters.
  If this parameter is not specified in the query, the default value for each other parameter is true.

• rscHeaders: resource headers.

• dataHeaders: resource properties headers. Also enables the export of some property-related header.

• aggHeaders: aggregates headers.

• updateHeaders: creation and modification headers.

For example, to get property headers without aggregate headers and update headers of dam catalog, use : /api/rest/dam?headers=false&dataHeaders=true (or /api/rest/dam?aggHeaders=false&updateHeaders=false).

If all parameters are false, you’ll get only the list of resource names.

Examples and response samples

See examples and response sample for catalog.

See examples and response sample for list of resource names.