ApexERPHost

GetJob

**Requires Authentication**
Required role:	SysAdmin

The following routes are available for this service:
GET	/sys/jobs/{JobId}

**GetJob** Parameters:
Name	Parameter	Data Type	Required	Description
JobId	path	string	No

**GetJobResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Result	form	ErpJob	No
Template	form	ErpJobTemplate	No
Trigger	form	ErpJobTriggerInfo	No

**ErpJob** Parameters:
Name	Parameter	Data Type	Required
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

**ErpJobTemplate** Parameters:
Name	Parameter	Data Type	Required
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

**ErpJobParameterInfo** Parameters:
Name	Parameter	Data Type	Required
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

**ErpJobTriggerInfo** Parameters:
Name	Parameter	Data Type	Required
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 .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/{JobId} HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetJobResponse 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>
    <JobId>String</JobId>
    <Name>String</Name>
    <TemplateId>String</TemplateId>
    <Queue>String</Queue>
    <Cron>String</Cron>
    <JobData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </JobData>
    <Enabled>false</Enabled>
    <Username>String</Username>
    <ExecuteAsUsername>String</ExecuteAsUsername>
  </Result>
  <Template>
    <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>
  </Template>
  <Trigger>
    <StartTimeUtc xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartTimeUtc>
    <EndTimeUtc xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EndTimeUtc>
    <FinalFireTimeUtc xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </FinalFireTimeUtc>
    <Priority>0</Priority>
    <NextFireTimeUtc xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </NextFireTimeUtc>
    <PreviousFireTimeUtc xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </PreviousFireTimeUtc>
  </Trigger>
</GetJobResponse>