|
Http Verb |
PUT |
|---|---|
|
Url |
/work-orders/r1/work-orders/{workOrderId}/meters |
|
Permissions required |
WO Edit: Edit (fsm.core.workorder.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 manages associations between a Work Order and its related meters.
-
To create new associations, provide a list of meter ids.
For example, to associate meters A, B, C, use the input:
[A, B, C] -
To remove a specific meter (e.g., meter B), provide the updated list without it:
[A, C] -
To remove all associations, pass an empty list:
[] -
To add a new meter while keeping existing ones, you must first retrieve the current list of associated meters with the api: GET /work-orders/r1/work-orders/{workOrderId}/meters , append the new one, and send the full updated list.
For example, if the current associations are A, B, and C, and you want to add D, the input should be:
[A, B, C, D]
Path Parameters
|
Field |
Note |
|---|---|
|
workOrderId |
|
Header Parameters
Default.
Request Body Parameters
|
Field |
Validations |
Note |
|---|---|---|
|
meterId |
|
|
Response documentation
Response error codes