Jump to

• Request
• Response

Catalog of all API end points.

get

/learn.rest/v1/metadata-catalog

Catalog of API end points.

Request

Query Parameters

• totalResults(optional): boolean
  If set to true, payload includes the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

metadata-catalog collection fetched.

Body ()

Root Schema : CatalogResponse

Type: object

Response object of the catalog items.

Show Source

• items(optional): array items
• links(optional): array links
  Links to the catalog item.

{
    "description":"Response object of the catalog items.",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CatalogItemResponse"
            }
        },
        "links":{
            "description":"Links to the catalog item.",
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "items":[
            {
                "name":"users",
                "links":[
                    {
                        "rel":"canonical",
                        "href":"{url}/learn.rest/v1/metadata-catalog/users",
                        "mediaType":"application/json"
                    },
                    {
                        "rel":"alternate",
                        "href":"https://{url}/learn.rest/v1/metadata-catalog/users",
                        "mediaType":"application/json"
                    },
                    {
                        "rel":"describes",
                        "href":"https://{url}/learn.rest/v1/metadata-catalog/users",
                        "mediaType":"application/json"
                    }
                ]
            },
            {
                "...":null
            }
        ],
        "links":[
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/users"
            }
        ]
    }
}

Example:

{
    "items":[
        {
            "name":"users",
            "links":[
                {
                    "rel":"canonical",
                    "href":"{url}/learn.rest/v1/metadata-catalog/users",
                    "mediaType":"application/json"
                },
                {
                    "rel":"alternate",
                    "href":"https://{url}/learn.rest/v1/metadata-catalog/users",
                    "mediaType":"application/json"
                },
                {
                    "rel":"describes",
                    "href":"https://{url}/learn.rest/v1/metadata-catalog/users",
                    "mediaType":"application/json"
                }
            ]
        },
        {
            "...":null
        }
    ],
    "links":[
        {
            "rel":"canonical",
            "href":"{url}/learn.rest/v1/users"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object User
  Response Object of the Catalog Items.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CatalogItemResponse"
    }
}

Nested Schema : links

Type: array

Links to the catalog item.

Show Source

• Array of: object items

{
    "description":"Links to the catalog item.",
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    }
}

Nested Schema : User

Type: object

Response Object of the Catalog Items.

Show Source

• links(optional): array links
  Array of Catalog Link Items.
• name(optional): string
  Name of the catalog item

{
    "description":"Response Object of the Catalog Items.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the catalog item"
        },
        "links":{
            "description":"Array of Catalog Link Items.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CatalogItemLinkItems"
            }
        }
    },
    "example":[
        {
            "name":"users",
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/metadata-catalog/users",
                    "mediaType":"application/json"
                },
                {
                    "rel":"alternate",
                    "href":"https://{url}/learn.rest/v1/metadata-catalog/users",
                    "mediaType":"application/json"
                },
                {
                    "rel":"describes",
                    "href":"https://{url}/learn.rest/v1/metadata-catalog/users",
                    "mediaType":"application/json"
                }
            ]
        }
    ],
    "xml":{
        "name":"User"
    }
}

Example:

[
    {
        "name":"users",
        "links":[
            {
                "rel":"canonical",
                "href":"https://{url}/learn.rest/v1/metadata-catalog/users",
                "mediaType":"application/json"
            },
            {
                "rel":"alternate",
                "href":"https://{url}/learn.rest/v1/metadata-catalog/users",
                "mediaType":"application/json"
            },
            {
                "rel":"describes",
                "href":"https://{url}/learn.rest/v1/metadata-catalog/users",
                "mediaType":"application/json"
            }
        ]
    }
]

Nested Schema : links

Type: array

Array of Catalog Link Items.

Show Source

• Array of: object CatalogItemLinkItems
  Object comprising links to the Catalog items.

{
    "description":"Array of Catalog Link Items.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CatalogItemLinkItems"
    }
}

Nested Schema : CatalogItemLinkItems

Type: object

Object comprising links to the Catalog items.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "description":"Object comprising links to the Catalog items.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/users/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/users/456"
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Authentication refused for provided credentials or the token is invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top