Types > Task
Commerce APITypesTask
Task

Description

Topic: Tasks

Fields

created_at: String!

The date and time when the task was created, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


id: String!

A unique task identifier

Example: "ta_EQzGqWoY"


is_done: Boolean!

Whether the worker has finished working on a task or not

Example: false


lines: Int!

Total amount of lines submitted

Example: 0


lines_complete: Int!

Amount of lines successfully processed

Example: 0


lines_per_second: Int!

Approximate rate of processing (in lines per second)

Example: 0


lines_skipped: Int!

Amount of lines skipped

Example: 0


messages: [TaskMessage!]!

Messages of the task


result_name: String

Name of the result

Example: "customers"


signed_url: String

Signed download URL for tasks with results (export tasks)

Example: "https://hello.com/123"


type: TaskType!

Type of the task


updated_at: String!

The date and time when the task was last updated, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


Used By

Mutations

tasksCreate, tasksModify

Queries

tasks

Preview (typescript)

Loading module