Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

Short Description

Chapter Contents: 

Long Description

Since API 3.3 Remark has a new attribute attachments that contains a list of Attachment objects. The Attachment resource has an attribute called file where can be stored the content of the file encoded in Base64.

The attribute fileName is mandatory, the attribute "filesize" is not mandatory but the client should pass it.

The two resources can be manipulated exactly as all other resources.

When a new Remark is posted with attachments in the JSON the source field must be before of the attachments field.

Some examples

Create a new remark with a file attached:

POST: http://localhost:8080/ws/rest/Remark
BODY:

{
  "remarkTitle": "test 1",
  "source": 19637583,
  "attachments": [
    {
      
      "file":"small file 1",
      "fileName":"test1.txt"
    }
  ]
}

Attach an Attachment to an existing Remark

PUT: http://localhost:8080/ws/rest/Remark/244324058
BODY:

{
  "attachments": [
    {
      "file":"small file 2",
      "fileName":"test2.txt"
    }
  ]
}


Properties

Property
Type
Length
Mandatory
Description
Comments
remark
String
Yes

remarkTitle
String



source
Integer



attachments
Array of /Attachment



remarks
Array of /Remark



  • No labels