Working with Core Service.REST

TheCore Service.REST API is exposed through the OpenAPI Specification.

Swagger user interface

You can use the Swagger user interface to explore the Core Service.REST API. You can access the Swagger user interface at the following location:

http://HOST:PORT/api/api-docs

where:

  • HOST is the hostname of your Content Manager server
  • PORT is the port number to connect to your Content Manager server

Open API Specification

You can access the the OpenAPI Specification (or OAS) for the Core Service.REST API from the following URL:

http://HOST:PORT/api/api-docs/VERSION/openapi.json

Where:

  • HOST and PORT are as described in the preceding section

  • VERSION is the version of the API you are using, such as "V2.0". For a list of all supported versions, see the related topic on Core Service.REST versioning.

Content Manager item identifiers

The Core Service.REST supports the following ways of identifying an item in the Content Manager:

  • Content Manager URIs (TCM URIs)
  • External Content Library (ECL) URIs