Getting StartedAPI Reference
API Reference

Executes the Add action for the Change Orders data object.

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

Adds a new Contract Change Order

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 jc/change_orders(JCCo, Job, ACO). Key to jc/jobs(JCCo, Job).

string
required
length ≤ 10

Key to jc/change_orders(JCCo, Job, ACO). Key to jc/jobs(JCCo, Job).

string
required
length ≤ 10

Key to jc/change_orders(JCCo, Job, ACO).

integer

Order in which this ACO is to be processed. Optional, If omitted, defaults to the next sequential number for the Job.

string | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

date

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

date | null

Format: YYYY-MM-DD. 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.

string
enum
required

Change Order Type. Options: I-Internal, E-External.

Allowed:
NewContractItems
array of objects

Use this to create new Contract Line Items as part of the change order.

NewContractItems
LineItems
array of objects
LineItems
__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 about 1 month ago

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

Updated about 1 month ago