Parameter | Type | Default Value | Description |
---|---|---|---|
query |
string | [no filter] | The TinyQ language filter that specifies a subset of all available records. |
field |
string | not present | The name or names of fields whose values are to be returned. The field item may appear zero or more times in the URI query parameters. A single value of "[none]" indicates return only metadata. The absence of any field parameter indicates return all field values, |
page |
integer | 1 | The 1-based offset into the total records based on page size. Actual offset is (page - 1) * pagesize. |
pagesize |
integer | [unlimited] | The maximum number of object records to return as a result of the request. |
Object type: page | |
---|---|
A container for one or more objects in the result listing. There may be multiple pages in a listing if a page size is specified that is less than the total number of objects in the listing. | |
Field | Description |
next | A URL addressing the subsequent page of objects in the total set of available objects. |
objects | The list of objects returned in the page of results. |
prev | A URL addressing the previous page of objects in the total set of available objects. |
Object type: IndexedLogPartition | |
---|---|
Needs description. | |
Field | Description |
ByteCount | Needs description. |
CorrelatedEventsExported | Needs description. |
CorrelatedEventsImported | Needs description. |
createdate | The date and time when the object was created. |
creator | The URL of the Sentinel User object that represents the creator of the object. |
Date | Needs description. |
EventAssocAction | Needs description. |
EventAssocActionStartTime | Needs description. |
EventAssocDataExported | Needs description. |
EventAssocDataInDB | Needs description. |
EventAssocThreadEndCause | Needs description. |
EventCount | Needs description. |
IncidentsEventsExported | Needs description. |
IncidentsEventsImported | Needs description. |
IndexVersion | Needs description. |
meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
moddate | The date and time when the object was last modified. |
modifier | The URL of the Sentinel User object that represents the last modifier of the object. |
Name | Needs description. |
RetentionPolicy | Needs description. |
State | Needs description. |
Object type: meta | |
---|---|
The metadata for an object, including the object type name and the URL reference to the object. | |
Field | Description |
@href | The URL reference to the object. |
type | The name of the object type |
GET https://164.99.19.131:8443/SentinelRESTServices/objects/IndexedLogPartition?page=2&pagesize=1
{ "objects":[ { "meta":{ "type":"IndexedLogPartition", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/IndexedLogPartition/42" }, "moddate":"2012-04-25T13:33:44.619Z", "createdate":"2012-04-25T13:33:44.619Z", "EventAssocActionStartTime":"2012-04-25T13:33:44.619Z", "IncidentsEventsImported":42, "EventAssocThreadEndCause":42, "Name":"Wildebeest", "CorrelatedEventsExported":42, "IncidentsEventsExported":42, "ByteCount":42, "EventCount":42, "State":42, "EventAssocDataExported":true, "Date":"2012-04-25T13:33:44.619Z", "CorrelatedEventsImported":42, "EventAssocDataInDB":42, "IndexVersion":42, "EventAssocAction":42 } ], "prev":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/IndexedLogPartition?pagesize=1&page=1" }, "next":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/IndexedLogPartition?pagesize=1&page=3" } }
Object type: IndexedLogPartition | ||
---|---|---|
Needs description. | ||
Field | Required | Description |
ByteCount | false | Needs description. |
CorrelatedEventsExported | false | Needs description. |
CorrelatedEventsImported | false | Needs description. |
Date | true | Needs description. |
EventAssocAction | false | Needs description. |
EventAssocActionStartTime | false | Needs description. |
EventAssocDataExported | false | Needs description. |
EventAssocDataInDB | false | Needs description. |
EventAssocThreadEndCause | false | Needs description. |
EventCount | false | Needs description. |
IncidentsEventsExported | false | Needs description. |
IncidentsEventsImported | false | Needs description. |
IndexVersion | true | Needs description. |
Name | true | Needs description. |
RetentionPolicy | false | Needs description. |
State | true | Needs description. |
Object type: meta | ||
---|---|---|
The metadata for an object, including the object type name and the URL reference to the object. | ||
Field | Required | Description |
@href | false | The URL reference to the object. |
type | false | The name of the object type |
Object type: | |
---|---|
The metadata representation of the newly-created IndexedLogPartition object, including the URL reference to the new object. | |
Field | Description |
meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
Object type: meta | |
---|---|
The metadata for an object, including the object type name and the URL reference to the object. | |
Field | Description |
@href | The URL reference to the object. |
type | The name of the object type |
POST https://164.99.19.131:8443/SentinelRESTServices/objects/IndexedLogPartition
{ "EventAssocActionStartTime":"2012-04-25T13:33:44.629Z", "IncidentsEventsImported":42, "EventAssocThreadEndCause":42, "Name":"Wildebeest", "CorrelatedEventsExported":42, "IncidentsEventsExported":42, "ByteCount":42, "EventCount":42, "State":42, "EventAssocDataExported":true, "Date":"2012-04-25T13:33:44.629Z", "CorrelatedEventsImported":42, "EventAssocDataInDB":42, "IndexVersion":42, "EventAssocAction":42 }
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/IndexedLogPartition/42
{ "meta":{ "type":"IndexedLogPartition", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/IndexedLogPartition/42" } }