Ratings

Find ratings.

get

Returns ratings 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 ratings satisfy all constraints that are specified in this search criteria. By default, the result contains up to 1000 ratings.

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 order of sorting (on creation date) the found ratings.

Default: DESCPossible values:

assetIdstring · uuidOptional

The ID of the asset the rating belongs to.

userIdstring · uuidOptional

The ID of the rating author.

Responses

200

The paged response with found ratings.

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

GET /rest/2.0/ratings HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

The paged response with found ratings.

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "rating": 0.2,
      "review": "text",
      "asset": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ]
}

Add rating.

post

Adds a new rating.

Authorizations

AuthorizationstringRequired

Body

ratingnumber · enumRequired

The value of the rating. Allowed values are 0.2, 0.4, 0.6, 0.8, 1.0 (representing 1 to 5 stars).

Example: 0.6Possible values:

reviewstringOptional

The review attached to the rating.

Example: This is a review

assetIdstring · uuidRequired

The ID of the asset to which the rating will be assigned.

Responses

201

Rating successfully added.

application/json

Represents a rating. A rating is a numerical value representing the author's opinion about the rated resource. Ratings can be accompanied by written reviews.

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. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

ratingnumber · doubleRequired

The value of the rating represented as a floating point number between 0 and 1.

Example: 0.2

reviewstringOptional

The review attached to the rating.

post/ratings

POST /rest/2.0/ratings HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "rating": 0.6,
  "review": "This is a review",
  "assetId": "123e4567-e89b-12d3-a456-426614174000"
}

201

Rating successfully added.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "rating": 0.2,
  "review": "text",
  "asset": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  }
}

Get rating.

get

Returns the rating with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

ratingIdstring · uuidRequired

The ID of the rating.

Responses

200

Rating found.

application/json

Represents a rating. A rating is a numerical value representing the author's opinion about the rated resource. Ratings can be accompanied by written reviews.

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. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

ratingnumber · doubleRequired

The value of the rating represented as a floating point number between 0 and 1.

Example: 0.2

reviewstringOptional

The review attached to the rating.

404

Rating with given ID could not be found.

get/ratings/{ratingId}

GET /rest/2.0/ratings/{ratingId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "rating": 0.2,
  "review": "text",
  "asset": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  }
}

Remove rating.

delete

Removes the rating with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

ratingIdstring · uuidRequired

The ID of the rating to be removed.

Responses

204

Rating successfully removed.

No content

404

Rating with given ID could not be found.

delete/ratings/{ratingId}

DELETE /rest/2.0/ratings/{ratingId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Change rating.

patch

Modifies the rating with the specified ID.

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

Authorizations

AuthorizationstringRequired

Path parameters

ratingIdstring · uuidRequired

The ID of the rating to be changed.

Body

ratingnumber · enumRequired

The value of the rating. Allowed values are 0.2, 0.4, 0.6, 0.8, 1.0 (representing 1 to 5 stars).

Example: 0.6Possible values:

reviewstringOptional

The review attached to the rating.

Responses

200

Rating successfully changed.

application/json

Represents a rating. A rating is a numerical value representing the author's opinion about the rated resource. Ratings can be accompanied by written reviews.

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. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

ratingnumber · doubleRequired

The value of the rating represented as a floating point number between 0 and 1.

Example: 0.2

reviewstringOptional

The review attached to the rating.

404

Rating with given ID could not be found.

patch/ratings/{ratingId}

PATCH /rest/2.0/ratings/{ratingId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "rating": 0.6,
  "review": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "rating": 0.2,
  "review": "text",
  "asset": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  }
}