カスタムHTTPヘッダー
このトピックでは、B2B Serviceのナレッジ管理用のREST APIで使用できるカスタムHTTPヘッダーを示します。
kmauthtoken
リクエストのkmauthtokenヘッダーを使用して、レスポンス内のデータのストライプおよびロケールを制御します。
kmauthtokenヘッダーには、次のパラメータがあります:
interfaceId
interfaceIdパラメータは、コール元アプリケーションで目的のKBストライプを示します。 interfaceIdの値をKBストライプにマップする方法を次に示します。
| interfaceIdの値 | KBストライプ |
|---|---|
| 1 |
SERVICE |
| 2 |
HCM |
| 3 |
ORA_SVC_ISR (つまり、内部ヘルプ・デスク) |
interfaceIdには、1つの値または複数の値を設定できます。 複数の値を設定する場合は、値をカンマで区切ります。 カンマ区切り値にはOR関係があります。
たとえば、
kmauthtoken: {"interfaceId":"1"}は、SERVICEリソースのみが返されることを示します。kmauthtoken: {"interfaceId":"1,2"}は、ユーザーの部門およびグループ・アクセスでフィルタされた、SERVICEリソースとHCMリソースの両方が返されることを示します。kmauthtoken: {"interfaceId": NULL}は、ユーザーの部門およびグループ・アクセスによってフィルタされた、すべてのKBストライプのリソースが返されることを示します。 すべてのストライプを本当に希望する場合は、kmauthtokenヘッダーからinterfaceIdを削除するか、目的のすべての値を渡すこともできます。 たとえば、「1,2,3」です。
localeId
localeIdパラメータは、レスポンスで受信するコンテンツのロケールを示します。
たとえば、次のヘッダーを含むGET /contentコールでは、ユーザーがアクセスできるナレッジ・ベース内の公開済サービス・コンテンツがスペイン語(スペイン)で返されます。
kmauthtoken:{"interfaceId":"1","localeId":"es_ES"}
ノート:
localeIdは、localeOverrideとともに使用することをお薦めします。 ロケールを指定するオプションと、このヘッダーに応答するAPIを理解するには、「言語」を参照してください。
localeOverride
localeOverrideパラメータは、localeIdがlangpref問合せパラメータより優先されるかどうかを示します。
kmauthoken.localeIdのkmauthtokenで"localeOverride":trueを使用して、langpref問合せパラメータより優先します。
kmauthtoken.localeIdのkmauthtokenで"localeOverride":falseを使用すると、langprefがリクエストに存在しない場合にのみ優先されます。
ノート:
localeIdを使用する場合は、localeOverrideをtrueに設定することをお薦めします。