Interests

There are different areas that customers are interested in, that they enjoy, that they like or prefer. Resource interests can be used to manage all this customer project specific preferences, personal interests, passions or hobbies.

Available methods

All available methods for resource Interests.

HTTP method Endpoint Description
[badge-blue GET] /interests Get information about all interests
[badge-blue GET] /interests/{interest_id} Get information about an interest


Get all interests

Get information about interests as a list of all interests
[badge-blue GET] /interests

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
name string Name for the interest No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
interests Interest[] List of all interests
total_items integer Count of all found interests

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/interests
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NTRlMDVkNzDNjYzY3YjM1MTBkMGE4N2VhYWU1MDg4N2M1NTA2OWU0NDM5ZDEwOTEwMWM1ODNiOA==

Example response

HTTP/1.1 200 OK
Date: Thu, 06 Aug 2020 12:21:11 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "interests": [
      {
        "interest_id": "86e05affc7a7abefcd513ab400",
        "name": "Common stuff"
      },
      {
        "interest_id": "8bed991c68a470e7aaeffbf048",
        "name": "Tech stuff"
      },
      {
        "interest_id": "81eaeea13b8984a169c490a325",
        "name": "Paranormal stuff"
      }
    ],
    "total_items": 3
  }
}


Get an interest

Get information about a specific interest
[badge-blue GET] /interests/{interest_id}

Path parameters

Parameter name Type Description
interest_id string The unique id for the interest

Response

Status code: 200 OK
Output structure : Interest

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/interests/81eaeea13b8984a169c490a325
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6MzUyYjM2MThmODNkMmY0NmZlYmUwOTcwZTFiMDFhYWFiOTZiMTc2MjZhNzkzNTNjYTE3ZmUwZDQ4NTE5YzJkZg==

Example response

HTTP/1.1 200 OK
Date: Fri, 14 Aug 2020 09:28:24 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "interest_id": "81eaeea13b8984a169c490a325",
    "name": "Paranormal stuff"
  }
}