ApexERPHost

<back to all web services

GetJobs

Requires Authentication
Required role:SysAdmin
The following routes are available for this service:
GET/sys/jobs/list
GetJobs Parameters:
NameParameterData TypeRequiredDescription
JobIdquerystringNo
GetJobsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<ErpJob>No
ErpJob Parameters:
NameParameterData TypeRequiredDescription
JobIdformstringNo
NameformstringNo
TemplateIdformstringNo
QueueformstringNo
CronformstringNo
JobDataformDictionary<string, string>No
Enabledformbool?No
UsernameformstringNo
ExecuteAsUsernameformstringNo

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

HTTP + 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: 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
		}
	]
}