editSystemFeedObject
The editSystemFeedObject operation handles configuration related to SystemFeedObject model.
Description
This API call is not allowed on the standby unit in an HA pair.
Data Parameters
Parameter | Required | Type | Description | ||
---|---|---|---|---|---|
version | False | string | A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected. | ||
name | True | string | A mandatory string representing the Feed Name. The string cannot have spaces or HTML tags. | ||
lastUpdate | False | string | An ISO8601 string representing the last update time of the feed. The string cannot have space or HTML tags. Field level constraints: must match pattern (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][ a-zA-Z0-9.+-]*[a-zA-Z0-9.+-]$). (Note: Additional constraints might exist) |
||
updateFrequency | False | string | An enum value that specifies the feed update frequency, set to THIRTY_MINS by default . The values can be one of the following. DISABLED - Disable the update frequency. THRITY_MINS - Update the feeds every 30 mins. ONE_HOUR - Update the feeds every 1 hour. TWO_HOURS - Update the feeds every 2 hours. FOUR_HOURS - Update the feeds every 4 hours. SIX_HOURS - Update the feeds every 6 hours. EIGHT_HOURS - Update the feeds every 8 hours. TWELVE_HOURS - Update the feeds every 12 hours. ONE_DAY - Update the feeds every day. TWO_DAYS - Update the feeds every two days. ONE_WEEK - Update the feeds every one week. |
||
id | False | string | A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
||
type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. |
Path Parameters
Parameter | Required | Type | Description | ||
---|---|---|---|---|---|
objId | True | string |
Example
- name: Execute 'editSystemFeedObject' operation
ftd_configuration:
operation: "editSystemFeedObject"
data:
version: "{{ version }}"
name: "{{ name }}"
lastUpdate: "{{ last_update }}"
updateFrequency: "{{ update_frequency }}"
id: "{{ id }}"
type: "{{ type }}"
path_params:
objId: "{{ obj_id }}"