v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Work Orders

Executes the Add Item action for the Work Orders data object.

Add an item on an existing EM Work Order

post/direct/subscribers/{subscriber_code}/vista/em/2/data/work_orders/actions/add_item

Path parameters

subscriber_codestring required

The code of the subscriber that you are making this request for.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

EMCointeger required

Key to em/work_orders(EMCo, WorkOrder).

WorkOrderstring required

Key to em/work_orders(EMCo, WorkOrder).

WOIteminteger

Optional, If omitted, the next WOItem number will be used.

Descriptionstring nullable
CostCodestring required

Key to em/cost_codes(EMGroup, CostCode). Optional.

StatusCodestring

Key to em/wo_status_codes(EMGroup, StatusCode). Optional.

Componentstring nullable

Optional.

ComponentTypeCodestring nullable

Optional.

StdMaintGroupstring nullable

Key to em/std_maint_groups(EMCo, Equipment, StdMaintGroup). Optional.

StdMaintIteminteger nullable

Key to $.Items array in em/std_maint_groups(EMCo, Equipment, StdMaintGroup). Optional.

PRCointeger nullable

Key to pr/employees(PRCo, mechanic). Optional.

Mechanicinteger nullable

Key to pr/employees(PRCo, mechanic). Optional.

RepairTypestring nullable

Key to em/wo_repair_type(EMGroup, RepType). Optional.

Priority'U' | 'N' | 'L'

Options: U-Urgent, N-normal, L-Low. Optional.

RepairCodestring nullable

Informational only. Can be used to track repairs. Optional.

PartCodestring nullable

Key to hq/materials(MatlGroup, Material). Optional.

SerialNostring nullable

Serial number of the part. Optional.

DateCreatedstring date

Format: YYYY-MM-DD. Optional.

DateDuestring date nullable

Format: YYYY-MM-DD. Optional.

DateSchedstring date nullable

Format: YYYY-MM-DD Optional.

InHseSubFlag'I' | 'O'

Options: I-InHouse, O-Outside. Optional.

EstHrsstring nullable

Optional. Can only be provided if InHseSubFlag == I. Input will be ignored if InHseSubFlag != I.

QuoteAmtstring nullable

Optional. Can only be provided if InHseSubFlag == O. Input will be ignored if InHseSubFlag != O.

Notesstring nullable
__custom_fieldsobject

Add properties to this object for any custom fields you want to set as this record is updated in Vista.

Response

Success

idstring
operationstring
statusstring