Jump to

• Request
• Response
• Examples

Get records for batch metric upload

get

/serviceapi/entityModel/uds/metrics/status/{ecId}/records

Read detailed ingest status records for a given packet.

Request

Supported Media Types

• application/json

Path Parameters

• ecId: string
  unique execution context id

Query Parameters

• limit(optional): integer(int32)
  when returning paged data, limit volume of results

  Default Value: 2000
• offset(optional): integer(int32)
  When returning paged data, start offset

  Default Value: 0

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : RefItemListIngestStatusDetailsRef

Type: object

Show Source

• count: integer(int32)
  The number of items in the list
• hasMore: boolean
  Default Value: false

  Indicates if there are more items
• items: array items
  The items
• nextLink(optional): string
  The link to get the next chunk of items (if paging)
• previousLink(optional): string
  The link to the previous chunk of items (if paging)
• totalCount(optional): integer(int32)
  The total number of items (if paging)

{
    "type":"object",
    "required":[
        "count",
        "hasMore",
        "items"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in the list"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more items",
            "default":false
        },
        "items":{
            "type":"array",
            "description":"The items",
            "items":{
                "$ref":"#/definitions/IngestStatusRef"
            }
        },
        "nextLink":{
            "type":"string",
            "description":"The link to get the next chunk of items (if paging)"
        },
        "previousLink":{
            "type":"string",
            "description":"The link to the previous chunk of items (if paging)"
        },
        "totalCount":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of items (if paging)"
        }
    }
}

Nested Schema : items

Type: array

The items

Show Source

• Array of: object IngestStatusRef

  References a data ingest status resource.

{
    "type":"array",
    "description":"The items",
    "items":{
        "$ref":"#/definitions/IngestStatusRef"
    }
}

Nested Schema : IngestStatusRef

Type: object

References a data ingest status resource.

Show Source

• canonicalLink: string
  Read Only: true

  The link to the status resource

  Example: /serviceapi/data/facts/status/92aa97cc-01eb-4ff8-a49e-13b4ce76aed0
• ecId: string
  The execution context id for the ingest status

  Example: 92aa97cc-01eb-4ff8-a49e-13b4ce76aed0

{
    "type":"object",
    "required":[
        "canonicalLink",
        "ecId"
    ],
    "properties":{
        "canonicalLink":{
            "type":"string",
            "example":"/serviceapi/data/facts/status/92aa97cc-01eb-4ff8-a49e-13b4ce76aed0",
            "description":"The link to the status resource",
            "readOnly":true
        },
        "ecId":{
            "type":"string",
            "example":"92aa97cc-01eb-4ff8-a49e-13b4ce76aed0",
            "description":"The execution context id for the ingest status"
        }
    },
    "description":"<p>References a data ingest status resource.</p>"
}

Back to Top

Examples

JSON Response:

{
  "count" : <number>,
  "hasMore" : <boolean>,
  "items" : [
    {
      "canonicalLink" : "/serviceapi/data/facts/status/92aa97cc-01eb-4ff8-a49e-13b4ce76aed0",
      "ecId" : "92aa97cc-01eb-4ff8-a49e-13b4ce76aed0",
    },
    ...
  ],
  "nextLink" : "<string>",
  "previousLink" : "<string>",
  "totalCount" : <number>,
}

Back to Top