REST API 開発者ガイド
jCall Options ヘッダー
REST API リソースにアクセスするために使用するクライアントのオプションを指定します。たとえば、デフォルトの名前空間プレフィックスを指定すれば、コードにプレフィックスを指定する必要はありません。
Call Options ヘッダーは、sObject Basic Information、sObject Rows、sObject Rows by External ID、Query、QueryAll、および Search で使用できます。Bulk API および Bulk API 2.0 でもサポートされます。
ヘッダーの項目名と値
- 項目名
- Sforce-Call-Options
- 項目値
-
- client — 要求を送信するクライアントの識別子として使用される文字列。この文字列はログファイルに表示され、要求を送信したクライアントを追跡するのに役立ちます。
- defaultNamespace — 要求のデフォルト名前空間として使用される開発者名前空間プレフィックス。要求では、このヘッダー項目を使用して、名前空間を指定せずに管理パッケージの項目名が解決されます。(Bulk API ではサポートされません。)
例
開発者名前空間プレフィックスが battle で、パッケージに botId というカスタム項目がある場合、デフォルトの名前空間に次のコールオプションヘッダーを設定します。
この場合、実際に照会される項目は、battle__botId__c です。
このヘッダーを使用すると、名前空間プレフィックスを指定せずにクライアントコードを作成することができます。上の例でヘッダーを使用しない場合は、battle__botId__c を記述する必要があります。
この項目が設定され、クエリでも名前空間を指定している場合、応答にはプレフィックスは含まれません。たとえば、このヘッダーを battle に設定し、SELECT+Id+battle__botID__c+FROM+Account のようなクエリを発行すると、応答は battle_botId__c 要素ではなく、botId__c 要素を使用します。
describe 情報を取得するときに defaultNamespace 項目は無視されるため、名前空間プレフィックスと、同じ名前のカスタム項目との間で混乱が生じることはありません。