developer notes

Update Job Order

The JobOrderUpdate API allows you to update an existing Job Order. The request body includes job order name, status, and other relevant information.

Method	API Endpoint
PUT	`{{endpoint}}/api/ext/job-orders`

‍

Headers

‍

Key	Value
Content-Type	`application/json`
Authorization	`Bearer {{token}}`

‍

Example Request

‍

{
      "jobOrder": {
          "jobOrderNumber": "JO-034886",
          "jobOrderName": "jobOrder1",
          "installationDate": "2023-10-05",
          "installationTime": "2023-10-05T02:12:53.000Z",
          "completionDate": null,
          "status": "OPEN",
          "completionTime": null,
          "jobExternalId": null,
          "orderAmount": null,
          "jobSfExternalId": null,
          "contactPersonName": null,
          "contactPersonEmail": null,
          "contactPersonPhone": null,
          "resolution": null,
          "description": null,
          "jobDescription": null,
          "installationStreet": null,
          "installationCity": null,
          "installationState": null,
          "installationPostalCode": null,
          "installationCountry": null,
          "createdDateTime": "2023-10-05T02:15:13Z",
          "modifiedDateTime": "2023-10-05T02:15:13Z",
          "placeId": null,
          "includePrice": false,
          "showServiceChecklist": false,
          "showCustomerServiceReport": false,
          "showHandoverCertificate": false,
          "serviceChecklistRequired": false,
          "customerServiceReportRequired": false,
          "handoverCertificateRequired": false,
          "systemValue": "",
          "redFlag": false,
          "medicalRecordNumber": null,
          "origExt": null,
          "ward": null,
          "bed": null,
          "onCode": null,
          "onCodeMessage": null,
          "offCode": null,
          "offCodeMessage": null,
          "ipAddress": null,
          "hospitalCode": null,
          "fault": null,
          "additionalFaultsValue": null,
          "faultDetails": null,
          "resolutionValue": null,
          "additionalResolutionsValue": null,
          "resolutionComments": null,
          "openingDays": null,
          "workNotDoneReasonValue": null,
          "workNotDoneOther": null,
          "physicalDamage": false,
          "physicalDamageDescription": null,
          "bedStatus": null,
          "ableToFix": null,
          "recommendation": null,
          "billable": false,
          "daysCategory": null,
          "notifyCustomer": false,
          "checkInDuration": null,
          "totalDistance": null,
          "travelDuration": null,
          "invoiceNumber": null,
          "assetUnderWarranty": false,
          "completionDateTime": null,
          "installationLatitude": null,
          "installationLongitude": null,
          "createdBy": {
              "id": 1,
              "login": "load.test1@trial.custella.com",
              "firstName": "Load",
              "lastName": "Adminnn",
              "imageUrl": null,
              "fullName": "Load Adminnn"
          },
          "orderOwner": {
              "id": 1,
              "login": "load.test1@trial.custella.com",
              "firstName": "Load",
              "lastName": "Adminnn",
              "imageUrl": null,
              "fullName": "Load Adminnn"
          },
          "modifiedBy": {
              "id": 1,
              "login": "load.test1@trial.custella.com",
              "firstName": "Load",
              "lastName": "Adminnn",
              "imageUrl": null,
              "fullName": "Load Adminnn"
          },
          "customerPurchaseHistoryPickListLites": null,
          "uncompleatedJobOrder": null,
          "valueFault": null,
          "valueResolution": null,
          "additionalValueFaults": null,
          "additionalValueResolutions": null,
          "customerServiceReport": null,
          "serviceChecklist": null,
          "handoverCertificate": null,
          "ticket": null,
          "additionalFaults": null,
          "additionalResolutions": null,
          "workNotDoneReason": null,
          "hpForm": null,
          "deleted": false,
          "journeyStatusActive": false,
          "serviceZone": null
      },
      "jobOrderProductList": [],
      "maintenanceItem": null
}

‍

Example Response

‍

//status - 200
{
    "jobOrder": {
    "id": 35307,
      "jobOrderNumber": "JO-035307",
      "jobOrderName": "TestNov1",
      "installationDate": "2023-11-01",
      "installationTime": "2023-11-01T05:20:00.000Z",
      "completionDate": null,
      "status": "OPEN",
      "completionTime": null,
      "jobExternalId": null,
      "orderAmount": null,
      "jobSfExternalId": null,
      "contactPersonName": null,
      "contactPersonEmail": null,
      "contactPersonPhone": null,
      "resolution": null,
      "description": null,
      "jobDescription": null,
      "installationStreet": "KLIA Terminal 2 - International Arrival Hall, Kuala Lumpur International Airport",
      "installationCity": "Sepang",
      "installationState": "Selangor",
      "installationPostalCode": "64000",
      "installationCountry": "Malaysia",
      "createdDateTime": "2023-11-01T05:20:12Z",
      "modifiedDateTime": "2023-11-01T05:20:12Z",
      "placeId": null,
      "includePrice": false,
      "showServiceChecklist": false,
      "showCustomerServiceReport": false,
      "showHandoverCertificate": false,
      "serviceChecklistRequired": false,
      "customerServiceReportRequired": false,
      "handoverCertificateRequired": false,
      "systemValue": "Main Unit",
      "redFlag": false,
      "medicalRecordNumber": null,
      "origExt": null,
      "ward": null,
      "bed": null,
      "onCode": null,
      "onCodeMessage": null,
      "offCode": null,
      "offCodeMessage": null,
      "ipAddress": null,
      "hospitalCode": null,
      "fault": null,
      "pmvId": null,
      "checklistRecordId": null,
      "additionalFaultsValue": null,
      "faultDetails": null,
      "resolutionValue": null,
      "additionalResolutionsValue": null,
      "resolutionComments": null,
      "openingDays": null,
      "workNotDoneReasonValue": null,
      "workNotDoneOther": null,
      "physicalDamage": false,
      "physicalDamageDescription": null,
      "bedStatus": null,
      "ableToFix": null,
      "recommendation": null,
      "billable": false,
      "daysCategory": null,
      "notifyCustomer": false,
      "checkInDuration": null,
      "totalDistance": null,
      "travelDuration": null,
      "invoiceNumber": null,
      "assetUnderWarranty": false,
      "completionDateTime": null,
      "installationLatitude": null,
      "installationLongitude": null,
      "uuid": "83f0abf2-f569-43f0-8cbe-2a318edba2e8",
      "createdByExternal": "load.tech1@trial.custella.com",
      "modifiedByExternal": "load.tech1@trial.custella.com",
      "createdBy": {
          "id": 3,
          "login": "load.tech1@trial.custella.com",
          "firstName": "Technician",
          "lastName": "User",
          "imageUrl": null,
          "email": "preeti@fieldex.com",
          "fullName": "Technician User"
      },
      "orderOwner": {
          "id": 3,
          "login": "load.tech1@trial.custella.com",
          "firstName": "Technician",
          "lastName": "User",
          "imageUrl": null,
          "email": "preeti@fieldex.com",
          "fullName": "Technician User"
      },
      "modifiedBy": {
          "id": 3,
          "login": "load.tech1@trial.custella.com",
          "firstName": "Technician",
          "lastName": "User",
          "imageUrl": null,
          "email": "preeti@fieldex.com",
          "fullName": "Technician User"
      },
      "customer": {
          "id": 3,
          "name": "1 Load Test [DO NOT DELETE]",
          "email": null,
          "isDeleted": "N"
      },
      "jobOrderType": {
          "id": 2,
          "name": "Installation",
          "label": "Installation",
          "order": 0,
          "isDefault": true,
          "active": true,
          "systemValue": false,
          "joTypeJOStatus": null
      },
      "serviceZone": {
          "id": 6,
          "name": "AssetServiceZone",
          "label": "AssetServiceZone",
          "isDefault": false
      },
      "customerPurchaseHistoryPickListLites": null,
      "taskList": null,
      "products": [],
      "uncompleatedJobOrder": null,
      "assets": {
          "id": 11555,
          "name": "aewrwtwe",
          "runningNo": "AST-011555",
          "serialNo": null,
          "externalId": null
      },
      "valueFault": {
          "id": 9,
          "name": "JO Fault 1",
          "faultCode": "JO_Fault_1",
          "active": true,
          "label": null,
          "order": 0,
          "isDefault": false,
          "systemValue": false
      },
      "valueResolution": {
          "id": 4,
          "name": "Solved on Site",
          "resolutionCode": "Solved_on_Site",
          "active": true,
          "label": null,
          "order": 0,
          "isDefault": false,
          "systemValue": false
      },
      "site": {
          "id": 6596,
          "siteNumber": "ST-006596",
          "siteName": "Site Hassan"
      },
      "project": {
          "id": 2168,
          "name": "sa test 1"
      },
      "additionalValueFaults": null,
      "additionalValueResolutions": null,
      "customerServiceReport": null,
      "serviceChecklist": null,
      "handoverCertificate": null,
      "ticket": null,
      "additionalFaults": null,
      "additionalResolutions": null,
      "workNotDoneReason": null,
      "hpForm": null,
      "createdByExternalUser": null,
      "modifiedByExternalUser": null,
      "deleted": false,
      "journeyStatusActive": false
    },
    "jobOrderProductList": [],
    "maintenanceItem": null
}