Getting StartedAPI Reference
API Reference

Executes the Add action for the Materials data object.

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

Add

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

HQ Company

string
required
length ≤ 20

Key (MatlGroup, Material).

string | null
string
required
length ≤ 10

Key to

string
enum
length ≤ 1

Options:S-Standard, E-Equipment. If omitted, 'S' will be defaulted.

Allowed:
string
enum

If omitted 'Y' will be defaulted.

Allowed:
string
enum

If omitted 'N' will be defaulted.

Allowed:
string
enum

If omitted 'N' will be defaulted.

Allowed:
string
required
length ≤ 3

Key to hq/unit_of_measures(UM).

string
^[-+]?[0-9]{1,11}(?:.[0-9]{1,5})?$

If omitted, 0 will be defaulted.

string
enum
length ≤ 1

If omitted, E will be defaulted.

Allowed:
string
^[-+]?[0-9]{1,11}(?:.[0-9]{1,5})?$

If omitted, 0 will be defaulted.

string
enum
length ≤ 1

If omitted, E will be defaulted.

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

lbs per StdUM

string
required
length ≤ 3

Key to hq/unit_of_measures(UM).

string
required
length ≤ 3

Key to hq/unit_of_measures(UM).

string | null

Key to hq/unit_of_measures(UM).

string
enum
length ≤ 1

Options: N-No Discount, U-Discount Amt Per Unit, R-Discount Rate per dollar. If omitted, N will be defaulted.

Allowed:
string
^[-+]?[0-9]{1,11}(?:.[0-9]{1,5})?$

Rate or Amt as noted in PayDiscType. Ignored if PayDiscType = N

string | null

Key to jc/phases(PhaseGroup, Phase) where Phase Group is determined by HQCo.

integer | null

Key to jc/cost_types(PhaseGroup, CostType) where Phase Group is determined by HQCo.

string | null

Key to jc/phases(PhaseGroup, Phase) where Phase Group is determined by HQCo.

integer | null

Key to jc/cost_types(PhaseGroup, CostType) where Phase Group is determined by HQCo.

string | null

Key to MS Haul Codes

string | null
string | null
__custom_fields
object

Add Properties in this object as needed to set User Defined Properties on this object as defined in Vista.

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