LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-11 04:19:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-sod-policy-schedule.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

110 lines
38 KiB
Plaintext
Raw Blame History

---
id: get-sod-policy-schedule
sidebar_label: Get SOD policy schedule
hide_title: true
hide_table_of_contents: true
api: eJztXOtT20gS/1emdB/yOGRs2bz85coBkniPQA5MpTZALWNpbM9GntHOSCFeiv/9unskWbJNYEn2bh9OJbElzfT089fdI8m3nk6E4anUqh95XW8s0jMdvdexDGdn4UREWSy8DS/lY+t1L7yzkwPmLnpXG14kEiNCngqYmZpMbHhWhJmR6QzG3nrnVph9rVLxJe1l6QTny0h1rY78hGh0jeCRd3VHpGxoZIJ8ABeDibRMqCjRUqUMeLKMM5uIUI6kiBhy4Sg8s8zmXDYu1an4JZNGWJZOBDM6FkyP2Mnpm596B+/6xw2QI+GGT0UqjCUOJS6WcOBtw1NwAY5kBN+R5pR73VsvnSV41qZGqrF3t+EZt0Yp8SLjgvUPcFlkQQ9/FmHKjBgJI1QoWKrhAEiJzwK5EV/4NImRvhi1d0d7nXZnR+x1traD4dZwuNsJOnxru723E+16qCOQLNHKCouMBc0mftSXnysGuMAVQlS/SnEkTxK4QJbe/Nni8NtlOR3HqCiDfpFKt5jTzaI2FoWfO0dpFEYzq5Ke7b/1W1u7nXYrCHbbzdYWKjUERyAvWl5ipM2UgwBeBCP8VBK5ZaXjBXYzEQoUD75TUUTJCpzO16nrPmgGTb/Zgr+DZrNLfxtN+vMReZvqiLzud2euWOg3cVdb7CkGqo6o2akYADIW3H6Z/YprFnNX+c2y8HMRlVMXXGoseZijs+jPhyqbQsQAyljwYhCJwgogBsIpjUGKLEm0AYvOV0FCFrDgUvWiSCIdHrPPPM4AFqZ8xoaC8SiCGVIRsVGWZgasI9OJzlKmdCpDxBIEvQVlCuAGQeyg1z/6EY4/HB7+m768OzkevKVv+72jw+OD3il87R0fn/eO4OxVVa3lnFSmNT0PcDFyN5VOSCU8jk9GBFNfD85vVp2IgSxYea66o/7ZgPk046XT3UvGjQH1IaBwqSzTCvDNgNOC8iJpYQVAOjeWSJz2jt8cPkAjvdH5lC6Nsyk3KeMqQuwvQNRwNRYbYK4wzqz8LH5f26LkcEjc1y2XXyntlmutsJtjY9kOFAI0Fvgq9TPngFQChzIVU7sy45QsXKCjkd8dQNKEKYDtBkgSQmdxzIc46r60VDJRTKPIdmYqXKDOGg4cC1PFOTjVDqo40b6r5cQLN7dUx9WywkCkVTpyfo8ZUnyBIiIVziMEN+Gkwagg0Ar8ltKYoIFFzFuyMFQIuDa6zXURe9dOnpLbUru5MQujXXhtONqGf3vwrxWQeusqvcNTEZ+tQ3Mdmn+z0ESvvycw0eB9CDgkfY1FzLVLcNcbNCp3gBsZx+gB16AkuHI9OD/ED1AWHb09x4/Xp338OOsN4AMd7frs/Ph6xQp5tr1GH59H+soFOQPfGQqDXhfpDIzAfsl0KuwGi+UnYOjSa116uCx8adI3JHrpBbtw0GDsJHGuHM8q9HHAEVxnIVe4SmbBdFTaQ52PX3BkzG2KmitihfDt0XA096YNDxRzHx5B7Jg1IK0B6W8GSOT2JZONlSHlrFKNKUrtu7jMXBnA0hWpLZFuE+QeoxTdxXwgw5avwY7gfwj0RFsrh8sDELCeBc32LrZwrb1Bs91tdbrNnX9iA/dshW8t2mZlh1ntDltAetsPtgZBsxsE3WC30Wp2Plac7wAmDnDeHZ6bio8Qjf1otZwAaFrJEOw9+MhkhGAAHalxAVfogMDVZAoj57n40mC9qTAwafNY3Pz0ozafXgBwAmQrTY3vrxj9oIZy+8YhqTbjZxa6zxHP4rQ2EOG0sUIVS2FYaqFgYH8C/4+1d4+fObS8Wu69/MDt7IQykSBzNbTuC7l7Gt5Ka1+Su7/ZfbhbX6TFDgYnhL2NCg71Dw6PB/3BQqdZnsXoX7l78fByYCHnBWmxoVRxvXCntdvkne0R55EQnWZrezTsCHDIMGhud0ilj983WrEyZIokBqRGIvWl38lwwkXM8k9LBi+NqqPTggpdEFMu48Npks5OhQVnq5pxqHUsuFpiqa8i3CuDXCFHTOBcYI0mMyVctocEQpRFVOVtxGMrih0tbfqPUPz7YicznwOarknbHLVao4B3/J1wr+N3hqO2z4Nh5O90gq3d5ki0h5GobFT9tjWLSU9btK72hV3juzu83lm1T7kfkzMfGgPi+uxUQO5VmG7yNA6xi6g61NEMEUEqAGsZfccNzUhAVRHv6+gR7vlaKuGPDVQhwKEglkOYyIDiZxlhteQKGyJZVCI0ru61oIlGi73iETvN5dvPhUE1Gh5+AlqPMd65kjCfFVMgRCk937Os2BF8uN3cCzqj7Q7nwW6ntbM13Bvxdru5t7W3R64jrOVjsQr46ku/EQqhlsUakoT8FRQCPgu6JwZo8a9hZd0GROMR+sfE5MaWYub8Mry1AM0Ce7X/nnV2oOZW44zO8/GCEpR/fraUU0ByR/jEyLFcuYFa7vkdvu6dH1G5d/if80Ms75DW0p2LHqZFwg5gFXxhom9cO+AEuOGVuoW9zKm+BIG4stWB0h3ZmQVlFmkSZuSrr5hRJc1GRk9roRS6+zDsuWyIxgaAF5yDwiKcsCHH9kW7KvhlLwxFkvpHuSZfsokAdDeQ0r+ljK7ZYq7KpQyfY8lR1SgYHMD5w37SC9MMmCMxq1FYekvOYm4f4Nlprs7doKI0UukMGpAwxaIoxnYEeiJoXoYgm4RkkMMR1TcAPKoYVyJWFSIJ7t45Zg5SV6aEPLOPiLv3McCPT6KVFz6LPPioOXdoRNYozJQjUt6Q0uR8VGmuIvAZ5IA4WsfuOnbXsfvI2F28eJrfnc2vUunTWi59zhXPQL+GkudS6WPIe6BzKga5VtIZkjan8hLphw8DCOxPQuF4ajrF96yPXCpfYr5X2sOdHxZ7RUXqn9sCGSQ9OglGVCl3ie85x6Qop6r28mqvtRlKcFC1okQE1DRspjPGQWXQjCrkhNsNFmlh1bOUTTjgI4eIsNYhoHuiwKdHCtaV5LqSXGejdTb662SjdSW5jt117P45Y/erlWTJFUVLXifZbDrlZuY8Lb+O0nIGA1jxnCArQ45MtVitIDFW1lhevXLwhkFr2BrthKIT8U603d4bBeF2wLd2WjutYSfY8aq5/mIex2WQ1WOqYm9nx/w+k/kMdVymwLlsqnVU3/7L6NlJhDWEnrJuBp2DSq/K2jHYW3E3Q2v2jqtZUSHZWg2p5jpCTIOxUxxrirEwgLMx4KJiAFVSuxuM+BSfzwze1onlVFLwohRA18z83igFUVygFE5WrkJ3JIFDQoJYY9WswbEkCClGWPMBBapgx4DO37E6zU30TZU8O0WJj1BidvglFAIDvazct1bt7/bxBhtixJkz8D0bva7b4QocABoCh1ll3bmuz9f1+TrHr3P8XyPHr+vzdeyuY/fPGbu/oT7Pq6H763MY8Oj6fAtf9WBlLfUanet/XqZTqOQcuGd1dEhPBkbzGpzqCnCl/AUyxBB8p6rrbZbvegGabN7K6G7Tzl8qc9W/4yszMYyfpGliu5ubt2AuMNNdgyeyUTyBovRNI9TTzSHoaAX84HMCLtRwAOu97+ftRYMUbCT6sAM8Iu7UTSKht4LaaWv4q5TxURS040xnAHFEZgMfx8n9iU4Diwk0E89s/uAKqmdJPpDr3MR33y6LI3SPLKvU99XVYDwDThdERBGu5u/24QMeU7f60ht+82yC3VqwtNgJDgvYK8ENPSqLNzCe//Bh8IKNsd6keM8slrpCYoMAEfMeXITwrFds5uMkSjFGZ+MJMd6r3S7B+GGjGARml+pMCHbRz5VwDEB/CshMKsVJgsAAZ109L6wTic8ixhzYmGsSHU9GahM0tMlr815QvqPGoPqG06Xy2YFEGJKYt3FMLiL1eewiKeTiFbmeysQ/Cmq+o+YTNftigQun2ovQPX4TQhAjCR5b0taTF3f0/Ao97KLgDFJd5AE1kfNRv8kVFlZ7Mh81ej7Sq/NxqT5MJCTT+jTmsItZyIVxxPosnGhtxb8YQ9fBMLgYZxBFT2brBhf1KSL8oFlhyXdL+tKH0pD4O4LAUM6Z+BBTM1UmGoo2FbmQvCbLQsxfu4fkazLT6QvIoDgy0qF9Ms+4oI8L+g4DbM6/S1DoWBDbKAPhgHOA/bn9CQlyRiu452itRHUiv0lzMDWEwCpRsUnXHXTnAFc8NUoXcHQ5BmAYK+vyth8cs5wWZqmasoo9gUUNLvMba0iOC3pz/JZ7Upgw/2jyosS9+dbJiYpn3xul70GSPw7u/p8Qb400f0WkyWtddDdaNm8Kqk7+Kq/XlrfyLL04Bf/DVYpVKquhaXFvL2IVUyWUxDxFr6aoDif4kwH4io7gKdZ+G+hZekqRCP06hn/xGuSY3nE3wDKHtk3GQI+2qYuVOQWMKyzRrnhsM/dLBbBWOMF3aBrsA/RlKgSzYE+GD1rAtZ913pydgWXe028zHBTGhqJrOs0UPikObGdTxsGlHvCISNowc8AFLZoShS40lX7lrCKK0dVQhAZ1J2ZqT0a4vwyta8XwD6wFdrf55jKont6Gcb/7MBfkVMTkmTiuXrY/RBu8zZ+IOMGuEFAXCjBRWeFdf7BEEYgpC3JB963NeDOfZDdxLL4oBMI792k3Wo2mT+0CnE+0TaGPrRB/I9JVvyuw6Ia382313+9HNvLkgl3BZoLbWchy5roU1xheeNXGEKZ0y5/dIK6v8GUNm+LA21vc+sBm6Q5PQ8uPffXF1bwPov4RTIDfo/wJ/K+I/TwXIHpBN28e/2sdK8Uq9vLUbN7Ge/D1k8DuH6Ry7+nR9gwx6i64DZzKlKVbHNhxlU31m0N0HX5P8s6/gFIAnv4LMJgxAw==
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get SOD policy schedule' (get-sod-policy-schedule)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Get SOD policy schedule</h1>
<MethodEndpoint method={"get"} path={"/sod-policies/{id}/schedule"}></MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This endpoint gets a specified SOD policy's schedule.
Requires the role of ORG_ADMIN.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the object reference to retrieve.","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
SOD policy ID.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SOD Policy schedule name","example":"SCH-1584312283015"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is created.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is modified.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SOD Policy schedule description","example":"Schedule for policy xyz"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>schedule</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The schedule information.
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"ScheduleType"} qualifierMessage={"**Possible values:** [`DAILY`, `WEEKLY`, `MONTHLY`, `CALENDAR`, `ANNUALLY`]"} schema={{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR","ANNUALLY"],"example":"WEEKLY","title":"ScheduleType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>months</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The months to execute the search. This only applies to schedules with a type of `ANNUALLY`.
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"SelectorType"} qualifierMessage={"**Possible values:** [`LIST`, `RANGE`]"} schema={{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST","title":"SelectorType"}}></SchemaItem><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The selected values.\n","type":"array","example":["MON","WED"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"interval"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>days</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
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.
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"SelectorType"} qualifierMessage={"**Possible values:** [`LIST`, `RANGE`]"} schema={{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST","title":"SelectorType"}}></SchemaItem><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The selected values.\n","type":"array","example":["MON","WED"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"interval"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>hours</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The hours selected.
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"SelectorType"} qualifierMessage={"**Possible values:** [`LIST`, `RANGE`]"} schema={{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST","title":"SelectorType"}}></SchemaItem><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The selected values.\n","type":"array","example":["MON","WED"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"interval"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"expiration"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000'","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","title":"DateTime"}}></SchemaItem><SchemaItem collapsible={false} name={"timeZoneId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"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.","nullable":true,"type":"string","example":"America/Chicago"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>recipients</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"SOD policy recipient DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SOD policy recipient's identity ID.","example":"2c7180a46faadee4016fb4e018c20642"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SOD policy recipient's display name.","example":"Michael Michaels"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"emailEmptyResults"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if empty results need to be emailed","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"creatorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></SchemaItem><SchemaItem collapsible={false} name={"modifierId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"name\": \"SCH-1584312283015\",\n \"created\": \"2020-01-01T00:00:00.000000Z\",\n \"modified\": \"2020-01-01T00:00:00.000000Z\",\n \"description\": \"Schedule for policy xyz\",\n \"schedule\": {\n \"type\": \"WEEKLY\",\n \"months\": {\n \"type\": \"LIST\",\n \"values\": [\n \"3\",\n \"6\",\n \"9\",\n \"12\"\n ]\n },\n \"days\": {\n \"type\": \"LIST\",\n \"values\": [\n \"MON\",\n \"WED\",\n \"FRI\"\n ]\n },\n \"hours\": {\n \"type\": \"RANGE\",\n \"values\": [\n \"9\",\n \"18\"\n ],\n \"interval\": 3\n },\n \"expiration\": \"2018-06-25T20:22:28.104Z\",\n \"timeZoneId\": \"America/Chicago\"\n },\n \"recipients\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c7180a46faadee4016fb4e018c20642\",\n \"name\": \"Michael Michaels\"\n }\n ],\n \"emailEmptyResults\": false,\n \"creatorId\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"modifierId\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"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.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"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.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"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.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"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.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
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.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"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.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"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.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink