Jobs
Fetch a job
Fetch an existing job given its UUID.
GET
/
transform
/
v1
/
jobs
/
{id}
Authorization
Path
curl --request GET \
--url https://api.invopop.com/transform/v1/jobs/{id}
{
"attachments": [
{
"desc": "My file description.",
"hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"meta": {},
"mime": "application/pdf",
"name": "my-file.pdf",
"size": 12345,
"url": "<string>"
}
],
"completed_at": "<string>",
"created_at": "<string>",
"envelope": "<any>",
"id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
"intents": [
{
"completed": true,
"created_at": "<string>",
"events": [],
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"name": "PDF Generation",
"provider": "pdf",
"step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
"updated_at": "<string>"
}
],
"silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
"status": "<string>",
"tags": [
"<string>"
],
"updated_at": "<string>",
"workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}
Path Parameters
id
string
requiredThe UUID of the job to fetch.
Response
200 - application/json
attachments
object[]
Any attachments that have been generated while processing the job in the workflow will be here.
completed_at
string
When this job was completed, will be nil if still ongoing.
created_at
string
When the job was created.
envelope
any
Raw JSON data of the complete GOBL Envelope.
id
string
The UUIDv1 (other versions not supported) of the job
intents
object[]
Array of intent objects following the execution of each of the steps of the associated workflow.
silo_entry_id
string
status
string
Last known status text for this job.
tags
string[]
Any tags that may be useful to be associated with the job.
updated_at
string
When the job was last updated.
workflow_id
string
curl --request GET \
--url https://api.invopop.com/transform/v1/jobs/{id}
{
"attachments": [
{
"desc": "My file description.",
"hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"meta": {},
"mime": "application/pdf",
"name": "my-file.pdf",
"size": 12345,
"url": "<string>"
}
],
"completed_at": "<string>",
"created_at": "<string>",
"envelope": "<any>",
"id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
"intents": [
{
"completed": true,
"created_at": "<string>",
"events": [],
"id": "b564ff94-7823-4f54-975e-280feb38df3f",
"name": "PDF Generation",
"provider": "pdf",
"step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
"updated_at": "<string>"
}
],
"silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
"status": "<string>",
"tags": [
"<string>"
],
"updated_at": "<string>",
"workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}