1. オプション リスト

オプション リスト アイテムの更新

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

PUT /datasources/:optionListName

以下のプレースホルダーを置き換えます。

プレースホルダー説明
:optionListName更新する必要があるオプション リストの name

本文パラメーター

パラメーター説明
nameString変更する必要があるオプション リストの名前。値を変更できなくても、このパラメーターは必須です。
labelsLabels正規名の翻訳。
typeStringFlat はオプション リスト アイテムのネストを無効にし、Hierarchical はオプション リスト アイテムのネストを有効にします。Flat に設定され、values 配列にネストされたアイテムが含まれている場合、エラーがスローされます。変更されていない場合でも、このパラメーターは必須です。
valuesArray.<DatasourceValue>オプション リストに属するオプション リスト アイテム
is_system_ownedBooleanfalse はオプション リストを編集可能にし、true はオプション リストをロックして、変更を防ぎます。API を使用してオプション リストを作成する場合は、既定値である false常に使用する必要があります。

このリソースは、オプション リストの values 配列全体を、PUT 要求本文で送信されているもので上書きすることによって機能します。

オプション リスト アイテムを削除するには、削除する必要のあるオプション アイテムを除いて、オプション リストの既存の values の配列全体を再度送信します。

アイテムの名前を変更するには、名前を変更する必要のあるオプション アイテムを除き、新しい名前を含むオプション アイテムを加えて、values の配列全体を送信します。

現時点では、オプション リストの名前は変更できません

本文の例

オプション リストの作成の例から設定を取得します。

オプション リストの例

これを次のように変換します。

更新したオプション リストの例

次の本文をリソースに渡します。

{
"name": "Groceries",
"type": "Hierarchical",
"values": [
{
"identifier" : "Aloafofbread",
"labels": {
"en-US": "A loaf of bread",
"nl-BE": "Een brood"
},
"values" : []
},
{
"identifier" : "Jam",
"values" : []
}
]
}

name パラメーターと type パラメーターは、変更できない、または変更しない場合でも必須です。識別子文字列は、英字、数字、アンダースコア、ハイフン、ピリオドのみを含めることができ、50 文字未満にする必要があります。

応答

応答本文
204 No Contentすべてがエラーなしで処理された場合、空の本文を返します。
400 Bad Request必要な本文パラメーターの 1 つが欠落している場合、other キーを使用してアクセス可能な本文にエラー メッセージを返します。

応答の例

Status: 400 Bad Request

{
"Message": "The type of an existing datasource cannot be changed."
}
この記事を改善するための提案がある場合は、 お知らせください!