Skip to content

getJob

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to GET /v1/jobs/{id} in the new API; the migration guide has the recommended order of work and the important model differences.

Open GET /v1/jobs/{id} in the new API →

View legacy reference

/rest/workflow/job/getJobByRef/{jobRef}


GET
Gets job details for a specific job based on the job reference supplied in the URL

Parameters

jobRef - Oneserve's unique 'J' reference assigned to each job

e.g. rest/workflow/job/getJobsByRef/J01234

available response representations:
  • 200 - XML


<root>
  <job jobRef="J01MFA" jobId="49352" ownerName="Courtney Timblin" ownerEmail="" siteRef="4751" siteName="1 Cavell House" siteAdd1="1 Cavell House" siteAdd2="1 Cavell House" siteAdd3="Farnham" siteAdd4="Surrey" sitePostCode="GU9 9RE" siteType="Unknown" siteGroup="Housing - Default" siteRegion="Ability Housing - Default" usageType="Housing" contact_c1="01252 727100" contact_c2="" contact_c3="" contact_c4="" contact_c1type="1" contact_c2type="" contact_c3type="" contact_c4type="" contactNotes="" contactConsiderations="" contactRef="10992" workLogType="1" jobClientRef="J01MFA" workTypeCode="Responsive" serviceDescription="AIDS &amp; ADAPTATIONS" priorityRef="null" supplierName=".Direct Team" supplierEmail="" supplierGroup="Sub Contractor" jobDescription="test" jobStatus="Operationally Reviewed" jobExportedDate="null" siteConsiderations="1 Cavell House  Farnham   Surrey" contactSal="Mr" contactForename="Michael" contactSurname="Cullen" contactPreferred="01252 727100" reportedBy="Courtney Timblin" reportedDateTime="18/04/2016 13:55:19" createDateTime="18/04/2016 13:55:19" targetDateTime="18/04/2016 17:54:23" plannedStartDateTime="19/04/2016 11:15:00" plannedEndDateTime="29/04/2016 16:25:00" actualStartDateTime="19/04/2016 10:00:00" actualEndDateTime="19/04/2016 12:00:00" jobVersion="3" damage="wefwef" versionStatus="New" invoiceNumber="null" invoiceDate="null">
    <activities>
      <activity activityId="110385" libraryActivityCode="CBH1" description="DISTRICT HEATING; EO for adding add. corrosion inhibitor &amp; biocide to Heat/S instructed by the CA" activityRef="null" quantity="1.0" completedQuantity="0.0" category="" siteLocation="" resourceName="David" addedBy="Courtney Timblin" addedOn="19/04/2016 09:50:00" notes=""/>
    </activities>
    <appointments>
      <appointment ref="30180" status="8" sequence="6" resourceName="Courtney" resourceId="46" resourceRef="" resourceEmail="" plannedStartDateTime="29/04/2016 12:58:00" plannedEndDateTime="29/04/2016 14:38:00" actualStartDateTime="null" actualEndDateTime="null" resolutionNotes="null" clientRef="null" dayDivision="Fixed" movedToId="30185"/>
    </appointments>
    <jobCosts>
      <jobCost jobCostId="228238" jobCostRef="null" description="CO2_12345ABC : CO2_12345ABC: CO2 Asset Installation" activityCode="CO2_12345ABC" activityId="110371" supplier=".Direct Team" resource="Stephen Gardiner" costType="Activity" postingTypeId="1" statusId="1" financialDate="18/04/2016" quantity="1.0" unitCost="100.0" total="0.0" cost="150.0" supplierCost="100.0" plusTax="180.0" plusUplift="0.0" plusProfit="0.0"/>
    </jobCosts>
    <jobParts>
      <jobPart jobRef="J01MFA" partRef="DOO59323" status="USED" partDescription="Door handle for wooden doors" partUnitSalesValue="0.0" quantityRequested="0.00" quantityReceived="0.00">
        <stockTransactions>
          <stockTransaction quantityUsed="1.0" resourceID="106" resourceName="Courtney" employeeRef="" />
        </stockTransactions>
      </jobPart>
    </jobParts>
    <attributes>
      <attribute id="136" name="Pipework Installation Checked" value="Yes" attributeGroupId="29" attributeGroup="Questions"/>
    </attributes>
  </job>
  <result>success</result>
  <result_msg>
  </result_msg>
</root>

See the Workflow API matrix for the full list of endpoints in this category.