Classification Data Category

Classification category operations

Associate data class with data category

post

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

The APIs require Basic HTTP authentication.

Path parameters

dataClassIdstring · uuidRequired

The ID of the data class to which the data category will be associated.

Body

application/json

string · uuidOptional

Responses

201

The newly created classification category association.

application/json

An association between a data class and a data category.

idstring · uuidRequired

The ID of the represented object (entity).

createdBystring · uuidOptional

The ID of the user who created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The Unix timestamp in milliseconds (in UTC time standard) of the resource creation date.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The ID of the user who last modified this resource.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The Unix timestamp in milliseconds (in UTC time standard) the resource last modified date.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequired

The type of the resource, for example [Community, Asset, Domain, Attribute, Relation, WorkflowInstance].

Example: AssetPossible values:

404

Resource not found.

application/json

422

Associations between provided Assets and Data Class already exist.

application/json

post/dataClasses/{dataClassId}/dataCategories

HTTPcURLJavaScriptPython

POST /rest/catalogClassification/v2/dataClasses/{dataClassId}/dataCategories HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 38

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataClass": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Test name",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "resourceType": "Asset"
  },
  "dataCategory": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "name": "text",
    "resourceType": "Asset"
  },
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "resourceType": "Asset"
}

Remove existing association between a data class and a data category

delete

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

The APIs require Basic HTTP authentication.

Path parameters

dataClassIdstring · uuidRequired

The ID of the data class from which the data category will be removed.

dataCategoryIdstring · uuidRequired

The ID of the data category to be removed.

Responses

204

Removed the association between data class and data category.

No content

404

Resource not found.

application/json

delete/dataClasses/{dataClassId}/dataCategories/{dataCategoryId}

HTTPcURLJavaScriptPython

DELETE /rest/catalogClassification/v2/dataClasses/{dataClassId}/dataCategories/{dataCategoryId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Retrieve the association with a data category and a data class.

get

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

The APIs require Basic HTTP authentication.

Query parameters

dataCategoryIdstring · uuidOptional

The ID of the data category for which you want to see the associated data classes.

dataClassIdstring · uuidOptional

The ID of the data class for which you want to see the associated data categories.

offsetinteger · int32Optional

The index of the first result to retrieve.

If not set (offset = 0), results are retrieved starting from row 0.

Default: 0

limitinteger · int32 · max: 1000Optional

The maximum number of results to retrieve.

If not set, the default limit (limit = 0) is used. The maximum value for this parameter is 1000.

Default: 0

Responses

200

The list of associations with a data category and a data classes.

application/json

400

The request is not valid.

application/json

404

Resource not found.

application/json

get/dataClasses/dataCategories

HTTPcURLJavaScriptPython

GET /rest/catalogClassification/v2/dataClasses/dataCategories HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dataClass": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Test name",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "resourceType": "Asset"
      },
      "dataCategory": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "name": "text",
        "resourceType": "Asset"
      },
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "resourceType": "Asset"
    }
  ]
}