Skip to content

jobVersion

No recent usage observed

No replacement exists in the new API yet. However, no calls to this endpoint were recorded in production access logs (April to June 2026), so it may be retired early, without a replacement. If your integration uses this endpoint, contact Oneserve support as soon as possible so that it stays supported.

Reference

/rest/workflow/job/version/{startDate}/{endDate}/{versionAction}/{clientId}/{supplierIdList}

GET
Gets job details for all jobs that have undergone a new version submission or approval in the period specified (start date/time to end date/time inclusive).  The results can be filtered by Client ID and Supplier ID.  If filtered by Supplier ID only versions where Activities have changed and are assigned to the specified Supplier will be included.

Parameters

startDate - date to get jobs from in format dd-mmm-yyyy hh:mm:ss
endDate - date to get jobs to in format dd-mmm-yyyy hh:mm:ss
versionAction - the version action that job must have undergone to be included: 
                        1 - Submit
                        2 - Approve
                            3 - Reject
clientId - retrieve jobs for the specified client Id
supplierIdList - a comma-separated list of Supplier Id's - only jobs with versions where activities that have changed and are assigned to the specified suppliers will be returned

e.g. rest/workflow/job/versions/29-May-2012%2010:30:00/30-May-2012%2000:00:00/1/1/71,135,326

available response representations:
  • 200 - XML

<root>  <jobs>    <job>      <jobRef>J007TG</jobRef>      <jobClientRef>abc123</jobClientRef>
      <workLogTypeCode>CYCL</workLogTypeCode>      <workTypeDescription>CYCL</worTypeDescription>      <serviceDescription>Plumbing</serviceDescription>      <priorityDescription>High</priorityDescription>      <jobDescription>fix tap</jobDescription>      <jobStatus>Open</jobStatus>
      <reportedBy>Kelly</reportedBy>      <reportedDateTime>12/12/2012 12:12:12</reportedDateTime>      <targetDateTime>12/12/2012 12:12:12</targetDateTime>      <jobVersion>1</jobVersion>      <damage>abc123</damage>
      <damageDesc>test</damageDesc>      <versionStatus>New</versionStatus>
      <siteRef>abc123</siteRef>      <siteName>12 abert ave</siteName>      <siteAddress1>12 abert ave</siteAddress1>      <siteAddress2>avonmouth</siteAddress2>      <siteAddress3>avon</siteAddress3>      <siteAddress4>UK</siteAddress4>      <sitePostCode>AV5 8UJ</sitePostCode>      <siteConsiderations>dog</siteConsiderations>      <contactSal>Mr</contactSal>      <contactForename>Bob</contactForename>      <contactSurname>Smith</contactSurname>      <contactPreferred>078676 787899</contactPreferred>
      <contactPreferredType>1</contactPreferredType>

      <contactConsideration>notes</contactConsideration>      <siteGroupId>3</siteGroupId>      <usageTypeId>4</usageTypeId>      <regionId>3</regionId>      <siteTypeId>4</siteTypeId>      <siteArea>abc</siteArea>
                  <activities>        <activity>          <activityId>433</activityId>          <libraryActivityCode>HHJS7</libraryActivityCode>          <activityRef>HHS6</activityRef>          <supplierId>23</supplierId>          <qty>23.00</totalQty>        </activity>      </activities>            
    </job>  </jobs></root>


Field Notes

Activities

activityId - unique activity record Id
activityCode - library activity code
totalQty - qty on activity history record
updateQty - qty change from previous value
action - action from activity history record: 1 = Add, 2 = Update, 3 = Delete
qtyAction - action that occurred to quantity: A - qty added, D - qty deleted, U - qty not changed

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