- ホワイトクラウド ASPIRE
- サービスご利用ガイド
- APIを利用する
- APIリファレンス
- ジョブ
- 更新
更新
ジョブの更新をします。
PUT /api/1.0/job/{jobId}
※ jobId:更新したいジョブID
Request parameters | ||||
---|---|---|---|---|
Name | Description | Type | Data type | Required |
Authorization | Bearer [APIキー] | header | String | True |
Job | 作成するジョブ情報 | body | Object | True |
body parameters | ||||
---|---|---|---|---|
Name | Description | Example | Data type | Required |
job | ジョブ情報 | Object | True | |
jobName | ジョブ名 | ジョブ名称 | String | True |
actionType | アクション 1:パワーオン 2:パワーオフ 3:シャットダウン 4:リセット |
1 | String | True |
comment | コメント | String | ||
notificationFlg | 通知有無 | false | Boolean | True |
address | 通知先アドレス ※notificationFlgがtrueの場合のみ指定必須。 Email形式。 カンマで分割して複数入力可能。 |
String | ||
scheduleType | スケジュールタイプ 1:1回のみ 2:時間単位 3:日単位 4:週単位 5:月単位(日付指定) |
4 | String | True |
startDate | ジョブ開始日 | 20230412 | String | True |
startTime | ジョブ開始時刻 | 0600 | String | True |
jobInterval | ジョブ実行間隔 | 2 | Number | |
dayOfWeek | 曜日 | 135 | String | |
day | 日付 | String |
Successful Response | |||
---|---|---|---|
Response Code | 200 OK | ||
Response Headers | Content-type: application/json | ||
Name | Description | Example | Data type |
jobId | ジョブID | 24714aac4703428292a03cd847c9ed62 | String |
実行例 |
---|
|
レスポンス例 |
---|
|