| 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: backup-command | |
|---|---|
| Needs description. | |
| Field | Description |
| CommandId | Needs description. |
| command-name | Needs description. |
| dest-dir | Needs description. |
| dest-file | Needs description. |
| done-file | Needs description. |
| meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
| options | Needs description. |
| part-range | Needs description. |
| src-dir | Needs description. |
| src-file | 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/backup-command?page=2&pagesize=1
{
"objects":[
{
"meta":{
"type":"backup-command",
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/backup-command/42"
},
"command-name":"Wildebeest",
"dest-file":"Wildebeest",
"src-dir":"Wildebeest",
"src-file":"Wildebeest",
"part-range":"Wildebeest",
"done-file":"Wildebeest",
"CommandId":42,
"dest-dir":"Wildebeest",
"options":"Wildebeest"
}
],
"prev":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/backup-command?pagesize=1&page=1"
},
"next":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/backup-command?pagesize=1&page=3"
}
}
| Object type: backup-command | ||
|---|---|---|
| Needs description. | ||
| Field | Required | Description |
| CommandId | true | Needs description. |
| command-name | false | Needs description. |
| dest-dir | false | Needs description. |
| dest-file | false | Needs description. |
| done-file | false | Needs description. |
| options | false | Needs description. |
| part-range | false | Needs description. |
| src-dir | false | Needs description. |
| src-file | false | 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 backup-command 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/backup-command
{
"command-name":"Wildebeest",
"dest-file":"Wildebeest",
"src-dir":"Wildebeest",
"src-file":"Wildebeest",
"part-range":"Wildebeest",
"done-file":"Wildebeest",
"CommandId":42,
"dest-dir":"Wildebeest",
"options":"Wildebeest"
}
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/backup-command/42
{
"meta":{
"type":"backup-command",
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/backup-command/42"
}
}