Files
developer.sailpoint.com/docs/api/nerm/v1/get-advanced-search.api.mdx
2024-03-06 16:17:34 -05:00

37 lines
15 KiB
Plaintext

---
id: get-advanced-search
sidebar_label: Get saved advanced search queries
hide_title: true
hide_table_of_contents: true
api: eJyVVNtu4jAQ/RXLzwjY7hvSPiBtt0LaXlTYpwpVE2cAt4mdtceoUZR/35kECoVVLzyExHNmfM7cGu0rDEDWu1muJ3qNNM234Azmc4RgNnqgc4wm2EowjLhCUhG2mCvYAVXskOpvwmAxsgfBOurJgz5B6OVAB4yVd5Fhk0ZfjMfy9/aCy5cKDbHTHqrIK1BbKKyc8S2R+A7jHaEj8YeqKqzpRIyeogRpdDQbLEHeqK6Qw/rsicOyYxVEMtmewp7i447iwQFCgJrxlrCMHwey+REmUrBuzZiVDyUwSZ0SA0Q+5LeuqPWEQsJ2oNP//UrrfqNbExP6fsGf8HL8eRalgAyL8zhtl6bcSmYeQyowPgKxKUuE8T2p4OrbFVfwXDRZKuTgLviVLXDB5nsOzFd9iJ0TUIqfRU/3RMVhvtfzNbefQF+/i+fgPZd7G597Dcu2bQ/nJ2PT7n5cO6SN382WdA1IFfXotPEGOmLYYohd2lPgcuoNURUno1HDnQ6ObqDEdui8w7IqfI04NL4cQWXZeQvBQlbsyvoK78drBamQJgRTovFnI73o4MoxXkGMdu14+njoTIrkSwwiZin8TAqW6o5gxqwxTJOIeVgem+cyeT2PY9BrRkWUqO1g/N2D+KR/+bWfmIV/Rsc0+Pmj9in0r1pSat3KS0RJVy/h23A8HB9V6eby/lpN72bnWjeo9kZlwKkMVYq9XjAGY1TgclX63K5qJVn1KcoqYgZsVdapjgy6rQ3elbyChnwJ7x/kVSWkXJd2fT1bdFwrH6kEd2T5zAZ9Q7o5LLvPrd8+0YQvNKoKsE4WQddRza79Hs72Hhdww0zF1DQZRPwTiraVY4krNV8emqwrOTvwGuLKSTs8Yy0zwAmsqOvGInWL5XQzS6O8DsTVpaToH+u8REQ=
sidebar_class_name: "get api-method"
info_path: docs/api/nerm/v1/nerm-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 saved advanced search queries' (get-advanced-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"}>Get saved advanced search queries</h1>
<MethodEndpoint method={"get"} path={"/advanced_search"}></MethodEndpoint>
Get saved advanced search queries
## Request
<div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
Expected response to a valid request
</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>advanced_search</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>condition_rules_attributes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"ProfileTypeRule"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ProfileTypeRule`]"} schema={{"type":"string","required":true,"enum":["ProfileTypeRule"]}}></SchemaItem><SchemaItem collapsible={false} name={"comparison_operator"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`==`, `!=`]"} schema={{"type":"string","enum":["==","!="]}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem></TabItem><TabItem label={"ProfileStatusRule"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ProfileStatusRule`]"} schema={{"type":"string","required":true,"enum":["ProfileStatusRule"]}}></SchemaItem><SchemaItem collapsible={false} name={"comparison_operator"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`==`, `!=`]"} schema={{"type":"string","enum":["==","!="]}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Inactive`, `Leave of absence`, `Terminated`]"} schema={{"type":"string","enum":["Active","Inactive","Leave of absence","Terminated"]}}></SchemaItem></TabItem><TabItem label={"ProfileAttributeRuleString"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ProfileAttributeRule`]"} schema={{"type":"string","required":true,"enum":["ProfileAttributeRule"]}}></SchemaItem><SchemaItem collapsible={false} name={"condition_object_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`TextFieldAttribute`, `TextAreaAttribute`]"} schema={{"type":"string","required":true,"enum":["TextFieldAttribute","TextAreaAttribute"]}}></SchemaItem><SchemaItem collapsible={false} name={"condition_object_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","required":true,"format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"comparison_operator"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`==`, `!=`, `>`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","required":true,"example":"Some value"}}></SchemaItem></TabItem><TabItem label={"ProfileAttributeRuleDate"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ProfileAttributeRule`]"} schema={{"type":"string","required":true,"enum":["ProfileAttributeRule"]}}></SchemaItem><SchemaItem collapsible={false} name={"condition_object_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`DateAttribute`]"} schema={{"type":"string","required":true,"enum":["DateAttribute"]}}></SchemaItem><SchemaItem collapsible={false} name={"condition_object_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"secondary_attribute_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`DateAttribute`]"} schema={{"type":"string","enum":["DateAttribute"]}}></SchemaItem><SchemaItem collapsible={false} name={"secondary_attribute_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"comparison_operator"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Today`, `<uid>`]"} schema={{"type":"string","required":true,"enum":["Today","<uid>"]}}></SchemaItem><SchemaItem collapsible={false} name={"secondary_value"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`after`, `before`]"} schema={{"type":"string","enum":["after","before"]}}></SchemaItem><SchemaItem collapsible={false} name={"tertiary_value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":30}}></SchemaItem></TabItem><TabItem label={"ProfileAttributeRuleId"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ProfileAttributeRule`]"} schema={{"type":"string","required":true,"enum":["ProfileAttributeRule"]}}></SchemaItem><SchemaItem collapsible={false} name={"condition_object_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ProfileSelectAttribute`, `ProfileSearchAttribute`, `OwnerSelectAttribute`, `OwnerSearchAttribute`, `ContributorSelectAttribute`, `ContributorSearchAttribute`]"} schema={{"type":"string","required":true,"enum":["ProfileSelectAttribute","ProfileSearchAttribute","OwnerSelectAttribute","OwnerSearchAttribute","ContributorSelectAttribute","ContributorSearchAttribute"]}}></SchemaItem><SchemaItem collapsible={false} name={"condition_object_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","required":true,"format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"comparison_operator"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`include?`, `exclude?`]"} schema={{"type":"string","required":true,"enum":["include?","exclude?"]}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","required":true,"format":"uuid"}}></SchemaItem></TabItem><TabItem label={"RiskRule"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`RiskRule`]"} schema={{"type":"string","required":true,"enum":["RiskRule"]}}></SchemaItem><SchemaItem collapsible={false} name={"comparison_operator"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`==`, `>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","summary":"id of the Risk Level being compared against","required":true,"format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"secondary_value"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`OverallRisk`]"} schema={{"type":"string","required":true,"enum":["OverallRisk"]}}></SchemaItem></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></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 \"advanced_search\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"uid\": \"string\",\n \"label\": \"string\",\n \"condition_rules_attributes\": [\n {},\n {},\n {},\n {},\n {},\n {}\n ]\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>