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

154 lines
58 KiB
Plaintext
Raw Blame History

---
id: create-scheduled-search
sidebar_label: Create a new scheduled search
hide_title: true
hide_table_of_contents: true
api: eJztXetz2zYS/1cwvA9NMqaslx/ylxvFdlr1HNu15cu0tucEkZCEhgJVPuyoHv/vt7sAXxJlKU7SJC3bSWKSwGKx2P3tAyD9YEV8HFoH19alMxFu7AmXXQoeOBPrdstyRegEchZJX1kH1mEgeCRCxpkS9yxM24fUvnajrC3Ln4mAY/ueCz0c6pFSNoS3rED8EYsweu27c+vgYWGY/kQsEWeRz4ByKMOoBv0dX0VCRdiXz2aedGjI7d9DJPBgYe8pp6eedzaC2T1Y0XwmgLg//F04EZCYBchqJEWI7RSfinJO8AnzRywq4UpP2VAOo0CqMVyLD3w68/DWEZfenLky5EPsxB3Hj1UUQhsVex7etA6iIBaPC5Iu4yN35+PYKQ61CXuPwE8kI2qzsHanKKfHrXXiDPld0gP1oGw+vaN0Gtg4XecJj9i99Dw2FEx8EE4cCbf2pJR3dtqjxk6jYY/qvGG399ptmw8bbXun09lptN2W2NlzgGejjG6pWqyU1sgPphwUzXKhrx1JmH5+7Ga9sW/Xd+3mTr9ZP2g2D5r7tUa9/Zu1aDtdlhJgUrHe5Zm9v1tvMEM/E/gRNOvjMI9L9kdqAI9LF5/d8xAoy0jC5ObMTLZGxsbdM+XNU12b+q4cye9dEh4PozXiSCZaKoWkB0phUZtXAxKwrBmFR7Ulvdd0FtX9WMVTFohZIEIALZAucezEQQCXsFZhPJv5QYS8J6MgoRDs+UZ1XVciHe6xO+4BarIpn6NxcNeFHiBBJDaKozgQYDjRxI8jpvxIOmIFPAE3iPdH3d7Jr3D97vj4P/TD27PT/k/002H35Pj0qHsBP3ZPT6+6J3D3Nr/YaZ9FmOjjYKRiKpqEH4PAnyw64QFZP8iJ7qR32Wc29XilZfeK8SAA8aH/4FKFzFcA7gEoCggPgBBGcCIjZyJx0T398XgNjejeN10OtCpGPIgYVy4T8MeAXMDVWGzBcjleHMo78WXXFmcOl8R9ceXMk3TdjNSSddNsrPDJ1Bb4SuWTcUAigUsZiWluORPOHnMsXKOikd4dWbfwQIIrD4AkueEFzHmCiaQb4gbTy5SoQJE1bDgWgZVDMLjVaubRq4UuD4MSGSAsXuu+qThulwVGTnCZPa33GK0Y36U1Qrtn1p9IVDnQW4paBDVMbD6kFYbgCsdGtRkktjfQ80m5TaVrFjNZtGurBVe78KcDfxpNEu9CpIG3XD6vTLMyzX+YaaLWrzBMXPAeGBySHjCw0YF2cIMtamUUIIlKByAkeDLoXx3jPyAsuvrpCv95c9HDfy67ffgHFW1weXU6KBnBeNsB6nhm6aUDQr4VT4ciQK1z/RgWgf0R+5CJbTFPvgeGbqzGjYXDwg91+gmJ3ljNfbioMXY206rszXP0scEJPGcOVzhKHMLSgXwCMYKh4IcoC7Lmia0Qvm0MR5k2bVkgmFV4BLYTVIBUAdI/DJBI7VMma6UmpVclb1Pk2vdxmEwYwNItiW0mdfFlWarfVD6H96biNzCoVdUBwCRfSQeWrP8bky7aMyRyQSHV0/gYxAqHfSE+1Fh3KgLotH0q7v/3qx+8fwnYB6irAMtgvD/RgAF6w5lwKC3UYOgH4x9C5ooRj72o0BARsVYiudWliISBwwn8PfatFaqiAe92OX2yqL0jZ1JgIWZJNF0AfABkwAktk4hiSCyZhEDTcwH+HAGIUZ4SAzYC/rE7yZmYcunV1tvkGgBelMTyQibBrCYEeIW4TC5GKAeEkuFQ7+j4tN/rL2Sa6V20fnezMbPSUjYQS2eSU3Gn09iv7+/u7TbbztDdqzf2dttNd9+B/xuj3b1Vywd83OIjoahwtrxMPeViSRLWRpZX6lC7TO8C/gx93xNc0axIH62DEffCfNWOrnFwXMHj6SyaX4gQWpZoS4ENas/GQpn6bKIxvgMekt1PhMrUBHwI+CqFsQCRfi6P4CVnHp//EotgfiTAA3rruERhGR5BWJpnwyi5Q1er9h9IkdxmyjMxysD530lxz17cgwVOwO/me573ei+fN5UFPSiWN3OlpIL1FjwBts2s/DZzciQRXYk15fESq88XR038CgrE4RbGZnCTsw7rvk0cRUkJ1uo4u826aLRsx2217PZ+vW3zRsu12/UWqP7QcYe8MJXM0pJCURqmrQr3Otos8gCWhXKpIWs73sD4iNg7Id4/UzT30JWhopOH1fE/qgxCfPhlRJXWxZIU++nIGDKIND6G/MFEyVsWZA/499WpVQiP/0q5v8VA/5mCpyThL5Z8VrxcJ/oGXO1hENWGv06+noS7SsUQ3zxHwHN4gvKNaF9oJBVgpa48bZGwtzJp176MuNOycL7Uu1riC9Hq97NIh9yDxAyk/ZHLhMqvw0wHYllDgyb9RZYjV7BfJ9lmvdmy6w27iUmNvmjixVcS8WPRt5q9GXDnM1+F2jlCJlKeJJgN4dy+SboTan3EHvFiqLtpFUKuyF2Wgr3e0dMbmHVXtHfrO217JDp1u91qc3u43xa2sztstXY6bt3ZbVslO1j+PQRK5TzQo1X7xEu0tqpwf124b6S9wW724upTPyrhnEOwGVKhjVoOpDtI6jYDajVI5CYVqDV3VxRuNp/R8kK7WB9z9D44qdHj+t386nBEdTjiWyshVYcjqsMR1eGIasOj2vD4fjY8qsMRlWlWpvlNmmZ1OKI6HFEBUgVI3wwgVYcjqsMR1eGI77VaWh2OqA5HPP9wRJGeRCJ6qyMrwpfAQ/J2od5Satfry9I89HBwdhwE4OpsdkFriS4wMQh6K5ENfXeOSigVOBDpftJmUhEaXFrnQ9/dACDeSCXsccBpd1cQyw50hFX076SLSKGDLSKZ2DS1K3hLlEStwV5zF+ar53doJoOuJuDOe6DV2wA9rpSE/izpAihLIcOKYcWe4MPdeqfZHu22OW/utxt7O8POiLda9c5Op0OFMBGGfJxHzRRri0P/iFovHeb54PXknwKxnIPsiQEafHN4JhobArRum07T8Msi8SGCBIa9Pjxn7T3IA9Q4pvt8vCAEZV9dlu1oaMJngRzL0ngkrUMev+lenVAIevzL1TGGnEhrqebbRT9PUOHTtt/Ev9cpip4A1nvTWIq9MlRfwYQ4xt1ZQ6mvwnkIwkz8PvQwo5f0yJNmo8CfFkyJ7OZDxF7ImqhtgYeDexD4APoMOaZU5hDDq67jiFlknxhJvmITwV0RQIzyKaF9cb8pFeVSyGKQ5CS/KGgcwPl6Pek6EZ7joGnmrTDVFsOiWR/gWUuuyF0/JzQS6RySIifCKA83LHzI0zBCgLlJQHIDRxSwAfCopF2KWPldKoK7t5qZo0jHXQ6Pww3s7twD+LFpaumDO2GMjwoGGo1oNZJlMohkkmTqbFqly5UYPoNI03Mr261st7LdDW138eGFOSpjnlLoU3Je5krxGOQbkPNcCn0C0h6IaZNGOgrWC0kFMxMi/fyuD4b9HuJhDNIxpRafMz7Srrwks0vWQ98fJvWrxPVna4EMkhz1DEaARMI9IL4zjklQWlSt5dHe+MFQgoKqkhARUDNgcz9mHEQG2bVCTjgeu/NFqH6I2ASiXzwsAPxqBKRkxrVnvlQf9+mKKpKsIsnKG1Xe6Jv2RlUkWdluZbvfp+0+GUkW308ycVIYT6c8mGtNM89xtpxBA5Yc2s6qyelJ93y0gsRYGmNZxcjBGjYbw8ZozxFtl7fd3VZn1HR2m3xnr7HXGLabeKQ18/XXmR2nRla0qdx663U0e1/BHcRxsQLlCiPfd4vlPxBvIEYIawg9adwMMq8lZ9Ypdmwvx46nfgRzA8IQOwYryotXFye69q7Jo9z8OHBo/9TsBNCuBYaUqMMgaRlGVehYhY6V+6ncz9/G/VShY2W7le1+n7b7UaFje13o2P6I0LHNMMQaYYj1NUNHF+IODM1GsCgwB3OOLjtgZ6qPxuwjHoxFlAZ6hSiy2Sk55OP77C1X8yRYCguVSJWJC+EN2k6xbZC0hQacjQEiFb4hKX19dA5PIEFMiq+EeHIqyY5xQkA3mNvdUQSz0jaT6Fs6ijkiEBIoeD7WXn3QMYknVkYY/gEFqoOOAag/Y43TrNYn1YPZBc74BGfMjj84QqDNp/XfnbJTAj08Oqbo1Wxa6xXHBXTNnCtII8SHmYavNAStQvUqVK/cfeXu/x7uvgrVK9utbPf7tN2PCNVNNLQ6VIcGG4fq0LZWZ2ks9YZOkP7VETuZiuFAH2GnE710aCGJwSmuAFVChmY+FVpnPJrA1XZ6MtnWJ2np40U6A9AMxYEH7SZRNAsPtrcfYJ1gfR5rfCZr5gz6XPn3Ncefbt+1SlAHD5lqCwPccmOHsobuec+kGfrjPYFEBdZoRwNoWZszuVYIMqfTBU/ST77UMIcMhGkyW3j+3CgT3QY2Z5BJ/BBS65qlvw2xMEeY21XgPa6bz39bT81DE1kxjzLxPTkWtGfA5cL0kP1bXC5YcCBE63UF/BxqmOrGuMbXt/k2eJR4qjlcapm5GtwQaC4xdIbNmuw1KAq9IYZnZF78/K7/MndkOw4xDhYSswcwp3NQIwK7bnJeBDuR/wn8eDyhyXULJ3LQuNjIA6GwG3UpBLvuGUGdghe4ANgmsWMnQUiBvW5fJKvnijvhoYOsZdJG5ZSu2gYpbvNCv5fkDClryL/Yf6NsdiQRoyQ6dWyTnJzHJJBdz5J58dy8nsvEvxJqtqZmE7Xw5QIXWrTXjj7h7YCFIwnuhSStZw+u6dk5ephiwR2kusgDSsLwUTxH5SSr9mw+CvRspFfk40a9ozP9xW5MA1vykkCPORPfD8W/GUPVQVO5Hsdgac9mi14ksMki7GY9x5Kth7SlDXEj8XcChqG0MvEh+m0KW3xdQSGzHdDKAi4M9LuhhTnT7Wtwr9jS9Z3w2TzjgDYOaGucCA3/2nuhYoFt4xwIB7QCHGbrT0hgGM3hoqZVivxEfpv6oPtwgFX9HZjZgb44yEAwedOKHmDrtA3ANIbd6ckyuGaGFrqwgrCSgsGiBJf59XzwnAty0/ym257oTb+1+dL387K6Cn665HOj9Aok+XZw9yshXoU0f0ekMYEw1icvst/Ndpy9cqu/AfbER7uKdra63eJHDzf6QNXTH1td/wXKkk9/bPaF1uLr+YvfR9z0BeTi28dPvT2cf/V3+YXZz/jlxdwLmslbfcvvTJonpW8qJq8xIkKRSEySmcdFnQQsF4b1B/Dgb3hK4E7CghRYf+UFw948GRg8QhgkN+BMpKCS0kzwCGewhVDkTwm6IYtCf5F8LmZM3/kKQMe5x4fSA3o19g5ydgXqGGC+jke5gervvkncL2Fy52jX7CixdYi5p9NYQV+E5XiKn1teBwggMSfWfgvSdyWSmfkU+ae9EhBHpEFR0DvHIpiGZyPce5COyNn9mrHA7EOz8QCCzJtsOpEL4ZEKYrtiVreONoCNPRHeDFUQnC7E33lQeNvrL1EEYsrsdvnBeNt0CrexLX4eAT/dScrQqtVrdbyFufeUqxxd/fsmV/y6yUWtesj2XDb6RZXGdDDB255h2RJ5iHVSqvP/a6sk/79FFAgjfPrwgHUtTIYf8Ta9dosZZZbrUn4JHai+RQb7XmBdxWyo2P3cxxEw2FncKcL0W/fQNbMn297m6hjnZ4RmQ/P7Nae6JBPwe7iJfx9YN/C/hb+uUysENKL7D1ZS4IQ2mi7+939QocXY
sidebar_class_name: "post 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 'Create a new scheduled search' (create-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"}>Create a new scheduled search</h1>
<MethodEndpoint method={"post"} path={"/scheduled-searches"}></MethodEndpoint>
Creates a new scheduled search.
## Request
<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={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={"201"} value={"201"}><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