Document service documentation

Store and query json based objects in the database.

Action	Method	URL	App auth req	User auth req
Create document	POST	/documents	Yes	No
Get document	GET	/documents/{documentId}	Yes	No
Query document	GET	/documents?key={key}&value={value}	Yes	No
Update document	PUT	/documents/{:documentId}	Yes	Yes
Delete document	DELETE	/documents/{:documentId}	Yes	Yes

Create document

• Call: POST /documents
• App Authentication is required
• User Authentication is required if documentOwnerId is provided

Request body

Property	Type	Mandatory
documentContent	JSON Object	true
documentOwnerId	String	false

Get document

• Call: GET /documents/{documentId}
• App Authentication required
• Returns json document

Query document

• Call: GET /documents?key={key}&value={value}&keySecondary={keySecondary}&valueSecondary={valueSecondary}
• App Authentication required
• If document has an owner ID then owner ID and Authenticated User ID have to match

Update document

• Call: PUT /documents/{documentId}
• App Authentication required
• User Authentication required
• Owner ID and Authenticated User ID have to match
• Old json document will be replaced with provided json document
  • Existing but unprovided fields will be lost

Request body

Property	Type	Mandatory
documentContent	JSON Object	true

Delete document

• Call: DELETE /documents/{documentId}
• App Authentication required
• User Authentication required
• Owner ID and Authenticated User ID have to match