search

Document

hashtag
Creates a document

POST https://demo.icure.cloud/rest/v2/document

hashtag
Request Body

Name
Type
Description

body*

Document

hashtag
Deletes a document's attachment

DELETE https://demo.icure.cloud/rest/v2/document/{documentId}/attachment

hashtag
Path Parameters

Name
Type
Description

documentId*

String

hashtag
Deletes documents

POST https://demo.icure.cloud/rest/v2/document/delete/batch

hashtag
Request Body

Name
Type
Description

body*

ListOfIds

hashtag
List documents with no delegation

GET https://demo.icure.cloud/rest/v2/document/woDelegation

Keys must be delimited by coma

hashtag
Query Parameters

Name
Type
Description

limit

Integer

hashtag
Gets a document

GET https://demo.icure.cloud/rest/v2/document/{documentId}

hashtag
Path Parameters

Name
Type
Description

documentId*

String

hashtag
Load document's attachment

GET https://demo.icure.cloud/rest/v2/document/{documentId}/attachment/{attachmentId}

hashtag
Path Parameters

Name
Type
Description

documentId*

String

attachmentId*

String

hashtag
Query Parameters

Name
Type
Description

enckeys

String

fileName

String

hashtag
Gets a document

GET https://demo.icure.cloud/rest/v2/document/externaluuid/{externalUuid}

hashtag
Path Parameters

Name
Type
Description

externalUuid*

String

hashtag
Gets a document

POST https://demo.icure.cloud/rest/v2/document/byIds

hashtag
Request Body

Name
Type
Description

body*

ListOfIds

hashtag
Get all documents with externalUuid

GET https://demo.icure.cloud/rest/v2/document/externaluuid/{externalUuid}/all

hashtag
Path Parameters

Name
Type
Description

externalUuid*

String

hashtag
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

hashtag
Query Parameters

Name
Type
Description

documentTypeCode*

String

hcPartyId*

String

secretFKeys*

String

hashtag
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

hashtag
Query Parameters

Name
Type
Description

hcPartyId*

String

secretFKeys*

String

hashtag
Updates a document

PUT https://demo.icure.cloud/rest/v2/document

hashtag
Request Body

Name
Type
Description

body*

Document

hashtag
Updates a batch of documents

PUT https://demo.icure.cloud/rest/v2/document/batch

Returns the modified documents.

hashtag
Request Body

Name
Type
Description

body*

List

hashtag
Creates a document's attachment

PUT https://demo.icure.cloud/rest/v2/document/{documentId}/attachment

hashtag
Path Parameters

Name
Type
Description

documentId*

String

hashtag
Query Parameters

Name
Type
Description

enckeys

String

hashtag
Request Body

Name
Type
Description

body*

Object

hashtag
Creates a document's attachment

PUT https://demo.icure.cloud/rest/v2/document/{documentId}/attachment/multipart

hashtag
Path Parameters

Name
Type
Description

documentId*

String

hashtag
Query Parameters

Name
Type
Description

enckeys

String

hashtag
Update delegations in healthElements.

POST https://demo.icure.cloud/rest/v2/document/delegations

Keys must be delimited by coma

hashtag
Request Body

Name
Type
Description

body*

List

hashtag
Creates a document's attachment

PUT https://demo.icure.cloud/rest/v2/document/attachment

hashtag
Query Parameters

Name
Type
Description

documentId*

String

enckeys

String

hashtag
Request Body

Name
Type
Description

body*

Object

PreviousFormNextMessage

Last updated

Was this helpful?