Call Options ヘッダー

Call Options ヘッダーは、特定のクライアントを操作するときに適用される要求ヘッダーです。REST API リソースにアクセスするときに、このヘッダーを使用してクライアント固有のオプションを指定します。Call Options ヘッダーは、SObject Basic Information、SObject Rows、Query、QueryAll、Search、および SObject Rows by External ID リソースで使用できます。

ヘッダーの項目名と値

項目名

Sforce-Call-Options

項目値

• client — クライアントを識別する文字列。
• defaultNamespace — 開発者の名前空間プレフィックスを識別する文字列。この項目を使用して、名前空間をすべての場所で指定することなく、管理パッケージの項目名を解決します。

例

開発者名前空間プレフィックスが battle で、botId というパッケージにカスタム項目がある場合、デフォルトの名前空間を次のように設定できます。

その後で次のようなクエリを実行します。

この場合、実際にクエリされる項目は、battle__botId__c です。

この項目を使用すると、名前空間プレフィックスを指定せずにクライアントコードを作成することができます。この項目を指定しない場合、クエリを正常に行うには、この項目の完全名を使用する必要があります。上記の例では、battle__botId__c を指定する必要があります。

この項目が設定され、クエリが名前空間を指定している場合、レスポンスにはプレフィックスは含まれません。たとえば、このヘッダーを battle に設定し、SELECT+Id+battle__botID__c+FROM+Account のようなクエリを発行すると、レスポンスは battle_botId__c 要素ではなく、botId__c 要素を使用します。

describe 情報を取得するときに defaultNamespace 項目は無視されるため、名前空間プレフィックスを持つ項目と、プレフィックスのない同じ名前のカスタム項目との間で混乱が生じることはありません。