Returns one or more attachment records
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | attachments.json | |
| General | Yes | Parameters described in overview | user=user&password=user&version=3.9 | Overview |
| Model Structure | Yes | Name of model required | modelstructure=attachmentslist | Using data models |
| View | No | Stored filter applied | Using views | |
| Sort | No | Change the view's default sort order | sort=CLIENT | Sorting |
| Filters | No | Filter by a key field | Filters | |
| Company | Yes | The company number | company=1 |
Example request:
http://<SERVER>/jsonapi/attachments.json?company=1&version=3.9&user=user&password=user&style=modeldata&modelstructure=attachmentsList
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 2,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"attachmentUuid": "A25519AD6B32BA4A8AD0FC7F5B647E75",
"attachmentTimestampModified": 1501072436,
"attachmentRecordVersionNumber": 0,
"attachmentCreatedDisplay": "Created by Mike Smith Dev on 26/07/2017 at 1:33pm",
"attachmentS3UrlGet": "",
"attachmentS3UrlPut": "",
"attachmentClientName": "Smith & Co",
"attachmentActivityID": 6957,
"attachmentID": 5463,
"attachmentDocumentName": "temp_5463.csv",
"attachmentJobAndPhase": "",
"attachmentDescription": "temp.csv",
"attachmentExtension": "CSV",
"attachmentContainer": "My Meeting notesa",
"attachmentCreationDate": "2017-07-26",
"attachmentCreationTime": "13:33:56",
"attachmentCreatedByUserID": 5,
"attachmentCreatedByFullName": "Mike Smith",
"attachmentMode": "Browse"
},
{
"attachmentUuid": "5337C90967F1D94C83607D2724F7FB82",
"attachmentTimestampModified": 1501073898,
"attachmentRecordVersionNumber": 0,
"attachmentCreatedDisplay": "Created by Jon Brown on 26/07/2017 at 1:58pm",
"attachmentS3UrlGet": "",
"attachmentS3UrlPut": "",
"attachmentClientName": "Smith & Co",
"attachmentActivityID": 6957,
"attachmentID": 5466,
"attachmentDocumentName": "special_5466.pdf",
"attachmentJobAndPhase": "",
"attachmentDescription": "Special.pdf",
"attachmentExtension": "PDF",
"attachmentContainer": "My Meeting notesa",
"attachmentCreationDate": "2017-07-26",
"attachmentCreationTime": "13:58:18",
"attachmentCreatedByUserID": 3,
"attachmentCreatedByFullName": "Jon Brown",
"attachmentMode": "API"
}
]
}