ApexERPHost

<back to all web services

GetJob

Requires Authentication
Required role:SysAdmin
The following routes are available for this service:
GET/sys/jobs/{JobId}
GetJob Parameters:
NameParameterData TypeRequiredDescription
JobIdpathstringNo
GetJobResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformErpJobNo
TemplateformErpJobTemplateNo
TriggerformErpJobTriggerInfoNo
ErpJob Parameters:
NameParameterData TypeRequiredDescription
JobIdformstringNo
NameformstringNo
TemplateIdformstringNo
QueueformstringNo
CronformstringNo
JobDataformDictionary<string, string>No
Enabledformbool?No
UsernameformstringNo
ExecuteAsUsernameformstringNo
ErpJobTemplate Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
DisplayNameformstringNo
DescriptionformstringNo
CategoryformstringNo
IsSysJobformboolNo
ParametersformList<ErpJobParameterInfo>No
ErpJobParameterInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DisplayNameformstringNo
DescriptionformstringNo
Orderformint?No
Requiredformbool?No
FormatformstringNo
EditTypeformint?No
DataTypeformint?No
AllowEvalformbool?No
ErpJobTriggerInfo Parameters:
NameParameterData TypeRequiredDescription
StartTimeUtcformDateTimeOffsetNo
EndTimeUtcformDateTimeOffset?No
FinalFireTimeUtcformDateTimeOffset?No
PriorityformintNo
NextFireTimeUtcformDateTimeOffset?No
PreviousFireTimeUtcformDateTimeOffset?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-protobuf suffix or ?format=x-protobuf

HTTP + X-PROTOBUF

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: application/x-protobuf
HTTP/1.1 200 OK
Content-Type: application/x-protobuf
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":"\/Date(-62135596800000)\/","EndTimeUtc":"\/Date(-62135596800000)\/","FinalFireTimeUtc":"\/Date(-62135596800000)\/","Priority":0,"NextFireTimeUtc":"\/Date(-62135596800000)\/","PreviousFireTimeUtc":"\/Date(-62135596800000)\/"}}