> 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"},"name":{"type":"string"},"fields":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Selection Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"],"title":"Short Answer Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Access Duration Form Field"}]},"title":"RequestFormFields"},"policy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of data use agreement"},"body":{"type":"string","description":"The contents of data use agreement"}},"required":["id","name","body"]},"title":"Request Form Data Use Agreements"},"createdBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who originally created the request form"},"createdAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"updatedBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who last updated the request form"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"version":{"type":"string","format":"cuid","description":"The current version of the request form"},"associatedDomains":{"type":"array","items":{"type":"string"},"description":"Domains associated with data products associated with this request form."}},"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"]}}},"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":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRequestForm"}}}}},"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":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Selection Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"],"title":"Short Answer Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Access Duration Form Field"}]},"title":"RequestFormFields"},"policy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["rules","defaultEvent"]},"id":{"type":"string","format":"uuid"},"dataUseAgreementIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["name","fields","policy"]},"RequestForm":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"fields":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Selection Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"],"title":"Short Answer Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Access Duration Form Field"}]},"title":"RequestFormFields"},"policy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of data use agreement"},"body":{"type":"string","description":"The contents of data use agreement"}},"required":["id","name","body"]},"title":"Request Form Data Use Agreements"},"createdBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who originally created the request form"},"createdAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"updatedBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who last updated the request form"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"version":{"type":"string","format":"cuid","description":"The current version of the request form"}},"required":["id","name","fields","policy","createdBy","createdAt","updatedBy","updatedAt","version"],"title":"Request Form"}}},"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."}},"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"},"name":{"type":"string"},"fields":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Selection Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"],"title":"Short Answer Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Access Duration Form Field"}]},"title":"RequestFormFields"},"policy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of data use agreement"},"body":{"type":"string","description":"The contents of data use agreement"}},"required":["id","name","body"]},"title":"Request Form Data Use Agreements"},"createdBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who originally created the request form"},"createdAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"updatedBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who last updated the request form"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"version":{"type":"string","format":"cuid","description":"The current version of the request form"}},"required":["id","name","fields","policy","createdBy","createdAt","updatedBy","updatedAt","version"],"title":"Request Form"}}},"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"}}}}},"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":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Selection Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"],"title":"Short Answer Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Access Duration Form Field"}]},"title":"RequestFormFields"},"policy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["rules","defaultEvent"]},"id":{"type":"string","format":"uuid"},"dataUseAgreementIds":{"type":"array","items":{"type":"string","format":"uuid"}}}},"RequestForm":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"fields":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Selection Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"],"title":"Short Answer Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Access Duration Form Field"}]},"title":"RequestFormFields"},"policy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of data use agreement"},"body":{"type":"string","description":"The contents of data use agreement"}},"required":["id","name","body"]},"title":"Request Form Data Use Agreements"},"createdBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who originally created the request form"},"createdAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"updatedBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who last updated the request form"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"version":{"type":"string","format":"cuid","description":"The current version of the request form"}},"required":["id","name","fields","policy","createdBy","createdAt","updatedBy","updatedAt","version"],"title":"Request Form"}}},"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"}}}}},"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"}}},"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":""}},"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"},"name":{"type":"string"},"fields":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Selection Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SHORT_ANSWER"]},"label":{"type":"string"},"required":{"default":true,"type":"boolean"}},"required":["id","type","label"],"title":"Short Answer Form Field"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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"],"title":"Access Duration Form Field"}]},"title":"RequestFormFields"},"policy":{"type":"object","properties":{"version":{"type":"string","description":"Policy schema version"},"rules":{"type":"array","items":{"type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"type":"array","items":{}}},"required":["any"],"additionalProperties":false},{"type":"object","properties":{"not":{}},"required":["not"],"additionalProperties":false}]},"event":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["conditions","event"]}},"defaultEvent":{"discriminator":{"propertyName":"type"},"oneOf":[{"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"]}},"additionalProperties":false}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["deny"]},"params":{"type":"object","properties":{"comment":{"type":"string"}}}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["review"]},"params":{"type":"object","properties":{"stages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["all"]},{"type":"object","properties":{"any":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["USER"],"description":"Entity type"},"id":{"type":"string","description":"Entity ID"},"displayName":{"type":"string","description":"Entity display name"}},"required":["type","id"]},{"type":"object","properties":{"type":{"type":"string","enum":["GROUP"],"description":"Entity type"},"id":{"type":"number","description":"Entity ID"},"iamId":{"type":"string","description":"IAM ID"},"name":{"type":"string","description":"Entity display name"}},"required":["type","name"]},{"type":"object","properties":{"type":{"type":"string","enum":["PERMISSION"]},"permission":{"type":"string","enum":["GOVERNANCE","USER_ADMIN","AUDIT"],"description":"Global permission"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["DOMAIN PERMISSION"]},"permission":{"type":"string","enum":["Manage Policies","Audit Activity","Manage Data Products","Manage Identifiers"],"description":"Domain permission"},"domainId":{"type":"string","description":"Domain ID"}},"required":["type","permission"]},{"type":"object","properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"key":{"type":"string","description":"Attribute key"},"value":{"type":"string","description":"Attribute value"}},"required":["type","key","value"]}]},"minItems":1}},"required":["any"]}]},"description":"Array of stages for manual review"}},"required":["stages"]}},"required":["type","params"]},{"type":"object","properties":{"type":{"type":"string","enum":["dataProductPolicy"]}},"required":["type"]}]}},"required":["rules","defaultEvent"]},"dataUseAgreements":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of data use agreement"},"body":{"type":"string","description":"The contents of data use agreement"}},"required":["id","name","body"]},"title":"Request Form Data Use Agreements"},"createdBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who originally created the request form"},"createdAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"updatedBy":{"type":"object","properties":{"globalUserId":{"type":"string","format":"uuid","description":"Immuta global user ID"},"name":{"type":"string","description":"Display name"}},"required":["globalUserId","name"],"description":"The user who last updated the request form"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}]},"version":{"type":"string","format":"cuid","description":"The current version of the request form"}},"required":["id","name","fields","policy","createdBy","createdAt","updatedBy","updatedAt","version"],"title":"Request Form"}}},"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"}}}}},"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":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","format":"cuid"},{"type":"string","format":"uuid"}]},"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9)(\\-_/\\\\\\s]*$","description":"Data product name"}},"required":["id","name"]},"description":"The data products linked to the request form"}}},"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"}}}}},"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":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Asset ID"},"name":{"type":"string","minLength":1,"description":"Asset name"}},"required":["id","name"]},"description":"The assets linked to the request form"}}},"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"}}}}},"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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://documentation.immuta.com/saas/developer-guides/api-intro/marketplace-api/request-form.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.