Oracle Management Cloud Common REST API

Perform search (JSON)

post

/serviceapi/querylanguage.query

Perform a search by using the ExportRequest object. The only mandatory body parameter is queryString. To learn more about how queries work, see Get Started With Log Analytics.

This API will output the query results as a JSON.

Request

Supported Media Types

application/json

Header Parameters

X-REMOTE-USER: string

User name
X-USER-IDENTITY-DOMAIN-NAME: string

Tenant ID

Query to be executed.

Root Schema : QueryRequest

Type: object

Show Source

includeColumns(optional): boolean

Default Value: false

Include columns in response

Example: true
includeFields(optional): boolean

Default Value: false

Include fields in response

Example: true
includeTotalCount(optional): boolean

Default Value: false

Include the total number of results from the query. Note, this value will always be equal to or less than maxTotalCount.

Example: false
limit(optional): integer(int32)

Maximum number of results to return in this request. Note a limit=-1 returns all results from offset onwards up to maxtotalCount.

Example: 500
maxTotalCount(optional): integer(int32)

Maximum number of results to count. Note a maximum of 2001 will be enforced; that is, actualMaxTotalCountUsed = Math.min(maxTotalCount, 2001).

Example: 500
offset(optional): integer(int32)

Index of first result to return for this request.

Example: 10
outputMode(optional): string

Allowed Values: [ "jsonRows" ]

Specifies the format for the returned results. Possible values include: jsonRows.
queryPriority(optional): integer(int32)
queryString: string

Query to perform. To learn more about how queries work, see Get Started With Log Analytics.

Example: * | stats count by 'Log Source'
queryTimeout(optional): integer(int32)

Amount of time, in seconds, allowed for a query to complete. If this time expires before the query is complete, any partial results will be returned.
subSystem(optional): string

Allowed Values: [ "LOG", "SECURITY" ]

Each subsystem has its own namespace for fields it contains. This means two fields in different subsystems can have the same name; for example, log.status and target.status refer to two different fields. The subsystem parameter identifies the default subsystem to use when validating/querying a field that is not explicity qualifed by its subsystem.
targetFilters(optional): object TargetFilters
timeFilter(optional): object TimeFilter

Discriminator: type

{
    "properties":{
        "includeColumns":{
            "default":false,
            "description":"Include columns in response",
            "example":true,
            "type":"boolean"
        },
        "includeFields":{
            "default":false,
            "description":"Include fields in response",
            "example":true,
            "type":"boolean"
        },
        "includeTotalCount":{
            "default":false,
            "description":"Include the total number of results from the query. Note, this value will always be equal to or less than maxTotalCount.",
            "example":false,
            "type":"boolean"
        },
        "limit":{
            "description":"Maximum number of results to return in this request.  Note a limit=-1 returns all results from offset onwards up to maxtotalCount.",
            "example":500,
            "format":"int32",
            "type":"integer"
        },
        "maxTotalCount":{
            "description":"Maximum number of results to count.  Note a maximum of 2001 will be enforced; that is, actualMaxTotalCountUsed = Math.min(maxTotalCount, 2001).",
            "example":500,
            "format":"int32",
            "type":"integer"
        },
        "offset":{
            "description":"Index of first result to return for this request.",
            "example":10,
            "format":"int32",
            "type":"integer"
        },
        "outputMode":{
            "description":"Specifies the format for the returned results. Possible values include: jsonRows.",
            "enum":[
                "jsonRows"
            ],
            "type":"string"
        },
        "queryPriority":{
            "format":"int32",
            "type":"integer"
        },
        "queryString":{
            "description":"Query to perform. To learn more about how queries work, see <a href='LogAnalytics.html'>Get Started With Log Analytics</a>.",
            "example":"* | stats count by 'Log Source'",
            "type":"string"
        },
        "queryTimeout":{
            "description":"Amount of time, in seconds, allowed for a query to complete. If this time expires before the query is complete, any partial results will be returned.",
            "format":"int32",
            "type":"integer"
        },
        "subSystem":{
            "description":"Each subsystem has its own namespace for fields it contains. This means two fields in different subsystems can have the same name; for example, log.status and target.status refer to two different fields. The subsystem parameter identifies the default subsystem to use when validating/querying a field that is not explicity qualifed by its subsystem.",
            "enum":[
                "LOG",
                "SECURITY"
            ],
            "type":"string"
        },
        "targetFilters":{
            "$ref":"#/definitions/TargetFilters"
        },
        "timeFilter":{
            "$ref":"#/definitions/TimeFilter"
        }
    },
    "required":[
        "queryString"
    ],
    "type":"object"
}

Nested Schema : TargetFilters

Type: object

Show Source

filters(optional): array filters
match(optional): string

Allowed Values: [ "ALL", "ANY" ]

{
    "properties":{
        "filters":{
            "items":{
                "$ref":"#/definitions/TargetFilter"
            },
            "type":"array"
        },
        "match":{
            "enum":[
                "ALL",
                "ANY"
            ],
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : TimeFilter

Type: object

Discriminator: type

Nested Schema : filters

Type: array

Show Source

Array of: object TargetFilter

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

Nested Schema : TargetFilter

Type: object

Show Source

name(optional): string

Allowed Values: [ "ENTITY_NAME", "ME_ID", "MEMBER_OF", "USED_BY", "USES", "SAVED_SEARCH" ]
operator(optional): string

Allowed Values: [ "IS_EQUAL" ]
values(optional): array values

{
    "properties":{
        "name":{
            "enum":[
                "ENTITY_NAME",
                "ME_ID",
                "MEMBER_OF",
                "USED_BY",
                "USES",
                "SAVED_SEARCH"
            ],
            "type":"string"
        },
        "operator":{
            "enum":[
                "IS_EQUAL"
            ],
            "type":"string"
        },
        "values":{
            "items":{
                "type":"string"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : values

Type: array

Show Source

Array of: string

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

Response

Supported Media Types

application/json

200 Response

Operation succeeded

Root Schema : QueryResultResponse

Type: object

Show Source

columns(optional): array columns
fields(optional): array fields
incrementalSearchTime(optional): integer(int64)
insights(optional): object Insights
nextOffset(optional): integer(int32)
partialResultReason(optional): string
partialResults(optional): boolean

Default Value: false
responseTime(optional): integer(int64)
results(optional): array results
totalCount(optional): integer(int64)
totalMatchedCount(optional): integer(int64)

{
    "properties":{
        "columns":{
            "items":{
                "$ref":"#/definitions/ColumnDescriptor"
            },
            "type":"array"
        },
        "fields":{
            "items":{
                "$ref":"#/definitions/ColumnDescriptor"
            },
            "type":"array"
        },
        "incrementalSearchTime":{
            "format":"int64",
            "type":"integer"
        },
        "insights":{
            "$ref":"#/definitions/Insights"
        },
        "nextOffset":{
            "format":"int32",
            "type":"integer"
        },
        "partialResultReason":{
            "type":"string"
        },
        "partialResults":{
            "default":false,
            "type":"boolean"
        },
        "responseTime":{
            "format":"int64",
            "type":"integer"
        },
        "results":{
            "items":{
                "items":{
                    "type":"object"
                },
                "type":"array"
            },
            "type":"array"
        },
        "totalCount":{
            "format":"int64",
            "type":"integer"
        },
        "totalMatchedCount":{
            "format":"int64",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : columns

Type: array

Show Source

Array of: object ColumnDescriptor

Discriminator: type

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

Nested Schema : fields

Type: array

Show Source

Array of: object ColumnDescriptor

Discriminator: type

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

Nested Schema : Insights

Type: object

Show Source

fields(optional): array fields
sampledValues(optional): array sampledValues

{
    "properties":{
        "fields":{
            "items":{
                "$ref":"#/definitions/InsightsField"
            },
            "type":"array"
        },
        "sampledValues":{
            "items":{
                "type":"string"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

Array of: array items

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

Nested Schema : ColumnDescriptor

Type: object

Discriminator: type

Show Source

displayName(optional): string
evaluable(optional): boolean

Default Value: false
fullDisplayName(optional): string
fullInternalName(optional): string
groupable(optional): boolean

Default Value: false
hasValues(optional): boolean

Default Value: false
internalName(optional): string
multiValued(optional): boolean

Default Value: false
originalDisplayName(optional): string
subsystem(optional): string

Allowed Values: [ "LOG", "SECURITY" ]
values(optional): array values
valueType(optional): string

Allowed Values: [ "BOOLEAN", "STRING", "DOUBLE", "FLOAT", "LONG", "INTEGER", "TIMESTAMP", "FACET" ]

{
    "discriminator":"type",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "evaluable":{
            "default":false,
            "type":"boolean"
        },
        "fullDisplayName":{
            "type":"string"
        },
        "fullInternalName":{
            "type":"string"
        },
        "groupable":{
            "default":false,
            "type":"boolean"
        },
        "hasValues":{
            "default":false,
            "type":"boolean"
        },
        "internalName":{
            "type":"string"
        },
        "multiValued":{
            "default":false,
            "type":"boolean"
        },
        "originalDisplayName":{
            "type":"string"
        },
        "subsystem":{
            "enum":[
                "LOG",
                "SECURITY"
            ],
            "type":"string"
        },
        "valueType":{
            "enum":[
                "BOOLEAN",
                "STRING",
                "DOUBLE",
                "FLOAT",
                "LONG",
                "INTEGER",
                "TIMESTAMP",
                "FACET"
            ],
            "type":"string"
        },
        "values":{
            "items":{
                "$ref":"#/definitions/FieldValue"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : values

Type: array

Show Source

Array of: object FieldValue

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

Nested Schema : FieldValue

Type: object

Show Source

deleted(optional): boolean

Default Value: false
displayValue(optional): string
internalValue(optional): object internalValue

{
    "properties":{
        "deleted":{
            "default":false,
            "type":"boolean"
        },
        "displayValue":{
            "type":"string"
        },
        "internalValue":{
            "type":"object"
        }
    },
    "type":"object"
}

Nested Schema : internalValue

Type: object

Nested Schema : fields

Type: array

Show Source

Array of: object InsightsField

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

Nested Schema : sampledValues

Type: array

Show Source

Array of: string

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

Nested Schema : InsightsField

Type: object

Show Source

displayName(optional): string
internalName(optional): string

{
    "properties":{
        "displayName":{
            "type":"string"
        },
        "internalName":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

400 Response

Bad request. See response body for explanation.

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.

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"
}