action agco_ats_activities_get_activities { label: "Get Activities" description: "Gets a collection of Activities. When successful, the response is a PagedResponse of Activities. \n If unsuccessful, an appropriate ApiError is returned." provider: agco_ats method: GET path: "/api/v2/activities" encoding: json input: { type: "object" properties: { isIncludeDeleted: { 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 IActivity" properties: { ActivityID: { type: "integer" format: "int32" description: "The ID of the activity" } Deleted: { type: "boolean" } Name: { type: "string" description: "The name of the activity" } Parameters: { type: "array" description: "The parameters for this activity" items: { type: "object" description: "A DTO for an IParameter" properties: { Direction: { type: "string" description: "The parameter direction (Input or Output)" enum: ["Input", "Output"] } Name: { type: "string" description: "The name of the parameter" } Type: { type: "string" description: "The data type of the parameter" enum: ["String", "Boolean", "Integer", "Float", "StringDictionary"] } } } } Steps: { type: "array" description: "The steps which are performed for this activity" 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" } } } } } } } 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." } } } } } }