Claromentis API Docs logoClaromentis API Docs

Claromentis module Thank You API v3.0.0

Rest API for the Claromentis Thank You application. Available from Claromentis 9.2.0 and later.

Base URLs:

Email: Discover Claromentis Web: Discover Claromentis

Notes

Notes are text which can be assigned to the user or group

Thank you notes

Method: GET

Path: /thanks

Return a list of the recent "Thank you" notes

Parameters

Name In Type Required Description
limit path integer false The limit of thank you notes. Default is 20
offset path integer false The offset of thank you notes. Default is 0
thanked path boolean false Show the list of thanked users in returned object
users path boolean false Show the list of users in returned object
tags path boolean false Show the list of tags in returned object
user_ids path array false List Thank You notes for specific users. User IDs are comma-separated.
group_ids path array false List Thank You notes for specific group of users. IDs are comma-separated.

Example responses

200 Response

{
  "data": [
    {
      "id": 12,
      "description": "Thank you!",
      "author": {
        "id": 12,
        "name": "John Doe"
      },
      "date_created": {
        "date": "2023-01-01T00:00:00.000Z",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "users": [
        {
          "id": 12,
          "name": "John Doe"
        }
      ]
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 100,
    "prev": "/api/thankyou/v3/thanks?offset=20&limit=20",
    "next": "/api/thankyou/v3/thanks?offset=20&limit=20"
  }
}

Responses

Status Meaning Description Schema
200 OK Array of thank you notes Inline
400 Bad Request The note can not be created Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» data [ThankYouNote] false none [Thank you note object]
»» id integer false read-only Thank you ID
»» description string true none Thank you note text
»» author Author true none The user name of the creator of the note
»»» id integer false read-only ID of the note creator
»»» name string false read-only User name of the note creator
»» date_created object false none Date object
»»» date string(date-time) false read-only The field contains time/date
»»» timezone_type integer false read-only Timezone ID
»»» timezone string false read-only Timezone name
»» users [ThankYouUser] false none A list of thanked users
»»» id integer false read-only ID of the assigned user
»»» name string false read-only Username of the assigned user
» pagination object false none Standard pagination object
»» offset integer false read-only The number of items results are offset by
»» limit integer false read-only The number of items returned
»» total integer false read-only The total number of items
»» prev string¦null false read-only URL to the previous page of items
»» next string¦null false read-only URL to the next page of items

Status Code 400

Name Type Required Restrictions Description
» error boolean false none is error flag

Create a thank you note

Method: POST

Path: /thanks

Create "Thank you" note

Body parameter

{
  "description": "Thank you note!",
  "tags": [
    1,
    2
  ],
  "thanked": [
    {
      "id": 1,
      "oclass": {
        "id": 1,
        "oclass": 1
      }
    }
  ]
}

Parameters

Name In Type Required Description
body body object false Content of Thank you request body
» description body string true The content of the thank you note
» tags body [any] true Tags ID (core values)
» thanked body [object] true An array with users or groups to assign a new thank you note
»» id body integer false User or group ID
»» oclass body object false Object represented user or group ID with that type
»»» id body integer false none
»»» oclass body any false Oclass object type 1 - for user, 3 - for groups of the users

Enumerated Values

Parameter Value
»»» oclass 1
»»» oclass 3

Example responses

200 Response

{
  "id": 12,
  "description": "Thank you!",
  "author": {
    "id": 12,
    "name": "John Doe"
  },
  "date_created": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "users": [
    {
      "id": 12,
      "name": "John Doe"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Thank you item ThankYouNote
401 Unauthorized Authentication is required Inline
404 Not Found The returned object was not found Inline

Response Schema

Status Code 401

Authentication is required

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

Status Code 404

Response object when Thank you note does not exist

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

Get thank you item with specified ID

Method: GET

Path: /thanks/{id}

Return "Thank you" note by specified ID

Parameters

Name In Type Required Description
id path integer true Object ID
thanked path boolean false Show the list of thanked users in returned object
tags path boolean false Show the list of tags in returned object

Example responses

200 Response

{
  "id": 12,
  "description": "Thank you!",
  "author": {
    "id": 12,
    "name": "John Doe"
  },
  "date_created": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "users": [
    {
      "id": 12,
      "name": "John Doe"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Thank you item ThankYouNote
401 Unauthorized Authentication is required Inline
404 Not Found The returned object was not found Inline

Response Schema

Status Code 401

Authentication is required

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

Status Code 404

Response object when Thank you note does not exist

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

Update a thank you note

Method: PUT

Path: /thanks/{id}

Update "Thank you" note

Body parameter

{
  "description": "Thank you note!",
  "tags": [
    1,
    2
  ],
  "thanked": [
    {
      "id": 1,
      "oclass": {
        "id": 1,
        "oclass": 1
      }
    }
  ]
}

Parameters

Name In Type Required Description
id path integer true Object ID
body body object false Content of Thank you request body
» description body string true The content of the thank you note
» tags body [any] true Tags ID (core values)
» thanked body [object] true An array with users or groups to assign a new thank you note
»» id body integer false User or group ID
»» oclass body object false Object represented user or group ID with that type
»»» id body integer false none
»»» oclass body any false Oclass object type 1 - for user, 3 - for groups of the users

Enumerated Values

Parameter Value
»»» oclass 1
»»» oclass 3

Example responses

200 Response

true

Responses

Status Meaning Description Schema
200 OK Thank you note has been edited boolean
401 Unauthorized Authentication is required Inline
404 Not Found The returned object was not found Inline

Response Schema

Status Code 401

Authentication is required

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

Status Code 404

Response object when Thank you note does not exist

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

Delete a thank you note

Method: DELETE

Path: /thanks/{id}

Delete "Thank you" note

Parameters

Name In Type Required Description
id path integer true Object ID

Example responses

200 Response

true

Responses

Status Meaning Description Schema
200 OK Thank you note has been deleted boolean
401 Unauthorized Authentication is required Inline
404 Not Found The returned object was not found Inline

Response Schema

Status Code 401

Authentication is required

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

Status Code 404

Response object when Thank you note does not exist

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

Tags

Core values can be linked to Notes

Returns the total number of tags in the system

Method: GET

Path: /tags/total

Returns the total number of Tags in the system

Parameters

Name In Type Required Description
active path boolean false Show only active tags

Example responses

200 Response

15

Responses

Status Meaning Description Schema
200 OK The number of the tags in system integer

Get a collection of tags

Method: GET

Path: /tags

Return a list of the core values (tags)

Parameters

Name In Type Required Description
limit path integer false The limit of thank you notes. Default is 20
name path string false The name of the tag
active path boolean false Show only active tags
offset path integer false The offset of thank you notes. Default is 0

Example responses

200 Response

{
  "data": [
    {
      "id": 1,
      "active": true,
      "name": "Tag 1",
      "created_by": "Administrator",
      "created_date": {
        "date": "2023-01-01T00:00:00.000Z",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "modified_by": "Administrator",
      "modified_date": {
        "date": "2023-01-01T00:00:00.000Z",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "bg_colour": "#00adef"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 100,
    "prev": "/api/thankyou/v3/thanks?offset=20&limit=20",
    "next": "/api/thankyou/v3/thanks?offset=20&limit=20"
  }
}

Responses

Status Meaning Description Schema
200 OK The list of tags Inline
400 Bad Request The core value (tag) cannot be created Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» data [Tag] false none [Tag object]
»» id integer false read-only ID of tag
»» active boolean false none Flag is tag active
»» name string true none Tag name
»» created_by string false read-only Username who created the tag
»» created_date object false none Date object
»»» date string(date-time) false read-only The field contains time/date
»»» timezone_type integer false read-only Timezone ID
»»» timezone string false read-only Timezone name
»» modified_by string false read-only Username who modified the tag
»» modified_date object false none Date object
»» bg_colour string false none Tag colour in RGB hex code
» pagination object false none Standard pagination object
»» offset integer false read-only The number of items results are offset by
»» limit integer false read-only The number of items returned
»» total integer false read-only The total number of items
»» prev string¦null false read-only URL to the previous page of items
»» next string¦null false read-only URL to the next page of items

Status Code 400

Name Type Required Restrictions Description
» type string false none none
» title string false none none
» status integer false none none
» invalid-params [object] false none none
»» name string false none none
»» reason string false none none

Create a tag

Method: POST

Path: /tags

Create the core value (tag)

Body parameter

{
  "active": true,
  "name": "Tag 1",
  "created_date": {},
  "modified_date": {},
  "bg_colour": "#00adef"
}

Parameters

Name In Type Required Description
body body Tag false Content of new tag request

Example responses

200 Response

{
  "id": 1,
  "active": true,
  "name": "Tag 1",
  "created_by": "Administrator",
  "created_date": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "modified_by": "Administrator",
  "modified_date": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "bg_colour": "#00adef"
}

Responses

Status Meaning Description Schema
200 OK The core value object (tag). Tag
400 Bad Request The core value (tag) cannot be created Inline

Response Schema

Status Code 400

Name Type Required Restrictions Description
» type string false none none
» title string false none none
» status integer false none none
» invalid-params [object] false none none
»» name string false none none
»» reason string false none none

Get a tag

Method: GET

Path: /tags/{id}

Return a tag by it's own ID number

Parameters

Name In Type Required Description
id path integer true Object ID

Example responses

200 Response

{
  "id": 1,
  "active": true,
  "name": "Tag 1",
  "created_by": "Administrator",
  "created_date": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "modified_by": "Administrator",
  "modified_date": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "bg_colour": "#00adef"
}

Responses

Status Meaning Description Schema
200 OK The core value object (tag). Tag
401 Unauthorized Authentication is required Inline
404 Not Found The core value (tag) was not found. Inline

Response Schema

Status Code 401

Name Type Required Restrictions Description
anonymous [#/components/responses/Tag] false none [The core value object (tag).]

Status Code 404

Name Type Required Restrictions Description
» type string false none none
» title string false none none
» status integer false none none

Update a tag

Method: PUT

Path: /tags/{id}

Update the core value (tag) by ID

Body parameter

{
  "active": true,
  "name": "Tag 1",
  "created_date": {},
  "modified_date": {},
  "bg_colour": "#00adef"
}

Parameters

Name In Type Required Description
id path integer true Object ID
body body Tag false Content of new tag request

Example responses

200 Response

{
  "id": 1,
  "active": true,
  "name": "Tag 1",
  "created_by": "Administrator",
  "created_date": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "modified_by": "Administrator",
  "modified_date": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "bg_colour": "#00adef"
}

Responses

Status Meaning Description Schema
200 OK The core value object (tag). Tag
400 Bad Request The core value (tag) cannot be created Inline
404 Not Found The core value (tag) was not found. Inline

Response Schema

Status Code 400

Name Type Required Restrictions Description
» type string false none none
» title string false none none
» status integer false none none
» invalid-params [object] false none none
»» name string false none none
»» reason string false none none

Status Code 404

Name Type Required Restrictions Description
» type string false none none
» title string false none none
» status integer false none none

Delete a tag

Method: DELETE

Path: /tags/{id}

Delete the core value (tag) by ID

Parameters

Name In Type Required Description
id path integer true Object ID

Example responses

200 Response

true

Responses

Status Meaning Description Schema
200 OK OK boolean
401 Unauthorized Authentication is required Inline
500 Internal Server Error An error occurred when contacting the Repository Inline

Response Schema

Status Code 401

Authentication is required

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

Status Code 500

Name Type Required Restrictions Description
» type string false none none
» title string false none none
» status integer false none none

Schemas

Author

{
  "id": 12,
  "name": "John Doe"
}

The user name of the creator of the note

Properties

Name Type Required Restrictions Description
id integer false read-only ID of the note creator
name string false read-only User name of the note creator

ThankYouUser

{
  "id": 12,
  "name": "John Doe"
}

User which thank you note is assigned

Properties

Name Type Required Restrictions Description
id integer false read-only ID of the assigned user
name string false read-only Username of the assigned user

ThankYouNote

{
  "id": 12,
  "description": "Thank you!",
  "author": {
    "id": 12,
    "name": "John Doe"
  },
  "date_created": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "users": [
    {
      "id": 12,
      "name": "John Doe"
    }
  ]
}

Thank you note object

Properties

Name Type Required Restrictions Description
id integer false read-only Thank you ID
description string true none Thank you note text
author Author true none The object with thank you note author
date_created Date false none The object with date when note has been created
users [ThankYouUser] false none A list of thanked users

Date

{
  "date": "2023-01-01T00:00:00.000Z",
  "timezone_type": 3,
  "timezone": "Europe/London"
}

Date object

Properties

Name Type Required Restrictions Description
date string(date-time) false read-only The field contains time/date
timezone_type integer false read-only Timezone ID
timezone string false read-only Timezone name

Pagination

{
  "offset": 0,
  "limit": 20,
  "total": 100,
  "prev": "/api/thankyou/v3/thanks?offset=20&limit=20",
  "next": "/api/thankyou/v3/thanks?offset=20&limit=20"
}

Standard pagination object

Properties

Name Type Required Restrictions Description
offset integer false read-only The number of items results are offset by
limit integer false read-only The number of items returned
total integer false read-only The total number of items
prev string¦null false read-only URL to the previous page of items
next string¦null false read-only URL to the next page of items

Tag

{
  "id": 1,
  "active": true,
  "name": "Tag 1",
  "created_by": "Administrator",
  "created_date": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "modified_by": "Administrator",
  "modified_date": {
    "date": "2023-01-01T00:00:00.000Z",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "bg_colour": "#00adef"
}

Tag object

Properties

Name Type Required Restrictions Description
id integer false read-only ID of tag
active boolean false none Flag is tag active
name string true none Tag name
created_by string false read-only Username who created the tag
created_date Date false none The date the tag was created
modified_by string false read-only Username who modified the tag
modified_date Date false none The date the tag was modified
bg_colour string false none Tag colour in RGB hex code