Jump to

• Request
• Response
• Examples

View All Uploads

get

/serviceapi/logan.uploads

Returns a list of uploads, optionally filtered by uploadName and uploadUser and restricted by offset and limit.

Request

Supported Media Types

• application/json

Query Parameters

• includeItems(optional): boolean
  Indicates whether to include the items. If not specified items are included. That is, if you only want the count of uploads use includeItems=false.
• limit(optional): integer
  Maximum number of results to return. Defaults to 50.
• offset(optional): integer
  First result to return. Defaults to 0.
• orderBy(optional): string
  Order in which results should be returned. The orderBy syntax is comma-separated list of fields along with an optional sort direction.

  Valid fields include: uploadName, uploadUser, modifiedOn and createdOn.

  Valid sort directions include: asc and desc.

  Default: modifiedOn:desc.

• uploadName(optional): string
  Name of upload. To match the upload's name must be an exact match to the value specified in uploadName.
• uploadUser(optional): string
  Name of upload user. To match the upload's user must be an exact match to the value specified in uploadUser.

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 2 most recently modified uploads 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?limit=2"

Example of Response

The following shows an example of the response body.

{
  "count": 2,
  "hasMore": true,
  "items": [
    {
      "uploadId": 1067,
      "uploadName": "DbAlertLogUpload",
      "uploadUser": "adminuser",
      "createdOn": "2016-04-28T14:19:53.171Z",
      "modifiedOn": "2016-04-28T14:19:53.171Z",
      "earliestLogTime": "2016-02-28T14:19:53.171Z",      
      "latestLogTime": "2016-02-28T15:19:53.171Z",        
      "statusSummary": {
        "successful": 1
      },
      "canonicalLink": "v1/logdata/uploads/searches/1067"
    },
    {
      "uploadId": 1066,
      "uploadName": "SyslogUpload",
      "uploadUser": "adminuser",
      "createdOn": "2016-04-28T14:15:35.532Z",
      "modifiedOn": "2016-04-28T14:15:35.532Z",
      "earliestLogTime": "2016-04-27T12:19:53.171Z",     
      "latestLogTime": "2016-04-27T16:19:53.171Z",       
      "statusSummary": {
        "successful": 1
      },
      "canonicalLink": "v1/logdata/uploads/searches/1066"
    }
  ],
  "canonicalLink": "v1/logdata/uploads/searches"
}

Back to Top