Get Templates API Catalog
get
/documents/api/{version}/metadata-catalog/templates
Return API catalog information for the templates resource, including supported services.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
version: string
Version value
Response
Supported Media Types
- application/json
- application/xml
200 Response
The request was fulfilled. Response includes links to supported services.
Examples
The following example returns information for the templates resource.
GET .../api/1.2/metadata-catalog/templates
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{
"$schema": "http://json-schema.org/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "template identifier"
},
"name": {
"type": "string",
"description": "template name"
},
"type": {
"type": "String",
"description": "has value 'template'"
},
"description": {
"type": "String",
"description": "template description"
},
"createdTime": {
"type": "string",
"description": "template created time"
},
"createdBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of template creator"
},
"id" : {
"type": "string",
"description": "ID of template creator"
},
"loginName": {
"type": "string",
"description": "login name of template creator"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"modifiedTime": {
"type": "string",
"description": "template last modified time"
},
"modifiedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of template last modifier"
},
"id" : {
"type": "string",
"description": "ID of template last modifier"
},
"loginName": {
"type": "string",
"description": "login name of template last modifier"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"ownedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of template owner"
},
"id" : {
"type": "string",
"description": "ID of template owner"
},
"loginName": {
"type": "string",
"description": "login name of template owner"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"links": {
"type": "array",
"items": {
"$ref": "rest-schemas/link#"
}
},
"required": ["id", "name", "type", "createdTime", "createdBy", "modifiedTime", "modifiedBy", "ownedBy"]
},
"links": [
{
"rel": "describedBy",
"href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/sites"
},
{
"rel": "self",
"href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/metadata-catalog/sites"
},
{
"rel": "create-site",
"href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/templates/{id}/site",
"method": "POST"
}
]
}