NextGen APIs

PATCH /work-orders/r1/types/{typeId}

Http Verb

PATCH

Url

PATCH /work-orders/r1/types/{typeId}

Permissions required

WO Configuration: Edit (fsm.core.workorder.configuration.edit)

Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2024 W1 (FSM 16.0)

Deprecated since


Removed since


Tech Tags

​ ​

Business Logic

This API modify an existing Work Order Types.

The triplet request type id, service type id and technical object type id must be unique.

The code must be unique.

It is not possible to set false in the Active flag of a work order type associated with an active work order, which is therefore not in the closed, canceled or aligned status.

It is not possible to associate the structure id with the same one already associated with the work order type.

Technical Object Type ID Validation

The following validation rules apply to the technical object type IDs (assetTypeId, accountTypeId, familyTypeId, ownerTypeId):

  1. At least one ID required: At least one technical object type ID must be provided (either assetTypeId, accountTypeId, familyTypeId, ownerTypeId, or technicalObjectTypeId).

  2. Only one ID allowed: Only one technical object type ID can be filled at a time. You cannot specify multiple IDs simultaneously.

  3. ID consistency: If both a specific type ID (e.g., assetTypeId) and technicalObjectTypeId are provided, they must match. Otherwise, a mismatch error will be returned.

  4. Automatic mapping: If exactly one specific type ID is provided, it will automatically become the technicalObjectTypeId.

Path Parameters

Field

Note

typeId


Header Parameters

Default.

Request Body Parameters

Field

Validations

Note

code

Max Lenght: 20

Unique


description

Max Lenght: 80


order

Max Lenght: 4


active



requestTypeId

Referenced resource id existance check


serviceTypeId

Referenced resource id existance check


technicalObjectTypeId

Referenced resource id existance check


assetTypeId


Available since 2026 W2 (FSM 23.0)

accountTypeId


Available since 2026 W2 (FSM 23.0)

familyTypeId


Available since 2026 W2 (FSM 23.0)

ownerTypeId


Available since 2026 W2 (FSM 23.0)

serviceLevelDays

MaxLength: 10


structureId

Referenced resource id existance check


color

MaxLength: 10


booking



totalOutcomes


Available since 2026 W2 (FSM 23.0)

mobileAccountingTypeId


Available since 2026 W2 (FSM 23.0)

preDistributedWorkOrder


Available since 2026 W2 (FSM 23.0)

bookingForSLA


Available since 2026 W2 (FSM 23.0)

autoGisPackage


Available since 2026 W2 (FSM 23.0)

Response documentation

Response error codes

NOT_FOUND, BASE_0001, BASE_0003, BASE_0007, BASE_0010, WORKORDERS_016, WORKORDERS_015, WORKORDERS_ORCHESTRATOR_026, WORKORDERS_ORCHESTRATOR_027, WORKORDERS_ORCHESTRATOR_028