機械翻訳について
  1. ドキュメント用REST API
  2. タスク
  3. メタデータ・コレクション

Metadataコレクションの編集

put

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

指定されたメタデータ・コレクションのフィールドを追加または削除します。

メタデータ・コレクションを有効または無効にします。

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
  • コレクション名。 ユーザー個人コレクションの場合は、Personal.MyCollectionなどのPersonal.で始まる必要があります。
本文 ()
リクエスト本文は、編集フィールドの詳細、またはメタデータ収集リクエストの有効化/無効化ステータスを定義します。
ルート・スキーマ: CollectionEditBody
タイプ: object

メタデータ・コレクション・リクエストのフィールドの編集に使用できるフィールドの説明。 必須の属性はありません。

ソースを表示

  • カンマで区切られた1つ以上のフィールド名を追加します。 コレクションが作成された後、フィールドを追加および削除できます。 フィールド名はコレクション内で一意である必要があります。

    コレクション名およびフィールド名には次の制限事項があります。

    • コレクション名およびフィールド名の先頭または末尾をスペースにすることはできません。
    • コレクション名およびフィールド名を結合した長さが240文字を超えることはできません。
    • コレクション名およびファイル名では、大文字と小文字は区別されません。つまり、Field Nameとfield nameは同一とみなされます。

    コレクション名またはフィールド名で次の文字を使用しないでください。

     / \ < > [ ] { } = $ %
     ' * " ? : # & ^ . , |

    コレクション名またはフィールド名では、次の文字列も使用できません。

    • NUL
    • NULL
    • xSystem
    • xUser
    • xAF
    • dMetadataUnitID
    • dParentMetadataUnitID
    • dMetadataInheritLevel
    • dAssignedMetaCollection
    • dMetaCollection
    • dMetaCollections
    • dMetadataCollectionID
    • dMetadataID

  • addFieldsArray
    追加したフィールドに対するより詳細な制御が必要な場合は、addFieldsパラメータのかわりに使用できます。 addFieldsとaddFieldsArrayの両方を指定した場合、前者は無視されます。
  • 削除する1つ以上のフィールドの名前をカンマで区切って指定します。

  • メタデータ・コレクションを有効または無効にします。

    使用可能な値は次のとおりです。

    • 有効
    • 無効

ネストされたスキーマ : addFieldsArray
タイプ: array
追加したフィールドに対するより詳細な制御が必要な場合は、addFieldsパラメータのかわりに使用できます。 addFieldsとaddFieldsArrayの両方を指定した場合、前者は無視されます。
ソースを表示
ネストされたスキーマ: items
タイプ: object
ソースを表示
リクエストの例(application/json)
{
    "addFields":"FieldX,FieldY,FieldZ",
    "removeFields":"FieldA,FieldB",
    "settings":"enable"
}
トップに戻る

レスポンス

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

200レスポンス

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

本文 ()
ルート・スキーマ: CollectionEditResponse
タイプ: object
レスポンス本文には、メタデータ・コレクションのフィールド編集操作に関する情報が含まれます。
ソースを表示

400レスポンス

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

その名前のコレクションは存在しません。

トップに戻る

例

次の例では、2つのフィールドB3およびB4を追加し、CollectionBメタデータ・コレクションからフィールドB2を削除します。 また、CollectionBも無効になります。 

PUT .../metadata/CollectionB

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "addFields": "B3,B4",
    "removeFields": "B2"
    "settings" : "disable"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0"
}

例2

次の例では、FieldEとFieldFという2つのフィールド(タイプ、説明、デフォルト値ありまたはなし)を追加し、Personal.CollectionAメタデータ・コレクションからフィールドFieldAを削除します。 また、Personal.CollectionAも無効になります。 

PUT .../metadata/Personal.CollectionA

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "addFieldsArray":[
        {"fieldName":"FieldE", "fieldType":"text", "fieldDescription":"Field E"},
        {"fieldName":"FieldF", "fieldType":"number", "fieldDescription":"Field F", "defaultValue":345}
    ],
    "removeFields": "FieldA",
    "settings" : "disable"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0"
}

例3

次の例では、存在しないコレクションの定義を編集しようとします。

PUT .../metadata/Personal.CollectionAB

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "addFields": "A3,A4",
    "removeFields": "A2"
    "settings" : "disable"
}

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csUnableToEditMetaColDef!csMetaCollectionDoesntExist,Personal.CollectionAB",
    "errorMessage": "Unable to edit metadata collection definition. Metadata Collection 'Personal.CollectionAB' is not defined.",
    "title": "Unable to edit metadata collection definition. Metadata Collection 'Personal.CollectionAB' is not defined.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例4

次の例では、名前に含まれる無効な文字を使用して、定義を編集しようとします。

PUT .../metadata/Personal.CollectionA,B

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "addFields": "A3,A4",
    "removeFields": "A2"
    "settings" : "disable"
}

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"
}
先頭に戻る