Jump to

• Request
• Response
• Examples

View All Instances

get

/serviceapi/logan.uploads/{uploadId}/instances

Returns the details for a specific upload including its instances.

Request

Supported Media Types

• application/json

Path Parameters

• uploadId: integer
  Id of the Upload.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Operation succeeded.

400 Response

Bad request. See response body for explanation.

Body ()

Root Schema : InternalErrorResponse

Type: object

Show Source

• 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

{
    "properties":{
        "messages":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "type":{
            "enum":[
                "PARSERERROR",
                "INVALIDPARAMETER",
                "UNSUPPORTEDSUBSYSTEM",
                "UNSUPPORTEDFILTER",
                "UNSUPPORTEDVERSION",
                "INVALIDJOBID",
                "INVALIDQUERYID",
                "FORBIDDEN",
                "INTERNALERROR",
                "JSONERROR",
                "INTERRUPTEDERROR",
                "EXECUTIONERROR",
                "COMPILATIONERROR",
                "SERVICEAVAILABILITYERROR"
            ],
            "type":"string"
        },
        "violations":{
            "items":{
                "$ref":"#/definitions/ParserViolation"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : messages

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : violations

Type: array

Show Source

• Array of: object ParserViolation

{
    "items":{
        "$ref":"#/definitions/ParserViolation"
    },
    "type":"array"
}

Nested Schema : ParserViolation

Type: object

Show Source

• end(optional): integer(int32)
• message(optional): string
• start(optional): integer(int32)

{
    "properties":{
        "end":{
            "format":"int32",
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "start":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

403 Response

Forbidden. User does not have required privileges.

500 Response

Internal server error. See response body for explanation.

Body ()

Root Schema : InternalErrorResponse

Type: object

Show Source

• 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

{
    "properties":{
        "messages":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "type":{
            "enum":[
                "PARSERERROR",
                "INVALIDPARAMETER",
                "UNSUPPORTEDSUBSYSTEM",
                "UNSUPPORTEDFILTER",
                "UNSUPPORTEDVERSION",
                "INVALIDJOBID",
                "INVALIDQUERYID",
                "FORBIDDEN",
                "INTERNALERROR",
                "JSONERROR",
                "INTERRUPTEDERROR",
                "EXECUTIONERROR",
                "COMPILATIONERROR",
                "SERVICEAVAILABILITYERROR"
            ],
            "type":"string"
        },
        "violations":{
            "items":{
                "$ref":"#/definitions/ParserViolation"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : messages

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : violations

Type: array

Show Source

• Array of: object ParserViolation

{
    "items":{
        "$ref":"#/definitions/ParserViolation"
    },
    "type":"array"
}

Nested Schema : ParserViolation

Type: object

Show Source

• end(optional): integer(int32)
• message(optional): string
• start(optional): integer(int32)

{
    "properties":{
        "end":{
            "format":"int32",
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "start":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

Back to Top

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?offset=0&limit=10""

Example of Response

The following shows an example of the response body.

{ 
   "count":2,
   "hasMore":false,
   "items":[ 
      { 
         "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",     
         "files":[                                        
            { 
               "fileName":"syslog.log",
               "sourceId":10051,
               "targetId":"D462B169ACBABC667A703A39BB39098D",             
               "sourceName":"Linux Syslog Logs",      
               "targetName":"test.example.com",                          
               "targetType":"Host (Linux)",                                 
               "entityName":"test.example.com",                        
               "entityType":"Host (Linux)",                               
               "entityId":"D462B1ABC846AEA778A703A39BB39098D"              
            }
         ],
         "canonicalLink":"v1/logdata/uploads/1066/instances/1066",
      },
      { 
         "uploadId":1066,
         "instanceId":1068,
         "status":"inProgress",
         "startedBy":"adminuser",
         "startedOn":"2016-04-28T14:22:55.753Z",
         "totalChunks":50,
         "chunksProcessed":15,                             
         "files":[                                         
            { 
               "fileName":"syslog2.log",
               "sourceId":10051,
               "targetId":"D462B169ACBABC667A703A39BB39098D",             
               "sourceName":"Linux Syslog Logs",      
               "targetName":"test.example.com",                         
               "targetType":"Host (Linux)",                                
               "entityName":"test.example.com",                         
               "entityType":"Host (Linux)",                              
               "entityId":"D462B1ABC846AEA778A703A39BB39098D"              
            }
         ],   
         "canonicalLink":"v1/logdata/uploads/1066/instances/1068"
      }
   ],
   "canonicalLink":"v1/logdata/uploads/1066/instances"
}

Back to Top