DeforaNetworks/corteza
3
0
Fork 0
Code Activity

Remove workflow & jobs stubs

Browse Source
This commit is contained in:
Denis Arh
2019-01-09 19:54:41 +01:00
parent 513152c277
commit 74fd548fa9
16 changed files with 0 additions and 1795 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/crm/README.md
-102
View File
@@ -75,108 +75,6 @@
# Jobs
Workflow Jobs
## List jobs
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/job/` | HTTP/S | GET | |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
| --------- | ---- | ------ | ----------- | ------- | --------- |
| status | string | GET | Job status (`ok`, `error`, `running`, `cancelled` or `queued`) | N/A | NO |
| page | int | GET | Page number (0 based) | N/A | NO |
| perPage | int | GET | Returned items per page (default 50) | N/A | NO |
## Create a new job
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/job/` | HTTP/S | POST | |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
| --------- | ---- | ------ | ----------- | ------- | --------- |
| workflowID | string | POST | Workflow ID | N/A | YES |
| startAt | string | POST | Start datetime for a delayed job | N/A | NO |
| parameters | types.JobParameterSet | POST | Extra job parameters (map[string]string) | N/A | NO |
## Get job details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/job/{jobID}` | HTTP/S | GET | |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
| --------- | ---- | ------ | ----------- | ------- | --------- |
| jobID | string | PATH | Job ID | N/A | YES |
## Get job logs
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/job/{jobID}/logs` | HTTP/S | GET | |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
| --------- | ---- | ------ | ----------- | ------- | --------- |
| jobID | string | PATH | Job ID | N/A | YES |
| page | int | PATH | Page number (0 based) | N/A | NO |
| perPage | int | PATH | Returned items per page (default 50) | N/A | NO |
## Update job details
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/job/{jobID}` | HTTP/S | POST | |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
| --------- | ---- | ------ | ----------- | ------- | --------- |
| jobID | string | PATH | Job ID | N/A | YES |
| status | string | POST | Job status (`ok`, `error`, `running`, `cancelled` or `queued`) | N/A | NO |
| log | sqlxTypes.JSONText | POST | Job log item (append-only) | N/A | NO |
| workflowID | string | POST | Workflow ID | N/A | NO |
| startAt | string | POST | Start datetime for a delayed job | N/A | NO |
| parameters | types.JobParameterSet | POST | Extra job parameters (map[string]string) | N/A | NO |
## Cancel job
#### Method
| URI | Protocol | Method | Authentication |
| --- | -------- | ------ | -------------- |
| `/job/{jobID}` | HTTP/S | DELETE | |
#### Request parameters
| Parameter | Type | Method | Description | Default | Required? |
| --------- | ---- | ------ | ----------- | ------- | --------- |
| jobID | string | PATH | Job ID | N/A | YES |
# Modules
CRM module definitions