Get Folder API Catalog
get
/documents/api/{version}/metadata-catalog/folders
Return metadata information for the folders 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. Folder metadata includes links to supported services.
Examples
The following example returns information for the folders resource.
GET .../api/1.2/metadata-catalog/folders
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": "folder identifier"
},
"name": {
"type": "string",
"description": "folder name"
},
"type": {
"type": "String",
"description": "has value 'folder'"
},
"description": {
"type": "String",
"description": "folder description"
},
"size": {
"type": "integer",
"description": "size of folder in byte"
},
"parentID": {
"type": "string",
"description": "parent folder identifier"
},
"createdTime": {
"type": "string",
"description": "folder created time"
},
"createdBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of folder creator"
},
"id" : {
"type": "string",
"description": "ID of folder creator"
},
"loginName": {
"type": "string",
"description": "login name of folder creator"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"modifiedTime": {
"type": "string",
"description": "folder last modified time"
},
"modifiedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of folder last modifier"
},
"id" : {
"type": "string",
"description": "ID of folder last modifier"
},
"loginName": {
"type": "string",
"description": "login name of folder last modifier"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"ownedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of folder owner"
},
"id" : {
"type": "string",
"description": "ID of folder owner"
},
"loginName": {
"type": "string",
"description": "login name of folder owner"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"conversationID": {
"type": "string",
"description": "conversation ID associated with this folder or a parent folder."
},
"isConversationInherited": {
"type": "boolean",
"description": "flag indicating whether conversation ID is associated with current folder (false) or if conversation ID is associated with a parent folder (true)."
},
"childItemsCount": {
"type": "",
"description": "number of child items"
},
"items": {
"type": "array",
"description": "list of child folders and files",
"items": {
"type": {
"type": "String",
"description": "indicate item is a folder or file"
},
"id": {
"type": "string",
"description": "item identifier"
},
"name": {
"type": "string",
"description": "item name"
},
"description": {
"type": "String",
"description": "item description (only folder has this property)"
},
"size": {
"type": "integer",
"description": "size of item in byte"
},
"version": {
"type": "number",
"description": "item version (only file has this property)"
},
"parentID": {
"type": "string",
"description": "parent folder identifier"
},
"createdTime": {
"type": "string",
"description": "item created time"
},
"createdBy": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "full name of item creator"
},
"id": {
"type": "string",
"description": "ID of item creator"
},
"loginName": {
"type": "string",
"description": "login name of item creator"
},
"type": {
"type": "string",
"description": "has value 'user'"
}
}
},
"modifiedTime": {
"type": "string",
"description": "item last modified time"
},
"modifiedBy": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "full name of item last modifier"
},
"id": {
"type": "string",
"description": "ID of folder item last modifier"
},
"loginName": {
"type": "string",
"description": "login name of folder item last modifier"
},
"type": {
"type": "string",
"description": "has value 'user'"
}
}
},
"ownedBy": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "full name of item owner"
},
"id": {
"type": "string",
"description": "ID of item owner"
},
"loginName": {
"type": "string",
"description": "login name of item owner"
},
"type": {
"type": "string",
"description": "has value 'user'"
}
}
},
"childItemsCount": {
"type": "integer",
"description": "number of child items (Only folder has this property)"
},
"childFileCount": {
"type" : "integer",
"description": "number of files in the folder"
},
"childFolderCount": {
"type": "integer",
"description": "number of folders in the folder"
},
"links": {
"type": "array",
"items": {
"$ref": "rest-schemas/link#"
}
}
}
},
"links": {
"type": "array",
"items": {
"$ref": "rest-schemas/link#"
}
},
"required": ["id", "name", "type", "parentID", "createdTime", "createdBy", "modifiedTime", "modifiedBy", "ownedBy"]
},
"links": [
{
"rel": "describedBy",
"href": "http://service1-tenant1:8080/documents/api/1.2/metadata-catalog/folders"
},
{
"rel": "self",
"href": "http://service1-tenant1:8080/documents/api/1.2/metadata-catalog/folders"
},
{
"rel": "own-list",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/items",
"method": "GET"
},
{
"rel": "self-list",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/self/items",
"method": "GET"
},
{
"rel": "list",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/items",
"method": "GET"
},
{
"rel": "self-info",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/self",
"method": "GET"
},
{
"rel": "info",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}",
"method": "GET"
},
{
"rel": "own-search",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/search",
"method": "GET"
},
{
"rel": "self-search",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/self/search",
"method": "GET"
},
{
"rel": "search",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/search",
"method": "GET"
},
{
"rel": "create",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}",
"method": "POST"
},
{
"rel": "delete",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}",
"method": "DELETE"
},
{
"rel": "modify",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}",
"method": "PUT"
},
{
"rel": "copy",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/copy",
"method": "POST"
},
{
"rel": "move",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/move",
"method": "POST"
},
{
"rel": "set-metadata-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/metadata",
"method": "POST"
},
{
"rel": "delete-metadata-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/metadata",
"method": "DELETE"
},
{
"rel": "get-metadata-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/metadata",
"method": "GET"
},
{
"rel": "get-assigned-metadata-collections",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/metadataFields",
"method": "GET"
},
{
"rel": "assign-metadata-collection",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/metadata/{metadata-collection-id}",
"method": "POST"
},
{
"rel": "unassign-metadata-collection",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/metadata/{metadata-collection-id}",
"method": "DELETE"
},
{
"rel": "get-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/tags",
"method": "GET"
},
{
"rel": "set-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/tags",
"method": "POST"
},
{
"rel": "edit-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/tags",
"method": "PUT"
},
{
"rel": "delete-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/tags",
"method": "DELETE"
},
{
"rel": "create-conversation",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/{id}/conversation",
"method": "POST"
},
{
"rel": "get-multiple-folders-info",
"href": "http://service1-tenant1:8080/documents/api/1.2/folders/lists",
"method": "GET"
}
]
}