Getting StartedAPI Reference
API Reference

Executes the Add Equipment action for the Work Order Completed data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/sm/2/data/wo_work_completeds/actions/add_equip

Add a 1-equip type Work Completed record.

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
integer
required
1 to 255

Key to sm/wo_work_completeds(SMCo, WorkOrder, WorkCompleted). Key to sm/work_order(SMCo, WorkOrder).

integer
required

Key to sm/wo_work_completeds(SMCo, WorkOrder, WorkCompleted). Key to sm/work_order(SMCo, WorkOrder).

integer
required

Key to Scopes array in sm/work_order(SMCo, WorkOrder).

string
required
length ≤ 10

Required to add a new equipment

string | null
required

Required to determinate if time or work units are going to be use.

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

Optional. If omitted, todays date will be defaulted. Format: YYYY-MM-DD.

string
enum

Optional. If omitted, it will be defaulted based on Vista defaulting logic.

Allowed:
string
enum

Optional. If omitted, N will be defaulted.

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

Optional. If omitted, it will be defaulted based on the $.Date value. Format YYYY-MM-01.

string | null
integer | null
string | null
enum
Allowed:
string | null

Key value in SM Technicians application. Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

integer | null

Optional. If omitted, null will be defaulted.

integer
1 to 255

Optional, EMCo value

string | null
^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$

Non-zero value. Optional. If omitted and CostQuantity is provided, ActualCost/CostQuantity will be defaulted. Otherwise, null will be defaulted.

string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

A ActualCost value will be applied if $.NonBillable = N. Optional. If omitted, null (when $.NonBIllable = Y) or 0 or CostQuantity*CostRate will be defaulted.

string | null
Billable
object

Optional. If omitted all properties will default as specified. This property is ignored if $.NonBillable = Y.

Taxes
object

Optional. If omitted each property will be be defaulted based on Vista defaulting behavior.

Accounts
object

Optional. If omitted all properties will default as specified.

__custom_fields
object

Add a property to this object for each user defined field to be set. Property name set to the user defined field name.

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 4 months ago

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

Updated 4 months ago