---
id: search-form-instances-by-tenant
sidebar_label: List form instances by tenant.
hide_title: true
hide_table_of_contents: true
api: eJztPGtz2ziSfwWl+7CTKkt+JJNk/GGvZJlJdCNLHkke712cykAkJHFCkRqCtKNz+b9vPwC+RFlKJt7M3SofHIpoNLob/UADDd43EjnTjdP3jU6qk2gh3kTxQjc+HDQ8pd3YXyZ+FDZOG/1ILGUsFypRsRax+iP1Y+W1GgeNaKliiVBdD+C0krE7RyTdUCcydJU+W41VKMMEYGOll1GoFQx43zg5OsL/yuMMVZLGoRZSBL5ORDQVU8AlfItMTFYisejcKITnBLHI5TLwXaLj8HeNqO4b2p2rhcSnZLVUgDya/K5c7LiMkerEZ0LcKGUkZVI6+FqE6WKiYiRkqHQaJBq6G3Q+jD5TMbxAGmXCr16+gBfqs1wsAwA6Pmh8bs6iZgiiszgbDyQJQlYjAGoQ8yjwimIoinRoxCj8RC0KBMk4liv4ya8BdYXPWMlEeTWccoPwtUjmSnjwgx5Kohd3EujR2p+FgKPAIkzkyfPm0avm8cn45Oj0+MXpj69ar168eP3yf4qiQazNxAcxZPTqJPbDWaMiIkMlCMkQfLZa58WvYaN7jhxIkYb+HykIxwPd8Kc+zVBO7ZH516z5Y/9tIbF7jtQxRJWIMbxlMsrSM7yQ/iKIAsUStzJI1U14PRj+/KY3uP7o/MPpXI27g35pujtWDIj7Ooo/TYPozvms3BTHvAlHg6thx9ncZRSlsYtixzHR1NfHg0bGgpafy6oWsFYyiLqJkqjt9TTsFKcEGxoP2azkpk5AS+l+kjN8P/OTeTppudHiUEs/WEZgsYd62cTJ0odetJB+iDz6CQmglgicfPV5CQ5wffodem8taSE/+wuYZ7kgXwJmjAYATTKxCuLKUEygQyhAwWfgFnRLtKfgZQEKsSC8jx5XgjfzEGuY2+adHwTYexHdYlsESDvtfsfpOecCiAYzlik4dXCLrgyCVUuMoWeqATn1DCMRRCG4MMQhJ4FCFCAamHzjAXQ6Wfhg81HYEtc4dFWtgTQWBWg8tKaenwDOWUbZTIUYHoA66MeMx8qN4joP8rregzxmiSxunBAkqxOFMD4QW+NX35Ta7QS59o0MkGzfZRIXkedPV7mcvRWMxzJca5OMCbjylz54HESNkSGWbgIEiyhNMuCib666/SXIELtbvcgpa61FrDgN1IDibhTXBS7TdQhgPeRKBhaa3BO5ndZN2O6fi23A7dC7CQfDrXCDuOBgADH8GgzL3oTfbnUf35yqosIMi5LDOAy/a6ajZ6IuNbc2h1RNvmhcGwnO1dQPFWsHuXzAx24JDAM1Q6sAfsAqSnSTzGAUOCgwSAkKNVWxQhsjuzZmtwRt+gFiCD8hU89EFNt2QLhAHfqBVknuPER5iE9q9Qxmu9u/vBqXJTbKyO8ivpsQPMeF098I5TD+wkwTUvhtOpYn3L7cYdK/KXHFCc/bcbp5vtbniqFEU/hT9ntZLzTnx8g6KMDzNBvXguOTx88XUjhlOJmuq5ZJS7yL7tStig++aFDD5cFNWBi3MqQsTz69CjPlAApiBRMBY8MCUhtvUPLHnoLFfmKk+Zj/NbH4waYBW91RB6KLjH1Yodd6JOcXsQO480cqAy0gmgHjbgYiLA3mnbE9IyMZQoSU8UwlFIoU4vCTFQzad3YZtB8l32JccAn5yJ3BLiMDSALLkscG5rSrPDDMs1awbJ8r8igQmF2LCKGsyPuD8cfd6AAJWFLQm+zSpRu6QQrq8IWkg0EAuYrFLcOVtSOiWRuid6MAiLZEgHpd7KRei2Wy4jF264CqwX1G17vAj0AfEn0Nnl6Izly5n3Q2S1KwneHyDWAgLACQDCNqhNWYaTXy0Gjw/KrFEs7EitKWWjVhTaGBnFs71btRCBzlRILcdurkhN4WphRAfHuWdqMOJ8kQWIhfzi/wo+/An84An8gY4KHbN7/owbkwv+hhdG1+0YNjf8FDOfr9skvg23u8vcfbe7y9x3tyj1dcthUzINKw+gymNMavFo5WuUDIaDzs9t+KeqARs8j80BC8KYa7EpBlG3Ytko+97mj8KCZKyKrYQkE7nihII9LMXGryiQwjrdvXSduYcLU2pB4ZQrMm3w3loznaI3JACdyEZ4NBz2n3N8CcRVGgZFiIbyxfDFq5oCm8ldO2g4ZpMPjLkSxDsjWafQed2CvFzkpRdAFZc+YD1u3/DHyPJyLecMw6lFNFJ5xBgFc1uSF1eII92RKX+UZ8dvpR3e7RtF87ncLYj+z0GIDSXk9la5cgcJvWS13eyZf5Nt36Jh1jrPesY7MfxDCoCNCRt3TtBm+GGXQmVkLhHBU2UkGVeMNyEkTuJ9CSd93zwqrOyQZ/53tKiHNf4wYvKaLv0TkZWsTo3eC6rtNoHt0J4YR1fc67o/ZZr3YsM8rG4Zz+pp481KYhh84vV91hbcchH0XehINLPGlo9+qABkveSQWGr84uuuOPF85o1H5bi3CEW97JhdIatDPrAFG3+6bbadNpxsZeEHH9qTmGhK7O+OO586Z91Rt//LXdu6ofTiXnairTICF7qboLfxZGMRvhMo2XkWbzM94d5xx9O8wi/GcmBt163zwYweFmrBEPgpdkkL8o8ohvq+SXg4IZe2tI2Ovlv49elo5mcvf3QEf1U3+27gjb8cRPYhmvxEIubbqGQZtcK3RJubhATIqxKMfdaqyHl7Ib9gpc9OREBYWCgExraz09Av0N3Cx2Kge9tuvCPKDbHio8e6MIY7aft2NnQMCcn1CX0L8+Pj56+fLkp5fPnx+/fP3yFYbQchEByfIJIysLYEtsdUxIfZpT14yWLVSUz/XsSeC5TKjwQ3r2EO2yqBQP1Tl5Y/oUSiAkRvpbmCI+s7e7+KCBdCia8GGqZzr5eDSKe+3NvxsjAX0uTup9cVO9vGzaJL8Ch8SP5Q3PlXxbcVN3zlmAOLcc+V7pMMLLQPjE05Yn0MLCHFV+05qJKl2WG2MNG05sbWvhvLbgEwoMHTDld1EaeHSaDcvsJbCUwfgK62mmcbTI+jSNU9p4uldXZPKmuFzfYMDfrsbEDFS/iCwIqHCIIm7CsfOPsai0jtVnyBTGg7dve85aWzSbBYr7tYdOu65vGxSEFpnnTr/aDqEcBHETXr4b9NeQX86jUOFGVLvbq7Y5YPgY/CCT6qxRPKLjUYjr7fEaUrAHjIHQy1aXlDq6HOg6g97VRX9Ube9EQboIdWEdhYzDT5YOPhhBwCNzDA/EHO0FAyO0PEKicdkF9NHvjlk4mWHLyyUzxKPFDIXJLoXMXb0YBwZzyNwqe5+AQ1/jPPdCW/xOx1rH2pJur1+76BdFLggJNdlfMcP/ypPXn9XKZO52PVpzqq2y0kFD3q8ZONcOlgZ/f19Axy7HJhDgjD48RZRfI0sDzU+0orD1AdvXE1lMsjEqjqN4U4SiturOE8XYXJhCMVQWfgKpE1sLVldnCUti2vEF1aa6LoTiFf/Ylna1RHda03suvZqBqWzMT/L4mFWMIYZuX1wOB2+HkHyYsrG7uYqZNjegoiYsU8uqBuC9Vgb15uhZq/qgtjaWl/a5/pQRLDgpqpkhky7x/GS1tHdq0qJ5M81ZHW3GidWbMpQ5sQFBezL2RPuyy0IQtq5ZGEp4i3xrahJEwH1NYO/R+2zNk8YxTgG/LQlKhc2r0RYZmW4gJh5uEPuw9Nw0KLea6mNI67SP6S/voKLoMP8mBWYSUVdtGVOJMpNf7kSboQjtEgJBnbv8nFhhSDdJQWMQ0C7teAqM5EtEUMrKlklAW6jBcRpZsrXF18gEbBjg+OEQVGqLY7Gq+Mh+6682u85O/rDgOnJ9WprzKZL4uWIs//oN2Mzt7eJK2UkYR0qb7F+al/HOPE+jqZ/LrwVgEy1tKBtnuZbWPQRyjMFQmq3gbbkWEwmAm5b/tiC4Um8+SyHHMhnBCrcwslwq885PkVTl1JArxOpUv67I/8K0WP2iEPRIqX+G6elK/S1JfCHC1M/WFsfatvzwRNvglRfeUuUbEsGpeY6RNtCTeaQxsEX0y3hs8m64oT71g8BW65ozGSxjMMXQ2OInX5Yo/sVuI5TvjxjJ5GnjDaTkTn/cHf93PWSXyE9WhaTJdijnOdnbXYo+dx3yX1zpn5Gw7XQp11msLcV1QTuAJRviKmw9Nk6nMtCq6ttGJXiepQmf1YlpIGeo4H7o4bat4hJR6070PNvmuAXWpFVirOzXpRr+W18W1iw4FmO46mLVsMFDiKMwWJUxAp6JylDxeRfH0sVEeR6fRJX2iQybRmKT2nPHMtfrcruKg5pEpgwy7Fknho92rWqls5CrNcJpT0/h3SUKpQXXkGp21XUyKlnqPEmW+vTwcLFqRvGs5RvtDKM70rHUP/QOWbe+gU2vMWwEldTVLifWifPaPapJC27C9mjUfduH5KGo6NS1be504fn4xywPWAPrhpfmgoo9fBjXYeMDhwTRdQYXlz2nFqpjJweg6MJKrxYKn4KAY5C9WmD4oCKGjNzsEGtMLdnI+GzxVy4j5Hi2+qn/67KraFby9P6T06HGQ9Vf8qXHXdfYm0fDU/viiNkl03zoBxzlRd0d07ZJB3hFzWsICNGYG7qUbKHMvtHdUk8lwE4n8lTdwVBROOc5ZCWlrUSgfZK6T1L/VJK6KSvF8JHqiq4+csm56lZMXxRRDHQB7XxA9Sg7FvKcLJZt9ngXm5UprOhj/3/NUdDecveWu7fc7225z3exXLqADHpqbhbrvfHujXdvvN/deE9+qhFvFEE+Ha7sCll/kYkWDWUXC9nNMsq2Xb1zbdvyU6ZcG1jSwsXmmD40U9HMLt7bx28BjFR8C07K2UEz9g5k70C+rwMpm32FvczQLZM217W9tmxQ/+R6R8/V9PWReilfnPyoJi8nx8cTbzI5+vGV601ebGO76Gi+nnnyUD9uSOZ9a7WarZbnbL+o2PuEf1+f8JdYVCAdCrQJD3GwuugKDBTv02K5F2TvuJ2rl6e0xXcKqwxk/gPWGS0UpPb4NbmZIh2WCNug3fVm9iW4BiJHe9eEO8Vzg2yT/p6/EffQkkt/bat+AtbZqJ7G2KnDCUYAMjYeAO3qVsY+3QAgIfAH6IonPI1soh7FbL/QsYrS2HzH7gBt13xbiF7TleFw9TdN0C2U5cEaf8DXVRw8/HleGNEGXurE9+hoAC+A0gqLyMKHXBdG6G959DWNyH0w7u+crA02QLATcaZkjJ/Iij6pUPzwX9fjZ4UvTfGRTvYhnUtQEfrAU1a1j53oElUcpTPOSdul3SRaQOJnybCadqSUeG8PI/vgjobOaEwixU74muPJhx/s7HjqVgXod1u5JFHxfC88BAkdylK/Z3R2t4jws2EhGybeJ7sJm+Lcj7nWkI62LIt8PeL90vIlC3x9LRH/YbE1GVuTsOlnFSpYtO9tURiEV0SBd9ZRWl89OONrFvA1ZzEoThOxVmngk06io7wH6NpZ+2o6SviaiK9Mx014PffduSh3E+yv7HFqV7jzKNLqP4VA1UEzeI+1IeqrybrDQZtkEc2TowJJTR6y6TdTrYi+HhhGyMokJ1jMQPEzElM/9Ngkf6OZBZv/jSocfivxTK/fQzxGSC9y9VfTjAM2ccAm+wBt6OdFFCoWhiHggT9NSQrQyeefPIEhtOD3GFetVyf0h9QHQ4MLpPInupan/OM0d3DmSVADQmcw4IZxeZbd74HfwuDCcFYSlo2uVQmu04s3NcOK3Jhe25dKZf5q/CLH7XzBPAiD1bf20hs8yV/H734nj7f3NP8fPY1ZFKO6FZO+opKfmfXamk1daVt4Da2ai4P4K5P5znoR0TKQCdWA0Bfn5lS4zXeicO13YL8MCpYIOSKavzIfKpnRVbAYSJaBnPj04R4sqLMjSzIYXljivOJvnXJhJtYezWU4Uy1xjd+4dWFaMD2F6cG232EuuZYdZuYSJ1ac28mGRddikYYwGtolfjQVVGqLRni+dlNtSp7CUFlZ8JdWsl7WilHVkAVKlBVkHYMpbvT5+EXAxo5jwbzbTVAQPc5ilvNbRoYqMDcyDirL9m24QduacxUsKXkGsrCQIR/hojtewwjIQv6EUCuKZ4emkz5EWCw0BuZZfZ63jltHTUoX4D0k2glkXAXk9B2EUs1Q4Vvbrao23ud7Ko98GtwECVzdH4I6csqdcrbBSd37RiWpgzRhDrRhy/093vnFLOcBX/+RqhjTyA95AoO/AONcSQ+yWswC6c4BXc9dJo2sznp916eUZb51UK5yQ2QzDzjUw8M/AZ6uxyM=
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List form instances by tenant.' (search-form-instances-by-tenant)"
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List form instances by tenant.</h1>

<MethodEndpoint method={"get"} path={"/form-instances"}></MethodEndpoint>



No parameters required.

## Request

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Returns a list of form instances by tenant

</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={"count"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"Count number of Results","type":"integer","format":"int64","example":1,"x-go-name":"Count"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>results</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Results holds a list of FormInstanceResponse items

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Created is the date the form instance was assigned","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>createdBy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`WORKFLOW_EXECUTION`, `SOURCE`]"} schema={{"description":"Type is a form instance created by type enum value\nWORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","enum":["WORKFLOW_EXECUTION","SOURCE"],"example":"WORKFLOW_EXECUTION","type":"string","x-go-enum-desc":"WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","x-go-name":"Type"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"expire"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record","example":"2023-08-12T20:14:57.74486Z","type":"string","x-go-name":"Expire"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>formConditions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"ruleOperator"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`AND`, `OR`]"} schema={{"description":"ConditionRuleLogicalOperatorType value.\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>rules</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of rules.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"sourceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`INPUT`, `ELEMENT`]"} schema={{"description":"Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key).\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"}}></SchemaItem><SchemaItem collapsible={false} name={"source"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement,\nthe source is the name of a technical key of an element to retrieve its value.","example":"department","type":"string","x-go-name":"Source"}}></SchemaItem><SchemaItem collapsible={false} name={"operator"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`EQ`, `NE`, `CO`, `NOT_CO`, `IN`, `NOT_IN`, `EM`, `NOT_EM`, `SW`, `NOT_SW`, `EW`, `NOT_EW`]"} schema={{"description":"ConditionRuleComparisonOperatorType value.\nEQ ConditionRuleComparisonOperatorTypeEquals  This comparison operator compares the source and target for equality.\nNE ConditionRuleComparisonOperatorTypeNotEquals  This comparison operator compares the source and target for inequality.\nCO ConditionRuleComparisonOperatorTypeContains  This comparison operator searches the source to see whether it contains the value.\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes  This comparison operator searches the source if it equals any of the values.\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith  Checks whether a string starts with another substring of the same string. This operator is case-sensitive.\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith  Checks whether a string ends with another substring of the same string. This operator is case-sensitive.\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals  This comparison operator compares the source and target for equality.\nNE ConditionRuleComparisonOperatorTypeNotEquals  This comparison operator compares the source and target for inequality.\nCO ConditionRuleComparisonOperatorTypeContains  This comparison operator searches the source to see whether it contains the value.\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes  This comparison operator searches the source if it equals any of the values.\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith  Checks whether a string starts with another substring of the same string. This operator is case-sensitive.\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith  Checks whether a string ends with another substring of the same string. This operator is case-sensitive.\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"}}></SchemaItem><SchemaItem collapsible={false} name={"valueType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`STRING`, `STRING_LIST`, `INPUT`, `ELEMENT`, `LIST`, `BOOLEAN`]"} schema={{"description":"ConditionRuleValueType type.\nSTRING ConditionRuleValueTypeString  This value is a static string.\nSTRING_LIST ConditionRuleValueTypeStringList  This value is an array of string values.\nINPUT ConditionRuleValueTypeInput  This value is a reference to a form input.\nELEMENT ConditionRuleValueTypeElement  This value is a reference to a form element (by technical key).\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString  This value is a static string.\nSTRING_LIST ConditionRuleValueTypeStringList   This value is an array of string values.\nINPUT ConditionRuleValueTypeInput  This value is a reference to a form input.\nELEMENT ConditionRuleValueTypeElement  This value is a reference to a form element (by technical key).\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"Based on the ValueType.","example":"Engineering","x-go-name":"Value"}}></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"}>effects</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of effects.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"effectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`HIDE`, `SHOW`, `DISABLE`, `ENABLE`, `REQUIRE`, `OPTIONAL`, `SUBMIT_MESSAGE`, `SUBMIT_NOTIFICATION`, `SET_DEFAULT_VALUE`]"} schema={{"description":"Type of effect to perform when the conditions are evaluated for this logic block.\nHIDE ConditionEffectTypeHide  Disables validations.\nSHOW ConditionEffectTypeShow  Enables validations.\nDISABLE ConditionEffectTypeDisable  Disables validations.\nENABLE ConditionEffectTypeEnable  Enables validations.\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue  This value is ignored on purpose.","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide  Disables validations.\nSHOW ConditionEffectTypeShow  Enables validations.\nDISABLE ConditionEffectTypeDisable  Disables validations.\nENABLE ConditionEffectTypeEnable  Enables validations.\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue  This value is ignored on purpose.","x-go-name":"EffectType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>config</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Arbitrary map containing a configuration based on the EffectType.

</div><SchemaItem collapsible={false} name={"defaultValueLabel"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Effect type's label.","example":"Access to Remove"}}></SchemaItem><SchemaItem collapsible={false} name={"element"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Element's identifier.","example":8110662963316867}}></SchemaItem></div></details></SchemaItem><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><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>formData</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

FormData is the data provided by the form on submit. The data is in a key -\> value map

</div></div></details></SchemaItem><SchemaItem collapsible={false} name={"formDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"FormDefinitionID is the id of the form definition that created this form","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>formElements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

FormElements is the configuration of the form, this would be a repeat of the fields from the form-config

</div><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={"string"} qualifierMessage={undefined} schema={{"description":"Form element identifier.","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"}}></SchemaItem><SchemaItem collapsible={false} name={"elementType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`TEXT`, `TOGGLE`, `TEXTAREA`, `HIDDEN`, `PHONE`, `EMAIL`, `SELECT`, `DATE`, `SECTION`, `COLUMNS`]"} schema={{"description":"FormElementType value. \nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-name":"ElementType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>config</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Config object.

</div></div></details></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Technical key.","example":"department","type":"string","x-go-name":"Key"}}></SchemaItem><SchemaItem collapsible={false} name={"validations"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"description":"Set of FormElementValidation items.","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain","title":"FormElementValidationsSet"}}></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"}>formErrors</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"}}></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"}}>

Messages is a list of web.ErrorMessage items

</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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"Value is the value associated with a Key","example":"Engineering","x-go-name":"Value"}}></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"}>formInput</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

FormInput is an object of form input labels to value

</div></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"FormInstanceID is a unique guid identifying this form instance","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormInstanceID"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Modified is the last date the form instance was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>recipients</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it

</div><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={"string"} qualifierMessage={undefined} schema={{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"description":"Type is a FormInstanceRecipientType value\nIDENTITY FormInstanceRecipientIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormInstanceRecipientIdentity","x-go-name":"Type"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"standAloneForm"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"default":false,"description":"StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form","example":false,"type":"boolean","x-go-name":"StandAloneForm"}}></SchemaItem><SchemaItem collapsible={false} name={"standAloneFormUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI","example":"https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"StandAloneFormURL"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ASSIGNED`, `IN_PROGRESS`, `SUBMITTED`, `COMPLETED`, `CANCELLED`]"} schema={{"description":"State the state of the form instance\nASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","enum":["ASSIGNED","IN_PROGRESS","SUBMITTED","COMPLETED","CANCELLED"],"example":"ASSIGNED","type":"string","x-go-enum-desc":"ASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","x-go-name":"State"}}></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  \"count\": 1,\n  \"results\": [\n    {\n      \"created\": \"2023-07-12T20:14:57.74486Z\",\n      \"createdBy\": {\n        \"id\": \"00000000-0000-0000-0000-000000000000\",\n        \"type\": \"WORKFLOW_EXECUTION\"\n      },\n      \"expire\": \"2023-08-12T20:14:57.74486Z\",\n      \"formConditions\": [\n        {\n          \"ruleOperator\": \"AND\",\n          \"rules\": [\n            {\n              \"sourceType\": \"ELEMENT\",\n              \"source\": \"department\",\n              \"operator\": \"EQ\",\n              \"valueType\": \"STRING\",\n              \"value\": \"Engineering\"\n            }\n          ],\n          \"effects\": [\n            {\n              \"effectType\": \"HIDE\",\n              \"config\": {\n                \"defaultValueLabel\": \"Access to Remove\",\n                \"element\": 8110662963316867\n              }\n            }\n          ]\n        }\n      ],\n      \"formData\": {\n        \"department\": \"Engineering\"\n      },\n      \"formDefinitionId\": \"00000000-0000-0000-0000-000000000000\",\n      \"formElements\": [\n        {\n          \"id\": \"00000000-0000-0000-0000-000000000000\",\n          \"elementType\": \"TEXT\",\n          \"config\": {\n            \"label\": \"Department\"\n          },\n          \"key\": \"department\",\n          \"validations\": [\n            {\n              \"validationType\": \"REQUIRED\"\n            }\n          ]\n        }\n      ],\n      \"formErrors\": [\n        {\n          \"key\": \"department\",\n          \"messages\": [\n            {\n              \"locale\": \"en-US\",\n              \"localeOrigin\": \"DEFAULT\",\n              \"text\": \"This is an error\"\n            }\n          ],\n          \"value\": \"Engineering\"\n        }\n      ],\n      \"formInput\": {\n        \"input1\": \"Sales\"\n      },\n      \"id\": \"00000000-0000-0000-0000-000000000000\",\n      \"modified\": \"2023-07-12T20:14:57.74486Z\",\n      \"recipients\": [\n        {\n          \"id\": \"00000000-0000-0000-0000-000000000000\",\n          \"type\": \"IDENTITY\"\n        }\n      ],\n      \"standAloneForm\": false,\n      \"standAloneFormUrl\": \"https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000\",\n      \"state\": \"ASSIGNED\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

An error with the request occurred

</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"string\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"statusCode\": 0,\n  \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

An error with the authorization occurred

</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"string\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"statusCode\": 0,\n  \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

An error with the user permissions occurred

</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"string\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"statusCode\": 0,\n  \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

Too many requests

</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={{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"Internal Server Error\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"trackingId\": \"9cd03ef80e6a425eb6b11bdbb057cdb4\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

An internal server error occurred

</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"string\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"statusCode\": 0,\n  \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>