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
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : DataIngestStatus
Type:
object
Describes the status of a data ingest batch job.
-
count:
integer(int32)
The number of records received in a load packetExample:
1000
-
ecId:
string
The execution context id that is associated with every load requestExample:
92aa97cc-01eb-4ff8-a49e-13b4ce76aed0
-
endTime:
string(date-time)
The time in UTC when the upload completedExample:
2017-12-23T21:08:45.998Z
-
errorMessage(optional):
string
The error message if the upload failedExample:
an error message
-
loaded:
integer(int32)
The number of loaded recordsExample:
900
-
message(optional):
string
An additional message about the loadExample:
a message
-
rejected:
integer(int32)
The number of rejected recordsExample:
100
-
selfLink:
string
Read Only:
true
The link to this status resourceExample:/serviceapi/data/facts/status/92aa97cc-01eb-4ff8-a49e-13b4ce76aed0
-
size:
integer(int32)
The size of the packetExample:
10000
-
startTime:
string(date-time)
The time in UTC when the upload startedExample:
2017-12-23T21:08:40.123Z
-
status:
string
Allowed Values:
[ "IN_PROGRESS", "SUCCESS", "FAILED" ]
The status of the uploadExample:IN_PROGRESS
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