機械翻訳について

移動先

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

Metadataコレクションのフィールドの編集

put

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

メタデータ・コレクションのフィールド定義またはステータスを編集します。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

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

本文 ()

リクエスト本文は、メタデータ収集リクエストのフィールドの有効/無効ステータスの詳細を定義します。

ルート・スキーマ: CollectionFieldEditBody

タイプ: object

リクエスト本文では、メタデータ・コレクションのフィールド有効化/無効化リクエストの詳細を定義します。

ソースを表示

• fields(optional): string
  フィールド名。カンマで区切られます。
• fieldsArray(optional): array fieldsArray
  フィールドの有効化と無効化に加えて、または変更する必要がある場合に、fieldsおよびsettingsパラメータのかわりに使用できます。
• settings(optional): string

  フィールドで指定されたメタデータ・フィールドを有効または無効にします。

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

  • 有効
  • 無効

{
    "description":"The request body defines details of the enable/disable fields in a metadata collection request.",
    "properties":{
        "fields":{
            "type":"string",
            "description":"Field names, separated by commas."
        },
        "settings":{
            "type":"string",
            "description":"<p>Enable or disable metadata fields specified in fields.</p><p>Possible values are:<ul><li>enable</li><li>disable</li></ul></p>"
        },
        "fieldsArray":{
            "type":"array",
            "description":"Can be used instead of <code>fields</code> and <code>settings</code> parameters if field definitions need to change in addition to or instead of enabling or disabling the fields.",
            "items":{
                "type":"object",
                "properties":{
                    "fieldName":{
                        "type":"string",
                        "description":"Field names as described for <code>fields</code> input parameter."
                    },
                    "fieldDescription":{
                        "type":"string",
                        "description":"Description of the field."
                    },
                    "defaultValue":{
                        "type":"string",
                        "description":"Default value of the field. If the <code>fieldType</code> is <code>date</code>, the value should be in the <code>yyyy-mm-ddThh:mm:ss</code> form. For <code>boolean</code> types, valid values should be (1) for <code>true</code> and (0) for <code>false</code>."
                    },
                    "isEnabled":{
                        "type":"boolean",
                        "description":"Enable (1) or disable (0) metadata field. Overrides <code>settings</code> value for this field."
                    }
                }
            }
        }
    }
}

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

タイプ: array

フィールドの有効化と無効化に加えて、または変更する必要がある場合に、fieldsおよびsettingsパラメータのかわりに使用できます。

ソースを表示

• Array of: object items

{
    "type":"array",
    "description":"Can be used instead of <code>fields</code> and <code>settings</code> parameters if field definitions need to change in addition to or instead of enabling or disabling the fields.",
    "items":{
        "type":"object",
        "properties":{
            "fieldName":{
                "type":"string",
                "description":"Field names as described for <code>fields</code> input parameter."
            },
            "fieldDescription":{
                "type":"string",
                "description":"Description of the field."
            },
            "defaultValue":{
                "type":"string",
                "description":"Default value of the field. If the <code>fieldType</code> is <code>date</code>, the value should be in the <code>yyyy-mm-ddThh:mm:ss</code> form. For <code>boolean</code> types, valid values should be (1) for <code>true</code> and (0) for <code>false</code>."
            },
            "isEnabled":{
                "type":"boolean",
                "description":"Enable (1) or disable (0) metadata field. Overrides <code>settings</code> value for this field."
            }
        }
    }
}

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

タイプ: object

ソースを表示

• defaultValue(optional): string
  フィールドのデフォルト値。 fieldTypeがdateの場合、値はyyyy-mm-ddThh:mm:ssフォームにある必要があります。 booleanタイプの場合、有効な値はtrueの場合は(1)、falseの場合は(0)です。
• fieldDescription(optional): string
  フィールドの説明。
• fieldName(optional): string
  fields入力パラメータの説明となるフィールド名。
• isEnabled(optional): boolean
  メタデータ・フィールドを有効化(1)または無効化(0)します。 このフィールドのsettings値をオーバーライドします。

{
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "description":"Field names as described for <code>fields</code> input parameter."
        },
        "fieldDescription":{
            "type":"string",
            "description":"Description of the field."
        },
        "defaultValue":{
            "type":"string",
            "description":"Default value of the field. If the <code>fieldType</code> is <code>date</code>, the value should be in the <code>yyyy-mm-ddThh:mm:ss</code> form. For <code>boolean</code> types, valid values should be (1) for <code>true</code> and (0) for <code>false</code>."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Enable (1) or disable (0) metadata field. Overrides <code>settings</code> value for this field."
        }
    }
}

リクエストの例(application/json)

{
    "settings":"disable"
}

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

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

本文 ()

ルート・スキーマ: CollectionEditResponse

タイプ: object

レスポンス本文には、メタデータ・コレクションのフィールド編集操作に関する情報が含まれます。

ソースを表示

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

{
    "description":"The response body includes information about edit fields in a metadata collection operation.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

400レスポンス

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

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

トップに戻る

例

次の例では、CollectionBメタデータ・コレクションのB1およびB2フィールドを無効にします。

PUT .../metadata/CollectionB/field

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "fields": "B1,B2",
    "settings" : "disable"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0"
}

例2

次の例では、FieldBの説明を変更し、有効にしてPersonal.CollectionAメタデータ・コレクションで無効にしている間に、FieldCの説明を変更します。

PUT .../metadata/Personal.CollectionA/field

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "fieldsArray":[
        {"fieldName":"FieldB", "fieldDescription":"Enabled Field B", "isEnabled":"1"},
        {"fieldName":"FieldC", "fieldDescription":"Disabled Field C", "isEnabled":"0"}
    ]
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0"
}

例3

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

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

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "fields": "A1,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"
}

先頭に戻る