Search schedules

POST

https://example.itential.io/trigger-service/service-schedules/search

POST

/trigger-service/service-schedules/search

curl -X POST https://example.itential.io/trigger-service/service-schedules/search \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{}'

{
  "data": [
    {
      "scheduleId": "string",
      "serviceName": "string",
      "triggerSetEnabled": true,
      "createdBy": {
        "principalId": "string",
        "displayName": "string",
        "inactive": true,
        "email": "string"
      },
      "status": "active",
      "scheduleType": "concrete",
      "schedule": {
        "recurrence": {
          "kind": "cron",
          "cron": "string",
          "every": {
            "quantity": 1.1,
            "unit": "seconds"
          },
          "window": {
            "from": "string",
            "to": "string"
          },
          "everyDays": 1.1,
          "everyWeeks": 1.1,
          "weekdays": [
            "sun"
          ],
          "months": [
            1.1
          ],
          "on": {
            "kind": "dayOfMonth",
            "day": 1.1,
            "ordinal": "first",
            "weekday": "sun"
          },
          "at": "string"
        },
        "startsAt": "string",
        "endsAt": "string",
        "maxOccurrences": 1.1
      },
      "concreteDate": "string",
      "lastRun": "string",
      "nextRun": "string"
    }
  ]
}

Filters (all must match):

createdBy, status: equals
nextRun, lastRun: before or after
serviceId: in with a non-empty string array. IDs that match no service match nothing.

Sorts: nextRun, lastRun, createdAt, and serviceName. The default is nextRun, ascending. Services with the same name are ordered by ID, in either direction.

Scope: only schedules of services the caller can read are returned, whatever the filter.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

body

filterslist of objectsOptional

Filter criteria. All filters must match (logical AND).

sortobjectOptional

skipdoubleOptional

Number of items to skip. Defaults to 0.

limitdoubleOptional

Number of items to return (1-100). Defaults to 25.

Response

result

datalist of objects

The schedules on this page.

Errors

500

Internal Server Error