Update a WorkOrder

PUT

/api/work-orders/{key}

Detail validations

Request

Authorization

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Successful operation

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/api/work-orders/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "Nostrum qui deleniti consequatur ut consequatur.",
    "statusKey": "07000717779517",
    "scheduledAt": "1995-02-15T04:14:26Z",
    "siteKey": "02000148837492",
    "locationKey": "08000110248275",
    "storeroomKey": "02000219760069",
    "assetKey": "03000386748703",
    "assetDowntimeKey": "03000992418810",
    "serviceRequestKey": "08000224870585",
    "pmKey": "00000481492761",
    "teamKey": "09000933435770",
    "laborAssignedKey": "02000400175797",
    "accountKey": "09000446519141",
    "userApprovedKey": "05000640977827",
    "code": "22666406",
    "instructions": "string",
    "severity": "string",
    "estimatedTime": 10,
    "actualTime": 10,
    "roleName": "string",
    "categoryName": "string",
    "documents": [
        {
            "name": "string",
            "url": "string",
            "type": "string",
            "contentType": "string",
            "description": "Quia ab vel ab quo inventore.",
            "notes": "string"
        }
    ],
    "tasks": [
        {
            "code": "46332349",
            "title": "Sint eos molestias est et temporibus eum.",
            "description": "Aperiam qui officia consequatur aliquid.",
            "priority": "string",
            "checkList": "string"
        }
    ],
    "notes": "string",
    "approvedAt": "1986-09-17T22:37:34Z",
    "dueAt": "1994-02-09T10:57:16Z",
    "completedAt": "2007-10-04T17:37:19Z",
    "completionRemarks": "string",
    "createdAt": "2000-07-21T15:23:45Z",
    "updatedAt": "2009-12-09T13:09:22Z",
    "deletedAt": "1999-12-28T09:11:38Z"
}'

Response Example

{
    "data": {
        "key": "06000223041215",
        "parentKey": "05000767460960",
        "locationKey": "08000413141314",
        "siteKey": "07000414586338",
        "assetKey": "04000419057989",
        "accountKey": "06000742654943",
        "title": "Quia sed molestiae voluptatum quia neque neque.",
        "serviceRequestKey": "01000586637003",
        "code": "78015203",
        "pmKey": "02000972393415",
        "teamKey": "09000450156717",
        "laborAssignedKey": "02000698521787",
        "userApprovedKey": "08000927094665",
        "assetDowntimeKey": "01000312804097",
        "organizationKey": "03000501723548",
        "instructions": "string",
        "status": "string",
        "statusKey": "04000172534931",
        "severity": "string",
        "estimatedTime": "string",
        "roleName": "string",
        "categoryName": "string",
        "storeroomKey": "01000874770160",
        "notes": "string",
        "approvedAt": "2013-05-13T09:24:28Z",
        "dueAt": "1998-10-18T01:07:49Z",
        "scheduledAt": "2022-04-09T18:46:11Z",
        "actualTime": "string",
        "completedAt": "1981-12-06T03:47:21Z",
        "completionRemarks": "string",
        "tasks": [
            {
                "key": "06000067848689",
                "parentKey": "09000196482735",
                "code": "23137479",
                "title": "Nesciunt quo aut nemo tempore.",
                "description": "Temporibus aut qui aut corporis tempora et alias.",
                "priority": "string",
                "checkList": "[]"
            }
        ],
        "documents": [
            {
                "key": "04000685281477",
                "entityKeys": "[]",
                "name": "string",
                "url": "string",
                "type": "string",
                "contentType": "string",
                "description": "Aliquam eum eum aspernatur excepturi quas sed.",
                "notes": "string",
                "createdAt": "1985-07-07T06:30:59Z",
                "updatedAt": "1976-03-20T14:08:15Z"
            }
        ],
        "resources": [
            {
                "laborKey": "07000007804970",
                "vendorKey": "05000183865312",
                "assetKey": "00000468219658",
                "teamKey": "02000393917519",
                "poKey": "09000241323788",
                "poLineItemKey": "01000842819108",
                "accountKey": "04000880833463",
                "name": "string",
                "description": "Molestiae ab sapiente quia aspernatur similique.",
                "estimatedTime": "string",
                "registeredTime": "string",
                "rate": "string",
                "cost": "string",
                "startedAt": "1991-10-08T08:20:18Z",
                "finishedAt": "2009-03-17T17:46:13Z",
                "createdAt": "2000-07-15T11:42:12Z",
                "updatedAt": "1996-07-14T23:17:10Z",
                "deletedAt": "2024-10-31T18:55:16Z"
            }
        ],
        "materialCount": "string",
        "createdAt": "2008-11-10T22:36:17Z",
        "updatedAt": "2015-09-08T00:12:05Z",
        "deletedAt": "2011-11-24T20:13:19Z"
    }
}

Modified at 2026-03-19 15:49:21

Get a WorkOrder

List WorkOrder Materials