ApexERPHost

<back to all web services

GetJobTemplates

Requires Authentication
Required role:SysAdmin
The following routes are available for this service:
GET/sys/jobs/templates
GET/sys/jobs/templates/{Id}
GetJobTemplates Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
GetJobTemplatesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<ErpJobTemplate>No
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

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/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
				}
			]
		}
	]
}