Schedule Behavior

Schedule Behavior

Schedules execution of a behavior.

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/entityTypes/{id}/behaviors/{behaviorId}/schedules
COPY
Path Parameters
string
id
Required

id

string
behaviorId
Required

behaviorId

Request Body
ScheduledBehavior of type(s) application/json
Optional 
{
    "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
        }
    }
}
string
id
Optional

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

string
name
Required

The name of the scheduled behavior.

ScheduledBehaviorConfiguration
configuration
Optional

Contains target and configuration of behavior to be scheduled.

ScheduledBehaviorState
state
Optional

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

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ScheduledBehavior of type(s) application/json;version=39.0 
{
    "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
        }
    }
}
string
id
Optional

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

string
name
Required

The name of the scheduled behavior.

ScheduledBehaviorConfiguration
configuration
Optional

Contains target and configuration of behavior to be scheduled.

ScheduledBehaviorState
state
Optional

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


Availability
Added in 39.0
On This Page
Defined Interface Behaviors Operations
POST
Add Defined Entity Type Access
POST
Add Interface Behavior
DELETE
Delete Interface Behavior
PUT
Edit Scheduled Behavior
GET
Get Behavior Execution Log
GET
Get Defined Entity Type Access
GET
Get Defined Entity Type Behaviors
GET
Get Interface Behavior
GET
Get Interface Behaviors
GET
Get Scheduled Behavior
GET
Get Static Behavior Execution Log
GET
Get Type Behavior
POST
Invoke Defined Entity Behavior
POST
Invoke Static Behavior
DELETE
Remove Behavior Override
POST
Schedule Behavior
GET
Schedule Behavior Query
PUT
Set Defined Entity Type Access
DELETE
Unschedule Behavior
PUT
Update Interface Behavior
PUT
Update Interface Behaviors
PUT
Update Type Behavior