Getting StartedAPI Reference
API Reference

Executes the Add action for the Resource Master data object.

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

Adds an Resource 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
1 to 255

Key natural(HRCo, HRRef).

1 to 999999

Key natural(HRCo, HRRef). Maximum 6 digits. Optional, if omitted this value will behave as if { "default": "default" } was provided.

provide the value.

string
length ≤ 15

Optional, if omitted This value will be calculated based on Vista defaulting logic with trailing digits incase of non unique results.

string
length ≤ 30
string | null

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 | null
enum

[PROTECTED FIELD] Options:S-Single, M-Married, D-Divorced, O-Other.

Allowed:
string | null

[PROTECTED FIELD]

string | null

[PROTECTED FIELD]

string | null
string | null
string | null
string | null

Key to HQ State.

string | null
string | null

Key to HQ Country.

string | null
string | null
string | null
string | null
string | null
string | null

[PROTECTED FIELD] Key to Race

string | null

Employment Status. Key to Status Code.

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

[PROTECTED FIELD] Format: YYYY-MM-DD.

string
enum
length ≤ 1

[PROTECTED FIELD] If omitted, 'M' will be defaulted.

Allowed:
string | null
enum
Allowed:
string | null
string | null
__payroll
object

Collection of properties from the Payroll Info Tab. Optional, if omitted each properties value will remain unchanged.

__other
object

Collection or properties from the Other Info tab. Optional, if omitted each properties value will remain unchanged.

__physicalResults
object

Collection of properties from the Physical Results tab.

__application
object

Collection of properties from the Application tab.

__canada
object

Only used if PRCo Country is CA. Optional, if omitted each properties value will remain unchanged.

__custom_fields
object

Add properties to this object for any custom fields you want to update.

string | null
enum
Allowed:
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