--- title: "Get rule execution status by ID" method: GET path: "/v1/quality/rules/{ruleId}/jobs" tags: ["Quality Rules"] --- # Get rule execution status by ID `GET /v1/quality/rules/{ruleId}/jobs` ## Request - Base URL: `https://api.cloud.precisely.com` - URL: `https://api.cloud.precisely.com/v1/quality/rules/{ruleId}/jobs` - Auth: HTTP bearer Fetches the rule execution status along with asset information ## Path parameters - `ruleId` string, required ## Query parameters - `assetId` string - `page` integer - `limit` integer ## Response `200` Rule found and execution status returned successfully - RuleExecutionStatus: Represents a rule information and its execution status, asset information and score band information in pagination. - `errorDetails` RuleErrorDetails[] - `assetDetails` CatalogAssetView[] - `assetId` string - `assetName` string - `assetPath` string - `assetType` string - `assetTypeId` string - `catalogType` string - `leaf` boolean - `parentId` string - `parentName` string - `assetPath` string - `assetTypePath` string - `connectionName` string - `datasetId` string - `datasetName` string - `displayPath` string - `error` Error - `details` string - `errorCode` string - `summary` string - `targetAssetCount` integer - `id` string - `name` string - `primaryMetricTypeId` string - `ruleAssetView` PageViewRuleAssetView: Pagination wrapper for paginated API responses containing a list of items and pagination metadata - `currentPage` integer: Current page number - `items` union[] - union: List of items for the current page - PipelineListItemView: Represents a summary view of a pipeline including basic metadata and validation status. - `createdBy` string - `createdDate` string, date-time - `error` boolean - `id` string - `inputStepCount` integer - `lastModifiedBy` string - `lastModifiedDate` string, date-time - `name` string - `sourceAssetNamePath` string - `sourceAssetTypePath` string - `validationStatus` boolean - PipelineJobItemView: Represents a single item in the pipeline job list. - `comment` string - `counts` OperatorRecordCountView[] - `count` integer - `name` string - `type` string - `duration` integer - `endTime` integer - `externalId` string - `externalUrl` string - `id` string - `isScheduled` boolean - `pipeline` string - `pipelineId` string - `recordsProcessed` integer - `runConfigId` string - `runConfigName` string - `sourceAssetNamePath` string - `sourceAssetTypePath` string - `sourceAssets` AssetView[] - `assetNamePath` string - `assetTypePath` string - `label` string - `startTime` integer - `status` string - `targetAssetNamePath` string - `targetAssetTypePath` string - `targetAssets` AssetView[] - `assetNamePath` string - `assetTypePath` string - `label` string - `user` string - PipelineRunConfigListItemView: Represents a summary view of a pipeline run configuration. - `compatibilityStatus` boolean - `id` string - `lastModifiedBy` string - `lastModifiedDate` string, date-time - `name` string - `published` boolean - `scheduled` boolean - `type` string - AssetQualityScoreView: Represents the asset quality score view, including asset details and dimension scores. - `assetView` CatalogAssetView: Represents the details of an asset. - `assetId` string - `assetName` string - `assetPath` string - `assetType` string - `assetTypeId` string - `catalogType` string - `leaf` boolean - `parentId` string - `parentName` string - `dimensionScores` QualityScoreDimensions: Represents aggregated quality scores, band information, and metric group dimensions for an asset. - `aggregatedScore` number, double - `dimensions` MetricGroupScore[] - … - `scoreBands` BandInfo: Represents a scoring band with label, color, and minimum value for rule evaluation. - … - ProfileFieldView: Represents information of a field inside a dataset profile. - `blankCount` integer - `dataType` string - `distinctValues` integer - `fieldName` string - `id` string - `invalidCount` integer - `maxLength` string - `maximumValue` string - `minLength` string - `minimumValue` string - `nullCount` integer - `outlierCount` integer - `popularity` integer - `sampleCount` integer - `semanticType` string - `validCount` integer - RuleAssetView: Represents asset information and its score band information. - `assetId` string - `assetName` string - `assetPath` string - `capturedFailedRecords` boolean - `catalogType` string - `evaluateCount` number, double - `failCount` number, double - `isSampleAvailable` boolean - `lastRunAt` string, date-time - `parentAssetId` string - `passCount` number, double - `score` number, double - `scoreBands` BandInfo: Represents a scoring band with label, color, and minimum value for rule evaluation. - `color` string - `label` string - `minimumValue` number, double - `totalCount` number, double - RuleViewSummary: Summary view of a rule, including key configuration and execution status. - `description` string - `dimensionId` string - `dimensionName` string - `enableAutoRun` boolean - `id` string - `name` string - `primaryMetricTypeId` string - `ruleType` string - `runStatus` RunStatus: Represents the execution status of a rule, including correlation ID, state, and last run timestamp. - `correlationId` string - `lastRunAt` string, date-time - `state` string - `scoreClass` string: Score class the rule belongs to. - `scoreTarget` string: Identifier of the asset the rule is scored against. - `targetAssetCount` integer - `targetAssetGroups` string[] - ObserverResponse: Observer definition returned by the portal API - `createdDate` string, date-time - `description` string - `id` string - `lastModifiedDate` string, date-time - `name` string - `observations` ObservationConfig[] - `alertingConfig` AlertConfig: Configuration that controls how observer alerts and warnings are evaluated - … - `evaluationType` 'NUMERIC' | 'TEMPORAL' | 'STRUCTURAL' - `excludedColumns` ExcludeColumn[] - … - `metricTypeId` string - `observationKind` string - `significanceFilterValue` number, double - `significanceMode` 'PERCENTAGE_OF_VALUE' | 'ABSOLUTE_POINT' - `sourcingMode` 'SCHEDULE' | 'NONE' - `tags` string[] - `timeUnit` 'HOURS' | 'DAYS' | 'WEEKS' - `triggers` SchemaConfig[] - … - `status` 'ACTIVE' | 'INACTIVE' | 'PAUSED' - `targetAssetGroupId` string - `targeting` union - AssetGroupConfig: Observer targeting configuration for an asset group - … - AssetIdConfig: Observer targeting configuration for a single asset - … - ObservationTypeView: Supported observation type and its available alerting modes - `allowedAlertingModes` string[] - `description` string - `observationType` string - AlertResponse: Alert emitted by an observer for an evaluated metric value - `alert` AlertDetail: Detailed alert evaluation data returned with an observer alert - `alertTimestamp` string, date-time - `bandSnapshot` BandSnapshot: Snapshot of the expected observer band bounds at alert evaluation time - … - `evaluations` AlertItemView[] - … - `metricTimestamp` string, date-time - `observerId` string - `tenantId` string - `assetId` string - `createdBy` string - `createdDate` string, date-time - `evaluationType` 'NUMERIC' | 'TEMPORAL' | 'STRUCTURAL' - `history` AlertHistoryView[] - `alertId` string - `createdBy` string - `createdDate` string, date-time - `details` union - … - `eventType` 'ALERT_CREATED' | 'STATE_CHANGED' | 'COMMENT_ADDED' | 'ASSIGNED' | 'VALUE_EXCLUDED' - `id` string - `id` string - `lastModifiedBy` string - `lastModifiedDate` string, date-time - `metricTypeId` string - `metricValueId` string - `observationKind` string - `observerId` string - `severity` 'WARN' | 'CRITICAL' | 'ALERT' - `state` 'NEW' | 'OPEN' | 'IN_PROGRESS' | 'CLOSED' - `tags` string[] - `timestamp` string, date-time - `pageSize` integer: Number of items per page - `totalItems` integer: Total number of items across all pages - `totalPages` integer: Total number of pages available based on page size and total items - `runStatus` RunStatus: Represents the execution status of a rule, including correlation ID, state, and last run timestamp. - `correlationId` string - `lastRunAt` string, date-time - `state` string ## Other responses - `400`: Invalid request parameters - `404`: Rule not found - `500`: Internal server error --- [API](https://skmtc.dev/precisely/apis/verify-api-portal.md) · [All operations](https://skmtc.dev/precisely/apis/verify-api-portal/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/verify-api-portal/revisions/380735465266?raw)