Executes the Change action for the Work Orders data object.

post

https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/sm/2/data/work_orders/actions/change

Changes an existing Work Order record.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriber_code

string

required

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

Body Params

__key

required

ServiceCenter

string

length ≤ 10

Enter the Service center that this request is assigned to.

Customer

integer | null

The SM Customer for this order. Required when WorkOrderType is C-Customer.

Job

string | null

The JC Job for this work order. Required when WorkOrderType is J-Job.

CustGroup

integer

ServiceSite

string | null

Enter a Site ID.

Description

string | null

Enter a description of the request.

RequestedDate

string | null

Enter the date that the request was made. Format: YYYY-MM-DD.

RequestedTime

string | null

Enter the time that the request was made. Format: HH:mm.

EnteredDateTime

string | null

The date the work order was entered. Format: YYYY-MM-DD HH:mm.

EnteredBy

string | null

The user that entered the work order.

RequestedBy

string | null

Enter the name of the person making this request.

ContactName

string | null

Enter the contact name.

ContactPhone

string | null

Enter the contact phone.

IsNew

boolean

Notes

string | null

Enter a note about this work order.

UniqueAttchID

string | null

[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

WOStatus

integer

LeadTechnician

string | null

Enter the lead technician.

RequestedByPhone

string | null

Enter the phone number of the person making this request.

JCCo

integer | null

Enter JC Company. Required when WorkOrderType is J-Job.

CostingMethod

string | null

enum

Select a costing method. Options: Cost, Revenue.

Allowed:

Certified

string

enum

Certified Payroll. For customer work orders only. Options: Y-Yes, N-No.

Allowed:

CertifiedStartDate

string | null

Enter the start date for certifieds. Format: YYYY-MM-DD.

PRState

string | null

Enter the State Code that identifies the location that work will be performed.

PRLocalCode

string | null

Enter the Payroll Local Code.

CraftTemplate

integer | null

Enter a template code to identify craft/class pay rates.

Reviewer

string | null

Enter the Reviewer for this work.

WorkOrderQuote

string | null

__custom_fields

object

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

Headers

X-Application-Key

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.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.