Data Contract

Manage data contracts.

List data contracts

get

Retrieves a paginated list of data contract metadata, sorted by the last modified date in descending order. Filtering options are available via query parameters.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

cursorstringOptional

The cursor pointing to the first resource to be included in the response. This cursor cannot be created and must have been extracted from a response returned by a previous API call. If this parameter is missing, the API will return the resources starting from the first resource available (index=0).

limitinteger · max: 500Optional

The maximum number of resources to retrieve. If not set, the default limit (limit = 100) will be used. The maximum value for this parameter is 500.

Default: 100

includeTotalbooleanOptional

Should results include the total number of resources available in this collection.

Default: false

manifestIdstring · stringOptional

The unique identifier of the Data Contract manifest.

domainIdstring · uuidOptional

The unique identifier (UUID) of the domain to filter data contracts.

Responses

200

Returns a paginated list of data contract metadata.

application/json

A paginated list of data contract resources.

totalintegerOptional

Count of resources available in this collection (based on the parameters provided to the API)

Example: 123

nextCursorstringRequired

The cursor pointing to the next page. If the cursor is missing, there are no additional pages of resources available after the current one.

Example: N3Vyc29yV2hlblRoZXJlSXNNb3JlRGF0YQo

limitintegerRequired

Maximum number of items returned in this response.

Example: 50

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

There was an error processing the request.

application/json

get/dataContracts

GET /rest/dataProduct/v1/dataContracts HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "total": 123,
  "nextCursor": "N3Vyc29yV2hlblRoZXJlSXNNb3JlRGF0YQo",
  "limit": 50,
  "items": [
    {
      "name": "Customer Sales Contract",
      "id": "19bc11f8-3a5b-488d-a04a-b9cc915c5e23",
      "manifestId": "123e4567-e89b-12d3-a456-426614174000",
      "domainName": "Sales Data Products",
      "domainId": "67a8e966-c9ad-4039-9e3d-77b6e93918ff",
      "activeVersion": "0.0.1"
    }
  ]
}

Initialize a data contract

post

This operation is the first step in creating a new data contract asset and linking it to its initial manifest. You can provide an existing manifest to upload, or a template will be generated from the associated Collibra content if none is provided.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

A data contract manifest file.

manifeststring · binaryOptional

The content of the data contract manifest file. The filename should be provided in the Content-Disposition header.

Example:

id: 123e4567-e89b-12d3-a456-426614174000 kind: DataContract apiVersion: 1.0.3 title: Sample Title description: Sample Description

governedAssetIdstring · uuidRequired

The unique identifier (UUID) of the Data Product Port asset to be governed by the new Data Contract.

Example: 123e4567-e89b-12d3-a456-426614174000

manifestIdstring · max: 200Optional

The unique identifier of the data contract as specified in the manifest. If omitted and a manifest that adheres to the Open Data Contract Standard is provided, the manifestID will be parsed automatically. If omitted and a manifest can not be parsed, the ID will match the UUID of the data contract asset being initialized. Maximum length: 200 characters.

Example: 123e4567-e89b-12d3-a456-426614174000

versionstring · max: 100Optional

The version value for the initial data contract manifest. If omitted and a manifest that adheres to the Open Data Contract Standard is provided, the version will be parsed automatically from the manifest. If omitted and a manifest cannot be parsed, it will default to '0.0.1'. Maximum length: 100 characters.

Example: 0.0.1

namestring · max: 200Optional

A custom, human-readable name for the data contract. If omitted and a manifest that adheres to the Open Data Contract Standard is provided, the name will be parsed automatically from the manifest. If omitted and a manifest cannot be parsed, it will inherit the name of the asset specified by 'governedAssetId'. Maximum length: 200 characters.

Example: MyFirstDataContract

domainIdstring · uuidOptional

The unique identifier (UUID) of the domain where the data contract asset will be created. The specified domain must support the data contract asset type, otherwise the call will fail. If omitted, it defaults to the domain of the asset identified by 'governedAssetId'.

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

201

Returns the metadata for the newly created data contract version.

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

404

Resource not found.

application/json

409

Conflicts found.

application/json

500

There was an error processing the request.

application/json

post/dataContracts

POST /rest/dataProduct/v1/dataContracts HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 358

{
  "manifest": "id: 123e4567-e89b-12d3-a456-426614174000\nkind: DataContract\napiVersion: 1.0.3\ntitle: Sample Title\ndescription: Sample Description\n",
  "governedAssetId": "123e4567-e89b-12d3-a456-426614174000",
  "manifestId": "123e4567-e89b-12d3-a456-426614174000",
  "version": "0.0.1",
  "name": "MyFirstDataContract\n",
  "domainId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "name": "Customer Sales Contract",
  "id": "19bc11f8-3a5b-488d-a04a-b9cc915c5e23",
  "manifestId": "123e4567-e89b-12d3-a456-426614174000",
  "domainName": "Sales Data Products",
  "domainId": "67a8e966-c9ad-4039-9e3d-77b6e93918ff",
  "activeVersion": "0.0.1",
  "manifestVersion": {
    "version": "0.0.1",
    "active": true,
    "format": "ODCS",
    "createdBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
    "createdOn": 1476703764163,
    "lastModifiedBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
    "lastModifiedOn": 1476703764163
  }
}

Retrieve data contract metadata

get

Retrieves the metadata for a specific data contract.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier UUID of the data contract asset to retrieve.

Responses

200

Returns the requested data contract metadata.

application/json

Metadata attributes of a data contract

namestringRequired

The name of the data contract asset.

Example: Customer Sales Contract

idstring · uuidRequired

UUID of the data contract asset.

Example: 19bc11f8-3a5b-488d-a04a-b9cc915c5e23

manifestIdstringRequired

The unique identifier of the data contract.

Example: 123e4567-e89b-12d3-a456-426614174000

domainNamestringRequired

The name of the domain where the data contract asset is located.

Example: Sales Data Products

domainIdstring · uuidRequired

The unique identifier (UUID) of the domain where the data contract asset is located.

Example: 67a8e966-c9ad-4039-9e3d-77b6e93918ff

activeVersionstringRequired

The version value of the currently active data contract manifest.

Example: 0.0.1

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

There was an error processing the request.

application/json

get/dataContracts/{id}

GET /rest/dataProduct/v1/dataContracts/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "name": "Customer Sales Contract",
  "id": "19bc11f8-3a5b-488d-a04a-b9cc915c5e23",
  "manifestId": "123e4567-e89b-12d3-a456-426614174000",
  "domainName": "Sales Data Products",
  "domainId": "67a8e966-c9ad-4039-9e3d-77b6e93918ff",
  "activeVersion": "0.0.1"
}

Delete all data contract versions

delete

Deletes all versions associated with a Data Contract Asset. By default (deleteAsset=false), only the manifest versions are deleted, preserving the asset for future re-initialization. Set 'deleteAsset=true' to perform a full deletion of the asset and all associated manifest versions.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier of the data contract asset.

Query parameters

deleteAssetbooleanOptional

Controls the deletion scope. Defaults to 'false'.

Default: false

Responses

200

The data contract was successfully deleted.

No content

204

The data contract does not exist or had been deleted already.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

There was an error processing the request.

application/json

delete/dataContracts/{id}

DELETE /rest/dataProduct/v1/dataContracts/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Automatically upload new version

post

Uploads a new version of a Data Contract manifest, with the manifestID and version being automatically parsed from the manifest content. Use this to add to the version history of a Data Contract that has already been initialized and exists within Collibra.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

A data contract manifest file.

manifeststring · binaryRequired

The content of the data contract manifest file. The filename should be provided in the Content-Disposition header.

Example:

id: 123e4567-e89b-12d3-a456-426614174000 kind: DataContract apiVersion: 1.0.3 title: Sample Title description: Sample Description

manifestIdstring · max: 200Optional

The unique identifier of the data contract as specified in the manifest. If omitted and a manifest that adheres to the Open Data Contract Standard is provided, the manifestID will be parsed automatically. If omitted and a manifest cannot be parsed, the call will end with an error. Maximum length: 200 characters.

Example: 123e4567-e89b-12d3-a456-426614174000

versionstring · max: 100Optional

The version of the data contract manifest being uploaded. If omitted, the version will be parsed automatically from the manifest unless it does not adhere to the Open Data Contract Standard, in which case omitting this will result in an error. Maximum length: 100 characters.

Example: 0.0.1

activebooleanOptional

Set to true to make this data contract manifest version the active version. This will automatically deactivate the previous active version. The active version is the one that's exposed through the data contract asset. Defaults to true.

Default: trueExample: true

forcebooleanOptional

Set to true to force the overwrite of an existing manifest version if it has the same version value. When a new manifest overwrites the active version, the 'active' parameter in the request is ignored, and the version's active state remains unchanged. Defaults to false.

Default: falseExample: true

Responses

200

Returns the metadata for the updated data contract version.

application/json

201

Returns the metadata for the newly created data contract version.

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

404

Resource not found.

application/json

409

Conflicts found.

application/json

500

There was an error processing the request.

application/json

post/dataContracts/addFromManifest

POST /rest/dataProduct/v1/dataContracts/addFromManifest HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 247

{
  "manifest": "id: 123e4567-e89b-12d3-a456-426614174000\nkind: DataContract\napiVersion: 1.0.3\ntitle: Sample Title\ndescription: Sample Description\n",
  "manifestId": "123e4567-e89b-12d3-a456-426614174000",
  "version": "0.0.1",
  "active": true,
  "force": true
}

{
  "name": "Customer Sales Contract",
  "id": "19bc11f8-3a5b-488d-a04a-b9cc915c5e23",
  "manifestId": "123e4567-e89b-12d3-a456-426614174000",
  "domainName": "Sales Data Products",
  "domainId": "67a8e966-c9ad-4039-9e3d-77b6e93918ff",
  "activeVersion": "0.0.1",
  "manifestVersion": {
    "version": "0.0.1",
    "active": true,
    "format": "ODCS",
    "createdBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
    "createdOn": 1476703764163,
    "lastModifiedBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
    "lastModifiedOn": 1476703764163
  }
}

Generate draft version

get

Generates a draft manifest for an existing Data Contract by executing a synchronization and merge operation. The core logic pulls the latest synchronized metadata from Collibra to update relevant content in the base manifest version (fromVersion), while preserving any content that is not synchronized by Collibra from the base manifest version.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier of the existing data contract asset for which a new draft version is required.

Query parameters

fromVersionstring · max: 100Optional

The specific version of the contract to base the new draft on. This is the source used to preserve the non-synchronized, custom metadata. The default value is active version.

Example: 0.0.1

versionstring · max: 100Optional

The manifest version to assign to the newly generated draft. The default uses the same version as fromVersion.

Example: 0.0.1

Responses

200

A downloadable file containing the data contract manifest.

Responsestring · binary

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

There was an error processing the request.

application/json

get/dataContracts/{id}/draftVersion

GET /rest/dataProduct/v1/dataContracts/{id}/draftVersion HTTP/1.1
Authorization: Basic username:password
Accept: */*

binary

Apply active manifest version to Collibra

post

Unstable: This endpoint may change without notice.

Apply the active Data Contract manifest version to the Collibra Knowledge Graph. This operation enforces the manifest as the source of truth for all synchronized metadata. The synchronization scope is controlled by the sections query parameter. Available sections are:

slas: synchronizes SLA properties (restricted to those that match existing Out-of-the-Box (OOTB) attributes on the Data Contract Asset).
relations: synchronizes relations (tables from the schema section of the manifest that match existing assets in Collibra). By default, all sections are applied.

It is typically executed after initializing a contract, uploading a new version, or setting a version as active. This operation is only supported for manifest versions using the ODCS format.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier (UUID) of the data contract asset.

Query parameters

dryRunbooleanOptional

Simulates changes without writing to Collibra. Returns planned actions with no side effects.

Default: false

sectionsstring[] · max: 2Optional

Which sections to apply. Each section is applied independently. Possible values are:

slas
relations

Default: ["slas","relations"]

Responses

200

The data contract version was applied to Collibra Knowledge Graph. The response contains detailed results for each resource that was processed.

application/json

Response containing the results of applying the data contract manifest to Collibra Knowledge Graph.

dryRunbooleanRequired

Whether the apply operation was a dry run.

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

There was an error processing the request.

application/json

post/dataContracts/{id}/apply

POST /rest/dataProduct/v1/dataContracts/{id}/apply HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "dryRun": true,
  "data": {
    "slas": {
      "summary": {
        "total": 1,
        "success": 1,
        "skipped": 1,
        "failed": 1
      },
      "error": "text",
      "results": [
        {
          "status": "text",
          "action": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "attributeDiscriminator": "text",
          "type": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "resourceDiscriminator": "text",
            "name": "text"
          },
          "asset": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "resourceDiscriminator": "text",
            "name": "text"
          },
          "previousValue": "text",
          "newValue": "text",
          "filePath": "text",
          "details": "text"
        }
      ]
    },
    "relations": {
      "summary": {
        "total": 1,
        "success": 1,
        "skipped": 1,
        "failed": 1
      },
      "error": "text",
      "results": [
        {
          "status": "text",
          "action": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "resourceDiscriminator": "text",
            "name": "text",
            "displayName": "text"
          },
          "target": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "resourceDiscriminator": "text",
            "name": "text",
            "displayName": "text"
          },
          "relationType": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "publicId": "text",
            "role": "text",
            "coRole": "text"
          },
          "filePath": "text",
          "details": "text"
        }
      ]
    }
  }
}

List versions

get

Retrieves a paginated list of all versions' metadata for a specified data contract, ordered by active=true first, then active=false, and finally sorted by the last modified date in descending order. You can optionally filter results using a version string with configurable matching modes (partial or exact match).

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier (UUID) of the data contract asset.

Query parameters

cursorstringOptional

limitinteger · max: 500Optional

The maximum number of resources to retrieve. If not set, the default limit (limit = 100) will be used. The maximum value for this parameter is 500.

Default: 100

includeTotalbooleanOptional

Should results include the total number of resources available in this collection.

Default: false

versionstringOptional

The version string to search for. The search behavior depends on the versionMatchMode parameter. When used with the default EXACT match mode, it filters versions that exactly match the provided string. When used with the START match mode, it filters versions that start with the provided string. For example, searching for "10." with START mode will return versions like "10.0.0", "10.0.1", "10.1.0", and so on.

versionMatchModestring · enumOptional

The mode used to match the filter value against the target field. If the match mode is EXACT the search is case-sensitive, otherwise the search is case-insensitive.

Possible values are:

START - The version must start with the given string.
END - The version must end with the given string.
ANYWHERE - The version must contain the given string anywhere.
EXACT - The version must exactly match the given string.

Possible values:

Responses

200

Returns a paginated list of data contract version metadata.

application/json

A paginated list of data contract Version resources.

totalintegerOptional

Count of resources available in this collection (based on the parameters provided to the API)

Example: 123

nextCursorstringRequired

The cursor pointing to the next page. If the cursor is missing, there are no additional pages of resources available after the current one.

Example: N3Vyc29yV2hlblRoZXJlSXNNb3JlRGF0YQo

limitintegerRequired

Maximum number of items returned in this response.

Example: 50

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

There was an error processing the request.

application/json

get/dataContracts/{id}/versions

GET /rest/dataProduct/v1/dataContracts/{id}/versions HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "total": 123,
  "nextCursor": "N3Vyc29yV2hlblRoZXJlSXNNb3JlRGF0YQo",
  "limit": 50,
  "items": [
    {
      "version": "0.0.1",
      "active": true,
      "format": "ODCS",
      "createdBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
      "createdOn": 1476703764163,
      "lastModifiedBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
      "lastModifiedOn": 1476703764163
    }
  ]
}

Upload new version

post

Uploads a new version of a data contract manifest. Use this to add to the version history of a data contract that has already been initialized and exists within Collibra.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier (UUID) of the data contract asset in Collibra. This ID must correspond to a data contract asset that has already been initialized in Collibra.

Body

A data contract manifest file.

manifeststring · binaryRequired

The content of the data contract manifest file. The filename should be provided in the Content-Disposition header.

Example:

id: 123e4567-e89b-12d3-a456-426614174000 kind: DataContract apiVersion: 1.0.3 title: Sample Title description: Sample Description

versionstring · max: 100Optional

The version of the data contract manifest being uploaded. If omitted, the version will be parsed automatically from the manifest unless it does not adhere to the Open Data Contract Standard, in which case omitting this field will result in an error. Maximum length: 100 characters.

Example: 0.0.1

activebooleanOptional

Default: trueExample: true

forcebooleanOptional

Default: falseExample: true

Responses

200

Returns the metadata for the updated data contract version.

application/json

201

Returns the metadata for the newly created data contract version.

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

404

Resource not found.

application/json

409

Conflicts found.

application/json

500

There was an error processing the request.

application/json

post/dataContracts/{id}/versions

POST /rest/dataProduct/v1/dataContracts/{id}/versions HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 195

{
  "manifest": "id: 123e4567-e89b-12d3-a456-426614174000\nkind: DataContract\napiVersion: 1.0.3\ntitle: Sample Title\ndescription: Sample Description\n",
  "version": "0.0.1",
  "active": true,
  "force": true
}

{
  "name": "Customer Sales Contract",
  "id": "19bc11f8-3a5b-488d-a04a-b9cc915c5e23",
  "manifestId": "123e4567-e89b-12d3-a456-426614174000",
  "domainName": "Sales Data Products",
  "domainId": "67a8e966-c9ad-4039-9e3d-77b6e93918ff",
  "activeVersion": "0.0.1",
  "manifestVersion": {
    "version": "0.0.1",
    "active": true,
    "format": "ODCS",
    "createdBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
    "createdOn": 1476703764163,
    "lastModifiedBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
    "lastModifiedOn": 1476703764163
  }
}

Delete specific version

delete

Deletes a specific data contract manifest version.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier (UUID) of the data contract asset.

Query parameters

versionstringRequired

The specific version of the data contract to delete.

Responses

200

The data contract version was successfully deleted.

No content

204

The data contract version does not exist or had been deleted already.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

There was an error processing the request.

application/json

delete/dataContracts/{id}/versions

DELETE /rest/dataProduct/v1/dataContracts/{id}/versions?version=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Download specific manifest file version.

get

Downloads the manifest file for the specific data contract version identified in the path.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier of the data contract asset.

Query parameters

versionstringRequired

The version of the data contract manifest to download.

Responses

200

A downloadable file containing the data contract manifest.

Responsestring · binary

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

There was an error processing the request.

application/json

get/dataContracts/{id}/versions/manifest

GET /rest/dataProduct/v1/dataContracts/{id}/versions/manifest?version=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

binary

Retrieve active version metadata

get

Retrieves the metadata for the currently active version of a specific data contract. This is the version that is exposed through the data contract asset.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier (UUID) of the data contract asset for which to retrieve the active version.

Responses

200

Returns the requested data contract manifest metadata.

application/json

Metadata attributes of a data contract version

versionstringRequired

Version of the data contract Manifest.

Example: 0.0.1

activebooleanRequired

The active version is the version exposed through the data contract asset.

Example: true

formatstringRequired

Format type of the data contract manifest.

Possible values are:

ODCS
DCS
CUSTOM

Example: ODCS

createdBystring · uuidRequired

The unique identifier of the user who created the data contract Version.

Example: beea52a2-a56b-4015-a0dc-24d165b733f8

createdOninteger · int64Required

The timestamp (in UTC time standard) when the data contract Version was created.

Example: 1476703764163

lastModifiedBystring · uuidRequired

The unique identifier of the user who last modified the data contract Version.

Example: beea52a2-a56b-4015-a0dc-24d165b733f8

lastModifiedOninteger · int64Required

The timestamp (in UTC time standard) when the data contract Version was last modified.

Example: 1476703764163

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

There was an error processing the request.

application/json

get/dataContracts/{id}/activeVersion

GET /rest/dataProduct/v1/dataContracts/{id}/activeVersion HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "version": "0.0.1",
  "active": true,
  "format": "ODCS",
  "createdBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
  "createdOn": 1476703764163,
  "lastModifiedBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
  "lastModifiedOn": 1476703764163
}

Set active version

patch

Sets a data contract version as active. This determines which version of a Data contract is exposed through its associated data contract asset. This will automatically deactivate the previous active version. If the specified version is already active, the operation will have no effect.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier (UUID) of the data contract asset.

Query parameters

versionstringRequired

The specific version of the data contract to set as active.

Responses

200

Returns the requested data contract manifest metadata.

application/json

Metadata attributes of a data contract version

versionstringRequired

Version of the data contract Manifest.

Example: 0.0.1

activebooleanRequired

The active version is the version exposed through the data contract asset.

Example: true

formatstringRequired

Format type of the data contract manifest.

Possible values are:

ODCS
DCS
CUSTOM

Example: ODCS

createdBystring · uuidRequired

The unique identifier of the user who created the data contract Version.

Example: beea52a2-a56b-4015-a0dc-24d165b733f8

createdOninteger · int64Required

The timestamp (in UTC time standard) when the data contract Version was created.

Example: 1476703764163

lastModifiedBystring · uuidRequired

The unique identifier of the user who last modified the data contract Version.

Example: beea52a2-a56b-4015-a0dc-24d165b733f8

lastModifiedOninteger · int64Required

The timestamp (in UTC time standard) when the data contract Version was last modified.

Example: 1476703764163

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

There was an error processing the request.

application/json

patch/dataContracts/{id}/activeVersion

PATCH /rest/dataProduct/v1/dataContracts/{id}/activeVersion?version=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "version": "0.0.1",
  "active": true,
  "format": "ODCS",
  "createdBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
  "createdOn": 1476703764163,
  "lastModifiedBy": "beea52a2-a56b-4015-a0dc-24d165b733f8",
  "lastModifiedOn": 1476703764163
}

Download active version

get

Downloads the manifest file for the currently active version of a specific data contract. This is the version that is exposed through the data contract asset.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The unique identifier (UUID) of the data contract asset for which to download the active manifest version.

Responses

200

A downloadable file containing the data contract manifest.

Responsestring · binary

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

There was an error processing the request.

application/json

get/dataContracts/{id}/activeVersion/manifest

GET /rest/dataProduct/v1/dataContracts/{id}/activeVersion/manifest HTTP/1.1
Authorization: Basic username:password
Accept: */*

binary

PreviousData Product REST API (Version 1)NextModels

Last updated 1 month ago

Was this helpful?