jobs

Deprecated

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

Legacy GET /rest/workflow/job/jobs/{startDate}/{endDate}/{clientIDs} returned jobs changed within a date range (max 1 month). The new endpoint filters by jobRefs/clientRef/workLogId/searchTerm only - there is no "changed-since" date filter. For change feeds use OneCore webhook event subscriptions instead of polling.

Open GET /v1/jobs in the new API →

View legacy reference

/rest/workflow/job/jobs/{startDate}/{endDate}/{clientIDs}

GET

Gets job details for all jobs that have changed within the period specified (start date/time to end date/time inclusive), for the client IDs specified (provided in a comma-separated list).

Parameters

startDate - date to get changes from in format dd-mmm-yyyy hh:mm:ss

endDate - date to get changes to in format dd-mmm-yyyy hh:mm:ss

clientIDs - the IDs of the clients

Notes

• maximum difference between end and start date is one month
• changed jobs will be identified by any Job where Job Details (including custom fields/attributes) or related Appointments, Activities, Costs or Parts have changed 

Example

e.g. rest/workflow/job/jobs/29-May-2012%2010:30:00/30-May-2012%2000:00:00/1,3,7

available response representations:

• 200 - XML

<root>
    <jobs>
        <job jobRef="J007TG"              jobId="1162"
             ownerName="ITAdmin"             ownerEmail="email"
             siteRef="abc123"
             siteName="14 New Street"             siteAdd1="Add 1"             siteAdd2="Add 2"             siteAdd3="Add 3"             siteAdd4="Add 4"             sitePostCode="Post Code"              siteType="Flat"                    usageType="Housing"
             workLogType="23"
             jobClientRef="hfhei"
             workTypeCode="CYCL"
             serviceDescription="Electrical"
             priorityRef="M34"
             supplierName="Direct Team"
             supplierEmail="DirectEmail"             supplierGroup="Direct"
             jobDescription="fix tap"
             jobStatus="In Progress"
             siteConsiderations="dkjf"
             contactSal="Mr"
             contactForename="Bob"
             contactSurname="Smith"
             contactPreferred="07845 377899"
             reportedBy="bob"
             reportedDateTime="11/07/2011 12:32:17"
             createDateTime="11/07/2011 12:32:17"
             targetDateTime="11/07/2011 12:32:17"
             plannedStartDateTime="11/07/2011 12:32:17"
             plannedEndDateTime="11/07/2011 12:32:17"
             actualStartDateTime="11/07/2011 12:32:17"
             actualEndDateTime="11/07/2011 12:32:17"
             jobVersion="2"
             damage="ABC23"
             versionStatus="3"
             invoiceNumber="3838"
             invoiceDate="11/07/2011 12:32:43"             jobExportedDate="06/05/2013 10:30:00">
             <activities>
                <activity activityId="15546"                           libraryActivityCode="fbfdjj"                           description="fix tap"                           quantity="2"                           completedQuantity="0"                          category="Activity category 1"                          siteLocation="location"                          resourceName="John Doe"                          addedBy="itadmin"                          addedOn="12/03/2011 12:34:34" />             </activities>

             <appointments>
                 <appointment id="44352"                              status="5"                               resourceName="Brian Cox"
                              plannedStartDateTime="12/03/2011 12:34:34"
                              plannedEndDateTime="12/03/2011 12:34:34"
                              actualStartDateTime="12/03/2011 12:34:34" 
                              actualEndDateTime="12/03/2011 12:34:34" 
                              resolutionNotes="All work completed"
                              dayDivision="AM"                              movedToId="" />             </appointments>
             <jobCosts>
                  <jobCost jobCostId="500"                            jobCostRef="null"                            description="description"                               libraryActivityCode="abc" 
                           supplier=""                            resource=""                            postingTypeId="1"                            statusId="1"                            financialDate="17/11/2011"
                           quantity="50.0"                            unitCost="0.9"                            total="0.0"                            cost="0.0"                            supplierCost="0.9" 
                           plusTax="0.99"                            plusUplift="0.9"                            plusProfit="0.9"/>
              </jobCosts>                            <jobParts>                   <jobPart id="1124"                            jobRef="J007TG"                             status="USED"                             quantityReceived="0.00"                             quantityRequested="0.00"                             partUnitSalesValue="0.0"                             partDescription="VAILLANT 114286 KNOB (SET OF 3) "                            partRef="489419">
                       <stockTransactions>                            <stockTransaction                                 resourceName="IT Admin"                                 resourceID="71"                                employeeRef="12345"
                                quantityUsed="1.0" />                       </stockTransactions>                   </jobPart>              </jobParts>                              <attributes>                  <attribute name="Issue Date" value="12/12/2009 12:34:56"/>
              </attributes>
        </job>         </jobs>
    <result>success</result><result_msg></result_msg>
</root>

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