Asset Rule Errors

Save PDF

Last UpdatedSep 08, 2023
2 minute read

`List Rule Errors By Rule Id`

Returns the RuleError objects for the specified ruleId.

Request

GET /api/v1-preview/tenants/{tenantId}/namespaces/{namespaceId}/assetrules/{ruleId}/errors

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string ruleId
Rule identifier.

Response

Status Code	Body Type	Description
200	RuleError[]	An `IEnumerable<T>`
403	ResponseBody	Forbidden.
404	ResponseBody	The specified rule was not found.
500	ResponseBody	Internal server error.

Example response body

200 Response

[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "RuleId": "ruleId",
    "TimeGenerated": "0001-01-01T00:00:00",
    "ErrorDetails": "Error details.",
    "ErrorMessageType": 1
  },
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "RuleId": "ruleId",
    "TimeGenerated": "0001-01-01T00:00:00",
    "ErrorDetails": "Error details.",
    "ErrorMessageType": 1
  }
]

403 Response

{
  "OperationId": "00000000-0000-0000-0000-000000000000",
  "Error": "Error message.",
  "Reason": "Reason that caused the error.",
  "Resolution": "Possible resolution for the error.",
  "Parameters": {
    "key1": "value1",
    "key2": "value2"
  }
}

404 Response

{
  "OperationId": "00000000-0000-0000-0000-000000000000",
  "Error": "Error message.",
  "Reason": "Reason that caused the error.",
  "Resolution": "Possible resolution for the error.",
  "Parameters": {
    "key1": "value1",
    "key2": "value2"
  }
}

500 Response

{
  "OperationId": "00000000-0000-0000-0000-000000000000",
  "Error": "Error message.",
  "Reason": "Reason that caused the error.",
  "Resolution": "Possible resolution for the error.",
  "Parameters": {
    "key1": "value1",
    "key2": "value2"
  }
}

`Delete Rule Errors By Rule Id`

Deletes the RuleError objects associated with the specified rule.

Request

DELETE /api/v1-preview/tenants/{tenantId}/namespaces/{namespaceId}/assetrules/{ruleId}/errors

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string ruleId
Rule identifier.

Response

Status Code	Body Type	Description
202	None	No content.
403	ResponseBody	Forbidden.
404	ResponseBody	The specified rule was not found.
500	ResponseBody	Internal server error.

`Overwrite User Conflicts`

Overwrites the user conflict RuleError objects associated with the specified rule.

Request

POST /api/v1-preview/tenants/{tenantId}/namespaces/{namespaceId}/assetrules/{ruleId}/errors/overwrite

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string ruleId
Rule identifier.

Response

Status Code	Body Type	Description
202	None	No content.
403	ResponseBody	Forbidden.
404	ResponseBody	The specified rule was not found.
500	ResponseBody	Internal server error.

Definitions

RuleError

Properties

Property Name	Data Type	Required	Nullable	Description
Id	guid	false	false	None
RuleId	string	false	true	None
TimeGenerated	date-time	false	false	None
ErrorDetails	string	false	true	None
ErrorMessageType	ErrorMessageType	false	false	None

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "RuleId": "ruleId",
  "TimeGenerated": "0001-01-01T00:00:00",
  "ErrorDetails": "Error details.",
  "ErrorMessageType": 1
}

ErrorMessageType

Enumerated Values

Property	Value
ConflictBetweenRules	0
CreateOrUpdate	1
Generic	2
AutomationId	3
ConflictBetweenStreams	4
MissingMappings	5
ConflictBetweenRuleAndUser	6

ResponseBody

Properties

Property Name	Data Type	Required	Nullable	Description
OperationId	string	false	true	None
Error	string	false	true	None
Reason	string	false	true	None
Resolution	string	false	true	None
Parameters	object	false	true	None

{
  "OperationId": "00000000-0000-0000-0000-000000000000",
  "Error": "Error message.",
  "Reason": "Reason that caused the error.",
  "Resolution": "Possible resolution for the error.",
  "Parameters": {
    "key1": "value1",
    "key2": "value2"
  }
}

CONNECT data services developer documentation