For the complete documentation index, see llms.txt. This page is also available as Markdown.

Comments

Find comments.

get

Returns comments matching the given search criteria.

Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored.

The returned comments satisfy all constraints that are specified in this search criteria.

By default, the result contains up to 1000 comments.

Authorizations
AuthorizationstringRequired
Query parameters
offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0
limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0
countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1
parentIdstring · uuidOptional

The ID of the comment which the reply comments should be searched for

Example: 8253ed81-0889-49d7-98db-defef5b5cd3b
userIdstring · uuidOptional

The ID of the user. By default, filters comments to include only those created by this user.

Example: 8253ed81-0889-49d7-98db-defef5b5cd3b
baseResourceIdstring · uuidOptional

The ID of the resource which the searched comments refer to.

Example: 8253ed81-0889-49d7-98db-defef5b5cd3b
rootCommentbooleanOptional

Whether the searched comments should be root comments (not reply comments).

Example: true
resolvedbooleanOptional

Whether the searched comments should be resolved.

Example: false
userThreadsbooleanOptional

Specifies whether to search for root comments created by or mentioning the user userId, or root comments with replies created by or mentioning the user userId.

Default: falseExample: false
sortOrderstring · enumOptional

The order of sorting on the date the comment was created.

Default: DESCExample: DESCPossible values:
Responses
200

The paged response with found comments.

application/json
totalinteger · int64Optional

The total number of results.

Example: 1000
offsetinteger · int64Optional

The offset for the results.

Example: 10
limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100
get/comments
200

The paged response with found comments.

Add comment.

post

Adds a new comment.

Authorizations
AuthorizationstringRequired
Body

The properties of the comment to be added. The 'baseResource' field is deprecated in favour of 'commentableResourceId' and 'commentableResourceDiscriminator', but we cannot mark it as such due to the version of the OpenApi spec.

contentstring · min: 1 · max: 2147483647Required

The actual HTML content of the comment to be added. Can contain user mentions using syntax [@User:$userId] where $userId is the ID of mentioned user.For example: [@User:00000000-0000-0000-0000-000000900002].

commentableResourceIdstring · uuidOptional

The identifier of the resource to which the new comment should be attached to. The combination of 'commentableResourceId' and 'commentableResourceDiscriminator' replaces the 'baseResource' field. These should not be used together.

commentableResourceDiscriminatorstringOptional

The discriminator of the resource to which the new comment should be attached to. The combination of 'commentableResourceId' and 'commentableResourceDiscriminator' replaces the 'baseResource' field. These should not be used together. Possible values for a discriminator of a Commentable Resource are: "Asset", "Domain", "Community", "Rating"

parentIdstring · uuidOptional

The id of the parent comment. If not null - the comment is the reply for the parent comment. Comment threads are not supported, replying to a reply will cause an illegal argument exception.

baseResourceTypestring · enumWrite-onlyOptionalDeprecated

The ResourceType to which the new comment should be attached to. Possible values for a ResourceType of a Commentable Resource are: "Asset", "Domain", "Community", "Rating". Please use 'commentableResourceDiscriminator' instead.

Possible values:
baseResourceDiscriminatorstringWrite-onlyOptionalDeprecated

The Resource discriminator to which the new comment should be attached to. Possible values for a resource discriminator of a Commentable Resource are: "Asset", "Domain", "Community", "Rating". Please use 'commentableResourceDiscriminator' instead.

baseResourceIdstring · uuidWrite-onlyOptionalDeprecated

The id of the resource to which the new comment should be attached to. Please use 'commentableResourceId' instead

Responses
201

Comment successfully added.

application/json

Represents a comment.

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb
createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320
lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe
lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163
systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:
contentstringOptional

The content of the comment.

resolvedbooleanOptional

Whether the comment is resolved or not.

contentLastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of when the content was last modified.

post/comments
201

Comment successfully added.

Get comment.

get

Returns the comment with the specified ID.

Authorizations
AuthorizationstringRequired
Path parameters
commentIdstring · uuidRequired

The ID of the comment.

Responses
200

The response with found comment.

application/json

Represents a comment.

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb
createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320
lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe
lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163
systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:
contentstringOptional

The content of the comment.

resolvedbooleanOptional

Whether the comment is resolved or not.

contentLastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of when the content was last modified.

get/comments/{commentId}

Remove comment.

delete

Removes the comment with the specified ID.

Authorizations
AuthorizationstringRequired
Path parameters
commentIdstring · uuidRequired

The ID of the comment to be removed.

Responses
200

Comment successfully removed.

No content

delete/comments/{commentId}

No content

Change comment.

patch

Modifies the comment with the specified ID.

Only properties that are specified in this request and have not null values are updated. All other properties are ignored.

Authorizations
AuthorizationstringRequired
Path parameters
commentIdstring · uuidRequired

The ID of the comment to be changed.

Body

The properties of the comment to be changed.

contentstring · min: 1 · max: 2147483647Optional

The new content of the comment to be changed.Can contain user mentions using syntax [@User:$userId] where $userId is the ID of mentioned user.For example: [@User:00000000-0000-0000-0000-000000900002].

resolvedbooleanOptional

Whether the comment is resolved.

Responses
200

Comment successfully updated.

application/json

Represents a comment.

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb
createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320
lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe
lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163
systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:
contentstringOptional

The content of the comment.

resolvedbooleanOptional

Whether the comment is resolved or not.

contentLastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of when the content was last modified.

patch/comments/{commentId}

Last updated

Was this helpful?