| Required role: | SysAdmin |
| GET | /sys/jobs/list |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| JobId | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Result | form | List<ErpJob> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| JobId | form | string | No | |
| Name | form | string | No | |
| TemplateId | form | string | No | |
| Queue | form | string | No | |
| Cron | form | string | No | |
| JobData | form | Dictionary<string, string> | No | |
| Enabled | form | bool? | No | |
| Username | form | string | No | |
| ExecuteAsUsername | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sys/jobs/list HTTP/1.1 Host: 10.10.0.107 Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Result:
[
{
JobId: String,
Name: String,
TemplateId: String,
Queue: String,
Cron: String,
JobData:
{
String: String
},
Enabled: False,
Username: String,
ExecuteAsUsername: String
}
]
}