Update – Documents – Backend API

Update

Copy Markdown

Open in

PUT

/api/studies/{study-id}/documents/{document-id}

Authorization

bearer

headerAuthorizationBearer <token>

Provide the username and password of the user

Path parameters

study-id*string

document-id*integer

Formatint32

Request body

application/json

body

name*|

Length1 <= length

data*|null

Response body

*/*

response

createdBy?string|null

createdAt?|

Formatdate-time

updatedBy?string|null

updatedAt?|

Formatdate-time

id?integer

Formatint32

name*string

collectionId*|

Formatint32

data?|null

Example request

curl -X PUT 'https://dev.carp.dk/api/studies/string/documents/0' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "data": {}}'

Example responseSchema

{  "createdBy": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedBy": "string",  "updatedAt": "2019-08-24T14:15:22Z",  "id": 0,  "name": "string",  "collectionId": 0,  "data": {    "integralNumber": true,    "missingNode": true,    "floatingPointNumber": true,    "nodeType": "ARRAY",    "string": true,    "textual": true,    "boolean": true,    "binary": true,    "valueNode": true,    "container": true,    "object": true,    "pojo": true,    "short": true,    "int": true,    "long": true,    "double": true,    "bigDecimal": true,    "bigInteger": true,    "number": true,    "array": true,    "empty": true,    "null": true,    "float": true,    "embeddedValue": true  }}