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

Issues

Returns issues matching the given search criteria.

get

Returns issues 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 issues satisfy all constraints that are specified in this search criteria. By default a result containing 1000 issues is returned.

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
sortOrderstring · enumOptional

The sorting order of the results.

Default: ASCPossible values:
sortFieldstring · enumOptional

The field on which the results are sorted. Default is NAME.

Default: NAMEPossible values:
onlyOpenIssuesbooleanOptional

Whether only open issues should be returned.

Default: true
userRelationstring · enumOptional

The relation of the user with the issues to be returned. By default all issues for the current user will be returned.

Default: ALLPossible values:
Responses
200

OK - The request has succeeded.

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/issues

Adds a new issue.

post

Adds a new issue with the given parameters.

Authorizations
AuthorizationstringRequired
Body
responsibleCommunityIdstring · uuidOptional

The ID of the community responsible for handling the issue.

namestringRequired

The name of the subject for which the issue is being created.

typeIdstring · uuidRequired

The type ID of the issue to be created.

descriptionstringRequired

The description for the issue.

prioritystringOptional

The priority for the issue.

requesterIdstring · uuidOptional

The requester of the issue.

categoryIdsstring · uuid[]Optional

The list of IDs of assets which represent categories for this issue. Each asset in this list should be of type Issue Category.

Responses
201

Created - The request has been fulfilled and resulted in a new resource being created.

application/json
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:
namestringOptional

The name of the resource.

Example: Test name
displayNamestringOptional

The display name of the asset.

Please note that "displayName" corresponds to the "Name" in the UI.

articulationScorenumber · doubleOptional

The articulation score for this asset.

Expresses how well this asset is articulated. The articulation score is a percentage number ranging from 0 to 100. The articulation rules can be configured to calculate the articulation score. Whenever the asset is modified, by changing its attributes or statuses, the articulation score is re-evaluated.

Example: 89.5
excludedFromAutoHyperlinkingbooleanOptional

Whether this asset is excluded from hyperlinking or not.

avgRatingnumber · doubleOptional

The average rating.

ratingsCountinteger · int32Optional

The number of ratings.

post/issues

Moves an issue to another community.

patch

Moves an issue to another community.

Authorizations
AuthorizationstringRequired
Path parameters
issueIdstring · uuidRequired

ID of the issue to be moved

communityIdstring · uuidRequired

ID of the community to move the issue to

Responses
200

OK - The request has succeeded.

application/json
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:
namestringOptional

The name of the resource.

Example: Test name
displayNamestringOptional

The display name of the asset.

Please note that "displayName" corresponds to the "Name" in the UI.

articulationScorenumber · doubleOptional

The articulation score for this asset.

Expresses how well this asset is articulated. The articulation score is a percentage number ranging from 0 to 100. The articulation rules can be configured to calculate the articulation score. Whenever the asset is modified, by changing its attributes or statuses, the articulation score is re-evaluated.

Example: 89.5
excludedFromAutoHyperlinkingbooleanOptional

Whether this asset is excluded from hyperlinking or not.

avgRatingnumber · doubleOptional

The average rating.

ratingsCountinteger · int32Optional

The number of ratings.

patch/issues/{issueId}/community/{communityId}

Last updated

Was this helpful?