GET /config/store_and_forward/policies
Retrieves a list of store and forward policies.
Retrieves a list of store and forward policies.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The store and forward policies were retrieved. |
|
422 |
1010 |
A request parameter is not valid. |
500 |
1020 |
An error occurred during the attempt to retrieve the store and forward policies. |
Response Description
- id - Long - The ID of the store and forward policy (Filterable).
- name - String - The name of the store and forward policy (Filterable).
- description - String - The description of the store and forward policy (Filterable).
- timezone - String - The timezone of the store and forward policy.
- owner - String - The owner of the store and forward policy (Filterable).
- store_and_forward_schedule_id - Long - The schedule ID of the store and forward policy.
- created - Long - The time in milliseconds since epoch since the store and forward policy was created.
- modified - Long - The time in milliseconds since epoch since the store and forward policy was last modified.
Response Sample
[
{
"created": 42,
"description": "String",
"id": 42,
"modified": 42,
"name": "String",
"owner": "String",
"saf_schedule_id": 42,
"timezone": "String"
}
]