DOC-API-MODEL-schema-s6i1d2bv7o#overview
ScheduledTriggerEnvelope
Declared context for a scheduled action: the schedule ID, tenant, project, beneficiary and scheduled time. These fields are intended to carry trusted context from the scheduler. Receiving support for this envelope is not currently implemented.
Type-reference view: API Schema i828te0das. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#request-field-scheduleidscheduleId | string | Required in requests | Identifier of the scheduled job. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#request-field-tenantidtenantId | string | Required in requests | Identifier of the tenant that owns or scopes this record. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#request-field-projectidprojectId | string | Required in requests | Identifier of the project within the tenant that scopes this record. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#request-field-onbehalfofonBehalfOf | string | Required in requests | Subject on whose behalf the scheduled trigger runs. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#request-field-scheduledtimescheduledTime | string (date-time) | Required in requests | Instant for which this execution or trigger was scheduled. |
Request validation
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#request-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
scheduleId | Minimum length | 1 |
tenantId | Minimum length | 1 |
projectId | Minimum length | 1 |
onBehalfOf | Minimum length | 1 |
scheduledTime | Required value | true |
In responses
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#field-scheduleidSection ID: DOC-API-MODEL-schema-s6i1d2bv7o#response-field-scheduleidscheduleId | string | Required in requests | Identifier of the scheduled job. |
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#field-tenantidSection ID: DOC-API-MODEL-schema-s6i1d2bv7o#response-field-tenantidtenantId | string | Required in requests | Identifier of the tenant that owns or scopes this record. |
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#field-projectidSection ID: DOC-API-MODEL-schema-s6i1d2bv7o#response-field-projectidprojectId | string | Required in requests | Identifier of the project within the tenant that scopes this record. |
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#field-onbehalfofSection ID: DOC-API-MODEL-schema-s6i1d2bv7o#response-field-onbehalfofonBehalfOf | string | Required in requests | Subject on whose behalf the scheduled trigger runs. |
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#field-scheduledtimeSection ID: DOC-API-MODEL-schema-s6i1d2bv7o#response-field-scheduledtimescheduledTime | string (date-time) | Required in requests | Instant for which this execution or trigger was scheduled. |
DOC-API-MODEL-schema-s6i1d2bv7o#validation
Request validation
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#response-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
scheduleId | Minimum length | 1 |
tenantId | Minimum length | 1 |
projectId | Minimum length | 1 |
onBehalfOf | Minimum length | 1 |
scheduledTime | Required value | true |
Where used
Section ID: DOC-API-MODEL-schema-s6i1d2bv7o#where-used
| Reference | Relationship |
|---|---|
| ScheduledTriggerEnvelope | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-s6i1d2bv7o