For the complete documentation index, see llms.txt. This page is also available as Markdown.

Request Form

APIs for managing request forms

Search request forms

get

Search request forms in the marketplace using the provided filters

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
offsetnumberOptionalDefault: 0
limitnumber · min: 1OptionalDefault: 10
sortOrderstring · enumOptionalDefault: ascPossible values:
sortBystring · enumOptionalDefault: namePossible values:
nameFilterstringOptional

Filter results by request form name

Default: ""
exactMatchbooleanOptional

Whether the filter should be an exact match

Default: false
Responses
200Success
application/json
get
/api/request-form
200Success

Create request form

post

Create a request form

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired
idstring · uuidOptional
dataUseAgreementIdsstring · uuid[]Optional
Responses
post
/api/request-form

Get request form by ID

get

Get request form by ID

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200Success
application/json
idstring · uuidRequired
namestringRequired
createdAtone ofRequired
string · date-timeOptional
or
string · date-timeOptional
updatedAtone ofRequired
string · date-timeOptional
or
string · date-timeOptional
versionstring · cuidRequired

The current version of the request form

get
/api/request-form/{id}
200Success

Update request form by ID

put

Update a request form

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
namestringOptional
idstring · uuidOptional
dataUseAgreementIdsstring · uuid[]Optional
Responses
put
/api/request-form/{id}
201Success

Delete request form by ID

delete

Delete a request form

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
delete
/api/request-form/{id}
204Success

No content

Get request form by version

get

Get request form by its version

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
versionstringRequired
Responses
200Success
application/json
idstring · uuidRequired
namestringRequired
createdAtone ofRequired
string · date-timeOptional
or
string · date-timeOptional
updatedAtone ofRequired
string · date-timeOptional
or
string · date-timeOptional
versionstring · cuidRequired

The current version of the request form

get
/api/request-form/version/{version}
200Success

Get data products assigned to the request form

get

Get the data products assigned to the request form

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200Success
application/json

The data products linked to the request form

idone ofRequired
string · cuidOptional
or
string · uuidOptional
namestring · min: 1 · max: 255Required

Data product name

Pattern: ^[a-zA-Z0-9)(\-_/\\\s]*$
get
/api/request-form/{id}/data-products
200Success

Get assets assigned to the request form

get

Get the assets assigned to the request form

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200Success
application/json

The assets linked to the request form

idstring · uuidRequired

Asset ID

namestring · min: 1Required

Asset name

get
/api/request-form/{id}/assets
200Success

Last updated

Was this helpful?