Validation

Returns the validation results matching the given search criteria.

get

Returns the validation results 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 validation results satisfy all constraints that are specified in this search criteria. By default a result containing at most 1000 validation results is returned.

Authorizations

basicAuthjwtAuthoauth2

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

assetIdstring · uuidOptional

The unique identifier of the asset for which we are searching validation results.

jobIdstring · uuidOptional

The unique identifier of the job for which we are searching validation results.

validationRuleIdstring · uuidOptional

The unique identifier of the validation rule for which we are searching validation results.

mostRecentJobbooleanOptional

Check the validationResults of only the most recent job according to the other criteria.

mostRecentExecutionbooleanOptional

Check the validationResults of only the most recent execution (inside or outside a validation job) according to the other criteria.

resultbooleanOptional

Filter on the result of validation results.

Responses

200

The paged response with found ValidationResults.

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/validation

HTTPcURLJavaScriptPython

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

200

The paged response with found ValidationResults.

{
  "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,
      "asset": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "validationRule": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "result": true,
      "message": "text",
      "jobId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Validates a single asset.

post

Validates a single asset.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

assetIdstring · uuidRequired

the unique identifier of the asset to be validated

Responses

200

The asset has been validated successfully.

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:

resultbooleanOptional

The validation result (true, false or null if there was an error.

messagestringOptional

The error message (if any). Can be a translatable key.

jobIdstring · uuidOptional

ID of the job that performed the validation.

post/validation/{assetId}

HTTPcURLJavaScriptPython

POST /rest/2.0/validation/{assetId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

The asset has been validated successfully.

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "asset": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "validationRule": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "result": true,
    "message": "text",
    "jobId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Validates multiple assets.

post

Validates multiple assets.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Body

application/json

assetIdsstring · uuid[]Optional

sendNotificationbooleanOptional

Responses

200

Validation Job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

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

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/validation/bulk

HTTPcURLJavaScriptPython

POST /rest/2.0/validation/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "assetIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "sendNotification": true
}

200

Validation Job successfully started.

{
  "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",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}