action agco_ats_reporting_update_groups {
  label: "Get a list of Update Groups.  Update Groups are used by the client to register for a specific type of update."
  description: "No Documentation Found."
  provider: agco_ats
  method: GET
  path: "/api/v2/Reporting/UpdateGroups"
  encoding: json
  input: {
    type: "object"
    properties: {
      limit: {
        type: "integer"
        format: "int32"
      }
      offset: {
        type: "integer"
        format: "int32"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "A response containing a page of results and metadata concerning the results"
    required: ["Entities", "Metadata"]
    properties: {
      Entities: {
        type: "array"
        items: {
          type: "object"
          required: ["Description", "UpdateType", "Priority"]
          properties: {
            Description: {
              type: "string"
              description: "The description of the update group"
            }
            ID: {
              type: "string"
            }
            InventoryFrequency: {
              type: "integer"
              format: "int32"
              description: "The time in minutes between inventory checks. Default value is 1440 minutes (one day)."
            }
            InventoryPackage: {
              type: "string"
              description: "The Package ID of the package used for inventory"
            }
            LocalizedDescription: {
              type: "string"
              description: "Optional. The StringID used to localize the description of the update group"
            }
            LocalizedName: {
              type: "string"
              description: "Optional. The StringID used to localize the name of the update group"
            }
            Priority: {
              type: "integer"
              format: "int32"
              description: "The execution priority of the package relative to other packages in the bundle. Range 1 - 100, lower value indication higher priority."
            }
            ReportField: {
              type: "string"
              description: "A field to return in the status report for this update group.
\n            Specify the field with the format [Label]: {[InventoryPackageID].[Category].[Attribute]}.  (i.e. example: {bec778ca-278d-424a-867a-4653a1a19e86.MyCategory.MyAttribute})"
            }
            UpdateType: {
              type: "string"
              description: "The update type name"
            }
            ValidatingField: {
              type: "string"
              description: "A field used for validation in the status report for this update group.
\n            Specify the field with the format [Label]: {[InventoryPackageID].[Category].[Attribute]}.  (i.e. example: {bec778ca-278d-424a-867a-4653a1a19e86.MyCategory.MyAttribute})"
            }
            ValueToValidate: {
              type: "string"
              description: "The value to validate the ValidationField against."
            }
            Version: {
              type: "string"
              format: "byte"
              description: "The version of the UpdateGroup, this value is incremented with each modification to a related Bundle or PackageType"
            }
          }
        }
      }
      Metadata: {
        type: "object"
        description: "Metadata for the paged response"
        required: ["Limit", "Offset", "TotalCount"]
        properties: {
          Limit: {
            type: "integer"
            format: "int32"
            description: "The number of entities this paged response is limited to."
          }
          Offset: {
            type: "integer"
            format: "int32"
            description: "The number of entities prior to this page of items."
          }
          TotalCount: {
            type: "integer"
            format: "int32"
            description: "The total number of entities matching the request."
          }
        }
      }
    }
  }
}