メインコンテンツまでスキップ

GetAutoActionSettings

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

Description​

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

Method​

GET

Request URL Format​

/api/v0/autoactions/:auto-id

URL Params​

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

Request URL Sample​

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

Response Sample​

Status 200​

{
    "auto_id": "6631db9865d9ce148a94180a", // 対象のauto_id
    "name": "スケジュール1", // オートメーション名
    "conditions": [ // 自動化する対象の検索条件
        {
            "search_value": [
                "1"
            ],
            "data_type": "text",
            "id": "64992b366bf00de2fac24de8"
        }
    ],
    "comment": "スケジュール1実行", // 実行時のコメント
    "action_schedule": { // 設定されているスケジュール情報
        "time_type": "day",
        "time_value": "2024-05-24T13:40:00.000Z",
        "NextExec": "2024-05-24T13:40:00Z"
    },
    "last_execution": { // 最後に実行された実行情報
        "started_at": "0001-01-01T00:00:00Z",
        "ended_at": "0001-01-01T00:00:00Z",
        "proc_sec": 0
    },
    "created_at": "2024-05-01T06:05:12.371Z", // オートアクション登録日時
    "updated_at": "2024-05-24T05:18:16.992Z", // オートアクション更新日時
    "enabled": false // 稼働中: true 停止中: false
}

action_scheduleに返却されるtime_type（どの間隔で実行しますか）毎の例​

数時間おきに実行​

"action_schedule": {
    "time_type": "hr",
    "time_value": "1", // hour単位で指定された値が返却される
    "NextExec": "2024-05-24T13:00:00Z" // 次回の実行予定時刻（UTC）
},

数分おきに実行​

"action_schedule": {
    "time_type": "min",
    "time_value": "10", // mininute単位で指定された値が返却される
    "NextExec": "2024-05-24T13:10:00Z" // 次回の実行予定時刻（UTC）
},

毎日指定の時刻に実行​

"action_schedule": {
    "time_type": "day",
    "time_value": "2024-05-24T09:00:00.000Z", // 登録時に指定した値のUTC時刻が返却される
    "NextExec": "2024-05-25T09:00:00Z" // 次回の実行予定時刻（UTC）
},

毎週指定曜日に実行​

"action_schedule": {
    "time_type": "week",
    "time_value": "0", // 0: 日曜日 1: 月曜日 2: 火曜日 3: 水曜日 4: 木曜日 5: 金曜日 6: 土曜日
    "NextExec": "2024-05-25T15:00:00Z" // 次回の実行予定時刻（UTC）
},

毎月指定日に実行​

"action_schedule": {
    "time_type": "month",
    "time_value": "1", // 指定された実行日が返却される
    "NextExec": "2024-05-31T15:00:00Z" // 次回の実行予定時刻（UTC）
}

Status 400​

{
    "error": "not found auto_id: 6631db9865d9ce148a94180b", // 指定したauto_idが存在しない
    "error_code": "INVALID_PARAMS"
}