upsertGeoLocation

The upsertGeoLocation operation handles configuration related to GeoLocation model.

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	False	string	A String object containing the name of the Geolocation object. The string can be a maximum of 128 characters. Field level constraints: cannot be null, cannot have HTML, length must be between 0 and 128 (inclusive), must match pattern (^[a-zA-Z0-9]$)\|(^[a-zA-Z0-9][ a-zA-Z0-9.+-]*[a-zA-Z0-9.+-]$). (Note: Additional constraints might exist)
description	False	string	A String object which describes the Geolocation object. The string can be a maximum of 200 characters. Field level constraints: length must be between 0 and 200 (inclusive), cannot have HTML. (Note: Additional constraints might exist)
locations	False	[object]	A Set of CountryBase objects which contain information about the Countries/Continents Allowed types are: [Continent, Country]
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 ^((?!;).)*$, cannot have HTML. (Note: Additional constraints might exist)
type	False	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Query Parameters

Parameter	Required	Type	Description
filter	False	string	Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertGeoLocation' operation
  ftd_configuration:
    operation: "upsertGeoLocation"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        locations: "{{ locations }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"