Skip to main content

UpdateAutoActionSettings

auto_idを指定して自動化BOTに定義しているオートアクションの一部設定を更新

Description​

auto_idを指定して自動化BOTに定義しているオートアクションの一部設定を更新します

Method​

POST

Request URL Format​

/api/v0/autoactions/:auto-id

URL Params​

auto-id    : 自動化BOTに定義されているオートアクションの一意なID

Request URL Sample​

POST https://api.xxx.com/api/v0/autoactions/6631db9865d9ce148a94180a

Payload​

（例） Content-Type : application/json

{
    "action_schedule": { // （任意）どういう間隔で実行するかタイプとそれに応じた値を設定します
        "time_type": "day",
        "time_value": "15:40"
    },
    "enabled": false //（任意） true: 稼働中 false: 停止中
}

action_scheduleのtime_type（どの間隔で実行しますか）毎のリクエスト例​

数時間おきに実行​

{
    "action_schedule": {
        "time_type": "hr",
        "time_value": "1" // 1～24の数値を文字列で指定できます
    }
}

数分おきに実行​

{
    "action_schedule": {
        "time_type": "min",
        "time_value": "10" // 10～59の数値を文字列で指定できます
    }
}

毎日指定の時刻に実行​

{
    "action_schedule": {
        "time_type": "day",
        "time_value": "09:00" // 00:00～23:59までのHH:mmのフォーマットで指定できます（UTC指定なのでご注意ください）
    }
}

毎週指定曜日に実行​

{
    "action_schedule": {
        "time_type": "week",
        "time_value": "0" // 0～6の数値を文字列で指定できます。0: 日曜日 1: 月曜日 2: 火曜日 3: 水曜日 4: 木曜日 5: 金曜日 6: 土曜日
    }
}

毎月指定日に実行​

{
    "action_schedule": {
        "time_type": "month",
        "time_value": "1" // 1～31の数値を文字列で指定できます。指定した日付が実行月に存在しない場合、その月の最終日に実行されます
    }
}

Response Sample​

Status 200​

{
    "error": null
}

Status 400​

{
    "error": "not found auto_id: 6631db9865d9ce148a94180b", // 指定したauto_idが存在しない
    "error_code": "INVALID_PARAMS"
}
{
    "code": 101,
    "error_code": "INVALID_PARAMS",
    "message": "invalid value for time_value. please specify a number between 1 and 24 as a string" // time_type: hrで無効な値が指定されている
}
{
    "code": 101,
    "error_code": "INVALID_PARAMS",
    "message": "invalid value for time_value. please specify a number between 10 and 59 as a string" // time_type: minで無効な値が指定されている
}
{
    "code": 101,
    "error_code": "INVALID_PARAMS",
    "message": "invalid value for time_value. please specify HH:mm format as a string" // time_type: dayで無効な値が指定されている
}
{
    "code": 101,
    "error_code": "INVALID_PARAMS",
    "message": "invalid value for time_value. please specify a number between 0 and 6 as a string" // time_type: weekで無効な値が指定されている
}
{
    "code": 101,
    "error_code": "INVALID_PARAMS",
    "message": "invalid value for time_value. please specify a number between 1 and 31 as a string"
}