POST operation

API情報

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

オペレーションの登録

APIバージョン:20190625

個別パラメータ
URL
パラメータ必須タイプ説明
APIVersionStringAPIバージョン20190625
ServiceCodeStringオペレーションを登録する対象の親サービスコードyemXXXXXXXX
ChildServiceCodeStringオペレーションを登録する対象の子サービスコード

yelXXXXXXXX

HTTPリクエストボディ
パラメータ必須タイプ説明
TypeString

登録するオペレーションの種別
以下の表を参考に指定します

オペレーション種別指定するパラメータ
コンソールセッションクリアCONSOLE_SESSION_CLEAR
勤怠簿出力WORKING_TIME_MANAGEMENT

CONSOLE_SESSION_CLEAR

WORKING_TIME_MANAGEMENT

Reserve String

実行予定日時(YYYYMMDD hhmm)
最大1か月先まで指定可能です
指定しない場合は、APIの実行日時となります

20190625 1030
ParametersObject

オペレーション種別ごとのパラメータ

オブジェクト
Parameters.UserString

オペレーション種別がCONSOLE_SESSION_CLEARの場合に利用
対象のユーザを指定します

user
Parameters.WorkingHourStart String

オペレーション種別がWORKING_TIME_MANAGEMENTの場合に利用
1日の開始時間を指定します(hh00)
指定しない場合は、0500となります

0500
Parameters.StartDate String

オペレーション種別がWORKING_TIME_MANAGEMENTの場合に利用
対象期間の始点を指定します(yyyymmdd)
指定しない場合は、EndDateから35日前(EndDateを含む)となります

20190624
Parameters.EndDate String

オペレーション種別がWORKING_TIME_MANAGEMENTの場合に利用
対象期間の終点を指定します(yyyymmdd)
指定しない場合は、StartDateから35日後(StartDateを含む)、またはAPIの実行日時の前日となります
StartDate、EndDateのいずれも指定しない場合は、EndDateはAPIの実行日時の前日、StartDateはEndDateの35日前(EndDateを含む)となります

20190625
レスポンス
パラメータタイプ説明
APIResult.OperationIdString登録したオペレーションのオペレーションID(英数字6)

123456
 

エラーコード
エラーHTTP Status CodeErrorTypeErrorMessageErrorDetail.Reason意味備考
パラメータエラー200BadRequestSpecified 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.

以下のいずれかの場合

  • リクエストパラメータのReserveがAPIの実行日時以前の値
  • リクエストパラメータのReserveが1か月以上先の値
 
Operations only on LanScope Cat contracts are currently supported.指定された子サービスコードがオペレーションに対応していないオペレーションに対応しているのはIT資産管理(yelXXXXXXXX)のみです
システム障害200SystemErrorSystem 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"
  }
}