Getting StartedAPI Reference
API Reference

Executes the Add action for the Attachments data object.

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

Adds a new attachment to a Vista record. Provide URLToFileBytes pointing to the file to upload (public HTTP URL or an App Xchange/AppNetwork file URL). The connector downloads the bytes and writes them to Vista per DM attachment options (HQAO): HQAF database storage or filesystem path.

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

HQ Company

string
required
length ≤ 30

Name of the form this file will be attached to.

string
required
length ≤ 500

Formatted string representing the where clause of the parent form (ie. KeyID = 123

string | null

Description of the file.

string | null
required

Table name/View name for the record that this file is being attached to.

string | null
required

Original file name and dot extension. No path information.

string
enum
required

Y - Document Type attachment. N - non document type attachment. PM module looks at this value. Generally speaking Y should be provided.

Allowed:
string
enum
required
Allowed:
integer | null
string
required

URL to download the file bytes to upload into Vista. Supports public HTTP(S) URLs and App Xchange/AppNetwork file URLs.

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 4 months ago

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

Updated 4 months ago