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: attachment | |
---|---|
A file included or added to an incident. | |
Field | 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. |
data | The data being attached to an incident, such as a log file. |
desc | A description of the file being attached to the incident. |
extension | The extension of the file being attached to the incident. |
filename | The name of the file being attached to the incident. |
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. |
source | The source of the file being attached to the incident. |
sub-type | The sub-type of the file being attached to the incident. |
type | The type of file being attached to the incident. |
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/attachment?page=2&pagesize=1
{ "objects":[ { "meta":{ "type":"attachment", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/attachment/42" }, "extension":"txt", "sub-type":"xml", "moddate":"2012-04-25T13:33:44.523Z", "desc":"Log file containing failed logins.", "source":"Log File", "createdate":"2012-04-25T13:33:44.523Z", "filename":"server.log", "type":"text" } ], "prev":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/attachment?pagesize=1&page=1" }, "next":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/attachment?pagesize=1&page=3" } }
Object type: attachment | ||
---|---|---|
A file included or added to an incident. | ||
Field | Required | Description |
data | false | The data being attached to an incident, such as a log file. |
desc | false | A description of the file being attached to the incident. |
extension | false | The extension of the file being attached to the incident. |
filename | false | The name of the file being attached to the incident. |
source | false | The source of the file being attached to the incident. |
sub-type | false | The sub-type of the file being attached to the incident. |
type | false | The type of file being attached to the incident. |
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 attachment 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/attachment
{ "extension":"txt", "sub-type":"xml", "desc":"Log file containing failed logins.", "source":"Log File", "filename":"server.log", "type":"text" }
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/attachment/42
{ "meta":{ "type":"attachment", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/attachment/42" } }