Rename a document
Attachment Update
Parameter | Description | Example | More info |
---|---|---|---|
API | The API area | attachments.json | |
Action | The action to perform | action=update | |
General | Parameters described in overview | user=user&password=user | [v3.3 Overview](ref:v30xxx-overview) |
input | Attachment ID (mandatory), then name/value pairs | "data": |
|
Response | Returned data | See below |
Example request:
http://<SERVER>/jsonapi/attachments.json?&user=user&password=user&version=3.3&action=update&input={
"data": [
{
"attachmentID": 5464,
"attachmentDescription": "my doc name.pdf"
}
]
}
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"data": [
{
"attachmentID": 5464,
"attachmentUuid": "9B7100C5B37B4F49B6B04F30833BAFC2",
"attachmentTimestampModified": 1501073421,
"attachmentRecordVersionNumber": 1
}
]
}
Note:
To discover which fields are editable make a call to the "Attachment details" endpoint and specify '&style=modelstructure' see Meta-data