Retrieve a function schedule by its id

{ "id": 4503599627370496, "name": "My schedule", "createdTime": 1730204346000, "cronExpression": "* * * * *", "when": "Every hour", "sessionId": "<string>", "description": "This is a nice schedule", "functionId": 4503599627370496, "functionExternalId": "my.known.id" }

Authorizations

Authorization

string

header

required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Path Parameters

scheduleId

integer

required

The function schedule id.

Response

integer<int64>

required

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991

name

string

required

Name of function schedule.

Required string length: 1 - 140

Example:

"My schedule"

createdTime

integer<int64>

required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

cronExpression

string

required

Cron expression describes when the function should be called. Use http://www.cronmaker.com to create a cron expression.

Maximum string length: 1024

Example:

"* * * * *"

when

string

required

When the schedule will trigger, in human readable text.

Example:

"Every hour"

sessionId

string

required

Id of the session.

description

string

Description of function schedule.

Maximum string length: 500

Example:

"This is a nice schedule"

functionId

integer<int64>

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991

functionExternalId

string

The external ID provided by the client. Must be unique for the resource type.

Maximum string length: 255

Example:

"my.known.id"

API reference (20230101)

Authorizations

Path Parameters

Response