Getting StartedAPI Reference
API Reference

Executes the Add action for the Work Orders data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/em/2/data/work_orders/actions/add

Adds a new EM Work Order to Vista

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Body Params
string
length ≤ 10

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.

string
length ≤ 20

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.

integer
required
1 to 255

Key to em/equipment(EMCo, Equipment).

string
required
length ≤ 10

Key to em/equipment(EMCo, Equipment).

string | null

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

string | null

Optional.

date
^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

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

integer | null
1 to 255

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

string | null

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

integer | null
1 to 255

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

integer | null

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

date | null
^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

Format: YYYY-MM-DD

date | null
^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

Format: YYYY-MM-DD

string | null
__custom_fields
object

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

WOItemInfo
array of objects
WOItemInfo
Headers
string
required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Updated 3 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago