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 .xml suffix or ?format=xml

HTTP + XML

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: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetJobTemplatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <ErpJobTemplate>
      <Id>String</Id>
      <Name>String</Name>
      <DisplayName>String</DisplayName>
      <Description>String</Description>
      <Category>String</Category>
      <IsSysJob>false</IsSysJob>
      <Parameters>
        <ErpJobParameterInfo>
          <Name>String</Name>
          <DisplayName>String</DisplayName>
          <Description>String</Description>
          <Order>0</Order>
          <Required>false</Required>
          <Format>String</Format>
          <EditType>0</EditType>
          <DataType>0</DataType>
          <AllowEval>false</AllowEval>
        </ErpJobParameterInfo>
      </Parameters>
    </ErpJobTemplate>
  </Result>
</GetJobTemplatesResponse>