Update a Work Order by its external reference (ERP reference)

patch

https://api.remberg.de/v2/work-orders/erp/{externalReference}

Partially updates an existing Work Order identified by its external reference (ERP reference). Only the fields provided in the request body will be modified. Returns 409 if multiple Work Orders share the same external reference.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

externalReference

string

required

The Work Order's external reference (ERP reference). Must be URL encoded.

Body Params

subject

string

The Work Order's subject

description

string

A detailed description of the Work Order

statusReference

string

The reference of the Work Order status.

typeReference

string

The reference of the Work Order type.

priority

string

enum

The priority of the Work Order.

Allowed:

dueDate

string

The due date of the Work Order.

externalReference

string

The external reference (ERP Reference) of the Work Order.

parentWorkOrderExternalReference

string

The parent Work Order external reference (ERP Reference) of the Work Order. (Provide either this or the parentWorkOrderId)

parentWorkOrderId

string

The parent Work Order internal ID of the Work Order. (Provide either this or the parentWorkOrderExternalReference)

relatedOrganizationId

string

The related organization internal ID of the Work Order.

relatedAssetIds

array of strings

The related asset internal IDs of the Work Order. Please note: all related asset ids are going to be replaced.

relatedAssetIds

customPropertyValues

array of objects

The custom property values of the Work Order.

customPropertyValues

startDate

string

The start date of the work order. Must be provided together with endDate.

endDate

string

The end date of the work order. Must be provided together with startDate. Must be after startDate.

isFullDay

boolean

Whether the work order is planned for a full day. This field is ignored if startDate and endDate are not set.

string

enum

The time zone for the planned work order. This field is ignored if startDate and endDate are not set.

assignedContactIds

array of strings

The performing contact internal IDs for the work order planning. Please note: all performing contact ids are going to be replaced by the provided values.

assignedContactIds

assignedGroupIds

array of strings

The performing group internal IDs for the work order planning. Please note: all performing group ids are going to be replaced by the provided values.

assignedGroupIds

responsibleGroupId

string

The responsible group internal ID of the Work Order.

responsibleContactId

string

The responsible contact internal ID of the Work Order.

estimatedDurationInSeconds

number

The estimated duration of the work order in seconds.

Responses

400

Bad Request

403

Forbidden

404

Not Found

409

Conflict (e.g., invalid updates or duplicate references)

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

204Resource updated