POST api/Collaboration/CreateCommentThread

Creating a new thread

Request Information

URI Parameters

None.

Body Parameters

Parameters of the new thread

CreateCommentThreadParams
NameDescriptionTypeAdditional information
MediaItemId

integer

None.

RevisionId

integer

None.

Geometry

string

None.

CommentText

string

None.

SubscriberGuids

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": [
    "bda338de-ba70-41ee-9cb7-d0103fbf776e",
    "8b6ac1f7-4468-42ef-bd4d-12c2befad851"
  ]
}

application/xml, text/xml

Sample:
<CreateCommentThreadParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PicaJet.Daminion.BusinessObjects">
  <_x003C_CommentText_x003E_k__BackingField>sample string 3</_x003C_CommentText_x003E_k__BackingField>
  <_x003C_Geometry_x003E_k__BackingField>sample string 2</_x003C_Geometry_x003E_k__BackingField>
  <_x003C_MediaItemId_x003E_k__BackingField>1</_x003C_MediaItemId_x003E_k__BackingField>
  <_x003C_RevisionId_x003E_k__BackingField>1</_x003C_RevisionId_x003E_k__BackingField>
  <_x003C_SubscriberGuids_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>bda338de-ba70-41ee-9cb7-d0103fbf776e</d2p1:guid>
    <d2p1:guid>8b6ac1f7-4468-42ef-bd4d-12c2befad851</d2p1:guid>
  </_x003C_SubscriberGuids_x003E_k__BackingField>
</CreateCommentThreadParams>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateCommentThreadParams'.

Response Information

Resource Description

TODO

ObjResultOfCreateCommentThreadOutcome
NameDescriptionTypeAdditional information
Data

CreateCommentThreadOutcome

None.

Error

Error description if the operation failed

string

None.

Success

Operation result

boolean

None.

ErrorCode

Error code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "data": {
    "geometryId": 1,
    "commentId": 2,
    "commentTime": "2021-09-22T12:34:41.0327905+02:00"
  },
  "error": "sample string 1",
  "success": true,
  "errorCode": 3
}

application/xml, text/xml

Sample:
<ObjResultOfCreateCommentThreadOutcomeSzI3Q8G_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <_x003C_ErrorCode_x003E_k__BackingField>3</_x003C_ErrorCode_x003E_k__BackingField>
  <_x003C_Error_x003E_k__BackingField>sample string 1</_x003C_Error_x003E_k__BackingField>
  <_x003C_Success_x003E_k__BackingField>true</_x003C_Success_x003E_k__BackingField>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/PicaJet.Daminion.BusinessObjects">
    <d2p1:_x003C_CommentId_x003E_k__BackingField>2</d2p1:_x003C_CommentId_x003E_k__BackingField>
    <d2p1:_x003C_CommentTime_x003E_k__BackingField>2021-09-22T12:34:41.0327905+02:00</d2p1:_x003C_CommentTime_x003E_k__BackingField>
    <d2p1:_x003C_GeometryId_x003E_k__BackingField>1</d2p1:_x003C_GeometryId_x003E_k__BackingField>
  </Data>
</ObjResultOfCreateCommentThreadOutcomeSzI3Q8G_P>
bool hasModels = Model.ParameterModels.Count > 0; if (hasModels) {

Parameter Information

parameters

Property Description
MediaItemId (Int64)

				
RevisionId (Nullable`1)

				
Geometry (String)

				
CommentText (String)

				
SubscriberGuids (Guid[])

				
}