API URLの構造
API URL は次のように構成されています。
{tenant url}/{base api url}/{business object name}({'business object unique key'})?${query parameter and value}
どこ、
{tenant url} | 必須 | サーバーにアクセスするためのテナント URL。 例、 https://xyz.api-example.com |
|---|---|---|
{base api url} | 必須 | API リソースにアクセスするための固定パス。ログインとログアウトを除くすべての API 呼び出しに使用されます。 固定パス - api/odata/businessobject ログインおよびログアウト API の固定パス - /api/rest/authentication |
{business object name} | 必須 | ビジネス オブジェクト名。 例、インシデント、アラート、変更など。 |
{(business object unique key)} | オプション | ビジネス オブジェクトの一意のキーは、特定のリソースまたはビジネス オブジェクトを要求するために使用される RecID です。 例、 ('02818A8426C9402E8DFE7C8D3132F783') |
{query parameter and value} | オプション | リストから上位 10 件のインシデントのみを取得する場合や、特定の所有者によるインシデントを取得する場合など、リクエストに応じてクエリ パラメーターと値が必要になります。 例、 ?$top=10 ?$filter=owner eq 'JClerk' |
エンドポイントの例:
http://xyz.api-example.com/api/odata/businessobject/incidents
http://xyz.api-example.com/api/odata/businessobject/alerts
http://xyz.api-example.com/api/odata/businessobject/employees
http://xyz.api-example.com/api/odata/businessobject/incidents?$search=Printer
http://xyz.api-example.com/api/odata/businessobject/incidents?$filter=Status eq 'Active'
