Document
Creates a document
POST https://demo.icure.cloud/rest/v2/document
Request Body
| Name | Type | Description |
|---|---|---|
body* | Document |
Deletes a document's attachment
DELETE https://demo.icure.cloud/rest/v2/document/{documentId}/attachment
Path Parameters
| Name | Type | Description |
|---|---|---|
documentId* | String |
Deletes documents
POST https://demo.icure.cloud/rest/v2/document/delete/batch
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
List documents with no delegation
GET https://demo.icure.cloud/rest/v2/document/woDelegation
Keys must be delimited by coma
Query Parameters
| Name | Type | Description |
|---|---|---|
limit | Integer |
Gets a document
GET https://demo.icure.cloud/rest/v2/document/{documentId}
Path Parameters
| Name | Type | Description |
|---|---|---|
documentId* | String |
Load document's attachment
GET https://demo.icure.cloud/rest/v2/document/{documentId}/attachment/{attachmentId}
Path Parameters
| Name | Type | Description |
|---|---|---|
documentId* | String | |
attachmentId* | String |
Query Parameters
| Name | Type | Description |
|---|---|---|
enckeys | String | |
fileName | String |
Gets a document
GET https://demo.icure.cloud/rest/v2/document/externaluuid/{externalUuid}
Path Parameters
| Name | Type | Description |
|---|---|---|
externalUuid* | String |
Gets a document
POST https://demo.icure.cloud/rest/v2/document/byIds
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
Get all documents with externalUuid
GET https://demo.icure.cloud/rest/v2/document/externaluuid/{externalUuid}/all
Path Parameters
| Name | Type | Description |
|---|---|---|
externalUuid* | String |
List documents found By type, By Healthcare Party and secret foreign keys.
GET https://demo.icure.cloud/rest/v2/document/byTypeHcPartySecretForeignKeys
Keys must be delimited by coma
Query Parameters
| Name | Type | Description |
|---|---|---|
documentTypeCode* | String | |
hcPartyId* | String | |
secretFKeys* | String |
List documents found By Healthcare Party and secret foreign keys.
GET https://demo.icure.cloud/rest/v2/document/byHcPartySecretForeignKeys
Keys must be delimited by coma
Query Parameters
| Name | Type | Description |
|---|---|---|
hcPartyId* | String | |
secretFKeys* | String |
Updates a document
PUT https://demo.icure.cloud/rest/v2/document
Request Body
| Name | Type | Description |
|---|---|---|
body* | Document |
Updates a batch of documents
PUT https://demo.icure.cloud/rest/v2/document/batch
Returns the modified documents.
Request Body
| Name | Type | Description |
|---|---|---|
body* | List |
Creates a document's attachment
PUT https://demo.icure.cloud/rest/v2/document/{documentId}/attachment
Path Parameters
| Name | Type | Description |
|---|---|---|
documentId* | String |
Query Parameters
| Name | Type | Description |
|---|---|---|
enckeys | String |
Request Body
| Name | Type | Description |
|---|---|---|
body* | Object |
Creates a document's attachment
PUT https://demo.icure.cloud/rest/v2/document/{documentId}/attachment/multipart
Path Parameters
| Name | Type | Description |
|---|---|---|
documentId* | String |
Query Parameters
| Name | Type | Description |
|---|---|---|
enckeys | String |
Update delegations in healthElements.
POST https://demo.icure.cloud/rest/v2/document/delegations
Keys must be delimited by coma
Request Body
| Name | Type | Description |
|---|---|---|
body* | List |
Creates a document's attachment
PUT https://demo.icure.cloud/rest/v2/document/attachment
Query Parameters
| Name | Type | Description |
|---|---|---|
documentId* | String | |
enckeys | String |
Request Body
| Name | Type | Description |
|---|---|---|
body* | Object |
Last updated