Executes the Refresh action for the Inquiry Data data object.

post

https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/va/2/data/inquiry_data/actions/refresh

Re-execute an existing inquiry run and push only added/changed/removed rows to inquiry_data.

Recent Requests

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.

Body Params

Schema for refreshing an existing inquiry run's data with diffy-cache change detection.

__inquiry_run_key

string

required

length between 36 and 36

^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

The unique key (GUID/UUID) identifying the inquiry_runs record to refresh.

__filter

object

Optional filter override. If omitted, the filter stored on the inquiry_runs record is reused.

__EnableRefreshCacheDeleteDetection

boolean

Enable detection and deletion of rows that disappeared from the inquiry result. Enabling it increases action runtime. If omitted, false is defaulted.

Headers

X-Application-Key

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.

Language

Loading…

Response

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

application/json

200Success