Update SOD Policy schedule

PUT 
/sod-policies/:id/schedule

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

This updates schedule for a specified SOD policy. Requires role of ORG_ADMIN.

Request

Path Parameters

id stringrequired
The ID of the SOD policy to update its schedule.
Example: ef38f94347e94562b5bb8424a56397d8

application/json

Body

required

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 ScheduleTyperequired

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 SelectorTyperequired

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 SelectorTyperequired

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

The hours selected.

type SelectorTyperequired

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

The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000'

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

Responses

200

SOD policy by ID.

application/json

Schema

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 ScheduleTyperequired

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 SelectorTyperequired

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 SelectorTyperequired

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

The hours selected.

type SelectorTyperequired

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

The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000'

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

Example (from schema)

{
  "name": "SCH-1584312283015",
  "created": "2020-01-01T00:00:00.000000Z",
  "modified": "2020-01-01T00:00:00.000000Z",
  "description": "Schedule for policy xyz",
  "schedule": {
    "type": "WEEKLY",
    "months": {
      "type": "LIST",
      "values": [
        "3",
        "6",
        "9",
        "12"
      ]
    },
    "days": {
      "type": "LIST",
      "values": [
        "MON",
        "WED",
        "FRI"
      ]
    },
    "hours": {
      "type": "RANGE",
      "values": [
        "9",
        "18"
      ],
      "interval": 3
    },
    "expiration": "2018-06-25T20:22:28.104Z",
    "timeZoneId": "America/Chicago"
  },
  "recipients": [
    {
      "type": "IDENTITY",
      "id": "2c7180a46faadee4016fb4e018c20642",
      "name": "Michael Michaels"
    }
  ],
  "emailEmptyResults": false,
  "creatorId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
  "modifierId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...