Skip to main content

Get SOD policy schedule

GET 

/sod-policies/:id/schedule

This endpoint gets a specified SOD policy's schedule.

Request

Path Parameters

    id stringrequired

    The ID of the SOD policy schedule to retrieve.

    Example: ef38f943-47e9-4562-b5bb-8424a56397d8

Responses

SOD policy schedule.

Schema

    name string

    SOD Policy schedule name

    created date-time

    The time when this SOD policy schedule is created.

    modified date-time

    The time when this SOD policy schedule is modified.

    description string

    SOD Policy schedule description

    schedule

    object

    The schedule information.

    type ScheduleType (string)required

    Possible values: [DAILY, WEEKLY, MONTHLY, CALENDAR, ANNUALLY]

    Enum representing the currently supported schedule types.

    Additional values may be added in the future without notice.

    months

    object

    The months to execute the search. This only applies to schedules with a type of ANNUALLY.

    type SelectorType (string)required

    Possible values: [LIST, RANGE]

    Enum representing the currently supported selector types.

    LIST - the values array contains one or more distinct values.

    RANGE - the values array contains two values: the start and end of the range, inclusive.

    Additional values may be added in the future without notice.

    values string[]required

    The selected values.

    interval int32nullable

    The selected interval for RANGE selectors.

    days

    object

    The days to execute the search.

    If type is WEEKLY, the values will be MON, TUE, WED, THU, FRI, SAT, and SUN.

    If type is MONTHLY or ANNUALLY, the values will be a number in double quotes, like "1", "10", or "28". Optionally, the value "L" can be used to refer to the last day of the month.

    type SelectorType (string)required

    Possible values: [LIST, RANGE]

    Enum representing the currently supported selector types.

    LIST - the values array contains one or more distinct values.

    RANGE - the values array contains two values: the start and end of the range, inclusive.

    Additional values may be added in the future without notice.

    values string[]required

    The selected values.

    interval int32nullable

    The selected interval for RANGE selectors.

    hours

    object

    required

    The hours selected.

    type SelectorType (string)required

    Possible values: [LIST, RANGE]

    Enum representing the currently supported selector types.

    LIST - the values array contains one or more distinct values.

    RANGE - the values array contains two values: the start and end of the range, inclusive.

    Additional values may be added in the future without notice.

    values string[]required

    The selected values.

    interval int32nullable

    The selected interval for RANGE selectors.

    expiration date-timenullable

    A date-time in ISO-8601 format

    timeZoneId stringnullable

    The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used.

    recipients

    object[]

  • Array [

  • type string

    Possible values: [IDENTITY]

    SOD policy recipient DTO type.

    id string

    SOD policy recipient's identity ID.

    name string

    SOD policy recipient's display name.

  • ]

  • emailEmptyResults boolean

    Indicates if empty results need to be emailed

    creatorId string

    Policy's creator ID

    modifierId string

    Policy's modifier ID

Loading...