REST APIのルールとガイドライン

• •loginリソースを使用して、REST APIセッションを開始します。セッション中に実行するすべての要求で、ログイン応答で返されたセッションIDを再利用します。
要求ヘッダーのセッションIDのプレースホルダを使用できます。プレースホルダを、ログイン応答で返されたセッションIDデータに置き換えます。
• •REST APIセッションは、非アクティブ状態が30分間続くと期限切れになります。ただし、セッションが期限切れとなる前にログアウトすることをお勧めします。REST APIで作業を続行するには、新しいセッションを開始します。
• •loginおよびregisterリソースの要求ヘッダーには、icSessionIdまたはINFA-SESSION-IDを含めないでください。
• •送信したすべての要求が実行されるまで、REST APIセッションからログアウトしないでください。
• •loginを除くすべてのリソースでは、ベースURLにプレースホルダを使用します。バージョン2リソースでは、プレースホルダをserverUrlで返されるURLに置き換えます。バージョン3リソースでは、プレースホルダをbaseApiUrlで返されるURLに置き換えます。
• •すべてのリソースおよび属性は、大文字と小文字が区別されます。
• •ヘッダーで要求および応答の形式を指定します。Content-Type属性を使用して要求形式を指定し、Accept属性を使用して応答形式を指定します。
• •要求または応答のタイプが指定されていない場合、IDMCはデフォルトではJSONを使用します。
• •バージョン2リソースを使用するJSONの要求では、必要に応じて@type属性を使用してオブジェクトを定義します。バージョン3リソースを使用するJSONの要求では、@type属性を使用しません。
• •XMLの要求では、<object name>タグで囲んでオブジェクトを定義します。
• •オブジェクトのリストを含むXML応答は、<root>タグで囲まれたオブジェクトを返します。
• •POST要求では、部分モードを使用してJSON形式で要求を送信する場合を除き、要求オブジェクトにすべてのフィールドを含める必要があります。部分モードはほとんどのリソースに適用されません。デフォルトでは、REST APIは完全モードを使用します。
• •指定されている場合、指定されたオブジェクトでPOST要求属性を囲みます。オブジェクトを指定しない場合は、要求本文に属性を含めます。