Samples

Data sampling operations

Create a request to collect and cache sample data for an Edge data source

post

Creates a request to collect sample data from an Edge data source for the asset with the specified ID and temporarily makes it available in the Edge cache.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

assetIdstring · uuidRequired

Asset identifier

Responses

202

Samples were successfully requested.
Returns job object which is running the fetching samples process and flag indicating if the new job was started to fetch samples or there was already one which existed before.

application/json

Represents the response returned when sample data is requested.

newJobbooleanOptional

Whether this is a newly created job or one that is in progress.

400

The parameter is not a valid UUID for asset type: Column or Table.

application/json

401

The user is not authenticated to use this API.

application/json

403

The user lacks permission to view samples for the requested asset.

application/json

404

The asset can't be found.

application/json

post/samples/{assetId}/request

HTTPcURLJavaScriptPython

POST /rest/catalogSampling/v1/samples/{assetId}/request HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "newJob": true,
  "job": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "resourceType": "View",
    "name": "Test name",
    "type": "IMPORT",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "progressPercentage": 50,
    "startDate": 1488016800,
    "endDate": 1488021800,
    "state": "COMPLETED",
    "message": "Import finished in 12s."
  }
}

Read sample data from the Collibra cloud repository or Edge cache

get

Reads the available sample data from the Collibra cloud repository or Edge cache depending on how the data is collected.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

assetIdstring · uuidRequired

Asset identifier

Query parameters

columnLimitinteger · int32Optional

The maximum number of columns to retrieve. If not set (columnLimit = 0), the default column limit will be used. Maximum is set to 1500.

Default: 0

columnOffsetinteger · int32Optional

The index of the fist column to retrieve. If not set (columnOffset = 0), results will be retrieved starting from column 0.

Default: 0

Responses

200

Samples were successfully read. Returns the paginated list of columns with the list of the ordered samples that were fetched during request samples process.
Returns additional flags:
isDataAvailable flag indicating if any samples for any column are available within the response.
canRequestAdditionalData flag indicating if the requestSamples API can be called to query the target database for the additional samples.

application/json

Represents the response returned when sample data is read.

dataAvailablebooleanOptional

Whether any sample data is available for the columns in the response.

canRequestAdditionalDatabooleanOptional

Whether the requestSamples API can be called to query the target database for sample data.

400

The parameter is not a valid UUID for asset type: Column or Table.

application/json

401

The user is not authenticated to use this API.

application/json

403

The user lacks permission to any of the columns within the requested asset.

application/json

404

The asset can't be found.

application/json

503

External edge service timeout or failure.

application/json

get/samples/{assetId}

HTTPcURLJavaScriptPython

GET /rest/catalogSampling/v1/samples/{assetId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "dataAvailable": true,
  "canRequestAdditionalData": true,
  "columnPagedResponse": {
    "columnOffset": 1,
    "columnLimit": 1,
    "columnTotal": 1,
    "columns": []
  },
  "error": {
    "statusCode": 1,
    "titleMessage": "text",
    "helpMessage": "text",
    "userMessage": "text",
    "errorCode": "text"
  }
}