Create a comment for an entity.

POST

/api/workspace/comments

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/comments"),
    Content = new StringContent("{ \"CommentText\": \"example\", \"Owner\": { \"ModuleKey\": \"example\", \"ResourceKind\": \"example\", \"ContextResourceId\": \"example\", \"ResourceObjectId\": \"example\" }, \"ParentCommentId\": \"example\", \"Relations\": [ { \"Target\": { \"ModuleKey\": \"example\", \"ResourceKind\": \"example\", \"ContextResourceId\": \"example\", \"ResourceObjectId\": \"example\" }, \"RelationKind\": 0, \"Source\": { \"ModuleKey\": \"example\", \"ResourceKind\": \"example\", \"ContextResourceId\": \"example\", \"ResourceObjectId\": \"example\" }, \"PolicyCode\": \"example\", \"CorrelationId\": \"example\" } ], \"Origin\": { \"Source\": { \"ModuleKey\": \"example\", \"ResourceKind\": \"example\", \"ContextResourceId\": \"example\", \"ResourceObjectId\": \"example\" }, \"PolicyCode\": \"example\", \"CorrelationId\": \"example\" } }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/comments';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"CommentText":"example","Owner":{"ModuleKey":"example","ResourceKind":"example","ContextResourceId":"example","ResourceObjectId":"example"},"ParentCommentId":"example","Relations":[{"Target":{"ModuleKey":"example","ResourceKind":"example","ContextResourceId":"example","ResourceObjectId":"example"},"RelationKind":0,"Source":{"ModuleKey":"example","ResourceKind":"example","ContextResourceId":"example","ResourceObjectId":"example"},"PolicyCode":"example","CorrelationId":"example"}],"Origin":{"Source":{"ModuleKey":"example","ResourceKind":"example","ContextResourceId":"example","ResourceObjectId":"example"},"PolicyCode":"example","CorrelationId":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/comments \
  --header 'Content-Type: application/json' \
  --data '{ "CommentText": "example", "Owner": { "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "ParentCommentId": "example", "Relations": [ { "Target": { "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "RelationKind": 0, "Source": { "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "PolicyCode": "example", "CorrelationId": "example" } ], "Origin": { "Source": { "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "PolicyCode": "example", "CorrelationId": "example" } }'

Authorizations

None

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Request payload to create a comment.

object

CommentText

Comment text.

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

ParentCommentId

Optional parent comment identifier.

string

nullable

Relations

Optional resource relations attached to the comment.

Array<object>

nullable

object

Target

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

integer format: int32

Allowed values: 0

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

Origin

object

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

Responses

200

application/json

object

Data

Comment details.

object

Comment identifier.

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

CommentText

Comment text.

string

nullable

DetectedLanguage

Detected language for search.

string

nullable

ParentCommentId

Optional parent comment identifier.

string

nullable

Relations

Resource relations attached to the comment.

Array<object>

nullable

object

string

nullable

Target

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

integer format: int32

Allowed values: 0

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

string

nullable

CreatedAt

string format: date-time

DeletedAt

string format: date-time

nullable

Origin

object

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

Creator user identifier.

string

nullable

CreatedByUserName

Creator display name.

string

nullable

ModifiedByUserId

Last modifier user identifier.

string

nullable

ModifiedByUserName

Last modifier display name.

string

nullable

EditDeadline

Edit deadline timestamp.

string format: date-time

nullable

IsEdited

Whether the comment has been edited.

boolean

ReplyCount

Number of replies.

integer format: int32

CreatedAt

Creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

nullable

IsDeleted

Whether the comment is soft deleted.

boolean

Permissions

Permissions for a comment evaluated for the current user.

object

CanView

Whether the comment can be viewed.

boolean

CanEdit

Whether the comment can be edited.

boolean

CanDelete

Whether the comment can be deleted.

boolean

CanReply

Whether a reply can be created.

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Relations": [
      {
        "RelationKind": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Comment details.

object

Comment identifier.

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

CommentText

Comment text.

string

nullable

DetectedLanguage

Detected language for search.

string

nullable

ParentCommentId

Optional parent comment identifier.

string

nullable

Relations

Resource relations attached to the comment.

Array<object>

nullable

object

string

nullable

Target

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

integer format: int32

Allowed values: 0

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

string

nullable

CreatedAt

string format: date-time

DeletedAt

string format: date-time

nullable

Origin

object

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

Creator user identifier.

string

nullable

CreatedByUserName

Creator display name.

string

nullable

ModifiedByUserId

Last modifier user identifier.

string

nullable

ModifiedByUserName

Last modifier display name.

string

nullable

EditDeadline

Edit deadline timestamp.

string format: date-time

nullable

IsEdited

Whether the comment has been edited.

boolean

ReplyCount

Number of replies.

integer format: int32

CreatedAt

Creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

nullable

IsDeleted

Whether the comment is soft deleted.

boolean

Permissions

Permissions for a comment evaluated for the current user.

object

CanView

Whether the comment can be viewed.

boolean

CanEdit

Whether the comment can be edited.

boolean

CanDelete

Whether the comment can be deleted.

boolean

CanReply

Whether a reply can be created.

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Relations": [
      {
        "RelationKind": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

Comment details.

object

Comment identifier.

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

CommentText

Comment text.

string

nullable

DetectedLanguage

Detected language for search.

string

nullable

ParentCommentId

Optional parent comment identifier.

string

nullable

Relations

Resource relations attached to the comment.

Array<object>

nullable

object

string

nullable

Target

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

integer format: int32

Allowed values: 0

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

string

nullable

CreatedAt

string format: date-time

DeletedAt

string format: date-time

nullable

Origin

object

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

Creator user identifier.

string

nullable

CreatedByUserName

Creator display name.

string

nullable

ModifiedByUserId

Last modifier user identifier.

string

nullable

ModifiedByUserName

Last modifier display name.

string

nullable

EditDeadline

Edit deadline timestamp.

string format: date-time

nullable

IsEdited

Whether the comment has been edited.

boolean

ReplyCount

Number of replies.

integer format: int32

CreatedAt

Creation timestamp.

string format: date-time

ModifiedAt

Last modification timestamp.

string format: date-time

nullable

IsDeleted

Whether the comment is soft deleted.

boolean

Permissions

Permissions for a comment evaluated for the current user.

object

CanView

Whether the comment can be viewed.

boolean

CanEdit

Whether the comment can be edited.

boolean

CanDelete

Whether the comment can be deleted.

boolean

CanReply

Whether a reply can be created.

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Relations": [
      {
        "RelationKind": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Create a comment for an entity.

Authorizations

Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

Example^generated