Jump to

• Request
• Response
• Examples

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

Supported Media Types

• application/json
• application/xml

Path Parameters

• version: string
  Version value

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : CatalogResponse

Type: object

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

Show Source

• links(optional): array links
  List of catalogs.

{
    "description":"The response body includes information about the get API catalog operation.",
    "properties":{
        "links":{
            "type":"array",
            "description":"List of catalogs.",
            "items":{
                "$ref":"#/definitions/CatalogDefinition"
            }
        }
    }
}

Nested Schema : links

Type: array

List of catalogs.

Show Source

• Array of: object CatalogDefinition
  Catalog information.

{
    "type":"array",
    "description":"List of catalogs.",
    "items":{
        "$ref":"#/definitions/CatalogDefinition"
    }
}

Nested Schema : CatalogDefinition

Type: object

Catalog information.

Show Source

• links(optional): array links
  List of catalog links.
• name(optional): string
  Name of the catalog.

{
    "description":"Catalog information.",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the catalog."
        },
        "links":{
            "type":"array",
            "description":"List of catalog links.",
            "items":{
                "$ref":"#/definitions/APILinks"
            }
        }
    }
}

Nested Schema : links

Type: array

List of catalog links.

Show Source

• Array of: object APILinks
  API links information.

{
    "type":"array",
    "description":"List of catalog links.",
    "items":{
        "$ref":"#/definitions/APILinks"
    }
}

Nested Schema : APILinks

Type: object

API links information.

Show Source

• href(optional): string
  Complete URL that uniquely defines the resource.
• ref(optional): string
  Relationship.

{
    "description":"API links information.",
    "properties":{
        "ref":{
            "type":"string",
            "description":"Relationship."
        },
        "href":{
            "type":"string",
            "description":"Complete URL that uniquely defines the resource."
        }
    }
}

Example Response (application/json)

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

Back to Top

Examples

The following example returns information for the specified version.

GET .../api/1.2/metadata-catalog

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "items":[
    {
      "name": "folders",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/folders"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/folders"
      	}
      ]
    },
    {
      "name": "files",
      "links": [
        {
          "rel": "canonical",
          "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/files"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/files"
        }
      ]
    },
    {
      "name": "shares",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/shares"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/shares"
      	}
      ]
    },
    {
      "name": "users",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/users"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/users"
      	}
      ]
    },
    {
      "name": "applinks",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/applinks"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/applinks"
      	}
      ]
    },
    {
      "name": "publiclinks",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/publiclinks"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/publiclinks"
      	}
      ]
    },
    {
      "name": "metadata",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/metadata"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata"
      	}
      ]
    },
    {
      "name": "configuration",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/configuration"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/configuration"
      	}
      ]
    },
    {
      "name": "collections",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/collections"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/collections"
      	}
      ]
    },
    {
      "name": "sites",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/sites"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/sites"
      	}
      ]
    },
    {
      "name": "templates",
      "links": [
        {
          "rel": "canonical",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/templates"
      	},
        {
          "rel": "describes",
      	  "href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/templates"
      	}
      ]
    }
  ]
}

Back to Top