Getting StartedAPI Reference
API Reference

Executes the Add action for the Project Phases data object.

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

Adds a new Project Phase record. The Project Phase is saved in Job Cost - Job Phases (vista/jc/2/job_phases)

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

Key to pm/project_phases(PMCo, Project, PhaseGroup, Phase). Key to pm/projects(PMCo, Project). Key to pm/contracts(JCCo, Contract).

string
required
length ≤ 10

Key to pm/project_phases(PMCo, Project, PhaseGroup, Phase). Key to pm/projects(PMCo, Project).

integer
required

Key to pm/project_phases(PMCo, Project, PhaseGroup, Phase). Key to jc/phases(PhaseGroup, Phase).

string
required
length ≤ 20

Key to pm/project_phases(PMCo, Project, PhaseGroup, Phase). Key to jc/phases(PhaseGroup, Phase).

string | null

Optional. If omitted, null will be defaulted.

string
required
length ≤ 10

Key to jc/contracts(JCCo, Contract).

string
required
length ≤ 16

Contract Item Id. Key to ContractItems array member in jc/contracts(JCCo, Contract, ContractItems.Item).

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

Optional. If omitted, 0 will be defaulted.

string
enum

Optional. If omitted, Y will be defaulted.

Allowed:
string | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

__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.

CostTypes
array of objects

CostTypes for this Phase. If Omitted, CostTypes will be defaulted based on Vista defaulting logic. If an empty array is provided no cost types will be added to this job_phase.

CostTypes
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 2 months ago

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

Updated about 2 months ago