mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
9.4 KiB
Plaintext
45 lines
9.4 KiB
Plaintext
---
|
|
id: create-workflow-page
|
|
sidebar_label: Create a workflow page
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztVktv2zgQ/isEz341TdyFgT2k2xRwgTZB4t09tEYxksY2G4nUkpQdwfB/7wwZWfKjWfTUS23Alshv3t8MuZWmRAteGT3N5ESmFsHjv8Y+LnKzuYMlyp7M0KVWlQwiyF8BIkBsnlGijDAPSycnnyW/OjnvSYv/Vej8W5PVcrINr8oimfG2wp5MjfaoPW9BWeYqDW4Mvzk2s5UuXWEB/OTrEsmwSb5h6slQadlpr8gK7Qbr/4uqVNYBOW+VXp6ENluhIKAwC+Hp8TkufIKizFmMF76ypt2R5F6xxyd/IMIpFAtj99k6a7SzcmCc7Ggo8JznrYmPtQhWPjHynHZWcawWbLpSa+wmJTEmR9Bd3QvIHR6rfIcebaE0OrFZISm1e81CObHXTFbOJ53SUQDVXVacS+YJZLc6rxtinEbQ1oRlD6K/wNE4+ePNuL+4vBr3L9+8zvpJNr7qJ+PL11c4SsbJBblCvnjlg8ABuXfhwy640mgXuXIxGvHfoRs3TyXxCjPRQIU31ARryBWvBabL36T+TepfQuq7MHMbNl+eI/BbyMR95Knoi0pDkgcOp4aNehz8DHuNxtsFDftThjYeTXVojQ8suuv9GPcPo4KZG2uNpSDmMYirc0FMyT+rIRcPaNdUoyBD4Vj0ldXUncS1Sq9AZzm94FOKQdL9VHAvNx2yyVPPrkWBzjFd4npCtAjFjfhudR+MtbVwpiCeMWpDXomNNcSjXVNC3jN8IpcmzJUS/IrehuFwHTZ99zWetT3pQjpcqEhlc0KuvC/dZDjcUsygPffRbqCpbuSEqREHVPchlIqE12AVsyGE18JjjAuocqY1pAWm5rQVAzx2IzinllwEZlXlPAVoOaI5+5dWVvk6OJggWLTXFUf0ed7dfuAaRD+6oH1JOCiONsC4uwOIVuLD+6YHZ+YRNblBv3/WprLxMXQMl/u+vZjcNFVpZ26Yqu1YPI743PCL8+x4aLXjKIwctq70wrANLlZU92owGow6/fDp5v6juL6bnh16zaZIQYuE5rqL2YY0JfIJor0oTKYWteCamsrxaUXx065QWoRUoF4r4lpBpOOuoD5AOs3YqSaK6SxkiplXgO7s/PDqd3Ru7Dvthctie7QMyxwUD4nI3O0z15uLZE8esZ34suKmIMR2m4DDv22+2/EyVdUyxeYtpwPDSICmMRGF2feINTsWXezP2A+G5xX7czIYeHRFieuUh8mL2Hmnb+9uH2ZMzOfLL5WFZSwwXfh3Ir/Ql15MnFDhhszrW5mDXlaBjDLq5c939xIC4A==
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/nerm/v1/nerm-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a workflow page' (create-workflow-page)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Create a workflow page</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/pages/workflow_pages"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create a workflow page
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>page</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The uid of the page","example":"page_uid"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"text"} qualifierMessage={undefined} schema={{"type":"text","example":"Page for workflow","description":"The description of the page"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"My Page Name","description":"The name of the page"}}></SchemaItem><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"description":"Determines whether the page is archived"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Expected response to a valid request
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>page</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The uid of the page","example":"page_uid"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"text"} qualifierMessage={undefined} schema={{"type":"text","example":"Page for workflow","description":"The description of the page"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"My Page Name","description":"The name of the page"}}></SchemaItem><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"description":"Determines whether the page is archived"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true,"description":"The id of the form","example":"2e06b876-f456-473d-bd65-b6435e0b6b2d"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"page\": {\n \"uid\": \"page_uid\",\n \"description\": \"Page for workflow\",\n \"name\": \"My Page Name\",\n \"archived\": false,\n \"id\": \"2e06b876-f456-473d-bd65-b6435e0b6b2d\"\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Bad Request - unable to complete.
|
|
|
|
</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"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"InvalidJson"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"Invalid JSON syntax. Please check your syntax and try again."}}></SchemaItem></TabItem><TabItem label={"ValidationErrors"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"The <object> failed to create/update"}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":{"attribute":"can't be blank"}}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - returned on unhandled exceptions.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"Sorry something went wrong"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"Sorry something went wrong\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |