ドキュメント用REST API

機械翻訳について

ファイル情報取得

get

/documents/api/1.2/files/{fileId}

指定したファイルのファイル情報を取得します。

リクエスト

サポートされるメディア・タイプ

application/json
application/xml

パス・パラメータ

fileId: string

ファイルのグローバル一意識別子(GUID)。

問合せパラメータ

includeOnlyExistingRenditions(optional): boolean

このパラメータは、includeRenditionsがtrueでないかぎり無視されます。デフォルトでは、既存のレンディションに関する情報のみが返されます。 falseの場合、ファイルを含むすべてのサポートされているレンディションの詳細情報が返されます。 existsフィールドには、レンディションが作成されたかどうかが示されます。デフォルトは、trueです。
includeRenditions(optional): boolean

trueの場合、ファイルに関連付けられた既存のレンディションに関する詳細情報が返されます。デフォルトは、falseです。
version(optional): string

問い合せるファイルのバージョン番号を指定します。バージョンが指定されていない場合は、最新バージョンが使用されます。

ヘッダー・パラメータ

accessToken(optional): string

現在のユーザーに親フォルダまたはこのファイルにアクセスすることを許可するApplinkアクセス・トークン。このパラメータは、appLinkIDが使用されている場合は必須です。これはaccessTokenまたはAccessTokenとして使用できます。
appLinkID(optional): string

現在のユーザーに親フォルダまたはこのファイルにアクセスすることを許可するApplink ID。パラメータappLinkIDが使用されるときはいつでも、パラメータaccessTokenも提供されなければなりません。 appLinkIDまたはAppLinkIDとして使用できます。
dAccessCode(optional): string

保護されたパブリック・リンクを使用するために必要なアクセス・コード。次の形式のCookieヘッダーの一部として送信する必要があります: dAccessCode-<linkID>=<passcodeValue>
linkID(optional): string

現在のユーザーにこのファイルへのアクセスを許可する、パブリック・リンクのパブリック・リンクID。 linkIDまたはLinkIDとして使用できます。

トップに戻る

レスポンス

サポートされるメディア・タイプ

application/json
application/xml

200レスポンス

リクエストが処理されました。

ルート・スキーマ : FileResponseWithConversation

タイプ: object

レスポンス本文には、ファイルに関する情報が含まれます。

ソースを表示

errorCode(optional): number

エラー・コードがゼロ(0)の場合は、エラーなしです

{
    "description":"The response body includes information about the file.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/FileDefinitionWithConversation"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

すべてに一致

ソースを表示

object FileDefinitionWithConversation

ファイル情報

{
    "description":"The response body includes information about the file.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/FileDefinitionWithConversation"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

ネストされたスキーマ : FileDefinitionWithConversation

タイプ: object

ファイル情報

ソースを表示

conversationID(optional): string

このファイルまたは親フォルダに関連付けられた会話ID。
createdBy(optional): object User

ユーザー情報
createdTime(optional): string

ファイルの作成日。
id(optional): string

ファイルのグローバル一意識別子(GUID)。
isConversationInherited(optional): boolean

会話IDが現在のファイルに関連付けられているか(false)、会話IDが親フォルダに関連付けられているか(true)を示すフラグ。
items(optional): array items

リクエストに対してincludeRenditionsがtrueの場合、レンディション・データの配列がレスポンスに含まれます。
mimeType(optional): string

ファイルのファイル形式
modifiedBy(optional): object User

ユーザー情報
modifiedTime(optional): string

ファイルの最終更新日
name(optional): string

ファイル名。
ownedBy(optional): object User

ユーザー情報
parentID(optional): string

親フォルダのグローバル一意識別子(GUID)。親フォルダがユーザーのホーム・フォルダの場合、parentIDの値はselfです。
reservationTime(optional): string

ファイルが予約された時刻(ファイルが予約されていない場合、レスポンス・データから除外されます)
reservedBy(optional): object User

ユーザー情報
size(optional): string

ファイルのサイズ(バイト単位)。
type(optional): string

アイテム・タイプfile。
version(optional): string

ファイルのバージョン。

{
    "description":"File information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "parentID":{
            "type":"string",
            "description":"<p>Globally unique identifier (GUID) for the parent folder. If the parent folder is the user&#39;s home folder, the value for <code>parentID</code> is <code>self</code>.</p>"
        },
        "name":{
            "type":"string",
            "description":"File name."
        },
        "mimeType":{
            "type":"string",
            "description":"File format of the file."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "size":{
            "type":"string",
            "description":"Size of the file in bytes."
        },
        "version":{
            "type":"string",
            "description":"File version."
        },
        "createdTime":{
            "type":"string",
            "description":"File creation date."
        },
        "modifiedTime":{
            "type":"string",
            "description":"File last modified date."
        },
        "reservationTime":{
            "type":"string",
            "description":"Time the file was reserved (excluded from response data if the file is not reserved)."
        },
        "createdBy":{
            "$ref":"#/definitions/User"
        },
        "ownedBy":{
            "$ref":"#/definitions/User"
        },
        "modifiedBy":{
            "$ref":"#/definitions/User"
        },
        "reservedBy":{
            "$ref":"#/definitions/User"
        },
        "conversationID":{
            "type":"string",
            "description":"Conversation ID associated with this file or a parent folder."
        },
        "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)."
        },
        "items":{
            "type":"array",
            "description":"If <code>includeRenditions</code> was true on the request, an array of rendition data is included in the response.",
            "items":{
                "$ref":"#/definitions/RenditionDataDefinition"
            }
        }
    }
}

ネストされたスキーマ: User

タイプ: object

ユーザー情報

ソースを表示

displayName(optional): string

ユーザーの表示名
id(optional): string

ユーザーのグローバル一意識別子(GUID)。
loginName(optional): string

ユーザーのログイン名。
type(optional): string

アイテム・タイプuser。

{
    "description":"User information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

ネストされたスキーマ: items

タイプ: array

リクエストに対してincludeRenditionsがtrueの場合、レンディション・データの配列がレスポンスに含まれます。

ソースを表示

Array of: object RenditionDataDefinition

{
    "type":"array",
    "description":"If <code>includeRenditions</code> was true on the request, an array of rendition data is included in the response.",
    "items":{
        "$ref":"#/definitions/RenditionDataDefinition"
    }
}

ネストされたスキーマ : RenditionDataDefinition

タイプ: object

ソースを表示

exists(optional): string

レンディションのステータス。レンディションが作成されている場合、値はtrueです。それ以外の場合、値はfalseです。
format(optional): string

レンディションのファイル形式。
height(optional): string

レンディションの高さ(ピクセル単位)。 '-1'の値は高さが不明であることを意味し、'0'の値は高さが設定されていないことを意味します。
link(optional): string

レンディションにアクセスするためのREST URL。 uithumbnailおよびresponsiveimageタイプの場合、REST urlは、レンディションを作成します(存在しない場合)。
name(optional): string

レンディションの名前。
type(optional): string
次のいずれかの値になります:
- サムネイル・レンディションを記述する場合は、値uithumbnailが使用されます。
- プレビュー・レンディションを記述する場合、値imagepreviewが使用されます。
- 値responsiveimageは、応答イメージの記述時に使用されます。
- 値nativeは、親ファイルまたはアセットを説明する場合に使用します。

値customrenditionは、ユーザーが追加した非定型レンディションの記述時に使用されます

width(optional): string

レンディションの幅(ピクセル単位)。 '-1'の値は高さが不明であることを意味し、'0'の値は高さが設定されていないことを意味します。

{
    "description":"",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the rendition."
        },
        "type":{
            "type":"string",
            "description":"Can be one of the following values:<ul><li> The value <code>uithumbnail</code> is used when describing a thumbnail rendition.</li> <li>The value <code>imagepreview</code> is used when describing preview renditions.</li> <li>The value <code>responsiveimage</code> is used when describing responsive images.</li> <li>The value <code>native</code> is used when describing the the parent file or asset.</li> </li>The value <code>customrendition</code> is used when describing ad-hoc renditions added by a user</li></ul>"
        },
        "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 <code>true</code> otherwise the value is <code>false</code>."
        },
        "link":{
            "type":"string",
            "description":"REST url to access the rendition. For <code>uithumbnail</code> and <code>responsiveimage</code> 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."
        }
    }
}

レスポンスの例(application/json)

{
    "count":"13",
    "createdBy":{
        "displayName":"Tenant1 UserB",
        "id":"Service1.UserB",
        "loginName":"Service1.UserB",
        "type":"user"
    },
    "createdTime":"2018-02-28T20:00:22Z",
    "errorCode":"0",
    "id":"DFB10CF19A743BF1338CFF01AB7008277F375F0158F1",
    "mimeType":"image/jpeg",
    "modifiedBy":{
        "displayName":"Tenant1 UserB",
        "id":"Service1.UserB",
        "loginName":"Service1.UserB",
        "type":"user"
    },
    "modifiedTime":"2018-02-28T20:00:22Z",
    "name":"BlueSquare.jpg",
    "ownedBy":{
        "displayName":"Tenant1 UserB",
        "id":"Service1.UserB",
        "loginName":"Service1.UserB",
        "type":"user"
    },
    "parentID":"F26D598E507E96F9B41C98BA36219C7DA83E60B83105",
    "size":"24205",
    "type":"file",
    "version":"1",
    "items":[
        {
            "type":"uithumbnail",
            "name":"thumbnail",
            "format":"png",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/thumbnail?version=1",
            "size":"2478",
            "width":"300",
            "height":"180"
        },
        {
            "type":"imagepreview",
            "name":"page1",
            "format":"jpg",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/rendition?rendition=page1&version=1",
            "size":"0",
            "width":"0",
            "height":"0"
        },
        {
            "type":"imagepreview",
            "name":"thumbnail1",
            "format":"png",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/rendition?rendition=thumbnail1&version=1",
            "size":"0",
            "width":"0",
            "height":"0"
        },
        {
            "type":"native",
            "name":"asset",
            "format":"jpg",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data?version=1",
            "size":"24205",
            "width":"360",
            "height":"216"
        },
        {
            "type":"responsiveimage",
            "name":"ImageThumbnailjpg",
            "format":"jpg",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/thumbnailImage?version=1",
            "size":"2275",
            "width":"150",
            "height":"90"
        },
        {
            "type":"responsiveimage",
            "name":"ImageThumbnailwebp",
            "format":"webp",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/thumbnailImage?format=webp&version=1",
            "size":"0",
            "width":"150",
            "height":"90"
        },
        {
            "type":"responsiveimage",
            "name":"ImageSmalljpg",
            "format":"jpg",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/smallImage?version=1",
            "size":"0",
            "width":"300",
            "height":"180"
        },
        {
            "type":"responsiveimage",
            "name":"ImageSmallwebp",
            "format":"webp",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/smallImage?format=webp&version=1",
            "size":"380",
            "width":"300",
            "height":"180"
        },
        {
            "type":"responsiveimage",
            "name":"ImageMediumjpg",
            "format":"jpg",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/mediumImage?version=1",
            "size":"24205",
            "width":"360",
            "height":"216"
        },
        {
            "type":"responsiveimage",
            "name":"ImageMediumwebp",
            "format":"webp",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/mediumImage?format=webp&version=1",
            "size":"0",
            "width":"360",
            "height":"216"
        },
        {
            "type":"responsiveimage",
            "name":"ImageLargejpg",
            "format":"jpg",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/largeImage?version=1",
            "size":"24205",
            "width":"360",
            "height":"216"
        },
        {
            "type":"responsiveimage",
            "name":"ImageLargewebp",
            "format":"webp",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/largeImage?format=webp&version=1",
            "size":"0",
            "width":"360",
            "height":"216"
        },
        {
            "type":"customrendition",
            "name":"Desert",
            "format":"jpeg",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/rendition?rendition=Desert&renditionType=uploaded&version=1",
            "size":"845941",
            "width":"1024",
            "height":"768"
        }
    ]
}

400レスポンス

リクエスト・パラメータが正しい形式ではありません。

403レスポンス

ユーザーに読取り権限がない場合は禁止されています。

404レスポンス

ファイルIDが見つかりません。

トップに戻る

例

次の例では、指定されたファイルのバージョン2のファイル定義情報を返します。

GET .../files/D574378400573ED9D62B3195T0000000000100000001?version=2

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:22:19Z",
    "name": "example.txt",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "2"
}

例2

次の例では、指定されたファイルのバージョン1のファイル定義情報を返します。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、パブリック・リンクIDを使用します。

GET .../files/D574378400573ED9D62B3195T0000000000100000001?version=1

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:22:19Z",
    "name": "example.txt",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "1"
}

例3

次の例では、指定されたファイルのバージョン1のファイル定義情報を返します。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、アクセス・コードで保護されているパブリック・リンクIDを使用します。アクセス・コード( test12345)は、リクエスト・ヘッダーのCookieの一部として発行されます。

GET .../files/D574378400573ED9D62B3195T0000000000100000001?version=1

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:22:19Z",
    "name": "example.txt",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "1"
}

例4

次の例では、指定されたファイルのバージョン1のファイル定義情報をリクエストします。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、アクセス拒否エラー・メッセージが返されます。

GET .../files/DBFC40982617C949CA373B08B5D17B95F47087F4E518?version=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-20",
    "errorKey": "!csCloudItemInsufficientPrivileges,Tenant2.UserB,fFileGUID:DBFC40982617C949CA373B08B5D17B95F47087F4E518,FLD_INFO",
    "errorMessage": "User 'User BB' has insufficient privilege to access fFileGUID:DBFC40982617C949CA373B08B5D17B95F47087F4E518 with service FLD_INFO.",
    "errorType": "file",
    "id": "DBFC40982617C949CA373B08B5D17B95F47087F4E518",
    "title": "User 'User BB' has insufficient privilege to access fFileGUID:DBFC40982617C949CA373B08B5D17B95F47087F4E518 with service FLD_INFO.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例5

次の例では、指定されたファイルのバージョン1のファイル定義情報をリクエストします。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあります。また、アクセス・コードで保護されているパブリック・リンクのみを使用可能です。アクセス・コードがリクエストの一部として送信されなかったため、エラーが返されます。

GET .../files/DBFC40982617C949CA373B08B5D17B95F47087F4E518?version=1

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-18",
    "errorKey": "!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "The access code must be provided to access the link.",
    "errorType": "file",
    "id": "DBFC40982617C949CA373B08B5D17B95F47087F4E518",
    "title": "The access code must be provided to access the link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例6

次の例では、指定されたファイルのバージョン2のファイル定義情報を返します。このファイルには会話が関連付けられているので、2つの追加フィールドconversationIDとisConversationInheritedも返されます。

GET .../files/D574378400573ED9D62B3195T0000000000100000001?version=2

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:22:19Z",
    "name": "example.txt",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "conversationID": "39911",
    "isConversationInherited": "false",
    "size": "13",
    "type": "file",
    "version": "2"
}

例7

次の例では、指定したファイルのバージョン1のファイル定義情報が返されます。このファイルは、現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplinkを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

GET .../files/D574378400573ED9D62B3195T0000000000100000001?version=1

リクエスト・ヘッダー

appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg==
accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "createdBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2017-06-26T15:29:00Z",
    "errorCode": "0",
    "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "mimeType": "text/plain",
    "modifiedBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2017-06-26T15:29:07Z",
    "name": "fileViaApplink.txt",
    "ownedBy": {
        "displayName": "User AA",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "parentID": "FDC22B65E850730CAA60AF83B5D17B95F47087F4E518",
    "size": "29",
    "type": "file",
    "version": "1"
}

例8

次の例では、ファイル定義情報と、360ピクセル幅のjpegイメージの最新バージョンのレンディションを示すitems配列を返します。

uithumbnail renditionは、アイテムがアップロードされたときに作成されたもので、唯一のレンディションです。

アップロードしたjpegイメージをこれらのイメージに使用できるため、<code>responsiveimage</code>レンディションがリストされます。

GET ../files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43?includeRenditions=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "4",
    "createdBy": {
        "displayName": "UserB",
        "id": "Service1.UserB",
        "loginName": "Service1.UserB",
        "type": "user"
    },
    "createdTime": "2018-06-27T19:43:57Z",
    "errorCode": "0",
    "id": "D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43",
    "mimeType": "image/jpeg",
    "modifiedBy": {
        "displayName": "UserB",
        "id": "Service1.UserB",
        "loginName": "Service1.UserB",
        "type": "user"
    },
    "modifiedTime": "2018-06-27T19:59:40Z",
    "name": "BlueSquare.jpg",
    "ownedBy": {
        "displayName": "UserB",
        "id": "Service1.UserB",
        "loginName": "Service1.UserB",
        "type": "user"
    },
    "parentID": "F58C9C0DC02C049077861CCC2D4215B40039AC067D9F",
    "size": "24205",
    "type": "file",
    "version": "2",
    "items": [
        {
            "type": "uithumbnail",
            "name": "thumbnail",
            "format": "png",
            "exists": "true",
            "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/thumbnail?version=2",
            "size": "2478",
            "width": "300",
            "height": "180"
        },
	{
	    "type": "native",
	    "name": "asset",
	    "format": "jpg",
	    "exists": "true",
	    "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data?version=2",
	    "size": "24205",
	    "width": "360",
	    "height": "216"
        },
        {
            "type": "responsiveimage",
            "name": "ImageMediumjpg",
            "format": "jpg",
            "exists": "true",
            "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/mediumImage?version=2",
            "size": "24205",
            "width": "360",
            "height": "216"
        },
        {
            "type": "responsiveimage",
            "name": "ImageLargejpg",
            "format": "jpg",
            "exists": "true",
            "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/largeImage?version=2",
            "size": "24205",
            "width": "360",
            "height": "216"
        }
    ]
}

例9

次の例では、ファイル定義情報と、360ピクセル幅のjpegイメージの最新バージョンのレンディションを示すitems配列を返します。

アイテムがアップロードされたときにuithumbnail renditionが作成されました。

includeOnlyExistingRenditionsパラメータはfalseであるため、サポートされている他のレンディションが返されます。

imagepreviewのレンディションは作成されていませんが、imagepreviewのレンディションを持つことができるため、2つのリストが表示されます。

responsiveimageのレンディションは作成されていませんが、responsiveimageのレンディションを持つことができるため、8つのリストが表示されます。

GET ../files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43?includeRenditions=1&includeOnlyExistingRenditions=0

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
     "count": "12",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-06-27T19:43:57Z",
     "errorCode": "0",
     "id": "D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43",
     "mimeType": "image/jpeg",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-06-27T19:59:40Z",
     "name": "BlueSquare.jpg",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F58C9C0DC02C049077861CCC2D4215B40039AC067D9F",
     "size": "24205",
     "type": "file",
     "version": "2",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/thumbnail?version=2",
             "size": "2478",
             "width": "300",
             "height": "180"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "jpg",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/rendition?rendition=page1&version=2",
             "size": "0",
             "width": "0",
             "height": "0"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/rendition?rendition=thumbnail1&version=2",
             "size": "0",
             "width": "0",
             "height": "0"
         },
	 {
	     "type": "native",
	     "name": "asset",
	     "format": "jpg",
	     "exists": "true",
	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data?version=2",
	     "size": "24205",
	     "width": "360",
	     "height": "216"
        },
         {
             "type": "responsiveimage",
             "name": "ImageThumbnailjpg",
             "format": "jpg",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/thumbnailImage?version=2",
             "size": "0",
             "width": "150",
             "height": "90"
         },
         {
             "type": "responsiveimage",
             "name": "ImageThumbnailwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/thumbnailImage?format=webp&version=2",
             "size": "0",
             "width": "150",
             "height": "90"
         },
         {
             "type": "responsiveimage",
             "name": "ImageSmalljpg",
             "format": "jpg",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/smallImage?version=2",
             "size": "0",
             "width": "300",
             "height": "180"
         },
         {
             "type": "responsiveimage",
             "name": "ImageSmallwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/smallImage?format=webp&version=2",
             "size": "0",
             "width": "300",
             "height": "180"
         },
         {
             "type": "responsiveimage",
             "name": "ImageMediumjpg",
             "format": "jpg",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/mediumImage?version=2",
             "size": "24205",
             "width": "360",
             "height": "216"
         },
         {
             "type": "responsiveimage",
             "name": "ImageMediumwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/mediumImage?format=webp&version=2",
             "size": "0",
             "width": "360",
             "height": "216"
         },
         {
             "type": "responsiveimage",
             "name": "ImageLargejpg",
             "format": "jpg",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/largeImage?version=2",
             "size": "24205",
             "width": "360",
             "height": "216"
         },
         {
             "type": "responsiveimage",
             "name": "ImageLargewebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/largeImage?format=webp&version=2",
             "size": "0",
             "width": "360",
             "height": "216"
         }
     ]
 }

例10

次の例では、ファイル定義情報と、最新バージョンのpngイメージのレンディションを示すitems配列を返します。

アイテムがアップロードされたときにuithumbnail renditionが作成されました。

imagepreviewのレンディションが作成されました。

GET ../files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E?includeRenditions=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
     "count": "6",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-06-27T20:17:14Z",
     "errorCode": "0",
     "id": "D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E",
     "mimeType": "image/png",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-06-27T20:17:14Z",
     "name": "Mugs.png",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F58C9C0DC02C049077861CCC2D4215B40039AC067D9F",
     "size": "226620",
     "type": "file",
     "version": "1",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/thumbnail?version=1",
             "size": "168743",
             "width": "300",
             "height": "300"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/rendition?rendition=page1&version=1",
             "size": "359897",
             "width": "475",
             "height": "475"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/rendition?rendition=thumbnail1&version=1",
             "size": "81040",
             "width": "200",
             "height": "200"
         }
	 {
	     "type": "native",
	     "name": "asset",
	     "format": "jpg",
	     "exists": "true",
	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data?version=1",
	     "size": "53834",
	     "width": "475",
	     "height": "475"
	 },
	 {
	     "type": "responsiveimage",
	     "name": "ImageMediumjpg",
	     "format": "jpg",
	     "exists": "true",
	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/mediumImage?version=1",
	     "size": "53834",
	     "width": "475",
	     "height": "475"
	 },
	 {
	     "type": "responsiveimage",
	     "name": "ImageLargejpg",
	     "format": "jpg",
	     "exists": "true",
	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/largeImage?version=1",
	     "size": "53834",
	     "width": "475",
	     "height": "475"
        }
     ]
 }

例11

次の例では、ファイル定義情報と、最新バージョンのpngイメージのレンディションを示すitems配列を返します。

アイテムがアップロードされたときにuithumbnail renditionが作成されました。

imagepreviewのレンディションが作成されました。

includeOnlyExistingRenditionsパラメータはfalseであるため、サポートされている他のレンディションが返されます。

responsiveimageのレンディションは作成されていません。

GET ../files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E?includeRenditions=1&includeOnlyExistingRenditions=0

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
     "count": "12",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-06-27T20:17:14Z",
     "errorCode": "0",
     "id": "D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E",
     "mimeType": "image/png",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-06-27T20:17:14Z",
     "name": "Mugs.png",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F58C9C0DC02C049077861CCC2D4215B40039AC067D9F",
     "size": "226620",
     "type": "file",
     "version": "1",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/thumbnail?version=1",
             "size": "168743",
             "width": "300",
             "height": "300"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/rendition?rendition=page1&version=1",
             "size": "359897",
             "width": "475",
             "height": "475"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/rendition?rendition=thumbnail1&version=1",
             "size": "81040",
             "width": "200",
             "height": "200"
         },
	 {
	     "type": "native",
	     "name": "asset",
	     "format": "jpg",
	     "exists": "true",
	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data?version=1",
	     "size": "53834",
	     "width": "475",
	     "height": "475"
	 },         
         {
             "type": "responsiveimage",
             "name": "ImageThumbnailjpg",
             "format": "jpg",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/thumbnailImage?version=1",
             "size": "0",
             "width": "150",
             "height": "150"
         },
         {
             "type": "responsiveimage",
             "name": "ImageThumbnailwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/thumbnailImage?format=webp&version=1",
             "size": "0",
             "width": "150",
             "height": "150"
         },
         {
             "type": "responsiveimage",
             "name": "ImageSmalljpg",
             "format": "jpg",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/smallImage?version=1",
             "size": "0",
             "width": "300",
             "height": "300"
         },
         {
             "type": "responsiveimage",
             "name": "ImageSmallwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/smallImage?format=webp&version=1",
             "size": "0",
             "width": "300",
             "height": "300"
         },
         {
             "type": "responsiveimage",
             "name": "ImageMediumjpg",
             "format": "jpg",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/mediumImage?version=1",
             "size": "53834",
             "width": "475",
             "height": "475"
         },
         {
             "type": "responsiveimage",
             "name": "ImageMediumwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/mediumImage?format=webp&version=1",
             "size": "0",
             "width": "475",
             "height": "475"
         },
         {
             "type": "responsiveimage",
             "name": "ImageLargejpg",
             "format": "jpg",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/largeImage?version=1",
             "size": "53834",
             "width": "475",
             "height": "475"
         },
         {
             "type": "responsiveimage",
             "name": "ImageLargewebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/largeImage?format=webp&version=1",
             "size": "0",
             "width": "475",
             "height": "475"
         }
     ]
 }

例12

次の例は、ドキュメント・ファイルの最新バージョンのファイル定義情報を返します。その他のレンディションは作成されていません。アップロードされたファイルに関するデータが常に返されます。

GET ../files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313?includeRenditions=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
     "count": "1",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-02-28T21:13:22Z",
     "errorCode": "0",
     "id": "D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313",
     "mimeType": "application/msword",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-02-28T21:13:22Z",
     "name": "5pages.DOC",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F26D598E507E96F9B41C98BA36219C7DA83E60B83105",
     "size": "19968",
     "type": "file",
     "version": "1",
     "items": [
     	 {
     	     "type": "native",
     	     "name": "asset",
     	     "format": "doc",
     	     "exists": "true",
     	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data?version=1",
     	     "size": "19968",
     	     "width": "-1",
     	     "height": "-1"
	 }
     ]
 }

例13

次の例では、ファイル定義情報と、最新バージョンのドキュメント・ファイルのレンディションを示すitems配列を返します。

includeOnlyExistingRenditionsパラメータはfalseであるため、サポートされている他のレンディションが返されます。

uithumbnailレンディションは作成されていませんが、アイテムにuithumbnailのレンディションがあるため、リストされています。

imagepreviewのレンディションは作成されていませんが、そのアイテムはimagepreviewレンディションを持つことができるため、2つのリストが表示されます。

このタイプのファイルにはこれらのレンディションがないため、responsiveimageのレンディションは表示されません。

GET ../files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313?includeRenditions=1&includeOnlyExistingRenditions=0

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
     "count": "4",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-02-28T21:13:22Z",
     "errorCode": "0",
     "id": "D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313",
     "mimeType": "application/msword",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-02-28T21:13:22Z",
     "name": "5pages.DOC",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F26D598E507E96F9B41C98BA36219C7DA83E60B83105",
     "size": "19968",
     "type": "file",
     "version": "1",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/thumbnail?version=1",
             "size": "0",
             "width": "0",
             "height": "0"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "png",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page1&version=1",
             "size": "0",
             "width": "0",
             "height": "0"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail1&version=1",
             "size": "0",
             "width": "0",
             "height": "0"
         },
     	 {
     	     "type": "native",
     	     "name": "asset",
     	     "format": "doc",
     	     "exists": "true",
     	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data?version=1",
     	     "size": "19968",
     	     "width": "-1",
     	     "height": "-1"
	 }
     ]
 }

例14

次の例では、ファイル定義情報と、最新バージョンのドキュメント・ファイルのレンディションを示すitems配列を返します。

uithumbnailの演奏が作成されました。

imagepreviewのレンディションが作成されました。

GET ../files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313?includeRenditions=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
     "count": "10",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-02-28T21:13:22Z",
     "errorCode": "0",
     "id": "D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313",
     "mimeType": "application/msword",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-02-28T21:13:22Z",
     "name": "4pages.DOC",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F26D598E507E96F9B41C98BA36219C7DA83E60B83105",
     "size": "19968",
     "type": "file",
     "version": "1",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/thumbnail?version=1",
             "size": "1773",
             "width": "300",
             "height": "388"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page1&version=1",
             "size": "21547",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page2",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page2&version=1",
             "size": "21190",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page3",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page3&version=1",
             "size": "21419",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page4",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page4&version=1",
             "size": "22144",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail1&version=1",
             "size": "1138",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail2",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail2&version=1",
             "size": "1933",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail3",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail3&version=1",
             "size": "1989",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail4",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail4&version=1",
             "size": "1468",
             "width": "200",
             "height": "258"
         },
     	 {
     	     "type": "native",
     	     "name": "asset",
     	     "format": "doc",
     	     "exists": "true",
     	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data?version=1",
     	     "size": "19968",
     	     "width": "-1",
     	     "height": "-1"
	 }         
     ]
 }

例15

次の例では、ファイル定義情報と、最新バージョンのドキュメント・ファイルのレンディションを示すitems配列を返します。

uithumbnailの演奏が作成されました。

imagepreviewのレンディションが作成されました。

includeOnlyExistingRenditionsパラメータはfalseですが、他のレンディションはサポートされていません。

GET ../files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313?includeRenditions=1&includeOnlyExistingRenditions=0

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
     "count": "12",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-02-28T21:13:22Z",
     "errorCode": "0",
     "id": "D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313",
     "mimeType": "application/msword",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-02-28T21:13:22Z",
     "name": "5pages.DOC",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F26D598E507E96F9B41C98BA36219C7DA83E60B83105",
     "size": "19968",
     "type": "file",
     "version": "1",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/thumbnail?version=1",
             "size": "1773",
             "width": "300",
             "height": "388"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page1&version=1",
             "size": "21547",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page2",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page2&version=1",
             "size": "21190",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page3",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page3&version=1",
             "size": "21419",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page4",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page4&version=1",
             "size": "22144",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page5",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page5&version=1",
             "size": "21225",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail1&version=1",
             "size": "1138",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail2",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail2&version=1",
             "size": "1933",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail3",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail3&version=1",
             "size": "1989",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail4",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail4&version=1",
             "size": "1468",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail5",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail5&version=1",
             "size": "1871",
             "width": "200",
             "height": "258"
         },
     	 {
     	     "type": "native",
     	     "name": "asset",
     	     "format": "doc",
     	     "exists": "true",
     	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data?version=1",
     	     "size": "19968",
     	     "width": "-1",
     	     "height": "-1"
	 }       
     ]
 }

例16

次の例は、ファイルのファイル定義情報を返します。 includeRenditionsパラメータは渡されますが、このファイルにはuithumbnailレンディション、imagepreviewレンディションまたはresponsiveimageレンディションを含めることはできません。アップロードされたファイルに関するデータが常に返されます。

GET ../files/DAF3997E4E00AF180598C34DD394A94AF203799A93B9?includeRenditions=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
     "count": "1",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-01-26T21:56:28Z",
     "errorCode": "0",
     "id": "DAF3997E4E00AF180598C34DD394A94AF203799A93B9",
     "mimeType": "Application/patch",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-01-26T21:56:28Z",
     "name": "HeaderRsetPatch.patch",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F62C1A59C7E759FD515C8F00D394A94AF203799A93B9",
     "size": "1585",
     "type": "file",
     "version": "1"
    "items": [
        {
            "type": "native",
            "name": "asset",
            "format": "patch",
            "exists": "true",
            "link": "http://service1-tenant1:8080/documents/api/1.2/files/DAF3997E4E00AF180598C34DD394A94AF203799A93B9/data?version=1",
            "size": "1585",
            "width": "-1",
            "height": "-1"
        }
    ]
}

先頭に戻る