/api/dms/objects/{objectId}/native/notes

Description

Within this endpoint new notes can be created or existing notes can be updated within their note text or color. In the payload the property system:objectId is the Id of the note to edit. If no system:objectId is send for a note it is inserted. Otherwise with system:objectId it is updated. Notes can be created or update within the following four colors. In the payload the ColorId must be sent to the DMS Microservice. Please note that this operation is not possible if the object is in the recycle bin. This objects can't be modified any longer.

ColorId	Color
1	White (Default)
2	Yellow
3	Green
4	Blue

Request Method

POST

Request Query Parameter

objectTypeId (Integer): For performance reasons, the objectTypeId of the object can be provided.
minimalResponse (Boolean): The response is on success HTTP/204. This speeds up the endpoint by 30%.

Response Format

JSON

Minimum Version

6.4.0

Request
Example

/api/dms/objects/4528/native/notes?objectTypeId=262168
/api/dms/objects/4528/native/notes?objectTypeId=262168&minimalResponse=true

Request
Example

{
	"objects": [{
		"properties": {
			"system:objectId": {
				"value": "1234567"
			},
			"text": {
				"value": "Change note text"
			},
			"color": {
				"value": "3"
			}
		}
	},{
		"properties": {
			"text": {
				"value": "Note text"
			},
			"color": {
				"value": "1"
			}
		}
	}]
}

Result
Example

{
	"objects": [{
			"properties": {
				"system:objectId": {
					"value": "1234567"
				},
				"system:lastModifiedBy": {
					"value": "ROOT"
				},
				"system:createdBy": {
					"value": "ROOT"
				},
				"color": {
					"value": "3"
				},
				"text": {
					"value": "Change note text"
				},
				"system:creationDate": {
					"value": "2024-06-27T16:12:01+02:00"
				},
				"system:lastModificationDate": {
					"value": "2024-06-27T16:12:01+02:00"
				}
			}
	},{
			"properties": {
				"system:objectId": {
					"value": "1234568"
				},
				"system:lastModifiedBy": {
					"value": "ROOT"
				},
				"system:createdBy": {
					"value": "ROOT"
				},
				"color": {
					"value": "1"
				},
				"text": {
					"value": "Note text"
				},
				"system:creationDate": {
					"value": "2024-06-21T16:16:51+02:00"
				},
				"system:lastModificationDate": {
					"value": "2024-06-28T14:40:04+02:00"
				}
			}
	}],
	"numItems": 2,
	"hasMoreItems": false,
	"totalNumItems": 2
}

[POST] /notes

/api/dms/objects/{objectId}/native/notes