Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "targetId": "<string>",
  "assignees": [
    "<unknown>"
  ],
  "recurrence": {
    "interval": 123,
    "cron": "<string>",
    "dueOffsetDays": 123,
    "expiryOffsetDays": 123
  },
  "originatorEmail": "<string>",
  "active": true,
  "nextRunAt": "<string>",
  "createdAssignmentIds": [
    "<string>"
  ],
  "targetVersion": "<string>",
  "assigneeStrategy": "<string>",
  "defaultMaxAttempts": 123,
  "defaultAllowDelegation": true,
  "defaultAllowRejection": true,
  "defaultReminderPolicy": {
    "offsetDaysBeforeDue": [
      123
    ]
  },
  "originatorName": "<string>",
  "originatorMessage": "<string>",
  "lastRunAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "_ts": 123,
  "_etag": "<string>"
}

Assignments

Get a schedule

Returns a single recurring schedule. Caller must be the creator or admin.

Authorization model — partition-key trust. Non-admin callers issue a Cosmos point-read with their own UPN as the partition key. If the schedule belongs to another user the point-read misses and the route returns 404 Not Found — there is no separate 403 path for “exists but you can’t see it”. This is intentional (it avoids the existence oracle pattern) but means clients cannot distinguish “schedule was deleted” from “schedule belongs to someone else”. Admin callers fall through to a cross-partition findScheduleById lookup.

GET

assignments

schedules

{id}

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "targetId": "<string>",
  "assignees": [
    "<unknown>"
  ],
  "recurrence": {
    "interval": 123,
    "cron": "<string>",
    "dueOffsetDays": 123,
    "expiryOffsetDays": 123
  },
  "originatorEmail": "<string>",
  "active": true,
  "nextRunAt": "<string>",
  "createdAssignmentIds": [
    "<string>"
  ],
  "targetVersion": "<string>",
  "assigneeStrategy": "<string>",
  "defaultMaxAttempts": 123,
  "defaultAllowDelegation": true,
  "defaultAllowRejection": true,
  "defaultReminderPolicy": {
    "offsetDaysBeforeDue": [
      123
    ]
  },
  "originatorName": "<string>",
  "originatorMessage": "<string>",
  "lastRunAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "_ts": 123,
  "_etag": "<string>"
}

Authorizations

Authorization

string

header

required

Azure AD access token obtained via MSAL

Path Parameters

string

required

Response

Schedule record

string

required

targetType

enum<string>

required

Available options:

chat,

document,

survey

targetId

string

required

assignees

any[]

required

recurrence

object

required

Show child attributes

originatorEmail

string

required

active

boolean

required

nextRunAt

string

required

createdAssignmentIds

string[]

required

targetVersion

string

assigneeStrategy

string

defaultCompletionCriteria

enum<string>

Available options:

chat_visited,

chat_engaged,

flow_started,

flow_completed,

flow_passed,

manual

defaultMaxAttempts

integer

defaultAllowDelegation

boolean

defaultAllowRejection

boolean

defaultReminderPolicy

object

Show child attributes

originatorName

string

originatorMessage

string

lastRunAt

string

createdAt

string

updatedAt

string

createdBy

string

updatedBy

string

_ts

number

_etag

string

Create a recurring assignment schedule Delete a schedule

⌘I