機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

ファイル・メタデータ・コレクションへの値の割当て

post

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

指定されたファイル・メタデータ・コレクションのフィールドに値を割り当てます。 特定のファイルのフィールドに値を割当て可能にするには、コレクションをその特定のファイルに割り当てる必要があります。

ノート: ファイルでメタデータ値を設定するには、そのファイルのコントリビュータまたはマネージャのロールが必要です。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• fileId: string

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

ヘッダー・パラメータ

• accessToken(optional): string

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

• appLinkID(optional): string

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

本文 ()

リクエスト本文では、メタデータ・コレクションへの値割当てリクエストの詳細を定義します。 必須の属性はありません。

ルート・スキーマ: FileAssignValuesBody

タイプ: object

1つ以上のフィールド名。

たとえば、コレクション名とフィールド名を個別に参照できます:

{

"collection": "CollectionA,"

"FieldA1": "Value1,"

"FieldA2": "Value2"

}

もう1つの方法として、コレクションとフィールド名を各フィールド参照で指定できます。

{

"CollectionA.FieldA1": "Value1,"

"CollectionA.FieldA2": "Value2"

}

ユーザー個人コレクションの場合、コレクション名はPersonal.MyCollectionなどのPersonal.で始まる必要があります。

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

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

本文 ()

ルート・スキーマ: FileCollectionResponse

タイプ: object

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

ソースを表示

• errorCode(optional): number
  エラー・コードがゼロ(0)の場合は、エラーなしです
• idList(optional): string
  元ファイルのグローバル一意識別子(GUID)
• type(optional): string
  アイテム・タイプfile。

{
    "description":"The response body includes information about the assign collection to a file 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."
        }
    }
}

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

{
    "idList":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type":"file",
    "errorCode":"0"
}

400レスポンス

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

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定された文字列値を、指定されたファイルに関連付けられたCollectionAメタデータ・コレクションのフィールドに割り当てます。

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/metadata

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "collection": "CollectionA",
    "A1": "A1_value",
    "A2": "A2_value"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0",
  "idList": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
  "type": "file"
}

例2

次の例では、指定された文字列値を、指定されたファイルに関連付けられたPersonal.CollectionAメタデータ・コレクションのフィールドに割り当てます。

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/metadata

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "collection": "Personal.CollectionA",
    "A1": "personal-A1_value",
    "A2": "personal-A2_value"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "idList": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file"
}

例3

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

POST .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/metadata

リクエスト・ヘッダー

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

リクエスト本文

{
    "collection": "ApplinkCollection",
    "appField1": "UserB_valueFile_field1",
    "appField2": "UserB_valueFile_field2"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "idList": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "type": "file"
}

先頭に戻る