LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/update-scheduled-search.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

158 lines
59 KiB
Plaintext
Raw Blame History

---
id: update-scheduled-search
sidebar_label: Update an existing Scheduled Search
hide_title: true
hide_table_of_contents: true
api: eJztXetT4zgS/1dUvg87M4VDXoTHl6sMMLvZY4CFcFO7QB2KrSTacSyvH0CW4n+/7pb8ShwCzN7tzK5nCohtqdVqdf+61ZKcByvmk8jau7TOnalwE0+47Fzw0Jla1xuWKyInlEEslW/tWReBy2MRMe4zcS+jWPoTFmW1IqrVuPKtDUsFIuRYa+BCvYTqZfQN+Q0r4CGfiViE2P6DJbGNgMf4yIcHcCVda5GJwQFTYxZPBQvFb4mIYmjaVU4yE37cgNLI0Ixbew9WPA+QRhSHwKj1uGFhBRkKYCkOE7FhiXs+Czws03Z2WzvNna3ejrPV3nV6zRZ8cnhvvNt0Wp1Wx3q81tWhvffKnSP5MltDYGhRFixWDAQRgaiQM0f5MTCJdXkQeNIhCW3+GiGBh2XG1ehX4cRQkXveyZhEtPgkCFHSsRQR1gNpPY+vwQHyU5ZPURxNV3R7za2uPRa7Tbvb6XJ7tNMVttMbdTpbu27T6XUtFAh3T3xvruUJAlZ3vgireaBH6cgtMrREa2NNT/XTxSFeVBVsF0tgs5oQGwlU2lCMRSh8R6B6CT+Zof4PDg6Ph4Phz6j3uSiyu9A9Ld/1bRZVNG2IZT1Z0rredq/ddUbudrO13eu23R0H/rfGvW3rsaS0l7pp4uM6lfZgxZjnPCyNPtUDO73yTz3BI8ES+MGSN9K9YdLXn6nUTSo36YOhcVdb92rFWduj5YF2RRAKMIXULB+h0+sUXaNDVbfxyaqOr2P+gEtvzlwZ8RFW4o6jEj+OEI0Sz8ObmaKXGq7io3DnZeyUm3oOe6gksYypzALGHqOc1osz4rdpjWeoExbOAG7KY3YnPQ8MC3yCcBIYx6exZWurO25ttVr2uMlbdne727X5qNW1t3Z3t1pdtyO2th00NgcUhZTiYRn/VkprrMIZB4S10OHYsZyJsno2Wzt2s2e3t4bt5l67vdfeabSa3V+WrLjPMgJoEIPzE3sHnAIz9HOBH0CxITbzuOQtSQ3gcbUR3vEIKMtYQufmzHS2UQWqM+XKsfzWJeHxKF4jjrSjlVJIa1T5x9UeD1jWjMKjxkovUq5/CP4AgBtQKQJvje4COXaSEIA8hrGKkiBQIYYdWStIKCJE7buuRDrcY7fcg3CBzfgcjYO7LtQw4DpO4iQUYDjxVCUx81UsHbECnox3OugPjn6G60+Hh/+iDx9Pjoc/0Kf9/tHh8UH/DD72j48v+kdHCz4sq7MIE0NsjFTMj6dRpYKtccCvFp3wgKwKC6I7GpwPmU013mnZvWM8DEF8GDhx8EBM+QDuISgKCM+lABRcky5LJM76x98frqER3ylTZU+rYszDGEJalwn4Sf029ydiA4bL8ZJI3or/7dhiz+GSuC+PnHmSjZuRWjpumo0VQR+VBb4y+eQckEgwkIjFLKoMlTMWLlHRSO8OKOiQEMOGQJLc8ALmPMFEWg1xg+lhSlWgzBoWnEAQWUAwuNVpF9GrsyIuMuK4XhYYOcFl9rTeY5hufJfWCO2e2XAqUeVAbylcF1QwtfmIRpjxLMC8SW3vRvcn4zaTrhnMdNAurQ5c9eBnF35abRLvQqSBt1w+r02zNs2/mWmi1q8wTBzwARgckob5SsRutIO72aBSRgHSqPQGhARPboYXh/gHhEVXP1zgnw9nA/xz3h/CH1S0m/OL45uKFoy3vUEdzy29skHOQHdGMNkFrXNVAoPAfktULKIN5snPwNCV1bqysFn40KRPSPTKau/ARYOxk0Crsjcv0McCR/CcOdzHVmDO5qJ8aIaJH+I8yJqntkL49mw4yrVpwwLBrMIjsJ2wBqQakP5mgERqnzHZqDQpPSpFmyLXvoPN5MIAlq5JbIHUSdKqrNJXNJ/DezPxCxjUquwAYJLypQNDNvyFSRftGSZyYWmqp/ExTHxs9o24b7D+TIRQafNY3P3nZxV+fgvYB6jrA5ZBe7+jAQP0RoFwaFqowVCFk+8i5ooxT7y4VBARsVEhudWpiJSB/Sn8nqhV6TYNeNfL0yedU3ZkIAUmYpZE0wfAB0AGnNAyiSmGxJRJBDQ9F+DPEYAY1VNiwEbAP3YrORMzLr3Gepuss6WrsqVobz4lzpaHaeC7mIuHsZErMqagXaZ2CX9GSnmC+9Qr0kdrb8y9qJi1o2tsHEfwcBbE8zMRQckKbSmxQeXZRPhmHSXVGOWAh2R3U+HnagI+BHyVj7EAkX4tj+AlA4/Pf0pEOD8Q4AG9dVyisAyPICzNs2GU3KGrVfs3pEhuM+OZGGXg/G+luGNv7sACp+B3izVPB4O3r+vKgh6U05uFVFLJekueAMvmVn5dpkeLUnqpI0/CV8BDutD1WGbIJLRABoHyI22h7WazGlnN8lEh2ZSlj+sVpXpFqV5RqleU6hWlekWpXlGqV5TqFaU6S1RnieoVpXpFqTbN2jTrFaV6RakGpBqQvmJAqleU6hWlekXpW82W1itK9YrSn7iiBBx1qxaN9j1snB2GIbg6m53RWKILLJ2ZYiPlzlEJpQ8ORLpftJhUhgaXxnlfuc8AiA/SF/YkhMgIB5tYdqAijKK6lS4ihQ62iGRq01Su5C1REo0We89d6K/u377pDLqakDufgdbgGehx4Uuoz9IqgLIUMqxoVmwLPuo1d9vdca/LeXun29reGu2OeafT3N3a3aVEmIgiPimiZoa15aa/R62XDvMUeD35u0As5yB7YoAafz48E41nArQum3XT8MticR/DBIa93z9l3W2YB/iThO7zyYIQfPvivGpFQxM+CeVEVsYjWR7y8EP/4ohC0MOfLg4x5ERaSznfPvp5ggpFy35TdaenKLoDmO/NYin2zlB9Bx3iGHfnBaW+iuYRCDP1+1DDtF5Ro0iajUM1K5kS2c19zN7IhmhsgIeDexD4APqMOE6plI7M3/UdRwSxfWQk+Y5NBXdFCDHKl4T25fWmTJRLIYtBkqPioKBxAOfr9aTvxAkwR90sWmGmLYZFMz7As5ZcmbthQWgk0jlMipwYozxcsFAwT8MIAfomAckNHFHABsDjp+UyxCquUhHcfdTMHMQ67nJ4Ej3D7k49gB+bupY9uBXG+ChhoNGIRiMdJoNIZpJMlU2pbLhSw2cQaXpubbu17da2+0zbXXx4ZrbKmKcU+rSWQ58Lnycg35Cc51LoE5L2QEybFtJRsB5ISpiZEOnHT0Mw7M8QD2OQjlNq8UfGR9qVV8zs0vHQ90dp/ip1/flYIIMkR92DMSCRcPeI75xjEpQWVWe5tQ8qHElQUL8iRATUDNlcJYyDyGB27SMnPNpgrhKR/13MphD94mYB4FcjIE1mXDtQ0v+yg+51JFlHkrU3qr3RV+WN6kiytt3adr9N230yksy4ImsxcVKUzGY8nGtNM8+xt5xBAZZu2s6zyTRUi9EKEmNZjGWVIwdr1G6NWuNtR3Rd3nV7nd1x2+m1+dZ2a7s16rZxS2vu6y9zO86MrGxThfHW42jWvsJbiOMSH5QripVyy+k/EG8oxghrCD1Z3AwyB5Fe57Fjdzl2PFYx9A0IQ+wYrkgvXpwd6dy7Jo9yU0no0PqpWQmgVQsMKVGH9fuk6tCxDh1r91O7n7+M+6lDx9p2a9v9Nm33RaFjd13o2H1B6NhlGGKNMcT6M0NHF+IODM3GMCjQB7OPLt9gZ7KPxuxjHk5EnAV6pSiyvVuxyUcp9pH78zRYikqZSD8XF8IblJ1h2TAtCwU4mwBE+nhCUiq9dQ53IEFMikdCPDmTZMfYIaAbzu3+OIZeaZtJ9S1rxWwRiAgUPIW5VwU6JnHHyhjDP6BAedAJAPUfmOM0o/VF+WB2hj0+wh6zw3tHCLT5LP+7VbVLYIBbxxAuzvVYr9guoHPm3IdphLgPNHxlIWgdqteheu3ua3f/13D3dahe225tu9+m7b4gVDfR0OpQHQo8O1SHso0my2KpD7SD9P8dsZOpGA70Fnba0UubFtIYnOIKUCVkKEgIQ/A1+3vWZrYx2dYbaUW0+SDdRyihZwGaqST0oPA0joNob3PzAcYKxuixwQPZMPvQ5766azhqtnnbqUAe3GiqrQywy00cmjn0TwdmqtEgCYcSlVgjHjWg5W325VoRyJ12GDxJP31bwxxmIUyT2cA96Eah6DawGcBs4ruISjcs/X6IhT5C3y5C73Fdf/7deaofmsiKflSJ78m2oDwDLhe6h+xf43DBoAMhGq8L4GdfQ1U/wYG+vC6Wwe3EM83hUsnc3eCiQHuJoRMs1mbvQVvolBjuk3nz46fh28K27STCWFhInEGASZ2CGhHg9dM9I1iJfFCoksmUOtcv7cpBA2NjD4TCrvxzIdjlwAjqGDzBGUA3iR0rCUILrHX9Jh09V9wKD51kI5c2Kqd0/U2Q4iYv1XtLDpFmDsXD/Ve+zQ4k4pREx45l0t3zOBFkl0HaL17o12uZ+EdKzdbUbKIWvV3gQov20tG7vB2wciTBvYik9erGNT27QA+nWXAHqS7ygJIwfJT3UjnpqL2ajxI9G+mV+bjyP9G+/nI1psEtPSgwYM5UqUj8kzFUHTSVy0kClvZqtugwgU0WYbebBZZs3aQtbYgdib8jMAxfKxMfoe+m0EXpLAqZ7Q2NLODCjT4fWuoz3b4EF4slXeVEr+YZG7SxQVvjRGT41x4MFQtsG/tAOKAVYD8ff0ICw2gBFzWtSuQn8ptUB92HA6zqd8EEe/piLwfB9LQVPcDSWRmAaQy9s91lcM0MLXRjJWGlSYNFCS7z6ynwngty0/xmS5/oUb+2/mKP+3luBV9f8kej9Aok+Xpw909CvBpp/opIY4JhzFGe5d/mdJgfuzXfO7X6xV1lO1tdbuENWM97SVXlS4myd+3k79R5wes/0nd9vOSIfnYe/4WHkMsnkJ86QVw8/rt8aLZ8BjZ/G0B2FlQfBX3G+c3rwiHN9GTf8rlJ86TytGJ6lBERikRiJppFXNSTgOXksH4JHvyGpwTuJCyYBus3vWDYWyQDjccIg+QGnKkUlFYKBI+xBxsIRWpG0A2zKPQX6StjJvSurxB0nHt8JD2g12CfYN7ugzqGOGfH7dxA9VdlJu/n0LlTtGt2kNo6xNyzWeJDXYTlZMY4IMoaQACJOYn2WzCF90XaM0WRf1YrBXFEGhQFnTsW4Sw6GeP6g3REwe7XtAVmH5nFBxBk0WSzjpwJj1QQy5VndetoA9jYU+EFqILgdCH+LoLCx8FwiSIQ882Klwonm6ZStIll8RUJ+PpOUoZOo9lo4q1ARfGM+wW6+mv1St+qt/RdfEsvCMxWX17wrXzGjHCytxlgGhP5SfQEVScELq3lhABU3JN0HHUKrGOZhwfMduH0+BFv02FcnGPms1+y2hQWcwNb1YU3Z+Yw7Fu27uv9KvuQJmz9eZ6rseDjZ4EpHmBev2aEcnDEmn5gFn3sYeEFDkhmcTUL0wO6hs7rPVn2upBrOb1AjRmZLwyc6axRyO/gJv7es67gv4Vfl6j1FQrR/QcrzcFCGU0W//0X/7UdNw==
sidebar_class_name: "put api-method"
info_path: docs/api/v3/identitynow-v-3-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 'Update an existing Scheduled Search' (update-scheduled-search)"
---
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 TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Update an existing Scheduled Search</h1>
<MethodEndpoint method={"put"} path={"/scheduled-searches/{id}"}></MethodEndpoint>
Updates an existing scheduled search.
## 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","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
The scheduled search to persist.
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owner of the scheduled search
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the scheduled search.\n","type":"string","example":"Daily disabled accounts","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The description of the scheduled search.\n","type":"string","nullable":true,"example":"Daily disabled accounts"}}></SchemaItem><SchemaItem collapsible={false} name={"savedSearchId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The ID of the saved search that will be executed.","type":"string","example":"554f1511-f0a1-4744-ab14-599514d3e57c"}}></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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</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={{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format","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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
A list of identities that should receive the scheduled search report via email.
</div><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={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the scheduled search is enabled.\n","type":"boolean","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"emailEmptyResults"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if email generation should occur when search returns no results.\n","type":"boolean","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"displayQueryDetails"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the generated email should include the query and search results preview (which could include PII).\n","type":"boolean","default":false,"example":false}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
The persisted scheduled search.
</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The scheduled search ID.","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64","readOnly":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owner of the scheduled search
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"ownerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The ID of the scheduled search owner.\n\nPlease use the `id` in the `owner` object instead.\n","type":"string","example":"2c9180867624cbd7017642d8c8c81f67","readOnly":true,"deprecated":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the scheduled search.\n","type":"string","example":"Daily disabled accounts","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The description of the scheduled search.\n","type":"string","nullable":true,"example":"Daily disabled accounts"}}></SchemaItem><SchemaItem collapsible={false} name={"savedSearchId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The ID of the saved search that will be executed.","type":"string","example":"554f1511-f0a1-4744-ab14-599514d3e57c"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"The date the scheduled search was initially created.","readOnly":true,"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","title":"DateTime"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"The last date the scheduled search was modified.","readOnly":true,"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","title":"DateTime"}}></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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</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={{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format","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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
A list of identities that should receive the scheduled search report via email.
</div><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={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the scheduled search is enabled.\n","type":"boolean","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"emailEmptyResults"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if email generation should occur when search returns no results.\n","type":"boolean","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"displayQueryDetails"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the generated email should include the query and search results preview (which could include PII).\n","type":"boolean","default":false,"example":false}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180867624cbd7017642d8c8c81f67\"\n },\n \"name\": \"Daily disabled accounts\",\n \"description\": \"Daily disabled accounts\",\n \"savedSearchId\": \"554f1511-f0a1-4744-ab14-599514d3e57c\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\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\": \"2c9180867624cbd7017642d8c8c81f67\"\n }\n ],\n \"enabled\": false,\n \"emailEmptyResults\": false,\n \"displayQueryDetails\": false\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"}><p> An example of a 403 response object</p><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={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</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={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\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"}><p> An example of a 500 response object</p><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