mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
94 lines
36 KiB
Plaintext
94 lines
36 KiB
Plaintext
---
|
|
id: get-campaign-reports
|
|
sidebar_label: Get Campaign Reports
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1tz2kgW/itd2odJUgabiy/wskUwzjIVGy/gSdU6qUwjtaBnREurlpywLv/3/U63JCTwLd7UzkyKl0SWTp8+9/OdRrp1wkjEPJGhGnpO15mLpM+XEZdzNRZRGCfa2XMSPtdO99rpiziRvnQNOcvptPNpz/GEdmMZ0QNwOROJuxCa8SBgsWXD/DBmnLkVFm7Ggs1W6+vhaf0jNv93KmOwiMMA/4Y+6w/G08+90/PhxR477U3+8XbUG5/usdH4nb3LuPLYeHA5yskguBZuGstkBeFvnSst4n6oEvE16aXJghSSnurm+9asoN1YcM/5dAedIh7zpUhErM16SZpFHCv3HIUH+Et6tAlUXXKne+skq4ju6iSWao4n4it4B3Sr6XYaJwcnh8eNmeu7/slB47jhNluiPWs3mw3fde72nNiqDC8kcSo2TTpdCFiGDJHgqjAWWfXLQrqLws48FmwmIADzjRe8ukPKwJZRqLTQJGjz4ID+q+7Qi2O+og0K5pYlC2e/CTfRdWjkkv1UQot5FAWZH/d/08ThdtsUnHhinUzEUpfuW5YUWjIxBsqDidmoc8rmuHasIFNaC1UQVSPfuGR9tcm3qtpkdMqiEOKu2I0MAxt8mXYwTBokpFwUUy4kUpQk3Xbqt3Jmp9MRIya0hVDpkhTK4nQ8mFy9n5JO61CpPkJcIMi+hxhIq/tCsnXoNToNfnJ00Dj0miftw8NZe9ZsNTltbcP8qc3/kS45pQ/3+CwQjBblcfo8w6+FIvpLS99gv+QrnLu7daRMQs/GyNisP01CSLodAFVn6oQnqX6GHQ0dSc8fk73syslVvz+YTHDnQ298Mbx4h6vBeDwa4//pYIxC1JsOTs0f55ef8yeXg4tToq24Pr95d0cZmytc1nYsfBEL5Ypn6FxKmif1pqdW6yL/cv36vfPL3vDdxef+6PxyNBlOh6OLzzZIQVU8HQ/OB6fDnnk6mfamV5N7iLYeoKYPz4b9bBlIRmdn+eOKaR6XomoqozIiJuA6Gaeql9ynP4XrSAWrvNqikC45KB2PJ6KWSAT+fSV4GWqKXBdFkBGl6TpEjXCXOg/tLxyXqcocWWhRSFHNcZviRY84OnEPmx0XCYkrlx/5nQO30Wq01m2nKJb9cBmFWprILByXx3opMsuh8IQpS0ZDm2h0ao1mrdGZNlrddqfbOq63Tg7/RXrdUU627+sj/UCSdQZxjN5Ug1xJGivhMWlLAtV1ASPOQm/FYDKpbnggvZd0lwcC3xMJl0E/9J4R+GdSido85pIkFEZkFwsZON5Ij7roMkRDtSzzqmboqoULlqg32FsOCJLp18+UodIVc/d38Bo+o5JfKYn1LF/CpGd6/APbimPBZ0cHnWbbP2pzjvrdOD6cdXzeah10Djsd2n0ptObzclMr2nJ163dCiVi6LAhdeOQ/MAiSBLY3ApjNH+vkVR8YHs+wP+WUpS3UzORlBNT2UJHe9i9Z+5gFXM1Tc5/PN4ygalcU5SoNAupANqWpABjGo1jOpboXn2Ul7nRw1rOJOB7882owwRXx2oK1PYVo9SgsISpiYRF+MRJnClDWaxHAHABd7E3G9Q0U4kqXCaX9S680jInY8jk1QvYm2/2eFWXWzI/DZSWVXItq2StZF/U9oD/cQzEDKJxxjQVwIZG/6bmuiJLa+8ySb9gCRVDEr+us53mmivCAIRvBFOtXYMS451HqWgZ+ilSGMDJZhGnCVJhIV1R9sTZl1RvrGv2+7BRKDkj+dJz03CSFcEbNchYW0ZKJmPkHMlvLVaWbloxmTLpSCXehBYAkJpAwRmVHZYJuEkg6K0fkLo3Co3K6omKVYYkpd+dWGINJ8MzlqX5G3l0GKD81o1rx4EZkyYcwCLNqZLyRuymrSHhIapvFGVXhrjzxmS9F4O1yd5e7u9x9Zu5uPhxn03P21ECfxjb0uVI8hX1j0zy3oE9sokeFLCeyI4V15B6DQTKI9POHKRL7d6GIXnyNaAz+jvjItvLt+b/wh70/I/hROKviCxLQ2NFq4KMSCa9r5F5LXEKJre3dzsJ4JhGg6h6IiKoZs1WYmrMM4GhFknC9x7xQaPVTwhYc9ZEjI7S2FZB2VV4tCqVKdkhyhyR33WjXjX6cbrRDkrvc3eXuXzN3H0WShVQmWzKcpNPlkscrG2nZc3s2CwKW/47DipQzrtpEK8SMFRjLqSIHZ9ZszBr+sSvaHm97R62O33SPmvzwuHHcmLWbx06511+v87hIsmpOlfxt/WhMDBB3AxyXKgSXTsLQqx7/pXSO6lNZo9JT4GbYnH6wWmPH9jZ2vAgT6AbGwI7xA8eLV+P3xB9bG/ZktzCNXUEw25oO5DwxkJJiGJaWOtlBxx103LWfXfv5YdrPDjrucneXu3/N3P0m6Nh+Cjq2vwE6thlBLJ8g1h8JHT3gDoJmPpxC746lMK8i2BhBFVxlp49Z2ic8noukAHoVFNnsbKPIaRiyc65WOVjSlZNItTYXlTfQLok2zmlBwNkcJVIxVC0JdEtRRS8CAJPSiwGBXEqTx6QQ+MarWs9PoJXNmTzeil2kcoMUEpqiEIR09hoixiTCSfgE/8DBnIPOUai/4xln5q3/6TyYjUnj96QxG3x1haCcL85/D+97S2AI4WMqFxPr6wdeF7Bn5lxhjBBfI1u+Cgi6g+o7qL5r97t2/2O0+x1U3+XuLnf/mrn7DVA9Q0MPQ3UQPBuqg7Z+wAosdUbB9X9H7CZVMglMeLPQNVjdW2NwgysQStk3JlRD6EuKrrOff22g92+ld7cfF1+d2CHAypTGAWgXSRLp7v7+LVwFF93VeSTrqGDwVrJS4Ze6Gy73b1r3FB56z9QmGUqXl7pmcOhdDrNJo24MHEuKYVvwzAbW3EYlilaY3bxg8Cj//O33FYYQZtns0ev/WTyZ2xAzwjDxkzbUdRM/WzpCt6s4uHtKn19aj+lhmTygx33me3Qv0DNIuaFe9pZz/q3NhFC33X3ri5t1J6Hz/ubWZiMia7K3gscYCewrMK9+/jB9zeaENU2up5pgrpA0HCBbLhEippb18tdBaJFpL3GYzhdG8F7lhRvKHeYHUJh9VBMh2PUwM8IFivwYVdmYlBYJUwho1adXuWc8cSMC6n/1tSUp8KSn9mGhfV5Z99r0OjMUSGVfMsfd+kdVY6eSSpCknk00mYpmxmPXUa4XL+n1UiH+lnOrWW41w02/3pDCmvbatS9wu0hgYsEDbaz14s0tv1qJH01QuENcN2UgS2RyVF+TcnOvvViOCr8a8avK8VF9MF9SVZcxW7eYRh8MPDZk7iIMtfg7YxQ6lAbX8xRZ9GKxzOdbNZMRteZBSaSa3bIma4CFRr73SAxlg4nPqC0bVBLaAxKTkr8azyLnfzVfJvxa0dncvkb3JEovdPWLZaYNa7RhzdYAnclvmxMFFnKbdDB1wAZAf+1/UwkyQUs1z/K6t6ob9vtmDbUGF6LaD3uirv2juy5w2RUzD4i6oEEJJlRdvDhG3ydmvKhDVYyVnwdsWnBb3iBEY9ywm5W3+FWTmuWfTV/SuLc+NqGPYb53lX6gkvx56u4fVPF2leZHrDQZzqVwM9tmA0E5yC1a2z7Eo1PmhcC/eGoy1QBqjCtmADMYpswmCnhCMW1y2l1IYcb/SPCEkN8exVW4NHkIuEvJjyHPMJrHoEHSaqBRPpMB+NXZB8xXyoWJabai127B9bcwG7ImsPIlOYmd5o6jz86WqcJayrF0yTjC4wnvelK7qS1CGLWUyDULDYwrVuUZSWFDpqibKSNe6pFP58QYQUtOfGIv+FBnh8QwJHkk+3xurchY2M86ia4Kv5/ijcipLUQQme8MIRZmtdIO58PpFkcwU9kvE2E8388W6X2iBRMadWwwtOqY6ehWFOoEo2iJ7zuRsI0vpfVmMN2uj8X/NN/hZ/2EBoH9iE6vSL3UDiZ2Drx2ijkQ9F3zYX0+CmK4WMAURHR7S6ccNBfd0W1M9zRCX39ajz1mXISX6BrDpo8asPktfdlCrzIFvdfmd5qXfmH/gIr5MZ5arSd4B5e/Cxr8oSTGYyhnTmaM4PaBPbspLdn6dYMGrmKefjegaOMP9O7sAkZCdfovPs/iCQ==
|
|
sidebar_class_name: "get 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 'Get Campaign Reports' (get-campaign-reports)"
|
|
---
|
|
|
|
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"}>Get Campaign Reports</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/campaigns/{id}/reports"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Fetches all reports for a certification campaign by campaign ID.
|
|
Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string","example":"2c91808571bcfcf80171c23e4b4221fc"},"required":true,"description":"The ID of the campaign for which reports are being fetched."}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Array of campaign report objects.
|
|
|
|
</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`REPORT_RESULT`]"} schema={{"type":"string","description":"SOD policy violation report result DTO type.","enum":["REPORT_RESULT"],"example":"REPORT_RESULT"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SOD policy violation report result ID.","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the SOD policy violation report result.","example":"SOD Policy 1 Violation"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SUCCESS`, `WARNING`, `ERROR`, `TERMINATED`, `TEMP_ERROR`, `PENDING`]"} schema={{"type":"string","description":"Status of a SOD policy violation report.","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"],"example":"PENDING"}}></SchemaItem><SchemaItem collapsible={false} name={"reportType"} required={false} schemaName={"ReportType"} qualifierMessage={"**Possible values:** [`CAMPAIGN_COMPOSITION_REPORT`, `CAMPAIGN_REMEDIATION_STATUS_REPORT`, `CAMPAIGN_STATUS_REPORT`, `CERTIFICATION_SIGNOFF_REPORT`]"} schema={{"type":"string","description":"type of a Report","enum":["CAMPAIGN_COMPOSITION_REPORT","CAMPAIGN_REMEDIATION_STATUS_REPORT","CAMPAIGN_STATUS_REPORT","CERTIFICATION_SIGNOFF_REPORT"],"example":"CAMPAIGN_COMPOSITION_REPORT","title":"ReportType"}}></SchemaItem><SchemaItem collapsible={false} name={"lastRunAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"format":"date-time","description":"The most recent date and time this report was run"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"type\": \"REPORT_RESULT\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Campaign Composition Report\",\n \"status\": \"SUCCESS\",\n \"reportType\": \"CAMPAIGN_COMPOSITION_REPORT\",\n \"lastRunAt\": \"2019-12-19T13:49:37.385Z\"\n }\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> |