Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Create a new job with the given ID.

put/transform/v1/jobs/{id}

Path parameters

idstring uuid required

ID of the job to create.

Example:5b45453c-cdd0-11ed-afa1-0242ac120002

ID of the job to create.

Query parameters

waitinteger

Only for testing. Maximum number of seconds to block the http request waiting for the job to complete and provide a response, do not use this in production.

Example:60

Only for testing. Maximum number of seconds to block the http request waiting for the job to complete and provide a response, do not use this in production.

Request body

argsobject

Additional arguments that may be used by workflow actions. Binary data may be provided inside a Data URI, including the 'name' parameter.

dataobject

Raw JSON data of the GOBL Envelope or Object when the Silo Entry ID is empty.

keystring

Key to associate with the job for idempotency.

silo_entry_idstring

ID for the entry in the silo as an alternative for the raw data object.

tagsstring[]

Tags to associate with the job.

workflow_idstring required

UUID of the workflow to execute for this job.

Response

Accepted

argsobject

Any additional arguments that might be used by workflow actions.

completed_atstring

When this job was completed, will be nil if still ongoing.

created_atstring

When the job was created.

envelopeobject

Raw JSON data of the complete GOBL Envelope.

idstring

The UUID v7 or v1 of the job

keystring

Key assigned to the job, used to identify it in the system.

silo_entry_idstring
statusstring

Last known status text for this job.

tagsstring[]

Any tags that may be useful to be associated with the job.

updated_atstring

When the job was last updated.

workflow_idstring

Example response

{
  "attachments": [
    {
      "category": "version",
      "desc": "My file description.",
      "hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "key": "pdf",
      "mime": "application/pdf",
      "name": "my-file.pdf",
      "size": 12345
    }
  ],
  "faults": [
    {
      "provider": "pdf"
    }
  ],
  "id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
  "intents": [
    {
      "events": [
        {
          "at": "2021-09-15T15:04:05.999Z",
          "status": "ERR"
        }
      ],
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "name": "PDF Generation",
      "provider": "pdf",
      "step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b"
    }
  ],
  "silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
  "workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}