Getting StartedAPI Reference
API Reference

Executes the Clear Inquiry action for the Inquiry Data data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/va/2/data/inquiry_data/actions/clear_inquiry

Data cleared and the status on the inquiry_run record updated to cleared.

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

Schema for clearing all associated inquiry data for a given inquiry run.

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 Run record. All associated inquiry data for this key will be cleared, and the status of the Inquiry Run record will be updated to 'Cleared'.

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