Gets all Job Phases objects from the cache.

get https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/jc/2/data/job_phases/cache

Represents data found in Viewpoint® Vista™ JC Job Phases program.

Vista views: JCJP, JCCH and JCJPRoles

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.

Query Params

limit

integer

Limits the number of records returned by the API, up to a maximum of 1,000. The API may return less than the limit even when more records exist. Always examine the 'next' and 'continuationToken' properties to determin if more records are available.

modifiedUTCSince

string

A string specifies a datetime against which to filter the results. When specified the result will be ordered oldest __modifiedUTC to newest. Example 2019-12-11T20:16:58.3419275Z. Optional. If unspecified, all cached objects will be returned.

continuationToken

string

A URL Encoded continuationToken value from a previous GET response. When provided, the next set of results for the original GET will be returned.

Headers

X-Application-Key

string

required

Used to authorize access to the Direct API.

Responses

Response body

object

limit

integer

required

data

array of objects

required

data*

object

__ryvitKeys

array of strings

__ryvitKeys

__modifiedUTC

string

JCCo

integer

required

Company Id. Part of the natural key for this object (JCCo, Job, PhaseGroup, Phase). Part of key identifing the Job (JCCo, Job).

Job

string

required

length ≤ 10

Job Id. Part of the natural key for this object (JCCo, Job, PhaseGroup, Phase). Part of key identifing the Job (JCCo, Job).

PhaseGroup

integer

required

Phase Group. Part of the natural key for this object (JCCo, Job, PhaseGroup, Phase). Part of key identifing the Phase (PhaseGroup, Phase).

Phase

string

required

length ≤ 20

Phase Id. Part of the natural key for this object (JCCo, Job, PhaseGroup, Phase). Part of key identifing the Phase (PhaseGroup, Phase).

Description

string | null

Contract

string

required

length ≤ 10

Contract Id. Part of the key identifing the Contract (JCCo, Contract). Part of the key identifing the Contract item (JCCo, Contract, Item).

Item

string

required

length ≤ 16

Contract Item Id. Part of the key identifing the Contract item (JCCo, Contract, Item).

ProjMinPct

string | null

ActiveYN

string

required

Y N

Notes

string | null

UniqueAttchID

string | null

KeyID

integer

required

Generated 64 bit integer value identifing the Job Phase record.

InsCode

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.

Has additional fields

CostTypes

array of objects

CostTypes for this Phase.

CostTypes

object

CostType

integer

required

CostType Id. This property is a natural key for the CostTypes of this Job Phase

string

required

length ≤ 3

Unit of Measure.

BillFlag

string

required

'Y' = Units and Dollars, 'C' = Dollars Only, 'N' = Neither.

ItemUnitFlag

string

required

Y N

PhaseUnitFlag

string

required

Y N

BuyOutYN

string

required

Y N

ActiveYN

string

required

Y N

KeyID

integer

required

Generated 64 bit integer value identifing the Cost Type for this Job Phase record.

Roles

array of objects

Roles

object

KeyID

integer

required

Process

string

required

length ≤ 1

Natural key for this array(PhaseGroup, Phase, Process, Role

Role

string

required

length ≤ 20

Natural key for this array(PhaseGroup, Phase, Process, Role

Notes

string | null

UniqueAttchID

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.

Has additional fields

string

required

continuationToken

string

required

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.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.xchange.trimble.com/connect/v1/direct/subscribers/subscriber_code/vista/jc/2/data/job_phases/cache \
3
     --header 'accept: application/json'

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

application/json

200Success

400Describes issues with the request.