GET operations

API情報

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

オペレーションの一覧取得

APIバージョン:20190625

個別パラメータ
URL
パラメータ必須タイプ説明
APIVersionStringAPIバージョン20190625
ServiceCodeStringオペレーションを一括取得する対象の親サービスコードyemXXXXXXXX
HTTPリクエストボディ
  • なし
レスポンス
パラメータタイプ説明
APIResult.OperationStatusListArrayオペレーション一覧

配列

APIResult.OperationStatusList.ServiceCodeString親サービスのサービスコードyemXXXXXXXX
APIResult.OperationStatusList.ChildServiceCodeString子サービスのサービスコードyelXXXXXXXX
APIResult.OperationStatusList.StartStringオペレーションの実行開始時間2019/06/25 17:00
APIResult.OperationStatusList.EndStringオペレーションの実行完了時間2019/06/25 17:00
APIResult.OperationStatusList.OperationIdStringオペレーションID123456
APIResult.OperationStatusList.ParametersObjectオペレーションのパラメータオブジェクト
APIResult.OperationStatusList.Parameters.StartDateString勤怠簿出力の場合の対象期間の始点2019/06/24
APIResult.OperationStatusList.Parameters.EndDateString勤怠簿出力の場合の対象期間の終点2019/06/25
APIResult.OperationStatusList.Parameters.WorkingHourStartString勤怠簿出力の場合の1日の開始時間5:00
APIResult.OperationStatusList.Parameters.UserStringコンソールセッションクリアの場合の対象ユーザuser
APIResult.OperationStatusList.ResultStringオペレーションの実行結果成功
APIResult.OperationStatusList.StatusStringオペレーションのステータス

実行待ち、実行中、実行済み、エラー、取り消し

APIResult.OperationStatusList.TypeStringオペレーション種別

CONSOLE_SESSION_CLEAR

WORKING_TIME_MANAGEMENT

エラーコード
エラーHTTP Status CodeErrorTypeErrorMessageErrorDetail.Reason意味備考
システム障害200SystemErrorSystem error occurred. API設備のシステム障害サポートセンターへお問い合わせください
制限
  • なし
サンプル
リクエスト 
GET /r/[APIVersion]/[ServiceCode]/operations.json HTTP/1.1
Host: ep.api.iij.jp
x-iijapi-Expire: 2019-09-20T09:40:01Z
x-iijapi-SignatureMethod: [SignatureMethod]
x-iijapi-SignatureVersion: [SignatureVersion]
Authorization:IIJAPI [AccessKeyId]:[Signature]
レスポンス
{
  "APIResult": {
    "OperationStatusList": [
      {
        "ChildServiceCode": "yelxxxxxxxx",
        "End": "2019/09/19 17:00",
        "OperationId": "xxxxxx",
        "Parameters": {
          "EndDate": "2019/08/18",
          "StartDate": "2019/08/01",
          "WorkingHourStart": "5:00"
        },
        "Result": "成功",
        "ServiceCode": "yemxxxxxxxx",
        "Start": "2019/09/19 17:00",
        "Status": "実行済み",
        "Type": "WORKING_TIME_MANAGEMENT"
      },
      {
        "ChildServiceCode": "yelxxxxxxxx",
        "End": "2019/09/19 17:00",
        "OperationId": "xxxxxx",
        "Parameters": {
          "User": "user"
        },
        "Result": "成功",
        "ServiceCode": "yemxxxxxx",
        "Start": "2019/09/19 17:00",
        "Status": "実行済み",
        "Type": "CONSOLE_SESSION_CLEAR"
      }
    ],
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx"
  }
}