Metadata Rule Expression Preview

Save PDF

Last UpdatedSep 08, 2023
4 minute read

`Get Expression Preview Results`

Returns a ExpressionPreviewResult.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/preview/metadatarules/expressions
?token={token}&skip={skip}&count={count}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string token
A Guid which corresponds to a preview that has been created using the StartExpressionPreview method.

[optional] integer skip
An Int32 to determine the number of preview results to skip.

[optional] integer count
An Int32 to determine the number of preview results to return.

Response

Status Code	Body Type	Description
200	ExpressionPreviewResult	A `ExpressionPreviewResult` object.
400	ResponseBody	Missing or invalid inputs.
403	ResponseBody	Forbidden.
404	ResponseBody	The specified preview was not found.
500	ResponseBody	Internal server error.

Example response body

200 Response

{
  "Streams": [
    {
      "Id": "streamId",
      "Name": "streamName",
      "TypeId": "streamTypeId"
    }
  ],
  "Status": "Complete",
  "Statistics": {
    "StreamsProcessed": 4,
    "MatchingStreams": 1
  }
}

400 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"
  }
}

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"
  }
}

`Start Expression Preview`

Creates a ExpressionPreviewResponse of a RuleExpression object.

Request

POST /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/preview/metadatarules/expressions

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Request Body

The RuleModel object to preview.

Response

Status Code	Body Type	Description
202	ExpressionPreviewResponse	A `ExpressionPreviewResponse` object.
400	ResponseBody	Missing or invalid inputs.
403	ResponseBody	Forbidden.
500	ResponseBody	Internal server error.

Example response body

202 Response

{
  "PreviewLink": "/api/v1-preview/tenants/{tenantId}/namespaces/{namespaceId}/preview/metadatarules/expressions?Token=00000000-0000-0000-0000-000000000000",
  "Expires": 7200
}

400 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"
  }
}

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"
  }
}

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"
  }
}

`Cancel Expression Preview`

Cancels a running preview.

Request

DELETE /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/preview/metadatarules/expressions
?token={token}

Parameters

Response

Status Code	Body Type	Description
204	None	No content.
400	ResponseBody	Missing or invalid inputs.
403	ResponseBody	Forbidden.
404	ResponseBody	The specified preview was not found.
500	ResponseBody	Internal server error.

Definitions

ExpressionPreviewResponse

Properties

Property Name	Data Type	Required	Nullable	Description
ExpressionPreviewLink	string	false	true	None
Expires	int32	false	false	None

{
  "ExpressionPreviewLink": "string",
  "Expires": 0
}

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"
  }
}

RuleExpression

Properties

Property Name	Data Type	Required	Nullable	Description
Field	string	false	true	None
Specifications	[Specification]	false	true	None

{
  "Field": "string",
  "Specifications": [
    {
      "Type": 0,
      "Value": "string",
      "Name": "string",
      "CharacterType": 0,
      "CharacterLength": 0,
      "StrictValueMappings": true,
      "RequiredDelimiters": [
        "string"
      ],
      "ValueMappings": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}

Specification

Properties

Property Name	Data Type	Required	Nullable	Description
Type	SpecificationType	false	false	None
Value	string	false	true	None
Name	string	false	true	None
CharacterType	CharacterType	false	false	None
CharacterLength	int32	false	true	Null represents the longest string length within the group.
StrictValueMappings	boolean	false	false	None
RequiredDelimiters	string[]	false	true	None
ValueMappings	object	false	true	None

{
  "Type": 0,
  "Value": "string",
  "Name": "string",
  "CharacterType": 0,
  "CharacterLength": 0,
  "StrictValueMappings": true,
  "RequiredDelimiters": [
    "string"
  ],
  "ValueMappings": {
    "property1": "string",
    "property2": "string"
  }
}

SpecificationType

Enumerated Values

Property	Value
Unspecified	0
Group	1
Wildcard	2
Literal	3
Delimiter	4

CharacterType

Enumerated Values

Property	Value
Any	0
Letter	1
Digit	2
Alphanumeric	3

ExpressionPreviewResult

Properties

Property Name	Data Type	Required	Nullable	Description
Status	string	false	true	None
Streams	[SdsStream]	false	true	None
Statistics	ExpressionPreviewStatistics	false	true	None

{
  "Streams": [
    {
      "Id": "streamId",
      "Name": "streamName",
      "TypeId": "streamTypeId"
    }
  ],
  "Status": "Complete",
  "Statistics": {
    "StreamsProcessed": 4,
    "MatchingStreams": 1
  }
}

SdsStream

Properties

Property Name	Data Type	Required	Nullable	Description
Id	string	false	true	None
Name	string	false	true	None
Description	string	false	true	None
TypeId	string	false	true	None
Indexes	[SdsStreamIndex]	false	true	None
InterpolationMode	SdsInterpolationMode	false	true	None
ExtrapolationMode	SdsExtrapolationMode	false	true	None
PropertyOverrides	[SdsStreamPropertyOverride]	false	true	None
CreatedDate	date-time	false	false	None
ModifiedDate	date-time	false	false	None

{
  "Id": "string",
  "Name": "string",
  "Description": "string",
  "TypeId": "string",
  "Indexes": [
    {
      "SdsTypePropertyId": "string"
    }
  ],
  "InterpolationMode": 0,
  "ExtrapolationMode": 0,
  "PropertyOverrides": [
    {
      "SdsTypePropertyId": "string",
      "Uom": "string",
      "InterpolationMode": 0
    }
  ],
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z"
}

SdsStreamIndex

Properties

Property Name	Data Type	Required	Nullable	Description
SdsTypePropertyId	string	false	true	None

{
  "SdsTypePropertyId": "string"
}

SdsInterpolationMode

Enumerated Values

Property	Value
Continuous	0
Default	0
StepwiseContinuousLeading	1
StepwiseContinuousTrailing	2
Discrete	3
ContinuousNullableLeading	4
ContinuousNullableTrailing	5

SdsExtrapolationMode

Enumerated Values

Property	Value
All	0
None	1
Forward	2
Backward	3

SdsStreamPropertyOverride

Properties

Property Name	Data Type	Required	Nullable	Description
SdsTypePropertyId	string	false	true	None
Uom	string	false	true	None
InterpolationMode	SdsInterpolationMode	false	true	None

{
  "SdsTypePropertyId": "string",
  "Uom": "string",
  "InterpolationMode": 0
}

ExpressionPreviewStatistics

Properties

Property Name	Data Type	Required	Nullable	Description
StreamsProcessed	int32	false	false	None
MatchingStreams	int32	false	false	None

{
  "StreamsProcessed": 0,
  "MatchingStreams": 0
}

CONNECT data services developer documentation