{"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"/api/dms/objects/{objectId}/native/notes","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1626.0264,"localId":"cdfacc4f-f2b8-438c-a0fa-e188e29bb164"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.58]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1431.45]},"content":[{"type":"paragraph","content":[{"text":"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 ","type":"text"},{"text":"system:objectId","type":"text","marks":[{"type":"em"}]},{"text":" is the Id of the note to edit. If no ","type":"text"},{"text":"system:objectId","type":"text","marks":[{"type":"em"}]},{"text":" is send for a note it is inserted. Otherwise with ","type":"text"},{"text":"system:objectId","type":"text","marks":[{"type":"em"}]},{"text":" 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.","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"nested-table","text":"","parameters":{"cxhtml":"

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

","nestedContent":{"type":"doc","content":[{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"ColorId","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1045.55]},"content":[{"type":"paragraph","content":[{"text":"Color","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1045.55]},"content":[{"type":"paragraph","content":[{"text":"White (Default)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1045.55]},"content":[{"type":"paragraph","content":[{"text":"Yellow","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1045.55]},"content":[{"type":"paragraph","content":[{"text":"Green","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[130.0]},"content":[{"type":"paragraph","content":[{"text":"4","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1045.55]},"content":[{"type":"paragraph","content":[{"text":"Blue","type":"text"}]}]}]}]}],"version":1},"adf":"{\"type\":\"doc\",\"content\":[{\"type\":\"table\",\"attrs\":{\"layout\":\"default\"},\"content\":[{\"type\":\"tableRow\",\"content\":[{\"type\":\"tableHeader\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":[130.0]},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"text\":\"ColorId\",\"type\":\"text\",\"marks\":[{\"type\":\"strong\"}]}]}]},{\"type\":\"tableHeader\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":[1045.55]},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"text\":\"Color\",\"type\":\"text\",\"marks\":[{\"type\":\"strong\"}]}]}]}]},{\"type\":\"tableRow\",\"content\":[{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":[130.0]},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"text\":\"1\",\"type\":\"text\"}]}]},{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":[1045.55]},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"text\":\"White (Default)\",\"type\":\"text\"}]}]}]},{\"type\":\"tableRow\",\"content\":[{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":[130.0]},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"text\":\"2\",\"type\":\"text\"}]}]},{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":[1045.55]},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"text\":\"Yellow\",\"type\":\"text\"}]}]}]},{\"type\":\"tableRow\",\"content\":[{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":[130.0]},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"text\":\"3\",\"type\":\"text\"}]}]},{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":[1045.55]},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"text\":\"Green\",\"type\":\"text\"}]}]}]},{\"type\":\"tableRow\",\"content\":[{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":[130.0]},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"text\":\"4\",\"type\":\"text\"}]}]},{\"type\":\"tableCell\",\"attrs\":{\"colspan\":1,\"rowspan\":1,\"colwidth\":[1045.55]},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"text\":\"Blue\",\"type\":\"text\"}]}]}]}]}],\"version\":1}","reason":"A table in a table cell can't be created or edited in the new editor."}}},{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.58]},"content":[{"type":"paragraph","content":[{"text":"Request Method","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1431.45]},"content":[{"type":"paragraph","content":[{"text":"POST","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.58]},"content":[{"type":"paragraph","content":[{"text":"Request Query Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1431.45]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"objectTypeId (Integer): For performance reasons, the ","type":"text"},{"text":"objectTypeId ","type":"text","marks":[{"type":"code"}]},{"text":"of the object can be provided.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"minimalResponse (Boolean): The response is on success HTTP/204. This speeds up the endpoint by 30%.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.58]},"content":[{"type":"paragraph","content":[{"text":"Response Format","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1431.45]},"content":[{"type":"paragraph","content":[{"text":"JSON","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.58]},"content":[{"type":"paragraph","content":[{"text":"Minimum Version","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1431.45]},"content":[{"type":"paragraph","content":[{"text":"6.4.0","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.58]},"content":[{"type":"paragraph","content":[{"text":"Request","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Example","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1431.45]},"content":[{"type":"paragraph","content":[{"text":"/api/dms/objects/","type":"text"},{"text":"4528","type":"text","marks":[{"type":"textColor","attrs":{"color":"#505050"}}]},{"text":"/native/notes?","type":"text"},{"text":"objectTypeId=262168","type":"text","marks":[{"type":"textColor","attrs":{"color":"#505050"}}]},{"type":"hardBreak"},{"text":"/api/dms/objects/4528/native/notes?objectTypeId=262168&minimalResponse=true","type":"text","marks":[{"type":"textColor","attrs":{"color":"#505050"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.58]},"content":[{"type":"paragraph","content":[{"text":"Request","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Example","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1431.45]},"content":[{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n\t\"objects\": [{\n\t\t\"properties\": {\n\t\t\t\"system:objectId\": {\n\t\t\t\t\"value\": \"1234567\"\n\t\t\t},\n\t\t\t\"text\": {\n\t\t\t\t\"value\": \"Change note text\"\n\t\t\t},\n\t\t\t\"color\": {\n\t\t\t\t\"value\": \"3\"\n\t\t\t}\n\t\t}\n\t},{\n\t\t\"properties\": {\n\t\t\t\"text\": {\n\t\t\t\t\"value\": \"Note text\"\n\t\t\t},\n\t\t\t\"color\": {\n\t\t\t\t\"value\": \"1\"\n\t\t\t}\n\t\t}\n\t}]\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.58]},"content":[{"type":"paragraph","content":[{"text":"Result","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Example","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1431.45]},"content":[{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n\t\"objects\": [{\n\t\t\t\"properties\": {\n\t\t\t\t\"system:objectId\": {\n\t\t\t\t\t\"value\": \"1234567\"\n\t\t\t\t},\n\t\t\t\t\"system:lastModifiedBy\": {\n\t\t\t\t\t\"value\": \"ROOT\"\n\t\t\t\t},\n\t\t\t\t\"system:createdBy\": {\n\t\t\t\t\t\"value\": \"ROOT\"\n\t\t\t\t},\n\t\t\t\t\"color\": {\n\t\t\t\t\t\"value\": \"3\"\n\t\t\t\t},\n\t\t\t\t\"text\": {\n\t\t\t\t\t\"value\": \"Change note text\"\n\t\t\t\t},\n\t\t\t\t\"system:creationDate\": {\n\t\t\t\t\t\"value\": \"2024-06-27T16:12:01+02:00\"\n\t\t\t\t},\n\t\t\t\t\"system:lastModificationDate\": {\n\t\t\t\t\t\"value\": \"2024-06-27T16:12:01+02:00\"\n\t\t\t\t}\n\t\t\t}\n\t},{\n\t\t\t\"properties\": {\n\t\t\t\t\"system:objectId\": {\n\t\t\t\t\t\"value\": \"1234568\"\n\t\t\t\t},\n\t\t\t\t\"system:lastModifiedBy\": {\n\t\t\t\t\t\"value\": \"ROOT\"\n\t\t\t\t},\n\t\t\t\t\"system:createdBy\": {\n\t\t\t\t\t\"value\": \"ROOT\"\n\t\t\t\t},\n\t\t\t\t\"color\": {\n\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t},\n\t\t\t\t\"text\": {\n\t\t\t\t\t\"value\": \"Note text\"\n\t\t\t\t},\n\t\t\t\t\"system:creationDate\": {\n\t\t\t\t\t\"value\": \"2024-06-21T16:16:51+02:00\"\n\t\t\t\t},\n\t\t\t\t\"system:lastModificationDate\": {\n\t\t\t\t\t\"value\": \"2024-06-28T14:40:04+02:00\"\n\t\t\t\t}\n\t\t\t}\n\t}],\n\t\"numItems\": 2,\n\t\"hasMoreItems\": false,\n\t\"totalNumItems\": 2\n}","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported