ドキュメント用REST API

機械翻訳について

ファイル・メタデータ・コレクションの取得

get

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

特定のファイルに対する指定されたメタデータ・コレクションのフィールドに割り当てられた値を取得します。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

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

問合せパラメータ

directAssigned(optional): string

直接割り当てられたコレクション値のみを取得する必要があるか(1)、または継承されたすべてのコレクションの値も含める必要があるか(0)を指定します。

ヘッダー・パラメータ

accessToken(optional): string

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

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

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ: FileGetCollectionResponse

タイプ: object

レスポンス本文には、コレクション割当て操作に関する情報が含まれます。

ソースを表示

errorCode(optional): number

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

元ファイルのグローバル一意識別子(GUID)
metadata(optional): object Collections

使用可能なその他のプロパティ: Collection

割り当てられたコレクション。
type(optional): string

アイテム・タイプfile。

{
    "description":"The response body includes information about the assign collection operation.",
    "properties":{
        "idList":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the original file."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "metadata":{
            "$ref":"#/definitions/Collections"
        }
    }
}

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

タイプ: object

使用可能なその他のプロパティ

ソースを表示

object 「コレクション」

使用可能なその他のプロパティ: true

Collectionのフィールドおよび値。キーは実際のフィールド名です。

{
    "type":"object",
    "description":"Assigned collections.",
    "additionalProperties":{
        "$ref":"#/definitions/Collection"
    }
}

割り当てられたコレクション。

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

タイプ: object

使用可能なその他のプロパティ: true

Collectionのフィールドおよび値。キーは実際のフィールド名です。

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

{
    "idList":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type":"file",
    "errorCode":"0",
    "metadata":{
        "CollectionA":{
            "FieldA1":"Value1",
            "FieldA2":"Value2"
        },
        "CollectionB":{
            "FieldB1":"Value1",
            "FieldB2":"Value2"
        }
    }
}

400レスポンス

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

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定したファイルに関連付けられたメタデータ・コレクションが返されます。この例では、ファイルおよび親フォルダの両方にメタデータ・コレクションが関連付けられています。レスポンスには、フォルダ・コレクション( CollectionA)の後にファイル・コレクション( CollectionB)がリストされます。

GET .../files/D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354/metadata

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0",
  "idList": "D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354",
  "metadata": {
    "CollectionA": {
      "A1": "A1_value",
      "A2": "A2_value"
    },
    "CollectionB": {
      "B1": "B1_value",
      "B2": "B2_value"
    }
  },
  "type": "file"
}

例2

GET .../files/D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354/metadata

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0",
  "idList": "D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354",
  "metadata": {
    "CollectionA": {
      "A1": "A1_value",
      "A2": "A2_value"
    },
    "CollectionB": {
      "B1": "B1_value",
      "B2": "B2_value"
    },
    "Personal.CollectionA": {
      "A1": "personal-A1_value",
      "A2": "personal-A2_value"
    }
  },
  "type": "file"
}

例3

次の例では、指定したファイルに関連付けられたメタデータ・コレクションが返されます。このファイルは現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

GET .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/metadata

リクエスト・ヘッダー

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

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "idList": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "metadata": {
        "ApplinkCollection": {
            "appField1": "UserB_valueFile_field1",
            "appField2": "UserB_valueFile_field2"
        }
    },
    "type": "file"
}

先頭に戻る