POST operation
API情報
HTTPメソッド | API名 | パス | 目的 |
---|---|---|---|
POST | operation | /r/[APIVersion]/[ServiceCode]/[ChildServiceCode]/operation.json | オペレーションの登録 |
APIバージョン:20190625
個別パラメータ
URL
パラメータ | 必須 | タイプ | 説明 | 例 |
---|---|---|---|---|
APIVersion | 〇 | String | APIバージョン | 20190625 |
ServiceCode | 〇 | String | オペレーションを登録する対象の親サービスコード | yemXXXXXXXX |
ChildServiceCode | 〇 | String | オペレーションを登録する対象の子サービスコード | yelXXXXXXXX、yeoXXXXXXXX、yexXXXXXXXX |
HTTPリクエストボディ
パラメータ | 必須 | タイプ | 説明 | 例 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Type | 〇 | String | 登録するオペレーションの種別
| CONSOLE_SESSION_CLEAR WORKING_TIME_MANAGEMENT | ||||||
Reserve | String | 実行予定日時(YYYYMMDD hhmm) | 20190625 1030 | |||||||
Parameters | 〇 | Object | オペレーション種別ごとのパラメータ | オブジェクト | ||||||
Parameters.User | 〇 | String | オペレーション種別がCONSOLE_SESSION_CLEARの場合に利用 | user | ||||||
Parameters.WorkingHourStart | String | オペレーション種別がWORKING_TIME_MANAGEMENTの場合に利用 | 0500 | |||||||
Parameters.StartDate | String | オペレーション種別がWORKING_TIME_MANAGEMENTの場合に利用 | 20190624 | |||||||
Parameters.EndDate | String | オペレーション種別がWORKING_TIME_MANAGEMENTの場合に利用 | 20190625 |
レスポンス
パラメータ | タイプ | 説明 | 例 |
---|---|---|---|
APIResult.OperationId | String | 登録したオペレーションのオペレーションID(英数字6桁) | 123456 |
エラーコード
- 共通エラーコードはエラーレスポンスを参照してください。
エラー | HTTP Status Code | ErrorType | ErrorMessage | ErrorDetail.Reason | 意味 | 備考 |
---|---|---|---|---|---|---|
パラメータエラー | 200 | BadRequest | Specified parameter has some errors. | Required parameter 'Parameters' not found. | リクエストパラメータにParametersが存在しない | |
Operation parameter must be object. | リクエストパラメータのParametersのフォーマットエラー | |||||
Required operation parameter '[Parameters]' not found. | リクエストパラメータのParameters内に必須パラメータが存在しない | |||||
Unknown parameter found '[Parameters]'. | リクエストパラメータのParameters内に定義されていないパラメータが存在する | |||||
Operation parameter 'WorkingHourStart' must be of hh00 format. | リクエストパラメータのWorkingHourStartのフォーマットエラー | オペレーション種別がWORKING_TIME_MANAGEMENTの場合 | ||||
Operation parameter 'WorkingHourStart' must be between 0000 and 2300. | リクエストパラメータのWorkingHourStartの範囲が不正 | オペレーション種別がWORKING_TIME_MANAGEMENTの場合 | ||||
Operation parameter '[StartDate|EndDate]' must be of yyyymmdd format. | リクエストパラメータのStartDate、またはEndDateのフォーマットエラー | オペレーション種別がWORKING_TIME_MANAGEMENTの場合 | ||||
Operation parameter '[StartDate|EndDate]' must before yesterday. | リクエストパラメータのStartDate、またはEndDateの値が不正 | オペレーション種別がWORKING_TIME_MANAGEMENTの場合 | ||||
Interval between operation parameter 'EndDate' and 'StartDate' exceeds 35 days. | リクエストパラメータのStartDateとEndDateの範囲が35日以上 | オペレーション種別がWORKING_TIME_MANAGEMENTの場合 | ||||
'StartDate' must be before or the same as 'EndDate'. | リクエストパラメータのStartDateがEndDateよりも後の日付 | オペレーション種別がWORKING_TIME_MANAGEMENTの場合 | ||||
No such operation type '[Type]'. | リクエストパラメータのTypeが定義されていない値 | |||||
Parameter 'Reserve' must be of yyyymmdd hhmm format. | リクエストパラメータのReserveのフォーマットエラー | |||||
Parameter 'Reserve' must be within a month from now. | 以下のいずれかの場合
| |||||
Operations only on LanScope Cat contracts are currently supported. | 指定された子サービスコードがオペレーションに対応していない | オペレーションに対応しているのはIT資産管理(yelXXXXXXXX)、IT資産管理/CE(yeoXXXXXXXX)、IT資産管理/S(yexXXXXXXXX)のみです | ||||
システム障害 | 200 | SystemError | System error occurred. | API設備のシステム障害 | サポートセンターへお問い合わせください |
制限
- なし
サンプル
リクエスト
POST /r/[APIVersion]/[ServiceCode]/[ChildServiceCode]/operation.json HTTP/1.1 Host: ep.api.iij.jp x-iijapi-Expire: 2019-09-20T09:19:01Z x-iijapi-SignatureMethod: [SignatureMethod] x-iijapi-SignatureVersion: [SignatureVersion] Authorization:IIJAPI [AccessKeyId]:[Signature] Content-Type: application/json {"Type":"WORKING_TIME_MANAGEMENT","Reserve":"20190926 1700","Parameters":{"StartDate": "20190801","EndDate":"20190818""WorkingHourStart": "0500"}}
レスポンス
{ "APIResult": { "OperationId": "xxxxxx", "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx" } }