Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Attachment Option

Gets one Attachment Option object from the cache.

Represents data found in Vista™ DM Attachment Options program.

Vista view: HQAO

get/direct/subscribers/{subscriber_code}/vista/dm/2/data/attachment_options/cache/{ryvitId_value}

Path parameters

subscriber_codestring required

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

ryvitId_valuestring required

The code of the data object you want to get.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Response

Success

__ryvitKeysstring[]

Array of key paths that can be used to retrieve this object.

__modifiedUTCstring

UTC timestamp of when this object was last modified in the cache.

OnlyOneRow'X'

Always X

TempDirectorystring nullable
PermanentDirectorystring nullable
ByCompany'Y' | 'N' | 'null' nullable
ByModule'Y' | 'N' | 'null' nullable
ByForm'Y' | 'N' | 'null' nullable
ByMonth'Y' | 'N' | 'null' nullable
Custom'Y' | 'N' | 'null' nullable
CustomFormatstring nullable
UseJPG'Y' | 'N' required
UseStructForAttYN'Y' | 'N' required
SaveToDatabase'Y' | 'N' required
ScanningFileFormatstring required
CreateStandAloneOnDelete'Y' | 'N' required
UseAuditing'Y' | 'N' required
ArchiveDeletedAttachments'Y' | 'N' required
PdfResolutioninteger required
UseViewpointViewer'Y' | 'N' required
AttachmentDatabaseServerstring required
AttachmentDatabaseNamestring required
__custom_fieldsobject

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.

Example response

{
  "__modifiedUTC": "2020-01-01T13:01:01.1234567Z"
}