Get File API Catalog
get
/documents/api/{version}/metadata-catalog/files
Return metadata information for the files resource, including supported services.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
- version
-
Type:
stringRequired:trueVersion value
Response
Supported Media Types
- application/json
- application/xml
200 Response
The request was fulfilled. File metadata includes links to supported services.
Examples
The following example returns information for the files resource.
GET .../api/1.1/metadata-catalog/files
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": "file identifier"
},
"name": {
"type": "string",
"description": "file name"
},
"type": {
"type": "string",
"description": "has value 'file'"
},
"version": {
"type": "number",
"description": "file version"
},
"size": {
"type": "integer",
"description": "size of file in byte"
},
"mimetype": {
"type": "string",
"description": "mimetype of file"
},
"parentID": {
"type": "string",
"description": "parent folder identifier"
},
"createdTime": {
"type": "string",
"description": "file created time"
},
"createdBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of file creator"
},
"id" : {
"type": "string",
"description": "ID of file creator"
},
"loginName": {
"type": "string",
"description": "login name of file creator"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"modifiedTime": {
"type": "string",
"description": "file last modified time"
},
"modifiedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of file last modifier"
},
"id" : {
"type": "string",
"description": "ID of file last modifier"
},
"loginName": {
"type": "string",
"description": "login name of file last modifier"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"ownedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of file owner"
},
"id" : {
"type": "string",
"description": "ID of file owner"
},
"loginName": {
"type": "string",
"description": "login name of file owner"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"conversationID": {
"type": "string",
"description": "conversation ID associated with this file or a parent folder."
},
"isConversationInherited": {
"type": "boolean",
"description": "flag indicating whether conversation ID is associated with current file (false) or if conversation ID is associated with a parent folder (true)."
},
"reservationDate": {
"type": "string",
"description": "file reservation time"
},
"reservedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of user who has the file reserved"
},
"id" : {
"type": "string",
"description": "ID of user who has the file reserved"
},
"loginName": {
"type": "string",
"description": "login name of user who has the file reserved"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"links": {
"type": "array",
"items": {
"$ref": "rest-schemas/link#"
}
},
"required": ["id", "name", "type", "version", "size", "parentID", "createdTime", "createdBy", "modifiedTime", "modifiedBy", "ownedBy"],
"count": {
"type": "string",
"description": "The number of accesses returned."
},
"hasMore": {
"type": "string",
"description": "Indicates if all accesses were returned; if all the accesses were returnturned this is zero (0)."
},
"totalCount": {
"type": "string",
"description": "The total number of accesses."
},
"accessType": {
"type": "string",
"description": "Type of the access (eg. preview, download)."
},
"accessedTime": {
"type": "string",
"description": "When the item was accessed."
},
"accessedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of user who has the file reserved"
},
"id" : {
"type": "string",
"description": "ID of user who has the file reserved"
},
"loginName": {
"type": "string",
"description": "login name of user who has the file reserved"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"errorCode": {
"type": "string",
"description": "An error code of zero (0) indicates no errors accessing the file."
},
"clientIP": {
"type": "string",
"description": "The client IP that accessed the file"
},
"refererURL": {
"type": "string",
"description": "The refering URL of the access."
}
},
"links": [
{
"rel": "describedBy",
"href": "http://service1-tenant1:8080/documents/api/1.1/metadata-catalog/files"
},
{
"rel": "self",
"href": "http://service1-tenant1:8080/documents/api/1.1/metadata-catalog/files",
"method": "GET"
},
{
"rel": "info",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}",
"method": "GET"
},
{
"rel": "delete",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}",
"method": "DELETE"
},
{
"rel": "modify-metadata",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}",
"method": "PUT"
},
{
"rel": "upload",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/data",
"method": "POST"
},
{
"rel": "download",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/data",
"method": "GET"
},
{
"rel": "upload-new-version",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/data",
"method": "POST"
},
{
"rel": "download-thumbnail",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/data/thumbnail",
"method": "GET"
},
{
"rel": "download-rendition",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/data/rendition",
"method": "GET"
},
{
"rel": "upload-custom-rendition",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/data/rendition",
"method": "POST"
},
{
"rel": "delete-custom-rendition",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/data/rendition",
"method": "DELETE"
},
{
"rel": "list-renditions",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/data/renditions",
"method": "GET"
},
{
"rel": "get-preview-path",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/previewPath",
"method": "GET"
},
{
"rel": "list-rendition-pages",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/pages",
"method": "GET"
},
{
"rel": "generate-rendition-pages",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/pages",
"method": "POST"
},
{
"rel": "copy",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/copy",
"method": "POST"
},
{
"rel": "move",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/move",
"method": "POST"
},
{
"rel": "set-metadata-values",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/metadata",
"method": "POST"
},
{
"rel": "delete-metadata-values",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/metadata",
"method": "DELETE"
},
{
"rel": "get-metadata-values",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/metadata",
"method": "GET"
},
{
"rel": "get-assigned-metadata-collections",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/metadataFields",
"method": "GET"
},
{
"rel": "assign-metadata-collections",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/metadata/{metadata-collection-id}",
"method": "POST"
},
{
"rel": "unassign-metadata-collections",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/metadata/{metadata-collection-id}",
"method": "DELETE"
},
{
"rel": "reserve",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/reserve",
"method": "POST"
},
{
"rel": "unreserve",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/unreserve",
"method": "POST"
},
{
"rel": "list-versions",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/versions",
"method": "GET"
},
{
"rel": "get-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/tags",
"method": "GET"
},
{
"rel": "set-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/tags",
"method": "POST"
},
{
"rel": "edit-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/tags",
"method": "PUT"
},
{
"rel": "delete-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/tags",
"method": "DELETE"
},
{
"rel": "create-conversation",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{id}/conversation",
"method": "POST"
},
{
"rel": "get-file-accesses",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/{fileId}/accesses",
"method": "GET"
},
{
"rel": "get-multiple-files-info",
"href": "http://service1-tenant1:8080/documents/api/1.1/files/lists",
"method": "GET"
}
]
}