ファイルAPIカタログの取得
get
/documents/api/{version}/metadata-catalog/files
サポートされているサービスを含むファイル・リソースのメタデータ情報を返します。
リクエスト
サポートされるメディア・タイプ
- application/json
- application/xml
パス・パラメータ
- version: string
バージョン値
レスポンス
サポートされるメディア・タイプ
- application/json
- application/xml
200レスポンス
リクエストが処理されました。 サポートされるサービスへのリンクを含むファイル・メタデータ。
例
次の例では、ファイル・リソースの情報が返されます。
GET .../api/1.2/metadata-catalog/files
リクエスト・ヘッダー
なし。
リクエスト本文
なし。
HTTPステータス・コード
HTTP_STATUS = 200
JSONレスポンス
{
"$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 objects returned in an items array."
},
"hasMore": {
"type": "string",
"description": "Indicates if all accesses were returned; if all the accesses were returned, this is zero (0)."
},
"totalCount": {
"type": "string",
"description": "The total number of accesses."
},
"items": [
{
"type": {
"type": "string",
"description": "The value 'uithumbnail' is used when describing a thumbnail rendition. The value 'imagepreview' is used when describing preview renditions. The value 'responsiveimage' is used when describing responsive images."
},
"name": {
"type": "string",
"description": "The name of a rendition."
},
"format": {
"type": "string",
"description": "The file format of a rendition."
},
"exists": {
"type": "string",
"description": "The status of a rendition. If the rendition has been created, the value is 'true'; otherwise, the value is 'false.'"
},
"link": {
"type": "string",
"description": "REST URL to access the rendition. For 'uithumbnail' and 'responsiveimage' types, the REST URL will create the rendition if it does not exist."
},
"width": {
"type": "string",
"description": "The width of a rendition in pixels. The value of '-1' means the height is unknown, a value of '0' means height is not set."
},
"height": {
"type": "string",
"description": "The height of a rendition in pixels. The value of '-1' means the height is unknown, a value of '0' means height is not set."
}
},
{
"type": {
"type": "string",
"description": "For accesses, the type is file."
},
"accessType": {
"type": "string",
"description": "Type of the access (for example, preview, download)."
},
"accessedTime": {
"type": "string",
"description": "When the item was accessed."
},
"id": {
"type": "string",
"description": "file identifier"
},
"version": {
"type": "number",
"description": "file version"
},
"accessedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of user who accessed the file"
},
"id" : {
"type": "string",
"description": "ID of user who accessed the file"
},
"loginName": {
"type": "string",
"description": "login name of user who accessed the file"
},
"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 referring URL of the access."
},
"size": {
"type": "integer",
"description": "size of file or rendition in bytes"
}
},
{
"type": {
"type": "string",
"description": "For renditions, the type is rendition"
},
"name": {
"type": "string",
"description": "name of the rendition"
},
"description": {
"type": "string",
"description": "the description of the rendition"
},
"path": {
"type": "string",
"description": "internal path to the rendition"
},
"originalName": {
"type": "string",
"description": "original filename of the rendition"
}
},
{
"type": {
"type": "string",
"description": "For metadataFields, the type is field."
},
"fieldName": {
"type": "string",
"description": "metadata field name"
},
"fieldType": {
"type": "string",
"description": "metadata field type"
},
"isEnabled": {
"type": "string",
"description": "indicates if metadata field is enabled (1) or disabled (0)"
}
},
{
"type": {
"type": "string",
"description": "For lists or versions, the type is 'file'."
},
"conversationID": {
"type": "string",
"description": "Conversation ID associated with this file or a parent folder"
},
"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'"
}
}
},
"createdTime": {
"type": "string",
"description": "file created time"
},
"id": {
"type": "string",
"description": "Globally unique identifier (GUID) for the file."
},
"isConversationInherited": {
"type": "boolean",
"description": "Flag indicating whether the conversation ID is associated with the current file (false) or if the conversation ID is associated with a parent folder (true)."
},
"mimeType": {
"type": "string",
"description": "File format of the file."
},
"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'"
}
}
},
"modifiedTime": {
"type": "string",
"description": "File last modified date"
},
"name": {
"type": "string",
"description": "File name"
},
"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'"
}
}
},
"parentID": {
"type": "string",
"description": "Globally unique identifier (GUID) for the parent folder. If the parent folder is the user's home folder, the value for parentID is self."
},
"reservationTime": {
"type": "string",
"description": "Time the file was reserved (excluded from response data if the file is not reserved)."
},
"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'"
}
}
},
"size": {
"type": "integer",
"description": "size of file or rendition in bytes"
},
"version": {
"type": "number",
"description": "file version"
}
}
]
},
"links": [
{
"rel": "describedBy",
"href": "http://service1-tenant1:8080/documents/api/1.2/metadata-catalog/files"
},
{
"rel": "self",
"href": "http://service1-tenant1:8080/documents/api/1.2/metadata-catalog/files",
"method": "GET"
},
{
"rel": "info",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}",
"method": "GET"
},
{
"rel": "delete",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}",
"method": "DELETE"
},
{
"rel": "modify-metadata",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}",
"method": "PUT"
},
{
"rel": "upload",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/data",
"method": "POST"
},
{
"rel": "download",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data",
"method": "GET"
},
{
"rel": "upload-new-version",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data",
"method": "POST"
},
{
"rel": "download-thumbnail",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data/thumbnail",
"method": "GET"
},
{
"rel": "download-rendition",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data/rendition",
"method": "GET"
},
{
"rel": "upload-custom-rendition",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data/rendition",
"method": "POST"
},
{
"rel": "delete-custom-rendition",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data/rendition",
"method": "DELETE"
},
{
"rel": "list-renditions",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data/renditions",
"method": "GET"
},
{
"rel": "get-preview-path",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/previewPath",
"method": "GET"
},
{
"rel": "list-rendition-pages",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/pages",
"method": "GET"
},
{
"rel": "generate-rendition-pages",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/pages",
"method": "POST"
},
{
"rel": "copy",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/copy",
"method": "POST"
},
{
"rel": "move",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/move",
"method": "POST"
},
{
"rel": "set-metadata-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/metadata",
"method": "POST"
},
{
"rel": "delete-metadata-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/metadata",
"method": "DELETE"
},
{
"rel": "get-metadata-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/metadata",
"method": "GET"
},
{
"rel": "get-assigned-metadata-collections",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/metadataFields",
"method": "GET"
},
{
"rel": "assign-metadata-collections",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/metadata/{metadata-collection-id}",
"method": "POST"
},
{
"rel": "unassign-metadata-collections",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/metadata/{metadata-collection-id}",
"method": "DELETE"
},
{
"rel": "reserve",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/reserve",
"method": "POST"
},
{
"rel": "unreserve",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/unreserve",
"method": "POST"
},
{
"rel": "list-versions",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/versions",
"method": "GET"
},
{
"rel": "get-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/tags",
"method": "GET"
},
{
"rel": "set-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/tags",
"method": "POST"
},
{
"rel": "edit-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/tags",
"method": "PUT"
},
{
"rel": "delete-tags-values",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/tags",
"method": "DELETE"
},
{
"rel": "create-conversation",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/conversation",
"method": "POST"
},
{
"rel": "get-file-accesses",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{fileId}/accesses",
"method": "GET"
},
{
"rel": "get-multiple-files-info",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/lists",
"method": "GET"
},
{
"rel": "download-responsive-thumbnail-image",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data/thumbnailImage",
"method": "GET"
},
{
"rel": "download-responsive-small-image",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data/smallImage",
"method": "GET"
},
{
"rel": "download-responsive-medium-image",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data/mediumImage",
"method": "GET"
},
{
"rel": "download-responsive-large-image",
"href": "http://service1-tenant1:8080/documents/api/1.2/files/{id}/data/largeImage",
"method": "GET"
}
]
}