IIJセキュアエンドポイントサービス APIリファレンス

GET contract

API情報

HTTPメソッドAPI名パス目的
GETcontract/r/[APIVersion]/[ServiceCode]/contract.json

契約情報の一覧取得

APIバージョン:20190625

個別パラメータ
URL
パラメータ必須タイプ説明例
APIVersion〇StringAPIバージョン20190625
ServiceCode〇String契約情報の一覧を取得する対象のサービスコードyemXXXXXXXX
HTTPリクエストボディ
  • なし
レスポンス
パラメータタイプ説明例
APIResult.AssociatedServiceContractsArray連携しているサービス一覧配列
APIResult.AssociatedServiceContracts.ServiceNameString連携しているサービス名IIJプライベートバックボーンサービス、IIJマネージドファイアウォールサービス
APIResult.AssociatedServiceContracts.LabelString連携しているサービスのラベル文字列
APIResult.AssociatedServiceContracts.ServiceCodeString連携しているサービスのサービスコードmtxXXXXXXXX、yfXXXXXXXX
APIResult.OptionDeviceContractsArrayトンネル機器オプションの契約情報一覧配列
APIResult.OptionDeviceContracts.TypeStringトンネル機器オプションのタイプタイプ1
APIResult.OptionDeviceContracts.ServiceNameStringトンネル機器オプションのサービス名トンネル機器オプション
APIResult.OptionDeviceContracts.LabelStringトンネル機器オプションのラベル文字列
APIResult.OptionDeviceContracts.ChildServiceCodeStringトンネル機器オプションのサービスコードyevXXXXXXXX
APIResult.ProductContractsArray子サービス契約情報一覧配列
APIResult.ProductContracts.OptionsArray子サービスのオプション一覧配列
APIResult.ProductContracts.ServiceNameString子サービスのサービス名アンチウイルス：Symantec、アンチウイルス：Cylance、IT資産管理、IT資産管理/CE
APIResult.ProductContracts.AccountObject子サービスの契約アカウントの情報オブジェクト
APIResult.ProductContracts.Account.RangeString子サービスの契約アカウントレンジ101～500
APIResult.ProductContracts.Account.Range(Mac)String

子サービスの契約アカウントレンジ(Mac)

※IT資産管理、IT資産管理/CEのみ

101～500
APIResult.ProductContracts.Account.NumString子サービスの契約アカウント数300
APIResult.ProductContracts.Account.Num(Mac)String

子サービスの契約アカウント数(Mac)

※IT資産管理、IT資産管理/CEのみ

300
APIResult.ProductContracts.LabelString子サービスのラベル文字列
APIResult.ProductContracts.ChildServiceCodeString子サービスのサービスコードyesXXXXXXXX、yecXXXXXXXX、yelXXXXXXXX、yeoXXXXXXXX
APIResult.LabelString親サービスのラベル文字列
APIResult.ServiceCodeString親サービスのサービスコードyemXXXXXXXX
エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照してください。
制限
  • なし
サンプル 
リクエスト  
GET /r/[APIVersion]/contract.json HTTP/1.1
Host: ep.api.iij.jp
x-iijapi-Expire: 2019-06-06T09:52:01Z
x-iijapi-SignatureMethod: [SignatureMethod]
x-iijapi-SignatureVersion: [SignatureVersion]
Authorization:IIJAPI [AccessKeyId]:[Signature]
レスポンス
{
  "APIResult": {
    "AssociatedServiceContracts": [
      {
        "ServiceName": "IIJプライベートバックボーンサービス",
        "Label": "xxxxx",
        "ServiceCode": "mtxXXXXXXXX"
      }
    ],
    "OptionDeviceContracts": [
      {
        "Type": "タイプ1",
        "ServiceName": "トンネル機器オプション",
        "Label": "",
        "ChildServiceCode": "yevXXXXXXXX"
      }
    ],
    "ProductContracts": [
      {
        "Options": [],
        "ServiceName": "アンチウイルス：Cylance",
        "Account": {
          "Range": "xxx～xxx",
          "Num": xxx
        },
        "Label": "xxxxx",
        "ChildServiceCode": "yecXXXXXXXX"
      },
      {
        "Options": [
          "Webアクセス管理",
          "デバイス制御",
          "メール管理",
          "アプリID監査"
        ],
        "ServiceName": "IT資産管理",
        "Account": {
          "Range": "xxx～xxx",
          "Num": xxx
        },
        "Label": "",
        "ChildServiceCode": "yelXXXXXXXX"
      },
      {
        "Options": [],
        "ServiceName": "アンチウイルス：Symantec",
        "Account": {
          "Range": "xxx～xxx",
          "Num": xxx
        },
        "Label": "xxxxx",
        "ChildServiceCode": "yesXXXXXXXX"
      }
    ],
    "Label": "xxxxx",
    "ServiceCode": "yemXXXXXXXX",
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx"
  }
}