Search through Cost Detail objects in the data cache

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

Represents data found in Viewpoint® Vista™ JC Cost Detail program.

Vista view: JCCD

Path Params

subscriber_code

string

required

The code of the subscriber that you are making this request for.

Body Params

modifiedUtcAfter

date-time

length between 28 and 28

Returns objects that were modified after the specified date (ISO 8601 format). Format: yyyy-MM-ddThh:mm:ss.fffffffZ. Example '2019-12-11T20:16:58.3419275Z'. If provided on the first call, the same value must be provided on all subsequent calls as you use the continuation token for the next result set.

modifiedUtcBefore

date-time

length between 28 and 28

Returns objects that were modified before the specified date (ISO 8601 format). Format: yyyy-MM-ddThh:mm:ss.fffffffZ. Example '2019-12-11T20:16:58.3419275Z'. If provided on the first call, the same value must be provided on all subsequent calls as you use the continuation token for the next result set.

continuationToken

string

Supplying this token will result in retrieving the next chunk of data if the first request contained more than 100 (up to) records or greater than 1 megabyte in size. On your first call, you must omit or provide an empty string. On subsequent calls, provide the continuationToken from the previous result.

filters

array

All provided filters are combined with AND conditions. E.g. filter1 AND filter2 AND filter3. Not providing a filter will result in an unfiltered result. Filtering can be performed on nested object properties but can not be performed on array item properties. If provided on the first call, the same value must be provided on all subsequent calls as you use the continuation token for the next result set.

filters

Headers

X-Application-Key

string

required

Used to authorize access to the Direct API.

Responses

Response body

object

count

integer

required

data

array of objects

required

data*

object

__ryvitKeys

array of strings

__ryvitKeys

__modifiedUTC

string

JCCo

integer

required

Mth

string

required

CostTrans

integer

required

Job

string

required

length ≤ 10

PhaseGroup

integer

required

Phase

string

required

length ≤ 20

CostType

integer

required

PostedDate

string

required

ActualDate

string

required

JCTransType

string

required

length ≤ 2

Source

string

required

length ≤ 10

Description

string | null

BatchId

integer | null

InUseBatchId

integer | null

GLCo

integer | null

GLTransAcct

string | null

GLOffsetAcct

string | null

ReversalStatus

integer

required

string | null

ActualUnitCost

string

required

PerECM

string | null

ActualHours

string

required

ActualUnits

string

required

ActualCost

string

required

ProgressCmplt

string

required

EstHours

string

required

EstUnits

string

required

EstCost

string

required

ProjHours

string

required

ProjUnits

string

required

ProjCost

string

required

ForecastHours

string

required

ForecastUnits

string

required

ForecastCost

string

required

PostedUM

string | null

PostedUnits

string

required

PostedUnitCost

string

required

PostedECM

string | null

PostTotCmUnits

string

required

PostRemCmUnits

string

required

TotalCmtdUnits

string

required

TotalCmtdCost

string

required

RemainCmtdUnits

string

required

RemainCmtdCost

string

required

DeleteFlag

string

required

Y N

AllocCode

integer | null

ACO

string | null

ACOItem

string | null

PRCo

integer | null

Employee

integer | null

Craft

string | null

Class

string | null

Crew

string | null

EarnFactor

string | null

EarnType

integer | null

Shift

integer | null

LiabilityType

integer | null

VendorGroup

integer | null

Vendor

integer | null

APCo

integer | null

APTrans

integer | null

APLine

integer | null

APRef

string | null

POItem

integer | null

string | null

SLItem

integer | null

string | null

MOItem

integer | null

MatlGroup

integer | null

Material

string | null

INCo

integer | null

Loc

string | null

INStdUnitCost

string

required

INStdECM

string | null

INStdUM

string | null

MSTrans

integer | null

MSTicket

string | null

JBBillStatus

string | null

JBBillMonth

string | null

JBBillNumber

integer | null

EMCo

integer | null

EMEquip

string | null

EMRevCode

string | null

EMGroup

integer | null

EMTrans

integer | null

TaxType

integer | null

TaxGroup

integer | null

TaxCode

string | null

TaxBasis

string

required

TaxAmt

string

required

UniqueAttchID

string | null

SrcJCCo

integer | null

KeyID

integer

required

TotalCmtdTax

string

required

RemCmtdTax

string

required

OffsetGLCo

integer | null

POItemLine

integer | null

SMWorkCompletedID

integer | null

SMCo

integer | null

SMWorkOrder

integer | null

SMScope

integer | null

PMCostProjection

string | null

Y N

PORDKeyID

integer | 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

continuationToken

string

Supply this token on the next request to get the next chunk of data. This will have a value if the result set contains more than 100 records or the set is greater than 1 megabyte.

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 POST \
2
     --url https://api.xchange.trimble.com/connect/v1/direct/subscribers/subscriber_code/vista/jc/2/data/cost_detail/cache/search \
3
     --header 'accept: application/json' \
4
     --header 'content-type: 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.