Get API Catalog

get

/documents/api/{version}/metadata-catalog

Get available resources in the specified versions of the API.

Note:

In version 1.1 of the Content Management REST API, the Catalog resource was renamed Metadata-Catalog. Catalog will continue to be supported as an alias for Metadata-Catalog.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

version

Type: string

Required: true

Version value

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body

The response body includes information about the get API catalog operation.

Root Schema : CatalogResponse

The response body includes information about the get API catalog operation.

Properties

links

Type: array links

Additional Properties Allowed:

List of catalogs.

Nested Schema : links

Type: array

List of catalogs.

Items

• Type: object CatalogDefinition
  Additional Properties Allowed:
  Catalog information.

Nested Schema : CatalogDefinition

Catalog information.

Properties

links

Type: array links

Additional Properties Allowed:

List of catalog links.

name

Type: string

Name of the catalog.

Nested Schema : links

Type: array

List of catalog links.

Items

• Type: object APILinks
  Additional Properties Allowed:
  API links information.

Nested Schema : APILinks

API links information.

Properties

href

Type: string

Complete URL that uniquely defines the resource.

ref

Type: string

Relationship.

Example application/json

{
    "items":[
        {
            "name":"folders",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1/metadata-catalog/folders"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.1/folders"
                }
            ]
        },
        {
            "name":"files",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1/metadata-catalog/files"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.1/files"
                }
            ]
        },
        {
            "name":"users",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1/metadata-catalog/users"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.1/users"
                }
            ]
        },
        {
            "name":"applinks",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1/metadata-catalog/applinks"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.1/applinks"
                }
            ]
        },
        {
            "name":"shares",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1/metadata-catalog/shares"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.1/shares"
                }
            ]
        },
        {
            "name":"publiclinks",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1/metadata-catalog/publiclinks"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.1/publiclinks"
                }
            ]
        },
        {
            "name":"metadata",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1/metadata-catalog/metadata"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.1/metadata"
                }
            ]
        },
        {
            "name":"configuration",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1/metadata-catalog/configuration"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.1/configuration"
                }
            ]
        },
        {
            "name":"collections",
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1/metadata-catalog/collections"
                },
                {
                    "ref":"describes",
                    "href":"https://www.example.com/documents/api/1.1/collections"
                }
            ]
        }
    ]
}

Examples

The following example returns information for the specified version.

GET .../api/1.1/metadata-catalog

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "items":[
    {
      "name": "folders",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://www.example.com/documents/api/1.1/metadata-catalog/folders"
      	},
        {
          "rel": "describes",
      	  "href": "http://www.example.com/documents/api/1.1/folders"
      	}
      ]
    },
    {
      "name": "files",
      "links": [
        {
          "rel": "canonical",
          "href": "http://www.example.com/documents/api/1.1/metadata-catalog/files"
      	},
        {
          "rel": "describes",
      	  "href": "http://www.example.com/documents/api/1.1/files"
        }
      ]
    },
    {
      "name": "shares",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://www.example.com/documents/api/1.1/metadata-catalog/shares"
      	},
        {
          "rel": "describes",
      	  "href": "http://www.example.com/documents/api/1.1/shares"
      	}
      ]
    },
    {
      "name": "users",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://www.example.com/documents/api/1.1/metadata-catalog/users"
      	},
        {
          "rel": "describes",
      	  "href": "http://www.example.com/documents/api/1.1/users"
      	}
      ]
    },
    {
      "name": "applinks",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://www.example.com/documents/api/1.1/metadata-catalog/applinks"
      	},
        {
          "rel": "describes",
      	  "href": "http://www.example.com/documents/api/1.1/applinks"
      	}
      ]
    },
    {
      "name": "publiclinks",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://www.example.com/documents/api/1.1/metadata-catalog/publiclinks"
      	},
        {
          "rel": "describes",
      	  "href": "http://www.example.com/documents/api/1.1/publiclinks"
      	}
      ]
    },
    {
      "name": "metadata",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://www.example.com/documents/api/1.1/metadata-catalog/metadata"
      	},
        {
          "rel": "describes",
      	  "href": "http://www.example.com/documents/api/1.1/metadata"
      	}
      ]
    },
    {
      "name": "configuration",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://www.example.com/documents/api/1.1/metadata-catalog/configuration"
      	},
        {
          "rel": "describes",
      	  "href": "http://www.example.com/documents/api/1.1/configuration"
      	}
      ]
    },
    {
      "name": "collections",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://www.example.com/documents/api/1.1/metadata-catalog/collections"
      	},
        {
          "rel": "describes",
      	  "href": "http://www.example.com/documents/api/1.1/collections"
      	}
      ]
    }
  ]
}