action agco_ats_job_runs_get_job_runs {
  label: "Get JobRuns"
  description: "Gets a collection of JobRuns. When successful, the response is a PagedResponse of JobRuns.
\n            If unsuccessful, an appropriate ApiError is returned."
  provider: agco_ats
  method: GET
  path: "/api/v2/jobRuns"
  encoding: json
  input: {
    type: "object"
    properties: {
      includeActivityRunDetails: {
        type: "boolean"
      }
      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 IJobRun"
          properties: {
            ActivityRuns: {
              type: "array"
              description: "The activity runs belonging to this JobRun"
              items: {
                type: "object"
                description: "A DTO for an IActivityRun"
                required: ["Status"]
                properties: {
                  ActivityRunID: {
                    type: "integer"
                    format: "int32"
                    description: "The identifier for the ActivityRun"
                  }
                  EndDate: {
                    type: "string"
                    format: "date-time"
                    description: "Read Only. The UTC date and time when the activity completed"
                  }
                  JobActivityID: {
                    type: "integer"
                    format: "int32"
                    description: "Read Only. The ID of the Job Activity that defines this activity run"
                  }
                  JobRunID: {
                    type: "integer"
                    format: "int32"
                    description: "Read Only. The ID of the JobRun under which this ActivityRun is executing"
                  }
                  Parameters: {
                    type: "array"
                    description: "The parameters used for this run of the activity.  Parameters cannot be added or removed, but output parameter values may be updated."
                    items: {
                      type: "object"
                      description: "A DTO for an IParameterValue"
                      properties: {
                        Direction: {
                          type: "string"
                          description: "The parameter direction (Input or Output)"
                          enum: ["Input", "Output"]
                        }
                        Name: {
                          type: "string"
                          description: "The name of the parameter this value is for"
                        }
                        Value: {
                          type: "string"
                          description: "The parameter value in string representation"
                        }
                      }
                    }
                  }
                  StartDate: {
                    type: "string"
                    format: "date-time"
                    description: "Read Only. The UTC date and time when the activity started"
                  }
                  Status: {
                    type: "object"
                    description: "A DTO for an IActivityRunStatus"
                    properties: {
                      CurrentStep: {
                        type: "integer"
                        format: "int32"
                        description: "The activity step currently executing, indicated by numeric order"
                      }
                      Status: {
                        type: "string"
                        description: "The status of the ActivityRun"
                        enum: ["Ready", "InProgress", "Succeeded", "Cancelled", "Failed"]
                      }
                      StepProgress: {
                        type: "integer"
                        format: "int32"
                        description: "The percent progress from the currently executing step.  This value shall be null if progress is not available"
                      }
                      StepStatus: {
                        type: "string"
                        description: "The status text from the currently executing step"
                      }
                    }
                  }
                  Steps: {
                    type: "array"
                    description: "Read Only. The steps to be executed for the activity.  These steps come from the relationship through JobActivity down to ActivityStep"
                    items: {
                      type: "object"
                      description: "A DTO for an IActivityStep"
                      properties: {
                        ActivityID: {
                          type: "integer"
                          format: "int32"
                          description: "The id of the activity this activity step belongs to"
                        }
                        ActivityStepID: {
                          type: "integer"
                          format: "int32"
                          description: "The id of this activity step"
                        }
                        ImplementationID: {
                          type: "string"
                          description: "The implementation id which is used to look up the step implementation"
                        }
                        ParameterMappings: {
                          type: "array"
                          description: "The mapping of values from a source to be used for the step parameters"
                          items: {
                            type: "object"
                            description: "A DTO for an IParameterMapping"
                            properties: {
                              Name: {
                                type: "string"
                                description: "The name of the parameter this mapping applies to"
                              }
                              Source: {
                                type: "string"
                                description: "The source of the value.  The meaning of this value is determined by the source type.  When the source type is “Constant” then source is the value formatted as a string.  When the source type is “Variable” then the source is the name of the variable"
                              }
                              SourceType: {
                                type: "string"
                                description: "The source type used for supplying the parameter"
                                enum: ["Constant", "Variable"]
                              }
                            }
                          }
                        }
                        RunOrder: {
                          type: "integer"
                          format: "int32"
                          description: "The order of this activity step relative to other activity steps"
                        }
                        StepID: {
                          type: "integer"
                          format: "int32"
                          description: "The id of the step"
                        }
                        StepName: {
                          type: "string"
                          description: "The name of the step"
                        }
                        UseConfig: {
                          type: "string"
                          description: "Indicates the configuration for the ActivityStep to use at runtime.  The build agent must provide this configuration"
                        }
                      }
                    }
                  }
                }
              }
            }
            EndDate: {
              type: "string"
              format: "date-time"
              description: "The UTC date and time when the job completed"
            }
            JobID: {
              type: "integer"
              format: "int32"
              description: "The ID of the job that defines the run"
            }
            JobRunID: {
              type: "integer"
              format: "int32"
              description: "The ID of this JobRun"
            }
            Parameters: {
              type: "array"
              description: "The parameters used for this run of the job"
              items: {
                type: "object"
                description: "A DTO for an IParameterValue"
                properties: {
                  Direction: {
                    type: "string"
                    description: "The parameter direction (Input or Output)"
                    enum: ["Input", "Output"]
                  }
                  Name: {
                    type: "string"
                    description: "The name of the parameter this value is for"
                  }
                  Value: {
                    type: "string"
                    description: "The parameter value in string representation"
                  }
                }
              }
            }
            StartDate: {
              type: "string"
              format: "date-time"
              description: "The UTC date and time when the job started"
            }
            Status: {
              type: "string"
              description: "The status of this JobRun"
              enum: ["Ready", "InProgress", "Succeeded", "Cancelled", "Failed"]
            }
          }
        }
      }
      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."
          }
        }
      }
    }
  }
}