ON THIS PAGE
GET /config/store_and_forward/policies/{id}
SUMMARY Retrieves a store and forward policy.
Retrieves a store and forward policy.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
id |
path |
Required |
Number (Integer) |
text/plain |
null |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The store and forward policy was retrieved. |
|
404 |
1002 |
The store and forward policy does not exist. |
500 |
1020 |
An error occurred during the attempt to retrieve the store and forward policy. |
Response Description
- id - Long - The ID of the store and forward policy.
- name - String - The name of the store and forward policy.
- description - String - The description of the store and forward policy.
- timezone - String - The timezone of the store and forward policy.
- owner - String - The owner of the store and forward policy.
- 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" }