Required role: | SysAdmin |
GET | /sys/jobs/{JobId} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
JobId | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Result | form | ErpJob | No | |
Template | form | ErpJobTemplate | No | |
Trigger | form | ErpJobTriggerInfo | 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 |
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StartTimeUtc | form | DateTimeOffset | No | |
EndTimeUtc | form | DateTimeOffset? | No | |
FinalFireTimeUtc | form | DateTimeOffset? | No | |
Priority | form | int | No | |
NextFireTimeUtc | form | DateTimeOffset? | No | |
PreviousFireTimeUtc | form | DateTimeOffset? | 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/{JobId} HTTP/1.1 Host: apex.nikoratrade.ge 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 }, Template: { 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 } ] }, Trigger: { StartTimeUtc: 0001-01-01T00:00:00.0000000+00:00, EndTimeUtc: 0001-01-01T00:00:00.0000000+00:00, FinalFireTimeUtc: 0001-01-01T00:00:00.0000000+00:00, Priority: 0, NextFireTimeUtc: 0001-01-01T00:00:00.0000000+00:00, PreviousFireTimeUtc: 0001-01-01T00:00:00.0000000+00:00 } }