Attachment Details

Returns a single attachment records

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaattachments.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.7v3.7 Overview
Model StructureYesName of model requiredmodelstructure=attachmentdetailsUsing data models
ViewNoStored filter appliedUsing views
SortNoChange the view's default sort ordersort=CLIENTSorting
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=1
IdentifierYesAttachment ID or UUIDattachmentid=5463

Example request:

http://<SERVER>/jsonapi/attachments.json?company=1&version=3.7&user=user&password=user&style=modeldata&modelstructure=attachmentdetails&attachmentid=7333

http://192.168.0.239/jsonapi/attachments.json?company=1&user=user&password=user&version=3.7&action=update&input={
"data": [
{
"attachmentID": 7333,
"attachmentVisibility": "Hidden"
}
]
}

Example response:

{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synversion": "12.690",
"synapiversion": 3.7,
"data": [
{
"attachmentUuid": "A90F2EC8D64E404F96587CE76658C56E",
"attachmentTimestampModified": 1614954315,
"attachmentRecordVersionNumber": 0,
"attachmentPath": "",
"attachmentSizeDescription": "2.88 K",
"attachmentDescription": "image.png",
"attachmentMode": "API",
"attachmentApplicationName": "",
"attachmentID": 7333,
"attachmentDocumentName": "image_7333.png",
"attachmentOriginalFilename": "image.png",
"attachmentWinPathDocument": "\\\\DEV\\Syndev\\CRM\\Company 16\\Client 16_NU100\\16_X050028\\",
"attachmentMacPathDocument": "Syndev:CRM:Company 16:Client 16_NU100:16_X050028:",
"attachmentServerPathDocument": "c:\\syndev\\CRM\\Company 16\\Client 16_NU100\\16_X050028\\",
"attachmentPrivate": false,
"attachmentDocumentSize": 2944,
"attachmentTemplateUsed": "",
"attachmentCreationDate": "2021-03-05",
"attachmentCreationTime": "14:25:15",
"attachmentCreatedByUserID": 5,
"attachmentCreatedByFullName": "Mike Pender",
"attachmentVisibility": ""
}
]
}