mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
125 lines
62 KiB
Plaintext
125 lines
62 KiB
Plaintext
---
|
|
id: create-form-definition
|
|
sidebar_label: Creates a form definition.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztHWtz2zbyr2B4Hy6ZseRHEqf1lxtFVhpdZcmV5Pru7EwKkbDEhiJVgIyj8/i/3y4eJEBRDyf2JNeynUkoElgsFvvCYhe581I6Fd7JldfORJrMyduEz4X3fs9LFozTNEzibuCdeD5nNGX48ZTdhHGIH7w9j7M/MibSN0mw9E7uvIAJn4cL+fHEw7ckFCSdMaIbkgVdRgkNSJoQBZLcAEwS5EBNSwDuJ3HK4hQB08UiCn2Jzv7vAqHfecKfsTnFpwVHZNOQiRUkyjidFr8MamUE7A57HvtM54uIQdezpWlqf5/Tzz0WT9OZd3J0cHAAL8LYvIBf6XKBfUXKw3gKzT83pkkjpnPm4uLd73kIvJ3EgcRidSbeW+e7wd43b2hEomQa+vCWpmSeBOHN0prfEgYFCkbRcuUbNUvkh4sQCI6gQyA9p34KWJMkS/PGMIUwZfMK9IZswZnA7lSBtTBrQjd3kXgWsYHksISvwsqnOYRmPZwVjUzrMVCUfKJRxprXcat/SrY1bsXBdTwYbm034LjccTZHaQDA8GswREkoWEC9rVxT7NjAWahmj4uVzTVDm3LANkjJiuXohSBtyQ2Rn5v2srkLIZKM+2wsp7QqLCAUTHEHThrhJZPfmZ+SCUPOECyCHyxokm5KbsMogveEhdCeAxdwdsM4i32G0q6ZIowXwE3PJkv9hJN6ThJuvgPAOfIQtkiZP4uRHuQjWz6H1e72zy/GLsVGOfpdhHcdd3qds05/bauOgm+ttAQKv3VHd8HNyx0W/VGRsxe8+I7LrdZrda1UK9Ig4Y1cr2JdUZw3obVntVfLrFULjo9LnisKtWS4mL7PFmmTvEtu2SfG9x40qJ7l3nVsjVsakrqLL1/FOXMABpzBQsDYJEyF1gaOsg7YgvJUU3OTElZ4IWWT3dRRO5kD6BCMUKVG6vxCdmje+SOjkSBkPIOJ+3kTYnDQ77TsaRrRGOwm5VOW4nIQhjDCdAmD9ju7DNpP0scYF1RCMXJ7sMvI0CSlYbxpYMEoB4PuDAzrLBgjtzMmNUqYok1RgLCVIXl/MP6wGx5AAYMKapNdunRjP8qAHR6IOggEoMsUuWm8NHIkcRYa6d0wAKQNEsBeZzux13yRLtUYu3VA1lB9Rpe7tB8BP6TiEjQ9Ie0Z8z+KfJUoUXIGf2EbMAvQiMaJ/Ciyif6q6SFQ4NWrpqJwTlakNhWsAT6FAHQ+maXeDUOYUYEk0G2nTp042DIpBi0ef0q7YYeLpBG07FfnF/jR78Af7QE+SWGAh25f/5IPnTP9Sz6MLvUv+dAxv+DBtX6/7GL4ao1Xa7xa49Ua78k1nu222TsgyWHVOxhnjF9NO+nlAiKj8bDb/4lUNxqpKar5yCFwMkgWmsIuW0/XAPnQ647GGyHJDVkZWkwo51TKiiZpLi4V+4kcovTbV1Fbu+Fqrtl65AC1T74byI17tA10QApcx28Gg16n1V/T5k2SRIzGln1T9EWjVRBamjd327bn6Q8avmvJciBbrdk34ImaKXZmClsF5J9zHVARggTdExAwXaim8g7uVrETT8HAs4q9oezg3d/nbKOCH6bVgvof6RTfT0FBZZMmmMp9QcNokYRxui8WDaSM2A+SOdhfZL4wlSM6s/QK8HLZK8I9AtuwmxsYe0OkRzdwYj1uy45sQRY8CTIf6AJLRYsw3WqQTkGs1qxjHQ9SbZARoKPkBLAgsRuaBJ7hjDBcI5rCuOhTpchTKmA5iRL/I3DJu+6p5dV18sHfhQEj5DQUdAK0QEYMAxkKRokYvRtcVnUazZJbQjpxVZ/T7qj1plc5lh5l7XCd/rqeaqh1Qw47v1x0h5Udh+AzhZxdx4PzcXfQb/WqGg0WKpIKE754c9YdfzjrjEatnyoBjrLJPEzPmBDAnXkHsLrdt912C8dY3wssbnijI+3QtTP+cNp527rojT/82updVA/H0lN2Q7MolfJSVhfhNE64EsJFxheJUOKntTuuOep2WEX4Sy8MqvW+ftCEw2CsJg82d2hQvLDniG/L6LtGQY+91STUfPnX4Utb9RagUP+CNrsJp6uKsMUnYcopX5I5XZjtGhptqVqhS6aO0cjEtkUF7Ka3al7KB1rFLHp0wiJ8WebaSk2Pjf4OahY7uUav5fuwDqi2h2yefJIz1CZ8B+iqIUAGCYhxYRh3wP9weHhwfHz04/GLF4fHPxy/RhNqU7ataPmEllURYItt7WiT+vh4OGd1W7Bwz/XMSaCm8ZpzQPNV+WOR9gBiJrR5zf0xsf7kJwyqYeeu3JrF9Q70f42KP8x/W6Lu3VOL4aodDGuaVoCdXMfjzr/GpPR1zD6DFzke/PQTKMHyt2Q6jZjq1xp2WlV9W5xR6YCcdvrl76DmgRDX8fm7QX8F+PksiRkGKVrdXvlbB5gCFSN42e0VjEfy6Ax0fmu8AvQUvCTs15Y6caWjr5Rge9C7OOuPyt/bSZTNY2HZWJw4/FTUwQdNCHhUM4YHOTkZJ4SJSNOJSKNJBvzk77Y2qnpY15TqITYtuYWiq05pYI6Jz23+vC9rHaU09AGkw5F3XqTUondaHPusk2lXBVWY+5q/duEvqdVge1exM7B3f194KvczAFa7OuOrVJx4Mqn0LPR+zZsTqfOcwa/uLHBK5RjnEpTR+6ewACtoCcD5iayNOTvebmtyy6ItjYwbVOtfFVJwbEwRPxAq0wS3dly5ioHa+8nEHuUBYetGGIuUYrQgn+4DLNJFHP6BDltui/Tu0T6SfiLzlK61S0UOlKSQcwCsA0hrmo3McKXw1tdFq7YNZs/NKODIeJLu9PoYy91GYvnqcAsRlataVuOVHoeEB+6k9ankrhIBA8A2RucxEQH6hXLtzT8Lm+AZAFkmmIugkNkjIHJsj7DUbz5XnOrTGPNTFlSgIw4ilRSTxBlnAvgsXs2o2jJPJ43rSWS7tLQ7yHjeTr2rXOQ16W+yR0XeWynX7dWrzVTBIWRWxW3M+Kqor5etAXZwJAq23/1xd/xv4nzuSo2QLu1UHt3Qlab87S5JPNuGqpKk3dSWlUgDnC7J8iR660k4UJIC5woyErypMPoX8r1rKtT48kiJM2Ua8FxQLGGXMkdpw8boEIR+hsKstE0K1oTKw8VEJRvlTCoY/xSqoDNnfsIDbIwHTBnnQOZoqbPSEMf1RmY956k5uJuNy8Hw57e9wSVxG1wm/ONNlNyCuh9cDNud0medVFRwpgGDnrTs4LKo9Xkri34lRl/NwPnyIanN2vz/cLIiyRYVahrdqwxndG1wFbVqVCrt0T3GdkWK9VAnQ987ux2N5TxXzO7SzSsTlXNFrLG21CKu/26Ldn/v0uSGRoLJN2IB7q2SsKODw6r04DTjeBJAYnZbNjreFyd7b2DdaRYGhn+XNrNaAz8635bM9ekWG2xnV67DqrC/u9jb7c5WMc4mj6s6231nP6g2/H8Rw98rGXvXLthMTS7BA8B0YTwwd3wAbKmykFvn3QeYf+nVWzbJ8QUUImG6Ife9dgVqV2BXV2BjrKRXERzJYyJFqVN1PGQDg9YBkTogUgdEHjUgsvlsrbfhJO2Bclofpf1Zjjrqo7T6KK0+SquP0rYfpW0q326XrWhhg7+mOFtm5pd2OXVhdl2YXRdm14XZdWF2XZi9eeS6TLEuU6zLFOvC7Frj1Rqv1ni1xqsLs+sa3Lowuy7MfjBT1IXZdWF2XQD7JyiArQuza778HvmyLsyuC7O/eWG2yuOqSPZQuduBiZZjpk1lcc0tFcQAsVf96ODoRePgdePwaHx0cHL48uTV6+brly9/OP6Pp04WaYqxc+jXSEOZhL4pdK6xQYzlcWJYhfKZ/mJwjih4KxsRz2E9HeYGqSfPGxrqhHWd0f7y4KBCgcSEcQ4ukdxk27eYJ77MM0VK7Jy3vk2VgHaK2knAqqTcza7KW+L6KqVtpbPmrJz7moYCHZyM1vJm1TETMaA8kJm3arYml59o2GpTvlUZgq9Iowp/tCff59eVq/xcot46nMTixsVoWwqd6obZevJpwEPYI6wbVH0lsyQKBAFDIkI0uGrPhi4yWnzJ+gpF5HFzcOpgpi3aTrhpjJB92eeKVFFMYTHEoH6awV4MG5qIjVoCTXkHCWkk1S5UNtqCDY7j5ep9i9TQFKQf2qmH/Vs28UqG4czwGZ50wqY6EyVexZyEKeO20MOr45flU72iL5KIA16AezfYxvVj0/JUSqyS2Yoyk1WZpVk6S3j4X2Xra8mtJbeW3G8uuS92kdxMMI7Bi3kI64/Bilp4a+GthfdbC+/RjxXkTRLYZcdL4yGLB4moLSi7SMhukuHKdjmBznwz49ncoChNfPzMZd1qiTO7mICJiZwjxrGgrbMDZ9QKpFYg31aBuGJfml4u6OV/scv0Ilm58MyZ5o9+cPCC3fxwwI7py6NXbHI8OTycBJPJwavXfjB5uW3atqL58slLDfVqzWY+NFIrlNSqNaudilon/HV1wnfhVCAeDLgJK+2xuOQCBBSTo7DaJ8Pbhq48sTiRcb0T8DJw8u+xzORzA030FJhNK6vGJAmWZhj5jxKuVD7J0KgpOl+5cyHFbBhZvgFoyJKcjYPkx9tqMMRpztJZgvdpAI9KwaI4AW9fVv4Ww6GDpNSQGivjWHM1S9OFONnfvwM8aJzeN+kibIb6EoI4uZVLPQGlsTIvw1HId9hA6gA1QFOiyUN5yiTXRgK3DjBwoQz/bIRsssCXScaJArOHKkXXrsjXMi0tXv5dyNZNXOK9lfnBvC54dP/1c1GA1sylinwbR4P2BDAtTRGn8L5g0RGaATX6CqMWpgHDTkcrgw2w2RF5wygHA5QmH1lMnv3zcvycAINh4hQLdDl9XqxxDiwii4bykyHsJA/qeZJN1Va55QS5pF+LNwBgjeeIMXJlLrLog5YcdkZjSVLshK+VmXv/zKxOwD6xCM1Bs6AkMl4YxPtAoX3q9HsuswbmCcdaYaUvUJyu4wY5DbmqgBOyjZ6iOoK7Wph5UWteX4rE3wy0hoLWkNDE8xIWirRXfiQrqXyw+ggC8yKRWl88uILXsOA1phwYp4FQyziowmqJhxua9M2qfTEeDjyptlw8ruPLWejPiNuNKJVFxCzJooB0iT9LEsH+QQiyDorBFV6lw74YrVsctCElonF0YKHUUEM2wkYmmMSvB4IRK2aiE7wARJr1hIDaDJRI/iZXFmT+N5kM/JszZ/n6CtwEbBkkvvhinHHABg7YUDpAaPyVb4eMhdYR5iD1gGKAdrH+UhNoRC29p2BVanUJfl/2QdPgA6qqDGxxon6cFApOPxH5AVvnbUANo9eYnyHDb6JhoZV1iGWMfpmCq/hiNlBcopvC1/SV53rf23xxxq3Cjx/E0fKxtfQaTfL96N1vpPFqTfNn1DTaV8f98LD4h787xd0BpQyDyivEynXSV+WaY13Mq8tnr9xKWCut2BRcuiWFRbGgqpKxctCLZGPjtdsZpuji5amcV26OpclIs1ONVlJ/VlN3rMyd1cQbuYNxbyO5unvAVXylOz/MvREFitUXOahNjUMy52qALbX9Bml9EdIDMU5L62BQzK/PKcVsvuklNzhVs2POr+B7nFsUi+vUrnJI1sVfD4D0Hu/sAvVvx4Zso/NG759WaHshZKKPkHeuSaY1twoUB3A2oEVEU0kzWWU8kyW+nC1gN417sT3U9MlcWsYFT1AOmC5OmcodN1drNwllsRYZFyNTacDURg/1LP4WmSpmx6uzZjSewjpfMsJiH0Qeo1igLvHb76BbJaIj0JTnqGjJqVG+sAmazzPYbMuly+YEWGGbhg5C4WdKgoEdYmZooapr8l7GqqLqxynIeBrjczG4Gak76ixFvGUs0MPmrARIj6uYhwbNRIYsoiZk4G6jt8EG7d+YsWghY2yAFuY7FSOcdccrEAFYrPRqM+HTfd1J7GNbTOaHySv2edE8bB405PYd3mOsY05jC/jGOEvp/istALiL3gc2UxG3TO3qVfjkylsJn4BwzjDCAt/u7jCDE+MJ9/gaDBNHyXpfhArwF8CcMRqg9OaxnbYK+DaknivMwkrwFyMYqkdLFthvbGsHgc4HsvQFI0Y4m7l0uT1Ob9HAwZ8n3jX8L82W1r936j2q73iaqTifgmsc+Cr/VT/gNO/v/wcRfUQz
|
|
sidebar_class_name: "post 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 'Creates a form definition.' (create-form-definition)"
|
|
---
|
|
|
|
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"}>Creates a form definition.</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/form-definitions"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Creates a form definition.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
Body is the request payload to create form definition request
|
|
|
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 2000 characters`"} schema={{"description":"Description is the form definition description","example":"My form description","maxLength":2000,"minLength":0,"type":"string","x-go-name":"Description"}}></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"}>formElements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
FormElements is a list of nested form elements
|
|
|
|
</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"}>formInput</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
FormInput is a list of form inputs that are required when creating a form-instance object
|
|
|
|
</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":"Unique identifier for the form input.","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:** [`STRING`]"} schema={{"description":"FormDefinitionInputType value.\nSTRING FormDefinitionInputTypeString","enum":["STRING"],"example":"STRING","type":"string","x-go-enum-desc":"STRING FormDefinitionInputTypeString","x-go-name":"Type"}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name for the form input.","example":"input1","type":"string","x-go-name":"Label"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Form input's description.","example":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","type":"string","x-go-name":"Description"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 255 characters`"} schema={{"description":"Name is the form definition name","example":"My form","maxLength":255,"type":"string","x-go-name":"Name"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"description":"FormOwnerType value.\nIDENTITY FormOwnerTypeIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormOwnerTypeIdentity","x-go-name":"Type"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Unique identifier of the form's owner.","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usedBy</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`WORKFLOW`, `SOURCE`]"} schema={{"description":"FormUsedByType value. \nWORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","enum":["WORKFLOW","SOURCE"],"example":"WORKFLOW","type":"string","x-go-enum-desc":"WORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","x-go-name":"Type"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Unique identifier of the system using the form.","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"201"} value={"201"}><div>
|
|
|
|
Returns a new form definition
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Unique guid identifying the form definition.","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the form definition.","example":"My form","type":"string","x-go-name":"Name"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Form definition's description.","example":"My form description","type":"string","x-go-name":"Description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"description":"FormOwnerType value.\nIDENTITY FormOwnerTypeIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormOwnerTypeIdentity","x-go-name":"Type"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Unique identifier of the form's owner.","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usedBy</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using 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={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`WORKFLOW`, `SOURCE`]"} schema={{"description":"FormUsedByType value. \nWORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","enum":["WORKFLOW","SOURCE"],"example":"WORKFLOW","type":"string","x-go-enum-desc":"WORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","x-go-name":"Type"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Unique identifier of the system using the form.","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"}}></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"}}>
|
|
|
|
List of form inputs required to create a form-instance object.
|
|
|
|
</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":"Unique identifier for the form input.","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:** [`STRING`]"} schema={{"description":"FormDefinitionInputType value.\nSTRING FormDefinitionInputTypeString","enum":["STRING"],"example":"STRING","type":"string","x-go-enum-desc":"STRING FormDefinitionInputTypeString","x-go-name":"Type"}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name for the form input.","example":"input1","type":"string","x-go-name":"Label"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Form input's description.","example":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","type":"string","x-go-name":"Description"}}></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"}>formElements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of nested form elements.
|
|
|
|
</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"}>formConditions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Conditional logic that can dynamically modify the form as the recipient is interacting with 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={"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={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Created is the date the form definition was created","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Modified is the last date the form definition was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"My form\",\n \"description\": \"My form description\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"usedBy\": [\n {\n \"type\": \"WORKFLOW\",\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n ],\n \"formInput\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"STRING\",\n \"label\": \"input1\",\n \"description\": \"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic\"\n }\n ],\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 \"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 \"created\": \"2023-07-12T20:14:57.74486Z\",\n \"modified\": \"2023-07-12T20:14:57.74486Z\"\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> |