v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Attachments

Executes the Add action for the Attachments data object.

Adds a new Attachment to a Vista record.

post/direct/subscribers/{subscriber_code}/vista/dm/2/data/attachments/actions/add

subscriber_codestring required

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

X-Application-Keystring required

Used to authorize access to the Direct API.

HQCointeger required

HQ Company

FormNamestring required

Name of the form this file will be attached to.

KeyFieldstring required

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

Descriptionstring nullable

Description of the file.

TableNamestring nullable required

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

OrigFileNamestring nullable required

Original file name and dot extension. No path information.

DocAttchYN'Y' | 'N' required

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

IsEmail'Y' | 'N' required

AttachmentTypeIDinteger nullable

URLToFileBytesstring required

URL to directly download the file bytes.

Success

idstring

operationstring

statusstring