Data Quality Rules

Deprecated

Returns data quality rules matching the given search criteria.

get

Returns data quality rules matching the given search criteria. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. The returned data quality rules satisfy all constraints that are specified in this search criteria. By default a result containing 1000 data quality rules is returned.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Query parameters

offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0

countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1

namestringOptional

The name of the dataquality rule to search for.

nameMatchModestring · enumOptional

The match mode used to compare name.

Default: ANYWHEREPossible values:

sortFieldstring · enumOptional

The field that should be used as reference for sorting.

Default: NAMEPossible values:

sortOrderstring · enumOptional

The order of sorting.

Default: ASCPossible values:

Responses

200

The paged response with found DataQualityRule information.

application/json

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/dataQualityRules

HTTPcURLJavaScriptPython

GET /rest/2.0/dataQualityRules HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

The paged response with found DataQualityRule information.

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "name": "Test name",
      "description": "Sample descripion of the resource.",
      "categorizationRelationType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      },
      "relationTrace": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "relationTraceEntries": [
          {
            "outBoundRoleDirection": true,
            "roleDirection": true,
            "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
            "outBoundRelationTypeId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "dataQualityMetrics": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
          "createdOn": 1475503010320,
          "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
          "lastModifiedOn": 1476703764163,
          "system": true,
          "countOperation": "Sum",
          "attributeType": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text",
            "description": "This is the description of the resource"
          }
        }
      ],
      "profilingEnabled": true
    }
  ]
}

Deprecated

Adds a new data quality rule.

post

Adds a new data quality rule.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Body

application/json

idstring · uuidOptional

The ID of the new Data Quality Rule. Should be unique within all data quality rules.
It should have a format of universally unique identifier (UUID) and should not start with
00000000-0000-0000- which is a reserved prefix.

namestring · min: 1 · max: 255Required

The name of the new data quality rule. Should be unique within all data quality rules.

descriptionstring · max: 255Optional

The description of the new data quality rule.

categorizationRelationTypeIdstring · uuidRequired

The ID of the categorization relation type.

profilingEnabledbooleanOptional

Indicates whether profiling statistics should be enabled for this rule.

Responses

201

Data quality rule successfully added.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

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

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

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

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

profilingEnabledbooleanOptional

Indicates whether profiling statistics are enabled for this rule.

400

A data quality rule with the given ID already exists

post/dataQualityRules

HTTPcURLJavaScriptPython

POST /rest/2.0/dataQualityRules HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 383

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "categorizationRelationTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "profilingEnabled": true,
  "dataQualityMetrics": [
    {
      "countOperation": "Sum",
      "attributeTypeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "relationTraceEntries": [
    {
      "roleDirection": true,
      "relationTypeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource.",
  "categorizationRelationType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community"
  },
  "relationTrace": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "relationTraceEntries": [
      {
        "outBoundRoleDirection": true,
        "roleDirection": true,
        "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "outBoundRelationTypeId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "dataQualityMetrics": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "countOperation": "Sum",
      "attributeType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "description": "This is the description of the resource"
      }
    }
  ],
  "profilingEnabled": true
}

Deprecated

Returns the DataQualityRule identified by given id.

get

Returns the DataQualityRule identified by given id.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Path parameters

dataQualityRuleIdstring · uuidRequired

the unique identifier of the data quality rule

Responses

200

DataQualityRule found.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

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

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

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

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

profilingEnabledbooleanOptional

Indicates whether profiling statistics are enabled for this rule.

404

DataQualityRule not found.

get/dataQualityRules/{dataQualityRuleId}

HTTPcURLJavaScriptPython

GET /rest/2.0/dataQualityRules/{dataQualityRuleId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource.",
  "categorizationRelationType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community"
  },
  "relationTrace": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "relationTraceEntries": [
      {
        "outBoundRoleDirection": true,
        "roleDirection": true,
        "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "outBoundRelationTypeId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "dataQualityMetrics": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "countOperation": "Sum",
      "attributeType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "description": "This is the description of the resource"
      }
    }
  ],
  "profilingEnabled": true
}

Deprecated

Removes the DataQualityRule identified by the given id.

delete

Removes the DataQualityRule identified by the given id.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Path parameters

dataQualityRuleIdstring · uuidRequired

the unique identifier of the data quality rule

Responses

200

DataQualityRule removed.

No content

404

DataQualityRule not found.

delete/dataQualityRules/{dataQualityRuleId}

HTTPcURLJavaScriptPython

DELETE /rest/2.0/dataQualityRules/{dataQualityRuleId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Deprecated

Changes the data quality rule with the information that is present in the request.

patch

Changes the data quality rule with the information that is present in the request. Only properties that are specified in this request and have not null values are updated. All other properties are ignored.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Path parameters

dataQualityRuleIdstring · uuidRequired

the unique identifier of the data quality rule

Body

application/json

namestring · min: 1 · max: 255Optional

The new name for the data quality rule.

descriptionstring · max: 255Optional

The new description for the data quality rule.

profilingEnabledbooleanOptional

Indicates whether profiling statistics should be enabled for this rule.

categorizationRelationTypeIdstring · uuidOptional

The ID of the categorization relation type.

Responses

default

default response

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

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

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

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

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

profilingEnabledbooleanOptional

Indicates whether profiling statistics are enabled for this rule.

patch/dataQualityRules/{dataQualityRuleId}

HTTPcURLJavaScriptPython

PATCH /rest/2.0/dataQualityRules/{dataQualityRuleId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 339

{
  "name": "text",
  "description": "text",
  "profilingEnabled": true,
  "categorizationRelationTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "dataQualityMetrics": [
    {
      "countOperation": "Sum",
      "attributeTypeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "relationTraceEntries": [
    {
      "roleDirection": true,
      "relationTypeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

default

default response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource.",
  "categorizationRelationType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community"
  },
  "relationTrace": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "relationTraceEntries": [
      {
        "outBoundRoleDirection": true,
        "roleDirection": true,
        "relationTypeId": "123e4567-e89b-12d3-a456-426614174000",
        "outBoundRelationTypeId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "dataQualityMetrics": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "countOperation": "Sum",
      "attributeType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "description": "This is the description of the resource"
      }
    }
  ],
  "profilingEnabled": true
}