Query session progress or cancel a session
- Last UpdatedJul 01, 2026
- 1 minute read
Check object count before querying
Use this to determine the number of objects in a running session.
{
dataValidation {
session { numberOfObjectsToValidate(sessionHandle : 12345) }
}
}
Monitor a running session
This method returns the status of an actively running session.
{
dataValidation {
session {
list(filters : {handle : {eq : 12345}}) {
status numberOfObjectsToValidate numberOfObjectsValidated
numberOfDuplicatesToValidate numberOfDuplicatesValidated
numberOfIssuesTotal numberOfDataObjects numberOfDataAttributes
numberOfRules startedAt endedAt
}
}
}
}
Session status values: CREATED โ IN_PROGRESS โ COMPLETED | FAILED | CANCELLED
Cancel a Session
Use this to cancel a running session.
mutation {
dataValidation {
session {
cancel(sessionHandle : 12345) { handle status }
}
}
}
Session Entity Structure
|
Property |
Type |
Description |
|---|---|---|
|
handle |
long |
Unique identifier |
|
name |
string |
Session name |
|
description |
string? |
Purpose or notes |
|
vocabularyIdentifier |
string? |
Selected vocabulary |
|
vocabularyName |
string? |
Vocabulary display name |
|
vocabularyDescription |
string? |
Vocabulary description |
|
defaultObjectIntent |
string? |
Default intent: UPSERT, INSERT |
|
retentionPeriodInMinutes |
int? |
Retention (default: 7 days) |
|
retainUntil |
DateTime? |
Retention expiry |
|
status |
string |
CREATED, IN_PROGRESS, COMPLETED, FAILED, CANCELLED |
|
numberOfObjectsToValidate |
long? |
Objects queued |
|
numberOfObjectsValidated |
long? |
Objects processed |
|
numberOfDuplicatesToValidate |
long? |
Duplicates queued |
|
numberOfDuplicatesValidated |
long? |
Duplicates processed |
|
numberOfIssuesTotal |
long? |
Total issues |
|
numberOfDataObjects |
long? |
Total data objects |
|
numberOfDataAttributes |
long? |
Total attributes |
|
numberOfRules |
long? |
Rules applied |
|
startedAt |
DateTime? |
Validation start |
|
endedAt |
DateTime? |
Validation end |
|
createdAt |
DateTime |
Creation timestamp |
|
etag |
string |
Concurrency token |
|
classLibraryHandle |
long |
Associated class library |
|
datasetHandle |
long |
Associated Dataset |
|
grantedAccess |
string[] |
Effective permissions |
Child entities: createdByUser, classLibrary, dataset, dataObjects, rules, attributes, issues