action agco_ats_agents_get_agents {
  label: "Get Agents"
  description: "Gets a collection of Agents. When successful, the response is a PagedResponse of Agents.  
\n            If unsuccessful, an appropriate ApiError is returned."
  provider: agco_ats
  method: GET
  path: "/api/v2/agents"
  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"
          description: "A DTO for an IAgent"
          required: ["UserID", "MachineName", "Status", "KeepAliveInterval"]
          properties: {
            AgentID: {
              type: "integer"
              format: "int32"
              description: "The id of the Agent"
            }
            KeepAliveInterval: {
              type: "integer"
              format: "int32"
              description: "The 'Heartbeat Interval' used by the Build Agent."
            }
            MachineName: {
              type: "string"
              description: "The machine name of the computer the agent is running on"
            }
            Status: {
              type: "object"
              description: "A DTO for an IAgentStatus"
              required: ["Online"]
              properties: {
                LastStatusUpdate: {
                  type: "string"
                  format: "date-time"
                  description: "ReadOnly. The UTC date and time of the last status update"
                }
                Online: {
                  type: "boolean"
                  description: "Indicates if the agent is online"
                }
              }
            }
            StepConfigurations: {
              type: "array"
              description: "The agent's step configurations"
              items: {
                type: "object"
                description: "Step Configuration"
                required: ["StepImplementationID"]
                properties: {
                  Configurations: {
                    type: "array"
                    description: "The configuration names supported.  The configurations collection is empty for steps which do not require configuration."
                    items: {
                      type: "string"
                    }
                  }
                  StepImplementationID: {
                    type: "string"
                    description: "The Implementation ID of the step this configuration is for"
                  }
                }
              }
            }
            UserID: {
              type: "integer"
              format: "int32"
              description: "The UserID of the Agent"
            }
          }
        }
      }
      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."
          }
        }
      }
    }
  }
}