Edit Scheduled Behavior

Edit execution state of a schedule on given behvior. After edit the behavior will be re-scheduled if the "cronExpression" or the "active" property is changed.

Request

URI

PUT

https://{api_host}/cloudapi/1.0.0/entityTypes/{id}/behaviors/{behaviorId}/schedule/{scheduleId}

COPY

Path Parameters

string

Required

string

behaviorId

Required

behaviorId

string

scheduleId

Required

scheduleId

Request Body

ScheduledBehavior of type(s) application/json

Optional

Show optional properties

{
    "name": "string"
}

{
    "id": "string",
    "name": "string",
    "configuration": {
        "target": {
            "behaviorRef": {
                "name": "string",
                "id": "string"
            },
            "entityRef": {
                "name": "string",
                "id": "string"
            },
            "invocationArguments": {
                "arguments": {},
                "metadata": {}
            }
        },
        "config": {
            "active": false,
            "runOnce": false,
            "retries": 0,
            "allowedFailures": 0,
            "cronExpression": "30 * * * * * (Executes behavior every 30 seconds)",
            "taskTimeout": 0
        }
    },
    "state": {
        "execution": {
            "taskRef": {
                "name": "string",
                "id": "string"
            }
        },
        "schedule": {
            "inRetryMode": false,
            "retryCounter": 0,
            "allowedFailuresCounter": 0
        }
    }
}

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns ScheduledBehavior of type(s) application/json;version=39.1

"ScheduledBehavior Object"

string

Optional

The id of the scheduled behavior, used as unique identifier of the schedule.

string

name

Required

The name of the scheduled behavior.

object

configuration

Optional

Contains target and configuration of behavior to be scheduled.

object

state

Optional

Contains execution and schedule that represent the current state of the scheduled behavior.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}' https://{api_host}/cloudapi/1.0.0/entityTypes/{id}/behaviors/{behaviorId}/schedule/{scheduleId}

Availability

Added in 39.0

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Defined Interface Behaviors Operations

GET