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.
Response
Supported Media Types
- application/xml
- application/json
200 Response
metadata-catalog collection fetched.
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.
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:
Show Source
array
-
Array of:
object User
Response Object of the Catalog Items.
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
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.
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
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
}
401 Response
Authentication refused for provided credentials or the token is invalid.
Headers
500 Response
Internal server error.