Manage Data Products
Publishing a data product
With the UI
With the API
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestring · min: 1 · max: 64RequiredPattern:
Data product name
^[a-zA-Z0-9)(\-_/\\\s]*$descriptionone of | nullableOptional
Data product description
stringOptionalExample:
Data product description
All sales records from the current fiscal yearmetadataone of | nullableRequired
domainsstring[]RequiredExample:
["4d004a3a-4568-4c1d-822e-30958ef898dc"]idstring · uuidOptional
Data product ID
requestFormIdone ofRequired
string · cuidOptional
string · uuidOptional
Responses
201Success
application/json
409
Data Product name in use.
post
/api/data-productRemove members from data products
With the UI
With the API
Editing data products
With the UI
With the API
Update the request form
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired
idstring · uuidOptional
dataUseAgreementIdsstring · uuid[]Optional
Responses
201Success
application/json
409
Request form with name already exists.
post
/api/request-formAuthorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
namestring · min: 1 · max: 64OptionalPattern:
Data product name
^[a-zA-Z0-9)(\-_/\\\s]*$descriptionone of | nullableOptional
Data product description
stringOptionalExample:
Data product description
All sales records from the current fiscal yearmetadataone of | nullableOptional
domainsstring[]OptionalExample:
["4d004a3a-4568-4c1d-822e-30958ef898dc"]idstring · uuidOptional
Data product ID
requestFormIdone ofOptional
string · cuidOptional
string · uuidOptional
suspendedbooleanOptionalExample:
Whether access to the data product's data sources is suspended
falseResponses
200Success
application/json
put
/api/data-product/{id}200Success
Update the data sources
Suspend access to data products
With the UI
With the API
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
namestring · min: 1 · max: 64OptionalPattern:
Data product name
^[a-zA-Z0-9)(\-_/\\\s]*$descriptionone of | nullableOptional
Data product description
stringOptionalExample:
Data product description
All sales records from the current fiscal yearmetadataone of | nullableOptional
domainsstring[]OptionalExample:
["4d004a3a-4568-4c1d-822e-30958ef898dc"]idstring · uuidOptional
Data product ID
requestFormIdone ofOptional
string · cuidOptional
string · uuidOptional
suspendedbooleanOptionalExample:
Whether access to the data product's data sources is suspended
falseResponses
200Success
application/json
put
/api/data-product/{id}200Success
Deleting data products
With the UI
With the API
Last updated
Was this helpful?

