mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-06 12:27:46 +00:00
39 lines
8.1 KiB
Plaintext
39 lines
8.1 KiB
Plaintext
---
|
|
id: post-workflow-session-upload
|
|
sidebar_label: Uploads a new attachment attribute value to a workflow session
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: {"operationId":"postWorkflowSessionUpload","description":"Uploads a new attachment attribute value to a workflow session","tags":["workflow sessions"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attribute_id","in":"path","description":"The id of the attachment attribute","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"url","readOnly":true}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The <object> failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/workflow_sessions/{id}/upload/{attribute_id}","info":{"version":"1.0.0","title":"SecZetta Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Uploads a new attachment attribute value to a workflow session","description":{"content":"Uploads a new attachment attribute value to a workflow session","type":"text/plain"},"url":{"path":["workflow_sessions",":id","upload",":attribute_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The id of the attachment attribute","type":"text/plain"},"type":"any","value":"","key":"attribute_id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]}}}
|
|
sidebar_class_name: "post api-method"
|
|
info_path: nerm/api/seczetta-lifecycle-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 'Uploads a new attachment attribute value to a workflow session' (post-workflow-session-upload)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
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 DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
## Uploads a new attachment attribute value to a workflow session
|
|
|
|
|
|
|
|
Uploads a new attachment attribute value to a workflow session
|
|
|
|
<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"attribute_id","in":"path","description":"The id of the attachment attribute","required":true,"schema":{"type":"string","format":"uuid"}}}></ParamsItem></ul></div></details><MimeTabs><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"file"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"binary"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Expected response to a valid request
|
|
|
|
</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"url"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"url"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"url\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Bad Request - unable to complete.
|
|
|
|
</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem></SchemaTabs></div></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n}"} 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 schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={"A message describing the error"} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></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> |