latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Work Requests

Get work request

get/workrequests/{id}

Path parameters

idinteger required

ID of the workRequest

Query parameters

expandstring[]

To expand multiple fields: expand=asset&expand=location

Response

Successfully retrieved workRequest's information

Example response

{
  "workRequest": {
    "id": 963,
    "title": "Forklift Preventive Maintenance Form",
    "attachments": [
      {
        "id": 12345,
        "mimeType": "image/png",
        "fileName": "image.png",
        "url": "http://example.com/image.png",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "width": 220,
        "height": 100
      }
    ],
    "thumbnail": {
      "id": 12345,
      "mimeType": "image/png",
      "fileName": "image.png",
      "url": "http://example.com/image.png",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "width": 220,
      "height": 100
    },
    "priority": "MEDIUM",
    "description": "A forklift that needs to be reviewed for any potential problems",
    "requestStatus": "PENDING",
    "assetId": 843,
    "locationId": 852,
    "workOrderId": 254,
    "sendEmailNotification": true,
    "extraFields": {
      "Request Type": "Water Leak"
    },
    "approverTeamId": 254,
    "creatorContactInfo": {
      "type": "EMAIL",
      "value": "james@example.com"
    },
    "createdAt": "2022-01-01T00:00:00.000Z",
    "updatedAt": "2022-01-01T00:00:00.000Z",
    "asset": {
      "id": 963,
      "name": "Forklift",
      "description": "Forklift that is used to to move heavy equipments around the warehouse",
      "parentId": 852,
      "criticalityId": 150,
      "locationId": 852,
      "serialNumber": "000123ABC",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "updatedAt": "2022-01-01T00:00:00.000Z",
      "creatorId": 851
    },
    "location": {
      "id": 963,
      "name": "Warehouses",
      "description": "The warehouse where we store the forklifts",
      "address": "1090 main street, Franklin",
      "parentId": 852,
      "createdAt": "2022-01-01T00:00:00.000Z",
      "updatedAt": "2022-01-01T00:00:00.000Z"
    },
    "workOrder": {
      "assetId": 42,
      "attachments": [
        {
          "id": 12345,
          "mimeType": "image/png",
          "fileName": "image.png",
          "url": "http://example.com/image.png",
          "createdAt": "2022-01-01T00:00:00.000Z",
          "width": 220,
          "height": 100
        }
      ],
      "categories": [
        "Cleaning"
      ],
      "completedAt": "2022-01-01T00:00:00.000Z",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "deletedAt": "2022-01-01T00:00:00.000Z",
      "description": "A work order sample description",
      "dueDate": "2022-01-01T00:00:00.000Z",
      "estimatedTime": 3600,
      "externalData": {
        "popularErpSolutionId": "asd732da"
      },
      "lastMessageSentAt": "2022-01-01T00:00:00.000Z",
      "startDate": "2022-01-01T00:00:00.000Z",
      "locationId": 611,
      "priority": "MEDIUM",
      "recurrenceInfo": {
        "automationMeterTrigger": {
          "newDueDateOffsetSeconds": 86400
        }
      },
      "thumbnail": {
        "id": 12345,
        "mimeType": "image/png",
        "fileName": "image.png",
        "url": "http://example.com/image.png",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "width": 220,
        "height": 100
      },
      "updatedAt": "2022-01-01T00:00:00.000Z",
      "extraFields": {
        "Estimated Time Allotted": "24 Hours"
      },
      "vendorIds": [
        1
      ],
      "customerId": 128,
      "procedure": {
        "id": 1234,
        "templateIds": [
          1234,
          1235
        ],
        "title": "Control dashboard audit",
        "maxScore": 2,
        "score": 1,
        "fields": [
          {
            "id": 1234,
            "parentId": 1233,
            "procedureTemplateId": 1234,
            "procedureTemplateFieldId": 5678,
            "description": "Number of green lights",
            "type": "NUMBER",
            "label": "Number of green lights",
            "maxScore": 2,
            "score": 1,
            "value": {
              "text": "12",
              "attachment": {
                "id": 12345,
                "mimeType": "image/png",
                "fileName": "image.png",
                "url": "http://example.com/image.png",
                "createdAt": "2022-01-01T00:00:00.000Z",
                "width": 220,
                "height": 100
              },
              "attachments": [
                {
                  "id": 12345,
                  "mimeType": "image/png",
                  "fileName": "image.png",
                  "url": "http://example.com/image.png",
                  "createdAt": "2022-01-01T00:00:00.000Z",
                  "width": 220,
                  "height": 100
                }
              ],
              "notes": {
                "text": "1 light bulb is burned out."
              }
            },
            "meter": {
              "id": 123
            }
          }
        ]
      },
      "progress": {
        "openCount": 1,
        "inProgressCount": 1,
        "onHoldCount": 1,
        "doneCount": 1
      },
      "workOrderSummary": {
        "content": "Replaced the motor bearings and aligned the shaft.",
        "summary": "Motor bearing replacement and shaft alignment completed.",
        "authorId": 963
      }
    }
  }
}