GET /api/agents/{agentId}/wake-deliveries

Read the next scheduled deadline#

Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.

• Authentication, envelopes and pagination
• Language-neutral client examples

Path parameters#

object; fields below; unknown fields rejected

Validation#

check.object({ agentId: check.identifier })

Referenced definitions:

• object
• identifier

Query parameters#

custom validation: wakeAttachmentQuery ; see function below

Accepted query parameters: runId, sessionId.

Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.

Additional checks#

The following checks apply in addition to the field limits.

Constraint on value:

export function wakeAttachmentQuery(input: unknown) {
    const values = listQuery(['runId', 'sessionId'])(input);
    if (!values.ok)
        return values;
    return wakeAttachment({ runId: values.value.get('runId'), sessionId: values.value.get('sessionId') });
}

Validation#

wake.wakeAttachmentQuery

Referenced definitions:

• wakeAttachmentQuery

Request body#

empty object; unknown fields rejected

Validation#

check.empty

Referenced definitions:

• empty

Response data#

object; fields below; unknown fields rejected ( wakeMetadata )

Validation#

wake.wakeMetadata

Referenced definitions:

• wakeMetadata

Response envelope#

A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.

{
  "data": "<value matching the response-data validator>",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000001"
  }
}