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

basicAuthjwtAuth

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

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error has occurred.

application/json

get/prescriptivePaths

HTTPcURLJavaScriptPython

GET /rest/protect/v1/prescriptivePaths HTTP/1.1
Authorization: Basic username:password
Accept: */*

[
  {
    "description": "text",
    "relations": [
      {
        "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "relationTypeDirection": "text",
        "assetType": {
          "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "[Circular Reference]"
        }
      }
    ]
  }
]

Add a new prescriptive path

post

Adds a new prescriptive path.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

application/json

descriptionstringOptional

assetTypeIdstring · uuidRequired

The ID of the prescriptive path's asset type.

Responses

201

The prescriptive path has been added.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

409

Conflicts found.

application/json

500

An unexpected error has occurred.

application/json

post/prescriptivePaths

HTTPcURLJavaScriptPython

POST /rest/protect/v1/prescriptivePaths HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 380

{
  "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "relations": [
    {
      "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
      "relationTypeDirection": "text",
      "assetType": {
        "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "relation": {
          "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
          "relationTypeDirection": "text",
          "assetType": "[Circular Reference]"
        }
      }
    }
  ]
}

{
  "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": 1,
  "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedOn": 1,
  "description": "text",
  "relations": [
    {
      "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
      "relationTypeDirection": "text",
      "assetType": {
        "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "relation": {
          "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
          "relationTypeDirection": "text",
          "assetType": "[Circular Reference]"
        }
      }
    }
  ]
}

List asset types supported by Protect

get

Authorizations

basicAuthjwtAuth

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.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

An unexpected error has occurred.

application/json

get/prescriptivePaths/assetTypes

HTTPcURLJavaScriptPython

GET /rest/protect/v1/prescriptivePaths/assetTypes HTTP/1.1
Authorization: Basic username:password
Accept: */*

[
  "123e4567-e89b-12d3-a456-426614174000"
]

Retrieve a prescriptive path

get

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

Authorizations

basicAuthjwtAuth

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

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error has occurred.

application/json

get/prescriptivePaths/{assetTypeId}

HTTPcURLJavaScriptPython

GET /rest/protect/v1/prescriptivePaths/{assetTypeId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": 1,
  "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedOn": 1,
  "description": "text",
  "relations": [
    {
      "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
      "relationTypeDirection": "text",
      "assetType": {
        "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "relation": {
          "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
          "relationTypeDirection": "text",
          "assetType": "[Circular Reference]"
        }
      }
    }
  ]
}

Delete a prescriptive path

delete

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

Authorizations

basicAuthjwtAuth

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

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

409

Conflicts found.

application/json

500

An unexpected error has occurred.

application/json

delete/prescriptivePaths/{assetTypeId}

HTTPcURLJavaScriptPython

DELETE /rest/protect/v1/prescriptivePaths/{assetTypeId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Update a prescriptive path

patch

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

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

assetTypeIdstring · uuidRequired

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

Body

application/json

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

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

409

Conflicts found.

application/json

500

An unexpected error has occurred.

application/json

patch/prescriptivePaths/{assetTypeId}

HTTPcURLJavaScriptPython

PATCH /rest/protect/v1/prescriptivePaths/{assetTypeId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 327

{
  "description": "text",
  "relations": [
    {
      "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
      "relationTypeDirection": "text",
      "assetType": {
        "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "relation": {
          "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
          "relationTypeDirection": "text",
          "assetType": "[Circular Reference]"
        }
      }
    }
  ]
}

{
  "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": 1,
  "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedOn": 1,
  "description": "text",
  "relations": [
    {
      "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
      "relationTypeDirection": "text",
      "assetType": {
        "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "relation": {
          "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
          "relationTypeDirection": "text",
          "assetType": "[Circular Reference]"
        }
      }
    }
  ]
}