v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Work Orders

Executes the Add action for the Work Orders data object.

Adds a new EM Work Order to Vista

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

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

WorkOrderstring

Optional if em/company_parameters.WOAutoSeq == 'Y', otherwise required. If omitted and WOAutoSeq is not Y or configured for Shop and Shop can not be determined, this action will fail.

__AutoSeqShopstring

Used to AutoSeq $.WorkOrder when configured in em/company_parameters. Key to em/shop(ShopGroup, Shop). ShopGroup is determined by EMCo. Optional. When provided, this value will be used instead of $.Shop to determine the next WorkOrder value. If omitted and WOAutoSeq enabled, we will attempt to use $.Shop. If $.Shop is omitted, we will attempt to use the Equipment's default Shop.

EMCointeger required

Key to em/equipment(EMCo, Equipment).

Equipmentstring required

Key to em/equipment(EMCo, Equipment).

Shopstring nullable

Key to em/shop(ShopGroup, Shop). ShopGroup is determined by EMCo. Optional. If omitted, defaulted based on Vista defaults.

Descriptionstring nullable

Optional.

DateCreatedstring date

Format: YYYY-MM-DD. Optional. If omitted today's date will be defaulted.

INCointeger nullable

Key to em/equipment(INCo, InvLoc). Optional. If omitted, defaulted based on Vista defaults.

InvLocstring nullable

Key to em/equipment(INCo, InvLoc). Optional. If omitted, defaulted based on Vista defaults.

PRCointeger nullable

Key to pr/employees(PRCo, mechanic). Optional. If omitted, defaulted based on Vista defaults.

Mechanicinteger nullable

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

DateDuestring date nullable

Format: YYYY-MM-DD

DateSchedstring date nullable

Format: YYYY-MM-DD

Notesstring nullable
__custom_fieldsobject

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

Response

Success

idstring
operationstring
statusstring