View An Instance of an Upload
get
/serviceapi/logan.uploads/{uploadId}/instances/{instanceId}
Returns the details for a specific upload instance including its files.
Request
Supported Media Types
- application/json
Path Parameters
-
instanceId: integer
Id of the instance.
-
uploadId: integer
Id of the Upload.
Response
Supported Media Types
- application/json
200 Response
Operation succeeded.
400 Response
Bad request. See response body for explanation.
Root Schema : InternalErrorResponse
Type:
Show Source
object
-
messages(optional):
array messages
-
type(optional):
string
Allowed Values:
[ "PARSERERROR", "INVALIDPARAMETER", "UNSUPPORTEDSUBSYSTEM", "UNSUPPORTEDFILTER", "UNSUPPORTEDVERSION", "INVALIDJOBID", "INVALIDQUERYID", "FORBIDDEN", "INTERNALERROR", "JSONERROR", "INTERRUPTEDERROR", "EXECUTIONERROR", "COMPILATIONERROR", "SERVICEAVAILABILITYERROR" ]
-
violations(optional):
array violations
403 Response
Forbidden. User does not have required privileges.
500 Response
Internal server error. See response body for explanation.
Root Schema : InternalErrorResponse
Type:
Show Source
object
-
messages(optional):
array messages
-
type(optional):
string
Allowed Values:
[ "PARSERERROR", "INVALIDPARAMETER", "UNSUPPORTEDSUBSYSTEM", "UNSUPPORTEDFILTER", "UNSUPPORTEDVERSION", "INVALIDJOBID", "INVALIDQUERYID", "FORBIDDEN", "INTERNALERROR", "JSONERROR", "INTERRUPTEDERROR", "EXECUTIONERROR", "COMPILATIONERROR", "SERVICEAVAILABILITYERROR" ]
-
violations(optional):
array violations
Examples
The following example shows how retrieve the list of instances for an by submitting a GET request on the REST resource using cURL.
curl -u "OMC_USERNAME" -X GET -H "Content-Type:application/json" "https://{OMC_URL}/serviceapi/logan.uploads/1066/instances/1066"
Example of Response
The following shows an example of the response body.
{ "uploadId":1066, "instanceId":1066, "status":"successful", "startedBy":"adminuser", "startedOn":"2016-04-28T14:15:35.532Z", "completedOn":"2016-04-28T14:17:35.532Z", "totalChunks":1, "chunksProcessed":1, "earliestLogTime": "2016-04-27T12:19:53.171Z", "latestLogTime": "2016-04-27T16:19:53.171Z", "canonicalLink":"v1/logdata/uploads/1066/instances/1066", "files":[ { "fileName":"syslog.log", "sourceId":10051, "targetId":"D462B169A46ABCABCA703A39BB39098D", "sourceName":"Linux Syslog Logs", "targetName":"test.example.com", "targetType":"Host (Linux)", "entityName":"test.example.com", "entityType":"Host (Linux)", "entityId":"ABCABCABCEA778A703A39BB39098D" } ] }