NextGen APIs

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

Http Verb

GET

Url

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

Permissions required

WorkOrder: View (fsm.core.workorder.configuration.view)

or

WorkOrder: 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

MULTILANGUAGE-FIELDS

Business Logic

This API returns the requested Work Order Type

Technical Object Type IDs

The response includes four specific technical object type ID fields (assetTypeId, accountTypeId, familyTypeId, ownerTypeId) in addition to the generic technicalObjectTypeId.

Only one of these four specific IDs will be populated at a time. When populated, the specific ID will have the same value as technicalObjectTypeId and indicates which type of technical object is associated with the work order type:

  • assetTypeId: Indicates the technical object is an Asset Type

  • accountTypeId: Indicates the technical object is an Account Type

  • familyTypeId: Indicates the technical object is a Family Type

  • ownerTypeId: Indicates the technical object is an Owner Type

Available since 2026 W2 (FSM 23.0)

Path Parameters

Field

Note

typeId


Query String Parameters

Fields ℹ️

Default.

Language ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field

Note

id


code


description


order


active


requestTypeId


serviceTypeId


technicalObjectTypeId


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


structureId


color


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 error codes

NOT_FOUND, BASE_0001