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

Required

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

Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer

pageSize

Required

Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

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

This response body class contains all of the following: InlineScheduledBehaviors0 , 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
                }
            }
        }
    ]
}

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/entityTypes/{id}/behaviors/{behaviorId}/schedules?page=value&pageSize=v

Availability

Added in 39.0

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Defined Interface Behaviors Operations

GET