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

Prescriptive Paths

Manage prescriptive paths.

Lists all available prescriptive paths

get

Returns the prescriptive path information for the asset type with the specified ID.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Responses
200

All available prescriptive paths.

application/json
descriptionstringOptional
assetTypeIdstring · uuidRequired

The ID of the prescriptive path's asset type.

createdBystring · uuidRequired

Id of the Collibra user who created this group

createdOninteger · int64Required

Timestamp when this prescriptive path was created

lastModifiedBystring · uuidRequired

Id of the Collibra user who last updated this prescriptive path

lastModifiedOninteger · int64Required

Timestamp when this prescriptive path has last been updated

get/prescriptivePaths

Add a new prescriptive path

post

Adds a new prescriptive path.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body
descriptionstringOptional
assetTypeIdstring · uuidRequired

The ID of the prescriptive path's asset type.

Responses
201

The prescriptive path has been added.

application/json
post/prescriptivePaths

List asset types supported by Protect

get
Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Responses
200

The list of asset type ids supported by Protect.

application/json
string · uuid[]Optional

An array of asset type ids.

get/prescriptivePaths/assetTypes

Retrieve a prescriptive path

get

Returns the prescriptive path information for the asset type with the specified ID.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
assetTypeIdstring · uuidRequired

The universally unique identifier (UUID) of the asset type.

Responses
200

The prescriptive path information for the asset type with the specified ID.

application/json
descriptionstringOptional
assetTypeIdstring · uuidRequired

The ID of the prescriptive path's asset type.

createdBystring · uuidRequired

Id of the Collibra user who created this group

createdOninteger · int64Required

Timestamp when this prescriptive path was created

lastModifiedBystring · uuidRequired

Id of the Collibra user who last updated this prescriptive path

lastModifiedOninteger · int64Required

Timestamp when this prescriptive path has last been updated

get/prescriptivePaths/{assetTypeId}

Delete a prescriptive path

delete

Deletes the prescriptive path for the asset type with the specified ID.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
assetTypeIdstring · uuidRequired

The universally unique identifier (UUID) of the asset type.

Responses
204

The prescriptive path has been deleted.

No content

delete/prescriptivePaths/{assetTypeId}

No content

Update a prescriptive path

patch

Updates the prescriptive path for the asset type with the specified ID.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
assetTypeIdstring · uuidRequired

The universally unique identifier (UUID) of the asset type.

Body
descriptionstringOptional
Responses
200

The prescriptive path has been updated.

application/json
descriptionstringOptional
assetTypeIdstring · uuidRequired

The ID of the prescriptive path's asset type.

createdBystring · uuidRequired

Id of the Collibra user who created this group

createdOninteger · int64Required

Timestamp when this prescriptive path was created

lastModifiedBystring · uuidRequired

Id of the Collibra user who last updated this prescriptive path

lastModifiedOninteger · int64Required

Timestamp when this prescriptive path has last been updated

patch/prescriptivePaths/{assetTypeId}

Last updated

Was this helpful?