POST api/Collaboration/CreateCommentThread
Creating a new comment thread
Request Information
URI Parameters
None.
Body Parameters
Comment thread parameters
CreateCommentThreadParamsName | Description | Type | Additional information |
---|---|---|---|
MediaItemId |
Media Item ID |
integer |
None. |
RevisionId |
Media Item version ID |
integer |
None. |
Geometry |
Comment thread geometry |
string |
None. |
CommentText |
Comment |
string |
None. |
SubscriberGuids |
IDs of users who need to be notified about the current comment thread |
Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "mediaItemId": 1, "revisionId": 1, "geometry": "sample string 2", "commentText": "sample string 3", "subscriberGuids": [ "1f0d6e74-97b8-4bfd-ac57-1119cab37def", "a6517ba7-bc4f-43fe-86fb-398497b8a7f3" ] }
Response Information
Resource Description
Result containing the created comment thread
ObjResultOfCreateCommentThreadOutcomeName | Description | Type | Additional information |
---|---|---|---|
Data | CreateCommentThreadOutcome |
None. |
|
Error |
Error description |
string |
None. |
Success |
Flag of successful operation |
boolean |
None. |
ErrorCode |
Error code |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "data": { "geometryId": 1, "commentId": 2, "commentTime": "2024-04-20T16:36:01.2417637+02:00" }, "error": "sample string 1", "success": true, "errorCode": 3 }
Parameter Information
parameters
Comment thread parameters
Property | Description |
---|---|
MediaItemId (Int64) |
Media Item ID |
RevisionId (Nullable`1) |
Media Item version ID |
Geometry (String) |
Comment thread geometry |
CommentText (String) |
Comment |
SubscriberGuids (Guid[]) |
IDs of users who need to be notified about the current comment thread |