ドキュメント用REST API

機械翻訳について

ファイル・アクセス権の取得

get

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

指定したファイルにアクセスしたユーザーに関する情報を取得します。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

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

問合せパラメータ

limit(オプション): 文字列

返されるアクセスの最大数を指定します。 1ページの結果に含めるアイテム数を指定する場合は、このパラメータを使用します。デフォルトは200です。
offset(オプション): string

アクションで返されるアイテムの全セットの中で、アイテムのリストを始める位置を指定します。 offsetを指定しない場合、返されるアイテムはリストの最初のアイテムで始まります(offset=0)。
orderBy(optional): string
結果は次のフィールドでソートできます。ソート順序は、昇順(昇順)または降順(降順)として定義できます。デフォルトのソート順は昇順です。
- accessedByは、アクティビティを開始したユーザーでソートします。
- versionは、アクティビティが発生したアイテムのバージョンでソートします。
- accessTypeは、アクセスのタイプ別にソートします(たとえば、: preview, download).
- sizeは、アイテム・アクセスのサイズでソートします。
- accessedTimeは、アクセス時間でソートされます。
- clientIPは、このアクティビティが開始されたクライアントのIPアドレスでソートします。
- errorCodeは、アクティビティのステータス・コードでソートされます。

ヘッダー・パラメータ

accessToken(optional): string

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

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

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

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

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ : FileAccessesResponse

タイプ: object

ソースを表示

count(optional): string

返されるアクセスの数。
errorCode(optional): string

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

すべてのアクセスが返されたかどうかを示します。すべてのアクセスが返された場合、これはゼロ(0)です。
items(optional): array items

ファイル・アクセスのリスト。
totalCount(optional): string

アイテムのアクセスの合計数。

{
    "description":"",
    "properties":{
        "count":{
            "type":"string",
            "description":"The number of accesses returned."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "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 for the item."
        },
        "items":{
            "type":"array",
            "description":"List of File Accesses.",
            "items":{
                "$ref":"#/definitions/FileAccessItemsDefinition"
            }
        }
    }
}

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

タイプ: array

ファイル・アクセスのリスト。

ソースを表示

Array of: object FileAccessItemsDefinition

{
    "type":"array",
    "description":"List of File Accesses.",
    "items":{
        "$ref":"#/definitions/FileAccessItemsDefinition"
    }
}

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

タイプ: object

ソースを表示

accessedBy(optional): object User

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

アイテムがアクセスされた日付。
accessType(optional): string

アクセスのタイプ(例:#58;プレビュー、ダウンロード)。
clientIP(optional): string

ファイルにアクセスしたクライアントIP
errorCode(optional): string

エラー・コード0は、ファイルへのアクセス時にエラーがないことを示します。
id(optional): string

アクセスされたファイルのグローバル一意識別子(GUID)。
refererURL(optional): string

アクセスの参照URL。
size(optional): string

アクセスされるファイルのサイズ。
version(optional): string

アクセスされたファイルのバージョン。

{
    "description":"",
    "properties":{
        "accessType":{
            "type":"string",
            "description":"Type of the access (for example#58; preview, download)."
        },
        "accessedTime":{
            "type":"string",
            "description":"Date the item was accessed."
        },
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file that was accessed."
        },
        "version":{
            "type":"string",
            "description":"Version of the file that was accessed."
        },
        "accessedBy":{
            "$ref":"#/definitions/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":"string",
            "description":"The size of the accessed file."
        }
    }
}

ネストされたスキーマ: 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>."
        }
    }
}

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

{
    "count":"1",
    "errorCode":"0",
    "hasMore":"0",
    "totalCount":"1",
    "type":"access",
    "items":[
        {
            "type":"file",
            "accessType":"download",
            "accessedTime":"2017-05-02T21:23:18.000Z",
            "id":"D574378400573ED9D62B3195T0000000000100000001",
            "version":"1",
            "accessedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "errorCode":"0",
            "clientIP":"10.10.82.114",
            "refererURL":"https://service1-tenant1:19200/documents/fileview/D1EEF28A920A342E8EC0E39645B3E9DD6490EF9D4696/_Mugs.jpg",
            "size":"53834"
        }
    ]
}

400レスポンス

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

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、ファイルのアクセス(ダウンロードとプレビュー)に関する情報を取得します。

GET .../files/D28824DCD6CB04122318CE9845B3E9DD64902A090B2E/accesses

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "4",
    "errorCode": "0",
    "hasMore": "0",
    "totalCount": "4",
    "type": "access",
    "items": [
        {
            "type": "file",
            "accessType": "preview",
            "accessedTime": "2017-05-03T21:47:24Z",
            "id": "D28824DCD6CB04122318CE9845B3E9DD64902A090B2E",
            "version": "1",
            "accessedBy": {
            	"displayName": "User AA",
		"id": "U0EAA20910FAF3052ACB79E4T00000000001",
		"loginName": "userAALoginName",
		"type": "user"
            },
            "errorCode": "0",
            "clientIP": "10.154.148.63",
            "refererURL": "https://service1-tenant1.hourly.gemini.shared.osn.oraclecorp.com:19201/documents/fileview/D28824DCD6CB04122318CE9845B3E9DD64902A090B2E/_Mugs.jpg",
            "size": "53834"
        },
        {
            "type": "file",
            "accessType": "download",
            "accessedTime": "2017-05-03T21:47:06Z",
            "id": "D28824DCD6CB04122318CE9845B3E9DD64902A090B2E",
            "version": "1",
            "accessedBy": {
            	"displayName": "User AA",
		"id": "U0EAA20910FAF3052ACB79E4T00000000001",
		"loginName": "userAALoginName",
		"type": "user"
            },
            "errorCode": "0",
            "clientIP": "10.154.148.63",
            "refererURL": "https://service1-tenant1.hourly.gemini.shared.osn.oraclecorp.com:19201/documents/folder/F9D24A8073BF47E5B9B1CAE345B3E9DD64902A090B2E/_accessed",
            "size": "53834"
        },
        {
            "type": "file",
            "accessType": "preview",
            "accessedTime": "2017-05-03T21:46:45Z",
            "id": "D28824DCD6CB04122318CE9845B3E9DD64902A090B2E",
            "version": "1",
            "accessedBy": {
            	"displayName": "User AA",
		"id": "U0EAA20910FAF3052ACB79E4T00000000001",
		"loginName": "userAALoginName",
		"type": "user"
            },
            "errorCode": "0",
            "clientIP": "10.154.148.63",
            "refererURL": "https://service1-tenant1.hourly.gemini.shared.osn.oraclecorp.com:19201/documents/fileview/D28824DCD6CB04122318CE9845B3E9DD64902A090B2E/_Mugs.jpg",
            "size": "53834"
        },
        {
            "type": "file",
            "accessType": "preview",
            "accessedTime": "2017-05-03T21:44:21Z",
            "id": "D28824DCD6CB04122318CE9845B3E9DD64902A090B2E",
            "version": "1",
            "accessedBy": {
            	"displayName": "User AA",
		"id": "U0EAA20910FAF3052ACB79E4T00000000001",
		"loginName": "userAALoginName",
		"type": "user"
            },
            "errorCode": "0",
            "clientIP": "10.154.148.63",
            "refererURL": "https://service1-tenant1.hourly.gemini.shared.osn.oraclecorp.com:19201/documents/fileview/D28824DCD6CB04122318CE9845B3E9DD64902A090B2E/_Mugs.jpg",
            "size": "53834"
        }
    ]
}

例2

次の例では、ファイルのアクセス(ダウンロードおよびプレビュー)に関する情報を、accessTypeでソートして取得します。最初に"preview"タイプがリストされていることに注意してください。

GET .../files/D28824DCD6CB04122318CE9845B3E9DD64902A090B2E/accesses?orderBy=accessType

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "4",
    "errorCode": "0",
    "hasMore": "0",
    "totalCount": "4",
    "type": "access",
    "items": [
        {
            "type": "file",
            "accessType": "preview",
            "accessedTime": "2017-05-03T21:44:21Z",
            "id": "D28824DCD6CB04122318CE9845B3E9DD64902A090B2E",
            "version": "1",
            "accessedBy": {
            	"displayName": "User AA",
		"id": "U0EAA20910FAF3052ACB79E4T00000000001",
		"loginName": "userAALoginName",
		"type": "user"
            },
            "errorCode": "0",
            "clientIP": "10.154.148.63",
            "refererURL": "https://service1-tenant1.hourly.gemini.shared.osn.oraclecorp.com:19201/documents/fileview/D28824DCD6CB04122318CE9845B3E9DD64902A090B2E/_Mugs.jpg",
            "size": "53834"
        },
        {
            "type": "file",
            "accessType": "preview",
            "accessedTime": "2017-05-03T21:47:24Z",
            "id": "D28824DCD6CB04122318CE9845B3E9DD64902A090B2E",
            "version": "1",
            "accessedBy": {
            	"displayName": "User AA",
		"id": "U0EAA20910FAF3052ACB79E4T00000000001",
		"loginName": "userAALoginName",
		"type": "user"
            },
            "errorCode": "0",
            "clientIP": "10.154.148.63",
            "refererURL": "https://service1-tenant1.hourly.gemini.shared.osn.oraclecorp.com:19201/documents/fileview/D28824DCD6CB04122318CE9845B3E9DD64902A090B2E/_Mugs.jpg",
            "size": "53834"
        },
        {
            "type": "file",
            "accessType": "preview",
            "accessedTime": "2017-05-03T21:46:45Z",
            "id": "D28824DCD6CB04122318CE9845B3E9DD64902A090B2E",
            "version": "1",
            "accessedBy": {
            	"displayName": "User AA",
		"id": "U0EAA20910FAF3052ACB79E4T00000000001",
		"loginName": "userAALoginName",
		"type": "user"
            },
            "errorCode": "0",
            "clientIP": "10.154.148.63",
            "refererURL": "https://service1-tenant1.hourly.gemini.shared.osn.oraclecorp.com:19201/documents/fileview/D28824DCD6CB04122318CE9845B3E9DD64902A090B2E/_Mugs.jpg",
            "size": "53834"
        },
        {
            "type": "file",
            "accessType": "download",
            "accessedTime": "2017-05-03T21:47:06Z",
            "id": "D28824DCD6CB04122318CE9845B3E9DD64902A090B2E",
            "version": "1",
            "accessedBy": {
            	"displayName": "User AA",
		"id": "U0EAA20910FAF3052ACB79E4T00000000001",
		"loginName": "userAALoginName",
		"type": "user"
            },
            "errorCode": "0",
            "clientIP": "10.154.148.63",
            "refererURL": "https://service1-tenant1.hourly.gemini.shared.osn.oraclecorp.com:19201/documents/folder/F9D24A8073BF47E5B9B1CAE345B3E9DD64902A090B2E/_accessed",
            "size": "53834"
        }
    ]
}

例3

次の例では、ファイルのアクセス(ダウンロードとプレビュー)に関する情報が取得され、accessTypeで昇順、2に制限されます。 count、hasMoreおよびtotalCountが適切に設定された場合は、2つのアイテムのみが返されます。 downloadタイプが最初にリストされます。

GET .../files/D28824DCD6CB04122318CE9845B3E9DD64902A090B2E/accesses?orderBy=accessType?orderBy=accessType:asc&limit=2

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "2",
    "errorCode": "0",
    "hasMore": "1",
    "totalCount": "4",
    "type": "access",
    "items": [
        {
            "type": "file",
            "accessType": "download",
            "accessedTime": "2017-05-03T21:47:06Z",
            "id": "D28824DCD6CB04122318CE9845B3E9DD64902A090B2E",
            "version": "1",
            "accessedBy": {
            	"displayName": "User AA",
		"id": "U0EAA20910FAF3052ACB79E4T00000000001",
		"loginName": "userAALoginName",
		"type": "user"
            },
            "errorCode": "0",
            "clientIP": "10.154.148.63",
            "refererURL": "https://service1-tenant1.hourly.gemini.shared.osn.oraclecorp.com:19201/documents/folder/F9D24A8073BF47E5B9B1CAE345B3E9DD64902A090B2E/_accessed",
            "size": "53834"
        },
        {
            "type": "file",
            "accessType": "preview",
            "accessedTime": "2017-05-03T21:47:24Z",
            "id": "D28824DCD6CB04122318CE9845B3E9DD64902A090B2E",
            "version": "1",
            "accessedBy": {
            	"displayName": "User AA",
		"id": "U0EAA20910FAF3052ACB79E4T00000000001",
		"loginName": "userAALoginName",
		"type": "user"
            },
            "errorCode": "0",
            "clientIP": "10.154.148.63",
            "refererURL": "https://service1-tenant1.hourly.gemini.shared.osn.oraclecorp.com:19201/documents/fileview/D28824DCD6CB04122318CE9845B3E9DD64902A090B2E/_Mugs.jpg",
            "size": "53834"
        }
    ]
}

例4

次の例では、ファイルのアクセス(ダウンロードとプレビュー)に関する情報を取得します。このファイルは現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

GET .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/accesses

リクエスト・ヘッダー

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

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "1",
    "errorCode": "0",
    "hasMore": "0",
    "totalCount": "1",
    "type": "access",
    "items": [
        {
            "type": "file",
            "accessType": "download",
            "accessedTime": "2017-06-26T17:38:44Z",
            "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
            "version": "2",
            "accessedBy": {
                "displayName": "User BB",
                "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
                "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
                "type": "user"
            },
            "errorCode": "-25",
            "errorMessage": "Unable to download file. Access token for app link has expired.",
            "clientIP": "10.154.128.31",
            "size": "29"
        }
    ]
}

例5

次の例では、ファイルIDが無効なためアクセスに関する情報は返されません。

GET ...files/F8BDBD5812C1C10E3E5C1A1C45B3E9DD649028853801/accesses

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csActivitesGetHistoryError!csSecurityValidationFailed!csFldDoesNotExist,DF1D474F24FCE3A517F69D7F45B3E9DD64909ED47144!csUnprivilegedSystemError",
    "errorMessage": "Unable to get history of activities. Security validation failed. 'DF1D474F24FCE3A517F69D7F45B3E9DD64909ED47144' does not exist. The error was caused by an internally generated issue. The error has been logged.",
    "errorType": "file",
    "id": "DF1D474F24FCE3A517F69D7F45B3E9DD64909ED47144",
    "title": "Unable to get history of activities. Security validation failed. 'DF1D474F24FCE3A517F69D7F45B3E9DD64909ED47144' does not exist. The error was caused by an internally generated issue. The error has been logged.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例6

次の例は、ユーザーが指定されたファイルIDにアクセスできないため、アクセスに関する情報を返しません。

GET ...files/D1C9B4DB1F9D7632AA68A7B845B3E9DD64909ED4714F/accesses

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

JSON Response
{
    "errorCode": "-20",
    "errorKey": "!csActivitesGetHistoryError!csCloudItemInsufficientPrivileges,tenant1.cecsuser4,fFileGUID:D1C9B4DB1F9D7632AA68A7B845B3E9DD64909ED4714F,GET_ACTIVITY_HISTORY",
    "errorMessage": "Unable to get history of activities. User 'User AA' has insufficient privilege to access fFileGUID:D1C9B4DB1F9D7632AA68A7B845B3E9DD64909ED4714F with service GET_ACTIVITY_HISTORY.",
    "errorType": "file",
    "id": "D1C9B4DB1F9D7632AA68A7B845B3E9DD64909ED4714F",
    "title": "Unable to get history of activities. User 'User AA' has insufficient privilege to access fFileGUID:D1C9B4DB1F9D7632AA68A7B845B3E9DD64909ED4714F with service GET_ACTIVITY_HISTORY.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る