Jump to

• Request
• Response
• Examples

Get status for batch metric upload

get

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

Retrieves the ingest status for the given execution context id.

Request

Supported Media Types

• application/json

Path Parameters

• ecId: string
  unique execution context id

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : DataIngestStatus

Type: object

Describes the status of a data ingest batch job.

Show Source

• count: integer(int32)
  The number of records received in a load packet

  Example: 1000
• ecId: string
  The execution context id that is associated with every load request

  Example: 92aa97cc-01eb-4ff8-a49e-13b4ce76aed0
• endTime: string(date-time)
  The time in UTC when the upload completed

  Example: 2017-12-23T21:08:45.998Z
• errorMessage(optional): string
  The error message if the upload failed

  Example: an error message
• loaded: integer(int32)
  The number of loaded records

  Example: 900
• message(optional): string
  An additional message about the load

  Example: a message
• rejected: integer(int32)
  The number of rejected records

  Example: 100
• selfLink: string
  Read Only: true

  The link to this status resource

  Example: /serviceapi/data/facts/status/92aa97cc-01eb-4ff8-a49e-13b4ce76aed0
• size: integer(int32)
  The size of the packet

  Example: 10000
• startTime: string(date-time)
  The time in UTC when the upload started

  Example: 2017-12-23T21:08:40.123Z
• status: string
  Allowed Values: [ "IN_PROGRESS", "SUCCESS", "FAILED" ]

  The status of the upload

  Example: IN_PROGRESS

{
    "type":"object",
    "required":[
        "count",
        "ecId",
        "endTime",
        "loaded",
        "rejected",
        "selfLink",
        "size",
        "startTime",
        "status"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "example":1000,
            "description":"The number of records received in a load packet"
        },
        "ecId":{
            "type":"string",
            "example":"92aa97cc-01eb-4ff8-a49e-13b4ce76aed0",
            "description":"The execution context id that is associated with every load request"
        },
        "endTime":{
            "type":"string",
            "format":"date-time",
            "example":"2017-12-23T21:08:45.998Z",
            "description":"The time in UTC when the upload completed"
        },
        "errorMessage":{
            "type":"string",
            "example":"an error message",
            "description":"The error message if the upload failed"
        },
        "loaded":{
            "type":"integer",
            "format":"int32",
            "example":900,
            "description":"The number of loaded records"
        },
        "message":{
            "type":"string",
            "example":"a message",
            "description":"An additional message about the load"
        },
        "rejected":{
            "type":"integer",
            "format":"int32",
            "example":100,
            "description":"The number of rejected records"
        },
        "selfLink":{
            "type":"string",
            "example":"/serviceapi/data/facts/status/92aa97cc-01eb-4ff8-a49e-13b4ce76aed0",
            "description":"The link to this status resource",
            "readOnly":true
        },
        "size":{
            "type":"integer",
            "format":"int32",
            "example":10000,
            "description":"The size of the packet"
        },
        "startTime":{
            "type":"string",
            "format":"date-time",
            "example":"2017-12-23T21:08:40.123Z",
            "description":"The time in UTC when the upload started"
        },
        "status":{
            "type":"string",
            "example":"IN_PROGRESS",
            "description":"The status of the upload",
            "enum":[
                "IN_PROGRESS",
                "SUCCESS",
                "FAILED"
            ]
        }
    },
    "description":"<p>Describes the status of a data ingest batch job.</p>"
}

Back to Top

Examples

JSON Response:

{
  "count" : 1000,
  "ecId" : "92aa97cc-01eb-4ff8-a49e-13b4ce76aed0",
  "endTime" : 2017-12-23T21:08:45.998Z,
  "errorMessage" : "an error message",
  "loaded" : 900,
  "message" : "a message",
  "rejected" : 100,
  "selfLink" : "/serviceapi/data/facts/status/92aa97cc-01eb-4ff8-a49e-13b4ce76aed0",
  "size" : 10000,
  "startTime" : 2017-12-23T21:08:40.123Z,
  "status" : "IN_PROGRESS",
}

Back to Top