184 lines
4.2 KiB
JSON
184 lines
4.2 KiB
JSON
{
|
|
"Title": "Jobs",
|
|
"Description": "Workflow Jobs",
|
|
"Package": "crm",
|
|
"Interface": "Job",
|
|
"Struct": [
|
|
{
|
|
"imports": [
|
|
"github.com/crusttech/crust/crm/types",
|
|
"sqlxTypes github.com/jmoiron/sqlx/types"
|
|
]
|
|
}
|
|
],
|
|
"Parameters": null,
|
|
"Protocol": "",
|
|
"Authentication": [],
|
|
"Path": "/job",
|
|
"APIs": [
|
|
{
|
|
"Name": "list",
|
|
"Method": "GET",
|
|
"Title": "List jobs",
|
|
"Path": "/",
|
|
"Parameters": {
|
|
"get": [
|
|
{
|
|
"name": "status",
|
|
"required": false,
|
|
"title": "Job status (`ok`, `error`, `running`, `cancelled` or `queued`)",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "page",
|
|
"required": false,
|
|
"title": "Page number (0 based)",
|
|
"type": "int"
|
|
},
|
|
{
|
|
"name": "perPage",
|
|
"required": false,
|
|
"title": "Returned items per page (default 50)",
|
|
"type": "int"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"Name": "run",
|
|
"Method": "POST",
|
|
"Title": "Create a new job",
|
|
"Path": "/",
|
|
"Parameters": {
|
|
"post": [
|
|
{
|
|
"name": "workflowID",
|
|
"required": true,
|
|
"title": "Workflow ID",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "startAt",
|
|
"required": false,
|
|
"title": "Start datetime for a delayed job",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "parameters",
|
|
"required": false,
|
|
"title": "Extra job parameters (map[string]string)",
|
|
"type": "types.JobParameterSet"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"Name": "get",
|
|
"Method": "GET",
|
|
"Title": "Get job details",
|
|
"Path": "/{jobID}",
|
|
"Parameters": {
|
|
"path": [
|
|
{
|
|
"name": "jobID",
|
|
"required": true,
|
|
"title": "Job ID",
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"Name": "logs",
|
|
"Method": "GET",
|
|
"Title": "Get job logs",
|
|
"Path": "/{jobID}/logs",
|
|
"Parameters": {
|
|
"path": [
|
|
{
|
|
"name": "jobID",
|
|
"required": true,
|
|
"title": "Job ID",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "page",
|
|
"required": false,
|
|
"title": "Page number (0 based)",
|
|
"type": "int"
|
|
},
|
|
{
|
|
"name": "perPage",
|
|
"required": false,
|
|
"title": "Returned items per page (default 50)",
|
|
"type": "int"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"Name": "update",
|
|
"Method": "POST",
|
|
"Title": "Update job details",
|
|
"Path": "/{jobID}",
|
|
"Parameters": {
|
|
"path": [
|
|
{
|
|
"name": "jobID",
|
|
"required": true,
|
|
"title": "Job ID",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"post": [
|
|
{
|
|
"name": "status",
|
|
"required": false,
|
|
"title": "Job status (`ok`, `error`, `running`, `cancelled` or `queued`)",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "log",
|
|
"required": false,
|
|
"title": "Job log item (append-only)",
|
|
"type": "sqlxTypes.JSONText"
|
|
},
|
|
{
|
|
"name": "workflowID",
|
|
"required": false,
|
|
"title": "Workflow ID",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "startAt",
|
|
"required": false,
|
|
"title": "Start datetime for a delayed job",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "parameters",
|
|
"required": false,
|
|
"title": "Extra job parameters (map[string]string)",
|
|
"type": "types.JobParameterSet"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"Name": "delete",
|
|
"Method": "DELETE",
|
|
"Title": "Cancel job",
|
|
"Path": "/{jobID}",
|
|
"Parameters": {
|
|
"path": [
|
|
{
|
|
"name": "jobID",
|
|
"required": true,
|
|
"title": "Job ID",
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
} |