| 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: change-count | |
|---|---|
| A DeltaCounts object reflects changes that have been made to data objects in the running Sentinel system. The counts may be used by clients to avoid retrieving data that has not change. Delta counts do not persist across Sentinel server invocations; they are reset each time the server starts. | |
| Field | Description |
| created | The number of objects created since the server started. |
| deleted | The number of objects deleted since the server started. |
| meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
| modified | The number of times objects were modified since the server started. |
| name | The name of the object type for which this DeltaCounts object provides count values. |
| 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/change-count?page=2&pagesize=1
{
"objects":[
{
"meta":{
"type":"change-count",
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/change-count/user"
},
"created":12,
"name":"user",
"deleted":3,
"modified":546
}
],
"prev":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/change-count?pagesize=1&page=1"
},
"next":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/change-count?pagesize=1&page=3"
}
}
| Object type: change-count | ||
|---|---|---|
| A DeltaCounts object reflects changes that have been made to data objects in the running Sentinel system. The counts may be used by clients to avoid retrieving data that has not change. Delta counts do not persist across Sentinel server invocations; they are reset each time the server starts. | ||
| Field | Required | 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 change-count 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/change-count
{
"name":"Wildebeest"
}
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/change-count/Wildebeest
{
"meta":{
"type":"change-count",
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/change-count/Wildebeest"
}
}