GET operations

GET operations

API情報

HTTPメソッド	API名	パス	目的
GET	operations	/r/[APIVersion]/[ServiceCode]/operations.json	オペレーションの一覧取得

APIバージョン:20190625

個別パラメータ

URL

パラメータ	必須	タイプ	説明	例
APIVersion	〇	String	APIバージョン	20190625
ServiceCode	〇	String	オペレーションを一括取得する対象の親サービスコード	yemXXXXXXXX

HTTPリクエストボディ

なし

レスポンス

パラメータ	タイプ	説明	例
APIResult.OperationStatusList	Array	オペレーション一覧	配列
APIResult.OperationStatusList.ServiceCode	String	親サービスのサービスコード	yemXXXXXXXX
APIResult.OperationStatusList.ChildServiceCode	String	子サービスのサービスコード	yelXXXXXXXX、yeoXXXXXXXX、yexXXXXXXXX
APIResult.OperationStatusList.Start	String	オペレーションの実行開始時間	2019/06/25 17:00
APIResult.OperationStatusList.End	String	オペレーションの実行完了時間	2019/06/25 17:00
APIResult.OperationStatusList.OperationId	String	オペレーションID	123456
APIResult.OperationStatusList.Parameters	Object	オペレーションのパラメータ	オブジェクト
APIResult.OperationStatusList.Parameters.StartDate	String	勤怠簿出力の場合の対象期間の始点	2019/06/24
APIResult.OperationStatusList.Parameters.EndDate	String	勤怠簿出力の場合の対象期間の終点	2019/06/25
APIResult.OperationStatusList.Parameters.WorkingHourStart	String	勤怠簿出力の場合の1日の開始時間	5:00
APIResult.OperationStatusList.Parameters.User	String	コンソールセッションクリアの場合の対象ユーザ	user
APIResult.OperationStatusList.Result	String	オペレーションの実行結果	成功
APIResult.OperationStatusList.Status	String	オペレーションのステータス	実行待ち、実行中、実行済み、エラー、取り消し
APIResult.OperationStatusList.Type	String	オペレーション種別	CONSOLE_SESSION_CLEAR WORKING_TIME_MANAGEMENT

エラーコード

共通エラーコードはエラーレスポンスを参照してください。

エラー	HTTP Status Code	ErrorType	ErrorMessage	ErrorDetail.Reason	意味	備考
システム障害	200	SystemError	System 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"
  }
}