Get by study ID and collection name

Copy Markdown

Open in

GET

/api/studies/{study-id}/collections/{collection-name}

Gets a collection by studyId and collectionName

Authorization

bearer

headerAuthorizationBearer <token>

Provide the username and password of the user

Path parameters

study-id*string

collection-name*string

Response body

*/*

response

createdBy?string|null

createdAt?|

Formatdate-time

updatedBy?string|null

updatedAt?|

Formatdate-time

id?integer

Formatint32

name*string

studyId*string

studyDeploymentId?string|null

documentId?|

Formatint32

documents?array<>|null

Example request

curl -X GET 'https://dev.carp.dk/api/studies/string/collections/string'

Example responseSchema

{  "createdBy": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedBy": "string",  "updatedAt": "2019-08-24T14:15:22Z",  "id": 0,  "name": "string",  "studyId": "string",  "studyDeploymentId": "string",  "documentId": 0,  "documents": [    {      "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      }    }  ]}