Get Sites API Catalog
get
/documents/api/{version}/metadata-catalog/sites
Return API catalog information for the sites 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 sites resource.
GET .../api/1.2/metadata-catalog/sites
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": "site identifier"
},
"name": {
"type": "string",
"description": "site name"
},
"type": {
"type": "String",
"description": "has value 'site'"
},
"description": {
"type": "String",
"description": "site description"
},
"createdTime": {
"type": "string",
"description": "site created time"
},
"createdBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of site creator"
},
"id" : {
"type": "string",
"description": "ID of site creator"
},
"loginName": {
"type": "string",
"description": "login name of site creator"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"modifiedTime": {
"type": "string",
"description": "site last modified time"
},
"modifiedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of site last modifier"
},
"id" : {
"type": "string",
"description": "ID of site last modifier"
},
"loginName": {
"type": "string",
"description": "login name of site last modifier"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"ownedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of site owner"
},
"id" : {
"type": "string",
"description": "ID of site owner"
},
"loginName": {
"type": "string",
"description": "login name of site 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",
"href": "http://Service1-Tenant3.service1-tenant3.myhost:19200/documents/api/1.2/sites/{id}/site",
"method": "POST"
}
]
}