Schedule Behavior Query
Every entity returned by the API contains information about the scheduled behavior and execution state, where the execution state is used to persist and track the execution of the behavior.
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/entityTypes/{id}/behaviors/{behaviorId}/schedules
COPY
Path Parameters
string
id
Required
id
string
behaviorId
Required
behaviorId
Query Parameters
string
filter
Optional
Filter for a query. FIQL format.
string
sortAsc
Optional
Field to use for ascending sort
string
sortDesc
Optional
Field to use for descending sort
integer
page
Required
Page to fetch, zero offset.
integer
pageSize
Required
Results per page to fetch.
Responses
200
OK
Returns ScheduledBehaviors of type(s) application/json;version=39.0
This response body class contains all of the following: Page , InlineScheduledBehaviors1
{
"resultTotal": 0,
"pageCount": 0,
"page": 0,
"pageSize": 0,
"associations": [
{
"entityId": "string",
"associationId": "string"
}
],
"values": [
{
"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
}
}
}
]
}
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