> For the complete documentation index, see [llms.txt](https://documentation.immuta.com/saas/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.immuta.com/saas/developer-guides/api-intro/marketplace-api/request-form.md).

# Request Form

APIs for managing request forms

## Search request forms

> Search request forms in the marketplace using the provided filters

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Request Form","description":"APIs for managing request forms"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PaginatedRequestForm":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"type":"string"},"fields":{"title":"RequestFormFields","type":"array","items":{"$ref":"#/components/schemas/RequestFormField"}},"policy":{"type":"object","properties":{"version":{"description":"Policy schema version","type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleProperties"}},"defaultEvent":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"title":"Request Form Data Use Agreements","default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"The name of data use agreement","type":"string"},"body":{"description":"The contents of data use agreement","type":"string"}},"required":["id","name","body"]}},"createdBy":{"description":"The user who originally created the request form","type":"object","properties":{"globalUserId":{"description":"Immuta global user ID","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"Display name","type":"string"}},"required":["globalUserId","name"]},"createdAt":{"description":"The date when the request form was originally created","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedBy":{"description":"The user who last updated the request form","type":"object","properties":{"globalUserId":{"description":"Immuta global user ID","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"Display name","type":"string"}},"required":["globalUserId","name"]},"updatedAt":{"description":"The date when the request form was last updated","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"version":{"description":"The current version of the request form","type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"associatedDomains":{"description":"Domains associated with data products associated with this request form.","type":"array","items":{"type":"string"}}},"required":["id","name","fields","policy","createdBy","createdAt","updatedBy","updatedAt","version","associatedDomains"]}},"meta":{"type":"object","properties":{"offset":{"default":0,"type":"number","minimum":0},"limit":{"default":10,"type":"number","minimum":1},"totalCount":{"type":"number"},"pageCount":{"type":"number"},"currentPage":{"type":"number"},"totalPages":{"type":"number"}},"required":["totalCount","pageCount","currentPage","totalPages"]}},"required":["data","meta"]},"RequestFormField":{"oneOf":[{"$ref":"#/components/schemas/SelectionFormField"},{"$ref":"#/components/schemas/ShortAnswerFormField"},{"$ref":"#/components/schemas/AccessDurationFormField"}],"discriminator":{"propertyName":"type","mapping":{"DROPDOWN":"#/components/schemas/SelectionFormField","CHECKBOXES":"#/components/schemas/SelectionFormField","SHORT_ANSWER":"#/components/schemas/ShortAnswerFormField","ACCESS_DURATION":"#/components/schemas/AccessDurationFormField"}}},"SelectionFormField":{"title":"Selection Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["DROPDOWN","CHECKBOXES"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}}},"required":["id","type","label","options"]},"ShortAnswerFormField":{"title":"Short Answer Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"]},"AccessDurationFormField":{"title":"Access Duration Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["ACCESS_DURATION"]},"label":{"type":"string","enum":["How long do you need access to this data?"]},"required":{"type":"boolean","enum":[true]}},"required":["id","type","label","required"]},"RuleProperties":{"type":"object","properties":{"conditions":{"oneOf":[{"$ref":"#/components/schemas/AllConditions"},{"$ref":"#/components/schemas/AnyConditions"},{"$ref":"#/components/schemas/NotConditions"}]},"event":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["conditions","event"]},"AllConditions":{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},"AnyConditions":{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},"NotConditions":{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false},"ReviewPolicyEvent":{"oneOf":[{"$ref":"#/components/schemas/ApproveEvent"},{"$ref":"#/components/schemas/DenyEvent"},{"$ref":"#/components/schemas/ReviewEvent"},{"$ref":"#/components/schemas/DataProductPolicyEvent"}],"discriminator":{"propertyName":"type","mapping":{"approve":"#/components/schemas/ApproveEvent","deny":"#/components/schemas/DenyEvent","review":"#/components/schemas/ReviewEvent","dataProductPolicy":"#/components/schemas/DataProductPolicyEvent"}}},"ApproveEvent":{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}}}},"required":["type","params"]},"DenyEvent":{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},"ReviewEvent":{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"description":"Array of stages for manual review","type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["USER"]},"id":{"description":"Entity ID","type":"string"},"displayName":{"description":"Entity display name","type":"string"}},"required":["type","id"]},{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["GROUP"]},"id":{"description":"Entity ID","type":"number"},"iamId":{"description":"IAM ID","type":"string"},"name":{"description":"Entity display name","type":"string"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"description":"Global permission","type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"]}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"description":"Domain permission","type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"]},"domainId":{"description":"Domain ID","type":"string"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"description":"Attribute key","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["type","key","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["CATALOG PERMISSION"]}},"required":["type"]}]}}},"required":["all"]},{"type":"object","properties":{"any":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["USER"]},"id":{"description":"Entity ID","type":"string"},"displayName":{"description":"Entity display name","type":"string"}},"required":["type","id"]},{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["GROUP"]},"id":{"description":"Entity ID","type":"number"},"iamId":{"description":"IAM ID","type":"string"},"name":{"description":"Entity display name","type":"string"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"description":"Global permission","type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"]}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"description":"Domain permission","type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"]},"domainId":{"description":"Domain ID","type":"string"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"description":"Attribute key","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["type","key","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["CATALOG PERMISSION"]}},"required":["type"]}]}}},"required":["any"]}]}}},"required":["stages"]}},"required":["type","params"]},"DataProductPolicyEvent":{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]},"AugmentedZodDto":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/api/request-form":{"get":{"description":"Search request forms in the marketplace using the provided filters","operationId":"searchRequestForms","parameters":[{"name":"offset","required":false,"in":"query","schema":{"minimum":0,"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"minimum":1,"default":10,"type":"number"}},{"name":"sortOrder","required":false,"in":"query","schema":{"default":"asc","type":"string","enum":["asc","desc"]}},{"name":"sortBy","required":false,"in":"query","schema":{"default":"name","type":"string","enum":["name","createdAt","updatedAt"]}},{"name":"nameFilter","required":false,"in":"query","description":"Filter results by request form name","schema":{"default":"","type":"string"}},{"name":"exactMatch","required":false,"in":"query","description":"Whether the filter should be an exact match","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRequestForm"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AugmentedZodDto"}}}}},"summary":"Search request forms","tags":["Request Form"]}}}}
```

## Create request form

> Create a request form

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Request Form","description":"APIs for managing request forms"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateRequestForm":{"type":"object","properties":{"name":{"type":"string"},"fields":{"title":"RequestFormFields","type":"array","items":{"$ref":"#/components/schemas/RequestFormField"}},"policy":{"type":"object","properties":{"version":{"description":"Policy schema version","type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleProperties"}},"defaultEvent":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["rules","defaultEvent"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"dataUseAgreementIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"}}},"required":["name","fields","policy"]},"RequestFormField":{"oneOf":[{"$ref":"#/components/schemas/SelectionFormField"},{"$ref":"#/components/schemas/ShortAnswerFormField"},{"$ref":"#/components/schemas/AccessDurationFormField"}],"discriminator":{"propertyName":"type","mapping":{"DROPDOWN":"#/components/schemas/SelectionFormField","CHECKBOXES":"#/components/schemas/SelectionFormField","SHORT_ANSWER":"#/components/schemas/ShortAnswerFormField","ACCESS_DURATION":"#/components/schemas/AccessDurationFormField"}}},"SelectionFormField":{"title":"Selection Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["DROPDOWN","CHECKBOXES"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}}},"required":["id","type","label","options"]},"ShortAnswerFormField":{"title":"Short Answer Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"]},"AccessDurationFormField":{"title":"Access Duration Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["ACCESS_DURATION"]},"label":{"type":"string","enum":["How long do you need access to this data?"]},"required":{"type":"boolean","enum":[true]}},"required":["id","type","label","required"]},"RuleProperties":{"type":"object","properties":{"conditions":{"oneOf":[{"$ref":"#/components/schemas/AllConditions"},{"$ref":"#/components/schemas/AnyConditions"},{"$ref":"#/components/schemas/NotConditions"}]},"event":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["conditions","event"]},"AllConditions":{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},"AnyConditions":{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},"NotConditions":{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false},"ReviewPolicyEvent":{"oneOf":[{"$ref":"#/components/schemas/ApproveEvent"},{"$ref":"#/components/schemas/DenyEvent"},{"$ref":"#/components/schemas/ReviewEvent"},{"$ref":"#/components/schemas/DataProductPolicyEvent"}],"discriminator":{"propertyName":"type","mapping":{"approve":"#/components/schemas/ApproveEvent","deny":"#/components/schemas/DenyEvent","review":"#/components/schemas/ReviewEvent","dataProductPolicy":"#/components/schemas/DataProductPolicyEvent"}}},"ApproveEvent":{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}}}},"required":["type","params"]},"DenyEvent":{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},"ReviewEvent":{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"description":"Array of stages for manual review","type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["USER"]},"id":{"description":"Entity ID","type":"string"},"displayName":{"description":"Entity display name","type":"string"}},"required":["type","id"]},{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["GROUP"]},"id":{"description":"Entity ID","type":"number"},"iamId":{"description":"IAM ID","type":"string"},"name":{"description":"Entity display name","type":"string"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"description":"Global permission","type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"]}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"description":"Domain permission","type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"]},"domainId":{"description":"Domain ID","type":"string"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"description":"Attribute key","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["type","key","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["CATALOG PERMISSION"]}},"required":["type"]}]}}},"required":["all"]},{"type":"object","properties":{"any":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["USER"]},"id":{"description":"Entity ID","type":"string"},"displayName":{"description":"Entity display name","type":"string"}},"required":["type","id"]},{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["GROUP"]},"id":{"description":"Entity ID","type":"number"},"iamId":{"description":"IAM ID","type":"string"},"name":{"description":"Entity display name","type":"string"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"description":"Global permission","type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"]}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"description":"Domain permission","type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"]},"domainId":{"description":"Domain ID","type":"string"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"description":"Attribute key","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["type","key","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["CATALOG PERMISSION"]}},"required":["type"]}]}}},"required":["any"]}]}}},"required":["stages"]}},"required":["type","params"]},"DataProductPolicyEvent":{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]},"RequestForm":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"type":"string"},"fields":{"title":"RequestFormFields","type":"array","items":{"$ref":"#/components/schemas/RequestFormField"}},"policy":{"type":"object","properties":{"version":{"description":"Policy schema version","type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleProperties"}},"defaultEvent":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"title":"Request Form Data Use Agreements","default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"The name of data use agreement","type":"string"},"body":{"description":"The contents of data use agreement","type":"string"}},"required":["id","name","body"]}},"createdBy":{"description":"The user who originally created the request form","type":"object","properties":{"globalUserId":{"description":"Immuta global user ID","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"Display name","type":"string"}},"required":["globalUserId","name"]},"createdAt":{"description":"The date when the request form was originally created","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedBy":{"description":"The user who last updated the request form","type":"object","properties":{"globalUserId":{"description":"Immuta global user ID","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"Display name","type":"string"}},"required":["globalUserId","name"]},"updatedAt":{"description":"The date when the request form was last updated","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"version":{"description":"The current version of the request form","type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"}},"required":["id","name","fields","policy","createdBy","createdAt","updatedBy","updatedAt","version"],"title":"Request Form"},"AugmentedZodDto":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/api/request-form":{"post":{"description":"Create a request form","operationId":"createRequestForm","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestForm"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForm"}}}},"409":{"description":"Request form with name already exists."},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AugmentedZodDto"}}}}},"summary":"Create request form","tags":["Request Form"]}}}}
```

## Get request form by ID

> Get request form by ID

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Request Form","description":"APIs for managing request forms"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"RequestForm":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"type":"string"},"fields":{"title":"RequestFormFields","type":"array","items":{"$ref":"#/components/schemas/RequestFormField"}},"policy":{"type":"object","properties":{"version":{"description":"Policy schema version","type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleProperties"}},"defaultEvent":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"title":"Request Form Data Use Agreements","default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"The name of data use agreement","type":"string"},"body":{"description":"The contents of data use agreement","type":"string"}},"required":["id","name","body"]}},"createdBy":{"description":"The user who originally created the request form","type":"object","properties":{"globalUserId":{"description":"Immuta global user ID","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"Display name","type":"string"}},"required":["globalUserId","name"]},"createdAt":{"description":"The date when the request form was originally created","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedBy":{"description":"The user who last updated the request form","type":"object","properties":{"globalUserId":{"description":"Immuta global user ID","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"Display name","type":"string"}},"required":["globalUserId","name"]},"updatedAt":{"description":"The date when the request form was last updated","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"version":{"description":"The current version of the request form","type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"}},"required":["id","name","fields","policy","createdBy","createdAt","updatedBy","updatedAt","version"],"title":"Request Form"},"RequestFormField":{"oneOf":[{"$ref":"#/components/schemas/SelectionFormField"},{"$ref":"#/components/schemas/ShortAnswerFormField"},{"$ref":"#/components/schemas/AccessDurationFormField"}],"discriminator":{"propertyName":"type","mapping":{"DROPDOWN":"#/components/schemas/SelectionFormField","CHECKBOXES":"#/components/schemas/SelectionFormField","SHORT_ANSWER":"#/components/schemas/ShortAnswerFormField","ACCESS_DURATION":"#/components/schemas/AccessDurationFormField"}}},"SelectionFormField":{"title":"Selection Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["DROPDOWN","CHECKBOXES"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}}},"required":["id","type","label","options"]},"ShortAnswerFormField":{"title":"Short Answer Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"]},"AccessDurationFormField":{"title":"Access Duration Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["ACCESS_DURATION"]},"label":{"type":"string","enum":["How long do you need access to this data?"]},"required":{"type":"boolean","enum":[true]}},"required":["id","type","label","required"]},"RuleProperties":{"type":"object","properties":{"conditions":{"oneOf":[{"$ref":"#/components/schemas/AllConditions"},{"$ref":"#/components/schemas/AnyConditions"},{"$ref":"#/components/schemas/NotConditions"}]},"event":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["conditions","event"]},"AllConditions":{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},"AnyConditions":{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},"NotConditions":{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false},"ReviewPolicyEvent":{"oneOf":[{"$ref":"#/components/schemas/ApproveEvent"},{"$ref":"#/components/schemas/DenyEvent"},{"$ref":"#/components/schemas/ReviewEvent"},{"$ref":"#/components/schemas/DataProductPolicyEvent"}],"discriminator":{"propertyName":"type","mapping":{"approve":"#/components/schemas/ApproveEvent","deny":"#/components/schemas/DenyEvent","review":"#/components/schemas/ReviewEvent","dataProductPolicy":"#/components/schemas/DataProductPolicyEvent"}}},"ApproveEvent":{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}}}},"required":["type","params"]},"DenyEvent":{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},"ReviewEvent":{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"description":"Array of stages for manual review","type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["USER"]},"id":{"description":"Entity ID","type":"string"},"displayName":{"description":"Entity display name","type":"string"}},"required":["type","id"]},{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["GROUP"]},"id":{"description":"Entity ID","type":"number"},"iamId":{"description":"IAM ID","type":"string"},"name":{"description":"Entity display name","type":"string"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"description":"Global permission","type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"]}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"description":"Domain permission","type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"]},"domainId":{"description":"Domain ID","type":"string"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"description":"Attribute key","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["type","key","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["CATALOG PERMISSION"]}},"required":["type"]}]}}},"required":["all"]},{"type":"object","properties":{"any":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["USER"]},"id":{"description":"Entity ID","type":"string"},"displayName":{"description":"Entity display name","type":"string"}},"required":["type","id"]},{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["GROUP"]},"id":{"description":"Entity ID","type":"number"},"iamId":{"description":"IAM ID","type":"string"},"name":{"description":"Entity display name","type":"string"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"description":"Global permission","type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"]}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"description":"Domain permission","type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"]},"domainId":{"description":"Domain ID","type":"string"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"description":"Attribute key","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["type","key","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["CATALOG PERMISSION"]}},"required":["type"]}]}}},"required":["any"]}]}}},"required":["stages"]}},"required":["type","params"]},"DataProductPolicyEvent":{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]},"AugmentedZodDto":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/api/request-form/{id}":{"get":{"description":"Get request form by ID","operationId":"getRequestFormById","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForm"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AugmentedZodDto"}}}}},"summary":"Get request form by ID","tags":["Request Form"]}}}}
```

## Update request form by ID

> Update a request form

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Request Form","description":"APIs for managing request forms"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateRequestForm":{"type":"object","properties":{"name":{"type":"string"},"fields":{"title":"RequestFormFields","type":"array","items":{"$ref":"#/components/schemas/RequestFormField"}},"policy":{"type":"object","properties":{"version":{"description":"Policy schema version","type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleProperties"}},"defaultEvent":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["rules","defaultEvent"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"dataUseAgreementIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"}}}},"RequestFormField":{"oneOf":[{"$ref":"#/components/schemas/SelectionFormField"},{"$ref":"#/components/schemas/ShortAnswerFormField"},{"$ref":"#/components/schemas/AccessDurationFormField"}],"discriminator":{"propertyName":"type","mapping":{"DROPDOWN":"#/components/schemas/SelectionFormField","CHECKBOXES":"#/components/schemas/SelectionFormField","SHORT_ANSWER":"#/components/schemas/ShortAnswerFormField","ACCESS_DURATION":"#/components/schemas/AccessDurationFormField"}}},"SelectionFormField":{"title":"Selection Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["DROPDOWN","CHECKBOXES"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}}},"required":["id","type","label","options"]},"ShortAnswerFormField":{"title":"Short Answer Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"]},"AccessDurationFormField":{"title":"Access Duration Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["ACCESS_DURATION"]},"label":{"type":"string","enum":["How long do you need access to this data?"]},"required":{"type":"boolean","enum":[true]}},"required":["id","type","label","required"]},"RuleProperties":{"type":"object","properties":{"conditions":{"oneOf":[{"$ref":"#/components/schemas/AllConditions"},{"$ref":"#/components/schemas/AnyConditions"},{"$ref":"#/components/schemas/NotConditions"}]},"event":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["conditions","event"]},"AllConditions":{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},"AnyConditions":{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},"NotConditions":{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false},"ReviewPolicyEvent":{"oneOf":[{"$ref":"#/components/schemas/ApproveEvent"},{"$ref":"#/components/schemas/DenyEvent"},{"$ref":"#/components/schemas/ReviewEvent"},{"$ref":"#/components/schemas/DataProductPolicyEvent"}],"discriminator":{"propertyName":"type","mapping":{"approve":"#/components/schemas/ApproveEvent","deny":"#/components/schemas/DenyEvent","review":"#/components/schemas/ReviewEvent","dataProductPolicy":"#/components/schemas/DataProductPolicyEvent"}}},"ApproveEvent":{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}}}},"required":["type","params"]},"DenyEvent":{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},"ReviewEvent":{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"description":"Array of stages for manual review","type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["USER"]},"id":{"description":"Entity ID","type":"string"},"displayName":{"description":"Entity display name","type":"string"}},"required":["type","id"]},{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["GROUP"]},"id":{"description":"Entity ID","type":"number"},"iamId":{"description":"IAM ID","type":"string"},"name":{"description":"Entity display name","type":"string"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"description":"Global permission","type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"]}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"description":"Domain permission","type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"]},"domainId":{"description":"Domain ID","type":"string"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"description":"Attribute key","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["type","key","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["CATALOG PERMISSION"]}},"required":["type"]}]}}},"required":["all"]},{"type":"object","properties":{"any":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["USER"]},"id":{"description":"Entity ID","type":"string"},"displayName":{"description":"Entity display name","type":"string"}},"required":["type","id"]},{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["GROUP"]},"id":{"description":"Entity ID","type":"number"},"iamId":{"description":"IAM ID","type":"string"},"name":{"description":"Entity display name","type":"string"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"description":"Global permission","type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"]}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"description":"Domain permission","type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"]},"domainId":{"description":"Domain ID","type":"string"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"description":"Attribute key","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["type","key","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["CATALOG PERMISSION"]}},"required":["type"]}]}}},"required":["any"]}]}}},"required":["stages"]}},"required":["type","params"]},"DataProductPolicyEvent":{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]},"RequestForm":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"type":"string"},"fields":{"title":"RequestFormFields","type":"array","items":{"$ref":"#/components/schemas/RequestFormField"}},"policy":{"type":"object","properties":{"version":{"description":"Policy schema version","type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleProperties"}},"defaultEvent":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"title":"Request Form Data Use Agreements","default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"The name of data use agreement","type":"string"},"body":{"description":"The contents of data use agreement","type":"string"}},"required":["id","name","body"]}},"createdBy":{"description":"The user who originally created the request form","type":"object","properties":{"globalUserId":{"description":"Immuta global user ID","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"Display name","type":"string"}},"required":["globalUserId","name"]},"createdAt":{"description":"The date when the request form was originally created","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedBy":{"description":"The user who last updated the request form","type":"object","properties":{"globalUserId":{"description":"Immuta global user ID","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"Display name","type":"string"}},"required":["globalUserId","name"]},"updatedAt":{"description":"The date when the request form was last updated","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"version":{"description":"The current version of the request form","type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"}},"required":["id","name","fields","policy","createdBy","createdAt","updatedBy","updatedAt","version"],"title":"Request Form"},"AugmentedZodDto":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/api/request-form/{id}":{"put":{"description":"Update a request form","operationId":"updateRequestForm","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRequestForm"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForm"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AugmentedZodDto"}}}}},"summary":"Update request form by ID","tags":["Request Form"]}}}}
```

## Delete request form by ID

> Delete a request form

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Request Form","description":"APIs for managing request forms"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"AugmentedZodDto":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/api/request-form/{id}":{"delete":{"description":"Delete a request form","operationId":"deleteRequestFormById","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AugmentedZodDto"}}}}},"summary":"Delete request form by ID","tags":["Request Form"]}}}}
```

## Get request form by version

> Get request form by its version

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Request Form","description":"APIs for managing request forms"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"RequestForm":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"type":"string"},"fields":{"title":"RequestFormFields","type":"array","items":{"$ref":"#/components/schemas/RequestFormField"}},"policy":{"type":"object","properties":{"version":{"description":"Policy schema version","type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleProperties"}},"defaultEvent":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"title":"Request Form Data Use Agreements","default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"The name of data use agreement","type":"string"},"body":{"description":"The contents of data use agreement","type":"string"}},"required":["id","name","body"]}},"createdBy":{"description":"The user who originally created the request form","type":"object","properties":{"globalUserId":{"description":"Immuta global user ID","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"Display name","type":"string"}},"required":["globalUserId","name"]},"createdAt":{"description":"The date when the request form was originally created","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedBy":{"description":"The user who last updated the request form","type":"object","properties":{"globalUserId":{"description":"Immuta global user ID","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"name":{"description":"Display name","type":"string"}},"required":["globalUserId","name"]},"updatedAt":{"description":"The date when the request form was last updated","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"version":{"description":"The current version of the request form","type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"}},"required":["id","name","fields","policy","createdBy","createdAt","updatedBy","updatedAt","version"],"title":"Request Form"},"RequestFormField":{"oneOf":[{"$ref":"#/components/schemas/SelectionFormField"},{"$ref":"#/components/schemas/ShortAnswerFormField"},{"$ref":"#/components/schemas/AccessDurationFormField"}],"discriminator":{"propertyName":"type","mapping":{"DROPDOWN":"#/components/schemas/SelectionFormField","CHECKBOXES":"#/components/schemas/SelectionFormField","SHORT_ANSWER":"#/components/schemas/ShortAnswerFormField","ACCESS_DURATION":"#/components/schemas/AccessDurationFormField"}}},"SelectionFormField":{"title":"Selection Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["DROPDOWN","CHECKBOXES"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}}},"required":["id","type","label","options"]},"ShortAnswerFormField":{"title":"Short Answer Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"]},"AccessDurationFormField":{"title":"Access Duration Form Field","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"type":{"type":"string","enum":["ACCESS_DURATION"]},"label":{"type":"string","enum":["How long do you need access to this data?"]},"required":{"type":"boolean","enum":[true]}},"required":["id","type","label","required"]},"RuleProperties":{"type":"object","properties":{"conditions":{"oneOf":[{"$ref":"#/components/schemas/AllConditions"},{"$ref":"#/components/schemas/AnyConditions"},{"$ref":"#/components/schemas/NotConditions"}]},"event":{"$ref":"#/components/schemas/ReviewPolicyEvent"}},"required":["conditions","event"]},"AllConditions":{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},"AnyConditions":{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},"NotConditions":{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false},"ReviewPolicyEvent":{"oneOf":[{"$ref":"#/components/schemas/ApproveEvent"},{"$ref":"#/components/schemas/DenyEvent"},{"$ref":"#/components/schemas/ReviewEvent"},{"$ref":"#/components/schemas/DataProductPolicyEvent"}],"discriminator":{"propertyName":"type","mapping":{"approve":"#/components/schemas/ApproveEvent","deny":"#/components/schemas/DenyEvent","review":"#/components/schemas/ReviewEvent","dataProductPolicy":"#/components/schemas/DataProductPolicyEvent"}}},"ApproveEvent":{"type":"object","properties":{"type":{"type":"string","enum":["approve"]},"params":{"type":"object","properties":{"comment":{"type":"string"},"duration":{"type":"number","minimum":1},"durationUnit":{"type":"string","enum":["HOURS","DAYS","WEEKS","MONTHS","YEARS"]}}}},"required":["type","params"]},"DenyEvent":{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},"ReviewEvent":{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"description":"Array of stages for manual review","type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["USER"]},"id":{"description":"Entity ID","type":"string"},"displayName":{"description":"Entity display name","type":"string"}},"required":["type","id"]},{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["GROUP"]},"id":{"description":"Entity ID","type":"number"},"iamId":{"description":"IAM ID","type":"string"},"name":{"description":"Entity display name","type":"string"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"description":"Global permission","type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"]}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"description":"Domain permission","type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"]},"domainId":{"description":"Domain ID","type":"string"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"description":"Attribute key","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["type","key","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["CATALOG PERMISSION"]}},"required":["type"]}]}}},"required":["all"]},{"type":"object","properties":{"any":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["USER"]},"id":{"description":"Entity ID","type":"string"},"displayName":{"description":"Entity display name","type":"string"}},"required":["type","id"]},{"type":"object","properties":{"type":{"description":"Entity type","type":"string","enum":["GROUP"]},"id":{"description":"Entity ID","type":"number"},"iamId":{"description":"IAM ID","type":"string"},"name":{"description":"Entity display name","type":"string"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"description":"Global permission","type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"]}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"description":"Domain permission","type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"]},"domainId":{"description":"Domain ID","type":"string"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"description":"Attribute key","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["type","key","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["CATALOG PERMISSION"]}},"required":["type"]}]}}},"required":["any"]}]}}},"required":["stages"]}},"required":["type","params"]},"DataProductPolicyEvent":{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]},"AugmentedZodDto":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/api/request-form/version/{version}":{"get":{"description":"Get request form by its version","operationId":"getRequestFormByVersion","parameters":[{"name":"version","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForm"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AugmentedZodDto"}}}}},"summary":"Get request form by version","tags":["Request Form"]}}}}
```

## Get data products assigned to the request form

> Get the data products assigned to the request form

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Request Form","description":"APIs for managing request forms"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"LinkedDataProducts":{"description":"The data products linked to the request form","type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"}]},"name":{"description":"Data product name","type":"string","minLength":1,"maxLength":255,"pattern":"^[\\p{L}\\p{M}\\p{N})(\\-_/\\\\\\s]*$"},"requestTypes":{"description":"Request types linking this data product to the request form","type":"array","items":{"type":"string","enum":["DATA_ACCESS","MASKING_EXCEPTION"]}}},"required":["id","name","requestTypes"]}},"AugmentedZodDto":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/api/request-form/{id}/data-products":{"get":{"description":"Get the data products assigned to the request form","operationId":"getDataProducts","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedDataProducts"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AugmentedZodDto"}}}}},"summary":"Get data products assigned to the request form","tags":["Request Form"]}}}}
```

## Get assets assigned to the request form

> Get the assets assigned to the request form

```json
{"openapi":"3.0.0","info":{"title":"Immuta Data Marketplace","version":"1.0"},"tags":[{"name":"Request Form","description":"APIs for managing request forms"}],"servers":[{"url":"https://{global-segment}.api.immutacloud.com/marketplace","description":"Marketplace API Endpoint","variables":{"global-segment":{"default":"na","enum":["na","eu","ap"],"description":"Marketplace API global segment"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"LinkedAssets":{"description":"The assets linked to the request form","type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"}]},"name":{"description":"Asset name","type":"string","minLength":1},"type":{"type":"string","enum":["DATA_PRODUCT","DATA_OBJECT"]},"requestType":{"type":"string","enum":["DATA_ACCESS","MASKING_EXCEPTION"]}},"required":["id","name","type","requestType"]}},"AugmentedZodDto":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/api/request-form/{id}/assets":{"get":{"description":"Get the assets assigned to the request form","operationId":"getAssets","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedAssets"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AugmentedZodDto"}}}}},"summary":"Get assets assigned to the request form","tags":["Request Form"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.immuta.com/saas/developer-guides/api-intro/marketplace-api/request-form.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.