ドキュメント用REST API

機械翻訳について

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

post

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

既存のメタデータ・コレクションを指定されたファイルに関連付けます。

ノート: グローバル・コレクションをファイルに割り当てるには、ファイルの所有者であるか、ファイルのマネージャ・ロールがある必要があります。 個人コレクションの場合は、ファイルの所有者である場合のみ割り当てることができます。

特定のファイルのフィールドに値を割当て可能にするには、コレクションをその特定のファイルに割り当てる必要があります。コレクションを1つ以上のファイルに割当て可能であり、どのファイルにも1つ以上のコレクションを割り当てられます。

リクエスト

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

application/json
application/xml

パス・パラメータ

collectionName: string

割り当てるメタデータ・コレクションの名前。ユーザー個人コレクションの場合は、Personal.MyCollectionなどのPersonal.で始まる必要があります。
fileId: string

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

トップに戻る

レスポンス

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

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/CollectionA

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

例2

次の例では、指定されたファイルにPersonal.CollectionAメタデータ・コレクションを割り当てます。

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/metadata/Personal.CollectionA

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

例3

次の例では、存在しないメタデータ・コレクションを指定したファイルに割り当てようとします。

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/metadata/Personal.CollectionAB

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csUnableToSetMetadata!csMetaCollectionDoesntExist,Personal.CollectionAB",
    "errorMessage": "Unable to set metadata. Metadata Collection 'Personal.CollectionAB' is not defined.",    
    "type": "file"
    "idList": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "title": "Unable to set metadata. Metadata Collection 'Personal.CollectionAB' is not defined."
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例4

次の例では、名前に含まれる無効な文字を使用して、指定したファイルにメタデータ・コレクションを割り当てようとします。

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/metadata/Personal.CollectionA,B

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "errorCode": "-96",
    "errorKey": "!csCollectionNameInvalidCharacters,Personal.CollectionA\\,B",
    "errorMessage": "Invalid characters in the collection name 'Personal.CollectionA,B'."
    "title": "Invalid characters in the collection name 'Personal.CollectionA,B'.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る