Update SOD Policy schedule
PUT/sod-policies/:id/schedule
This updates schedule for a specified SOD policy.
Request
Path Parameters
The ID of the SOD policy to update its schedule.
- application/json
Body
required
Array [
]
SOD Policy schedule name
SOD Policy schedule description
schedule
object
The schedule information.
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.
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.
The selected values.
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.
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.
The selected values.
The selected interval for RANGE selectors.
hours
object
required
The hours selected.
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.
The selected values.
The selected interval for RANGE selectors.
A date-time in ISO-8601 format
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[]
Possible values: [IDENTITY]
SOD policy recipient DTO type.
SOD policy recipient's identity ID.
SOD policy recipient's display name.
Indicates if empty results need to be emailed
Responses
- 200
- 400
- 401
- 403
- 429
- 500
Created or updated SOD policy schedule.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
SOD Policy schedule name
The time when this SOD policy schedule is created.
The time when this SOD policy schedule is modified.
SOD Policy schedule description
schedule
object
The schedule information.
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.
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.
The selected values.
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.
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.
The selected values.
The selected interval for RANGE selectors.
hours
object
required
The hours selected.
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.
The selected values.
The selected interval for RANGE selectors.
A date-time in ISO-8601 format
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[]
Possible values: [IDENTITY]
SOD policy recipient DTO type.
SOD policy recipient's identity ID.
SOD policy recipient's display name.
Indicates if empty results need to be emailed
Policy's creator ID
Policy's modifier ID
{
"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": "0f11f2a47c944bf3a2bd742580fe3bde",
"modifierId": "0f11f2a47c944bf3a2bd742580fe3bde"
}
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "JWT validation failed: JWT is expired"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
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."
}
]
}
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
- Example (from schema)
Schema
A message describing the error
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (from schema)
- 500
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
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."
}
]
}