| Required role: | SysAdmin |
| GET | /sys/jobs/templates | ||
|---|---|---|---|
| GET | /sys/jobs/templates/{Id} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Result | form | List<ErpJobTemplate> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No | |
| DisplayName | form | string | No | |
| Description | form | string | No | |
| Category | form | string | No | |
| IsSysJob | form | bool | No | |
| Parameters | form | List<ErpJobParameterInfo> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| DisplayName | form | string | No | |
| Description | form | string | No | |
| Order | form | int? | No | |
| Required | form | bool? | No | |
| Format | form | string | No | |
| EditType | form | int? | No | |
| DataType | form | int? | No | |
| AllowEval | form | bool? | 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/templates 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:
[
{
Id: String,
Name: String,
DisplayName: String,
Description: String,
Category: String,
IsSysJob: False,
Parameters:
[
{
Name: String,
DisplayName: String,
Description: String,
Order: 0,
Required: False,
Format: String,
EditType: 0,
DataType: 0,
AllowEval: False
}
]
}
]
}