Create metric instances - Precisely Data Integrity Suite

Data Integrity Suite APIs

Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Add new metric instances.

HTTP

POST https://hostname/v2/catalog/metric-instances

This API endpoint is used to submit one or more metric instances associated with a specific assets.

Request

Request body properties

Property Required Type Description
assetId Yes string
  • Format: objectId
  • Pattern: ^[a-fA-F\d]{24}$
effectiveDate No string
  • Format: date-time
metrics Yes array  
correlationId No string  
tags No array  
parentAssetId No string
  • Format: objectId
  • Pattern: ^[a-fA-F\d]{24}$
Example
[
  {
    "assetId": "307eFB67308C4fDdeA21bcFE",
    "effectiveDate": "2025-08-12T10:20:46.627Z",
    "metrics": [
      {
        "metricTypeId": "Bb8Cb6f25dbDfBEBc1bF42D8",
        "ruleId": "D42702E21FA68e02a624bd94",
        "xref": "E42802E546FA68e02aSdw",
        "value": "1.0"
      }
    ],
    "correlationId": "bb62b735-b8c7-4172-b229-b2445603c838",
    "tags": [
      "zogOlYRV4KM6Fhu6QGfLy:AvouJTIJt1an6DmaBq1x3n_xXo=lIzt_l3Bzx6AKf1iOL"
    ],
    "parentAssetId": "Fa444f7DD9f9DC3aaAdc492e"
  }
]

Response

The successful response returns the collection of new metric instances.

Response headers

Example status code responses for this method are shown here. To view the response schemas, you can download the Data Catalog APIs Open API Specification from the Precisely Developer Portal..

Response body

Example status code responses for this method are shown here. To view the response schemas, you can download the Data Catalog APIs Open API Specification from the Precisely Developer Portal..

Examples
{
  "links": {
    "self": "https://example.com/",
    "next": "https://example.com/",
    "prev": "https://example.com/"
  },
  "data": [
    {
      "assetId": "bbbd59d9cae2A50D85AAdED6",
      "effectiveDate": "2025-10-01T00:35:54.616Z",
      "metrics": [
        {
          "metricTypeId": "9D1EbC91bBE68faEd584eE54",
          "ruleId": "ECaaDf8defEbcbD9e7fE284C",
          "xref": "string",
          "value": "string"
        }
      ],
      "correlationId": "string",
      "tags": [
        "B:JerKd_e7UbZ4pVqdtIo=dgVDHlix=w7Lerlg=T04k81j7kNZdy4qqO1IKhN"
      ],
      "parentAssetId": "7272dDb9Ee7A3cBaaD5BFEE1"
    }
  ]
}
{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Bad Request"
}
{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required"
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Resource not found"
}
{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Rate limit exceeded"
}
{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred"
}
{
  "statusCode": 503,
  "error": "Service Unavailable",
  "message": "Service temporarily unavailable"
}
{
  "statusCode": 504,
  "error": "Gateway Timeout",
  "message": "Request timeout"
}