StarMeUp OS

BetterMe

Operations

We expose the following operations listed below:

Feedback

Find Feedback by Id

Returns a specific Feedback given the Id.

Resource URL

GET: /betterme/public-api/v1/feedbacks/{id}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The expected language of the response. If this is not present or is invalid then the response will be returned using the user’s language or the Community’s language or the Feedback’s default language.

Path Parameters

Parameter Optional/Required Description

id

Required

Long value that represents the Feedback’s Id.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": {
      "id": 1357,
      "sender": {
        "id": 246,
        "identification": "john.doe@qastarmeup.com",
        "firstName": "John",
        "lastName": "Doe",
        "project": "StarMeUp OS",
        "job": "Developer",
        "profileImage": {
          "code": "tdstjgeoqowriusiqhow_jpg",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
        },
        "enabled": true,
        "area": "Development",
        "account": "Globant",
        "office": "Mexico"
      },
      "recipient": {
        "id": 135,
        "identification": "jane.doe@qastarmeup.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "project": "StarMeUp OS",
        "job": "Director",
        "profileImage": {
          "code": "tdstjgeoqowriusiqhow_jpg",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
        },
        "enabled": true,
        "area": "Product Management",
        "account": "Globant",
        "office": "Colombia"
      },
      "ratedTopics": [
        {
          "id": 13,
          "name": "Amazing",
          "description": "An evaluation aspect with an amazing high values.",
          "ordinality": 3,
          "value": 3,
          "imageCode": "yfaaajvmgznafufkoudg_png",
          "color": "#f5a623",
          "topics": [
            {
              "id": 217,
              "name": "Fast Learner",
              "description": "Exercises the ability to unlearn and relearn.",
              "active": true,
              "skill": false
            }
          ]
        }
      ],
      "totalMessages": 0,
      "creationTime": 1508520013000,
      "community": {
        "id": 3,
        "name": "Globant"
      },
      "comment": "Very good worker."
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "There was an unexpected error.",
    "type": "uri=/betterme/public-api/v1/feedbacks/1",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Find List of Feedback by Filters

Returns a list of Feedback associated with a specific person.

  • Page is given by the page parameter.

  • Size is the amount of results wanted to be returned per page.

  • If you want to sort the records in a specific way, the value "sort" must be defined. It makes reference to the field name in the Database.

Resource URL

GET: /betterme/public-api/v1/feedbacks

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The expected language of the response. If this is not present or is invalid then the response will be returned using the user’s language or the Community’s language or the Feedback’s default language.

URL Parameters

Parameter Optional/Required Description

sender

Optional

The user’s identification who had sent the Feedback.

recipient

Optional

The user’s identification who had received the Feedback.

creationTimeFrom

Optional

The timestamp in milliseconds equal or greater than the creation time of the returned list of Feedback. Default 0.

creationTimeTo

Optional

The timestamp in milliseconds equal or lower than the creation time of the returned list of Feedback. Default 0.

page

Optional

Page to find the records. It starts at 0. Default 0.

size

Optional

The amount of records wanted to be returned in the page.

sort

Optional

Field name used for sorting the records in a DESC way. Default sort by "id".

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": [
      {
        "id": 1357,
        "sender": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "tdstjgeoqowriusiqhow_jpg",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Mexico"
        },
        "recipient": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Director",
          "profileImage": {
            "code": "tdstjgeoqowriusiqhow_jpg",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "ratedTopics": [
          {
            "id": 13,
            "name": "Very Good",
            "description": "An evaluation aspect with very high good values.",
            "ordinality": 3,
            "value": 3,
            "imageCode": "yfaaajvmgznafufkoudg_png",
            "color": "#f5a623",
            "topics": [
              {
                "id": 217,
                "name": "Fast Learner",
                "description": "Exercises the ability to unlearn and relearn.",
                "active": true,
                "skill": false
              }
            ]
          }
        ],
        "totalMessages": 0,
        "creationTime": 1508520013000,
        "community": {
          "id": 3,
          "name": "Globant"
        },
        "comment": "Very good worker."
      }
    ],
    "page": {
      "number": 200,
      "size": 10,
      "totalElements": 2013,
      "totalPages": 202,
      "numberOfElements": 10
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "There was an unexpected error.",
    "type": "uri=/betterme/public-api/v1/feedbacks",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Send Feedback Request

Create a Feedback Request based on the Skills array sent in the body request.

Resource URL

POST /betterme/public-api/v1/feedback/requests

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The expected language of the response. If this is not present or is invalid then the response will be returned using the Community’s language default language.

Body Parameters

Parameter Optional/Required Description

sender

Required

Refers to the sender’s identification of the Feedback Request.

recipient

Required

Refers to the recipient’s identification of the Feedback Request.

comment

Required

The comment associated with the Feedback Request.

skills

Optional

Array of the name codes for the Skills to be evaluated in the Feedback Request.

Request

Example: 

  {
    "sender": "john.doe@qastarmeup.com",
    "recipient": "jane.doe@qastarmeup.com",
    "comment": "I want you to evaluate me based on these Skills.",
    "skills": [
      "fast_learner",
      "team_worker"
    ]
  }

Response

HTTP/1.1 201 Created

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The Evaluation Request was not sent",
    "type": "uri=/betterme/public-api/v1/feedback/requests",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Decline Feedback Request

Decline a Feedback Request.

Resource URL

PUT /betterme/public-api/v1/feedback-requests/{feedback-request-id}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Body Parameters

Parameter Optional/Required Description

sender

Required

Refers to the sender’s identification of the Feedback Request.

recipient

Required

Refers to the recipient’s identification of the Feedback Request.

declineReasonId

Required

The reason id to decline the Feedback Request.

Request

Example: 

  {
    "sender": "john.doe@qastarmeup.com",
    "recipient": "jane.doe@qastarmeup.com",
    "declineReasonId": 1
  }

Response

HTTP/1.1 200 OK

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The Request Decline was not sent",
    "type": "uri=/betterme/public-api/v1/feedback-requests/12356",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Send Feedback/Answer Feedback Request

Send feedback. It can be related to a previous feedback request or not.

Resource URL

POST /betterme/public-api/v1/feedbacks

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Body Parameters

Parameter Optional/Required Description

sender

Required

Refers to the sender’s identification of the Feedback Request.

recipient

Required

Refers to the recipient’s identification of the Feedback Request.

feedbackRequestId

Optional

Feedback request id that is answered in this feedback. If true feedback request will be marked as answered.

feedback

Optional

user’s feedback information.

Request

Example: 

  {
    "sender": "john.doe@qastarmeup.com",
    "recipient": "jane.doe@qastarmeup.com",
    "feedbackRequestId": 10,
    "feedback": {
              "comments":"",
              "strengths":"",
              "opportunities":"",
              "competences": [
              ]
    }
  }

Response

HTTP/1.1 200 OK

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The Request Decline was not sent",
    "type": "uri=/betterme/public-api/v1/feedback-requests/12356",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Goals

Find Goal by Id and Identification

Returns a specific Goal given the Goal’s code and the assignee user identification.

Resource URL

GET: /betterme/public-api/v1/goals/{code}/users/{identification}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Path Parameters

Parameter Optional/Required Description

code

Required

String value that represents the Goal’s code.

identification

Required

String value that represents the identification of the user who has assigned the Goal.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": {
      "code": "tds7j6e1qowr5us0qh5w",
      "title": "Goal to be Closed",
      "description": "The common Goal for everyone.",
      "type": "COMMUNITY",
      "status": "OPENED",
      "weighting": 10,
      "assignment": "SHARED",
      "startDate": "2018-01-01",
      "endDate": "2018-12-31",
      "progress": 0,
      "assignedTo": "jhon.doe@globant.com",
      "creationDate": "2017-06-14T22:13:14.000Z",
      "period": {
        "name": "2018",
        "description": "2018 Period : 1/1/2018 - 31/12/2018",
        "startDate": "2018-01-01",
        "endDate": "2018-12-31"
      },
      "scales": [
        {
          "name": "Achieved",
          "description": "When the Goal had positive exceed results.",
          "details": "Exceed Expectations.",
          "min": 1,
          "max": 10
        }
      ]
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The Goal does not exist.",
    "type": "uri=/betterme/public-api/v1/goals/tds7j6e1qowr5us0qh5w",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Find Goals by Filters

Returns a list of Goals using filters.

  • The Page of the records list is given by the "pageNumber" parameter.

  • The Size of the Page is given by the "pageSize" parameter.

  • If you want to sort the records in a specific way, the value "sort" must be defined. It makes reference to the field name in the Database.

Resource URL

GET: /betterme/public-api/v1/goals

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The expected language of the response. If this is not present or is invalid then the response will be returned using the user’s language or the Community’s language or the Goal’s default language.

URL Parameters

Parameter Optional/Required Description

title

Optional

String value that represents the Goal’s title.

status

Optional

String value that represents the current status of the Goal.

assignment

Optional

String value that represents the assignment type of the Goal.

periodName

Optional

String value that represents the Name of the Period.

type

Optional

The Goal’s type. If it’s not present, it will return both the COMMUNITY and TEAM Goals.

startDateFrom

Optional

Date value that represents the start of the range for the Goal’s start date.

startDateTo

Optional

Date value that represents the end of the range for the Goal’s start date.

endDateFrom

Optional

Date value that represents the start of the range for the Goal’s end date.

endDateTo

Optional

Date value that represents the end of the range for the Goal’s end date.

assignedTo

Optional

String value that represents the identification of the user who has assigned the Goal.

pageNumber

Optional

The page number. The default value is 0.

pageSize

Optional

The page size. The default value is 10.

orderBy

Optional

The order by criteria. The default is 'creationDate' field.

sort

Optional

The sorting criteria. The default is a DESC order.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": [
      {
        "code": "tds7j6e1qowr5us0qh5w",
        "title": "Goal to be Closed",
        "type": "COMMUNITY",
        "status": "OPENED",
        "weighting": 13,
        "assignment": "SHARED",
        "startDate": "2018-01-01",
        "endDate": "2018-12-31",
        "assignedTo": "jhon.doe@globant.com",
        "creationDate": "2017-06-14T22:13:14.000Z",
        "scales": [
          {
            "name": "Not Achieved",
            "description": "When the Goal was not achieved successfully.",
            "details": "Not Achieved.",
            "min": 1,
            "max": 10
          },
          {
            "name": "Partially Achieved",
            "description": "When the Goal was partially achieved successfully.",
            "details": "Partially Achieved.",
            "min": 1,
            "max": 20
          },
          {
            "name": "Achieved",
            "description": "When the Goal was achieved successfully.",
            "details": "Achieved.",
            "min": 1,
            "max": 30
          },
          {
            "name": "Exceed Expectations",
            "description": "When the Goal had positive exceed results.",
            "details": "Exceed Expectations.",
            "min": 1,
            "max": 40
          },
          {
            "name": "Widely Exceeded Expectations",
            "description": "When the Goal was highly achieved successfully.",
            "details": "Widely Exceeded Expectations.",
            "min": 1,
            "max": 50
          },
          {
            "name": "Normal Expectations",
            "description": "When the Goal was achieved in a normal way.",
            "details": "Normal Expectations.",
            "min": 1,
            "max": 60
          }
        ],
        "period": {
          "name": "2018",
          "description": "2018 Period : 1/1/2018 - 31/12/2018",
          "startDate": "2018-01-01",
          "endDate": "2018-12-31"
        }
      }
    ],
    "page": {
      "numberElements": 1
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The user wasn’t found",
    "type": "uri=/betterme/public-api/v1/goals",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Create Goal

Create a Goal based on the information sent in the body request.

NOTE: This endpoint is pointing to the 'v2' API version.

Resource URL

POST /betterme/public-api/v2/goals

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Body Parameters

Parameter Optional/Required Description

code

Required

String value that represents the Goal’s code. It has to be unique.

title

Required

Text that represents the title of the Goal.

description

Optional

Text that represents the description of the Goal.

type

Required

The type of the Goal. It can be: TEAM or COMMUNITY.

weighting

Required

Positive number that indicates the degree of importance of completing the Goal.

assignment

Required

Value that indicates if the Goal is for many or just one user. It can be: INDIVIDUAL or SHARED.

startDate

Optional

Date value that represents when the Goal stars. It must be inside the current Period. If the value is not present, the Start Date of the current Period will be used.

endDate

Optional

Date value that represents the Goal’s due date. It must be inside the current Period. If the value is not present, the End Date of the current Period will be used.

periodName

Optional

String value that represents the Name of the Period. It must be the current Period or one in the future. If the value is not present, the current active Period will be used.

assignedTo

Required

String value that represents the identification of the user who has assigned the Goal.

locale

Required

String value that represents the locale of the Goal.

Request

Example: 

  {
    "code": "tds7j6e1qowr5us0qh5w",
    "title": "Goal to be Closed",
    "description": "The common Goal for everyone.",
    "type": "COMMUNITY",
    "weighting": 10,
    "assignment": "INDIVIDUAL",
    "startDate": "2018-01-01",
    "endDate": "2018-12-31",
    "periodName": "2018",
    "assignedTo": "jhon.doe@globant.com",
    "locale": "en-us"
  }

Response

HTTP/1.1 201 Created

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "It was not able to create the Skill.",
    "type": "uri=/betterme/public-api/v1/goals",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Update Goal

Update a Goal based on the information sent in the body request and using the given code.

Resource URL

PUT /betterme/public-api/v1/goals/{code}/users/{identification}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Path Parameters

Parameter Optional/Required Description

code

Required

String value that represents the Goal’s code.

identification

Required

String value that represents the identification of the user who has assigned the Goal.

Body Parameters

Parameter Optional/Required Description

code

Required

String value that represents the Goal’s code. It has to be unique.

title

Required

Text that represents the title of the Goal.

description

Optional

Text that represents the description of the Goal.

weighting

Required

Positive number that indicates the degree of importance of completing the Goal.

startDate

Optional

Date value that represents when the Goal stars. It must be inside the current Period. If the value is not present, the Start Date of the current Period will be used.

endDate

Optional

Date value that represents the Goal’s due date. It must be inside the current Period. If the value is not present, the End Date of the current Period will be used.

periodName

Optional

String value that represents when the Name of the Period. It must be the current Period or one in the future. If the value is not present, the current active Period will be used.

locale

Required

String value that represents the locale of the Goal.

Request

Example: 

  {
    "code": "tds7j6e1qowr5us0qh5w",
    "title": "Goal to be Closed",
    "description": "The common Goal for everyone.",
    "weighting": 10,
    "startDate": "2018-01-01",
    "endDate": "2018-12-31",
    "periodName": "2018",
    "locale": "es-co"
  }

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": {
      "code": "tds7j6e1qowr5us0qh5w",
      "title": "Goal to be Closed",
      "description": "The common Goal for everyone.",
      "type": "COMMUNITY",
      "status": "OPENED",
      "weighting": 10,
      "assignment": "SHARED",
      "startDate": "2018-01-01",
      "endDate": "2018-12-31",
      "progress": 0,
      "assignedTo": "jhon.doe@globant.com",
      "creationDate": "2017-06-14T22:13:14.000Z",
      "locale": "es-co",
      "period": {
        "name": "2018",
        "description": "2018 Period : 1/1/2018 - 31/12/2018",
        "startDate": "2018-01-01",
        "endDate": "2018-12-31"
      },
      "scales": [
        {
          "name": "Achieved",
          "description": "When the Goal had positive exceed results.",
          "details": "Exceed Expectations.",
          "min": 1,
          "max": 10
        },
        {
          "name": "Normal Expectations",
          "description": "When the Goal was achieved in a normal way.",
          "details": "Normal Expectations.",
          "min": 1,
          "max": 60
        }
      ]
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "Updating Goal had an unexpected error.",
    "type": "uri=/betterme/public-api/v1/goals/tds7j6e1qowr5us0qh5w",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Delete Goal

Deletes a specific Goal given the Goal’s code.

Resource URL

DELETE: /betterme/public-api/v1/goals/{code}/users/{identification}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Path Parameters

Parameter Optional/Required Description

code

Required

String value that represents the Goal’s code.

identification

Required

String value that represents the identification of the user who has assigned the Goal.

Response

HTTP/1.1 204 No Content

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "It was not able to delete the Goal.",
    "type": "uri=/betterme/public-api/v1/goals/tds7j6e1qowr5us0qh5w",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Evaluations

Find Evaluation by Id

Returns a specific Evaluation given the Id.

Resource URL

GET /betterme/public-api/v1/evaluations/{id}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The expected language of the response. If this is not present or is invalid then the response will be returned using the user’s language or the Community’s language or the Evaluation’s default language.

Path Parameters

Parameter Optional/Required Description

id

Required

Long value that represents the Evaluation’s Id.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": {
      "id": 3,
      "creationTime": 1527702452000,
      "updateTime": 1527702452000,
      "submissionTime": 1527702452000,
      "dateTimeFrom": 1514765000,
      "dateTimeTo": 1546301000,
      "title": "Assessment 2015",
      "evaluator": {
        "id": 246,
        "identification": "john.doe@qastarmeup.com",
        "firstName": "John",
        "lastName": "Doe",
        "project": "StarMeUp OS",
        "job": "Developer",
        "profileImage": {
          "code": "tdstjgeoqowriusiqhow_jpg",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
        },
        "enabled": true,
        "area": "Development",
        "account": "Globant",
        "office": "Mexico"
      },
      "evaluee": {
        "id": 135,
        "identification": "jane.doe@qastarmeup.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "project": "StarMeUp OS",
        "job": "Director",
        "profileImage": {
          "code": "tdstjgeoqowriusiqhow_jpg",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
        },
        "enabled": true,
        "area": "Product Management",
        "account": "Globant",
        "office": "Colombia"
      },
      "type": "EVALUATION",
      "ratedTopics": [
        {
          "id": 17,
          "name": "Very Good",
          "description": "An evaluation aspect with very good values.",
          "ordinality": 4,
          "value": 4,
          "ratedTopicImage": {
            "imageCode": "tuldigvxknbjkykjmhnz_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tuldigvxknbjkykjmhnz_png/80/80/1"
          },
          "color": "#fd3171",
          "topics": [
            {
              "id": 208,
              "name": "Fast Learner",
              "description": "Exercises the ability to unlearn and relearn.",
              "active": true,
              "skill": false
            }
          ]
        },
        {
          "id": 16,
          "name": "Amazing",
          "description": "An evaluation aspect with amazing values.",
          "ordinality": 3,
          "value": 3,
          "ratedTopicImage": {
            "imageCode": "yfaaajvmgznafufkoudg_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/yfaaajvmgznafufkoudg_png/80/80/1"
          },
          "color": "#f5a623",
          "topics": [
            {
              "id": 353,
              "name": "Collaborative",
              "description": "Works with others effectively.",
              "active": false,
              "skill": false
            }
          ]
        },
        {
          "id": 14,
          "name": "Awesome",
          "description": "An evaluation aspect with very awesome values.",
          "ordinality": 1,
          "value": 1,
          "ratedTopicImage": {
            "imageCode": "lbzcyaeocfqzzqnzdswq_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/lbzcyaeocfqzzqnzdswq_png/80/80/1"
          },
          "color": "#7c4ba7",
          "topics": [
            {
              "id": 214,
              "name": "Integrity",
              "description": "Acts in a fair way.",
              "active": true,
              "skill": false
            }
          ]
        },
        {
          "id": 15,
          "name": "Cool",
          "description": "An evaluation aspect with very cool values.",
          "ordinality": 2,
          "value": 2,
          "ratedTopicImage": {
            "imageCode": "xdqamgabxwuazpmgdxpx_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/xdqamgabxwuazpmgdxpx_png/80/80/1"
          },
          "color": "#6faf2d",
          "topics": [
            {
              "id": 363,
              "name": "Flexible",
              "description": "Accepts and deals with uncertainty.",
              "active": false,
              "skill": false
            }
          ]
        },
        {
          "id": 18,
          "name": "Work On",
          "description": "An evaluation aspect with very work on values.",
          "ordinality": 5,
          "value": 5,
          "ratedTopicImage": {
            "imageCode": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image//80/80/1"
          },
          "color": "#bd10e0",
          "topics": [
            {
              "id": 365,
              "name": "Committed",
              "description": "Commitments with passion and professionalism.",
              "active": false,
              "skill": false
            }
          ]
        }
      ],
      "score": {
        "message": "Exceed Expectations",
        "value": 2,
        "manualScore": false
      },
      "comment": "Amazing working partner.",
      "answer": {
        "approved": true,
        "comment": "I agree with the feedback.",
        "creationTime": 1553787013000
      },
      "period": {
        "id": 5,
        "startTime": 1514764800000,
        "endTime": 1546214400000,
        "title": "2015 Year",
        "message": "2015 Period : 1/1/2015 - 31/12/2015",
        "subPeriods": [
        ]
      },
      "status": "SUBMITTED"
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The evaluation wasn’t found",
    "type": "uri=/betterme/public-api/v1/evaluations",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Find Evaluations

Returns all Evaluations in a Community.

Resource URL

GET /betterme/public-api/v1/evaluations

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The expected language of the response. If this is not present or is invalid then the response will be returned using the user’s language or the Community’s language or the Evaluation’s default language.

URL Parameters

Parameter Optional/Required Description

title

Optional

The Evaluation’s title.

evaluatorIdentification

Optional

The evaluator’s identification.

evalueeIdentification

Optional

The evaluee’s identification.

status

Optional

The Evaluation’s status. It must be DRAFT or SUBMITTED.

creationTimeFrom

Optional

The timestamp in milliseconds equal or greater than the creation time of the returned Evaluation.

creationTimeTo

Optional

The timestamp in milliseconds equal or lower than the creation time of the returned Evaluation.

updateTimeFrom

Optional

The timestamp in milliseconds equal or greater than the update time of the returned Evaluation.

updateTimeTo

Optional

The timestamp in milliseconds equal or lower than the update time of the returned Evaluation.

submissionTimeFrom

Optional

The timestamp in milliseconds equal or greater than the submission time of the returned Evaluation.

submissionTimeTo

Optional

The timestamp in milliseconds equal or lower than the submission time of the returned Evaluation.

pageNumber

Optional

The page number. The default value is 0.

pageSize

Optional

The page size. The default value is 10.

sort

Optional

Sorting criteria in the format: property(asc|desc). Default sorting order is ascending. Multiple sorting criterias are supported.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": [
      {
        "id": 13,
        "creationTime": 1527702432000,
        "updateTime": 1527702432000,
        "submissionTime": 1527702432000,
        "dateTimeFrom": 1514765000,
        "dateTimeTo": 1546301000,
        "title": "Assessment 2015",
        "evaluator": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "oospovnrixlhxmcicdag_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oospovnrixlhxmcicdag_png/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Argentina"
        },
        "evaluee": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Director",
          "profileImage": {
            "code": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oyxzvdxpxhsljtvsvzbc_png/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "type": "EVALUATION",
        "score": {
          "message": "Accomplished Expectations",
          "value": 5,
          "manualScore": false
        },
        "comment": "Good worker.",
        "answer": {
          "approved": false,
          "comment": "You have been a great team worker and a great person in this team.",
          "creationTime": 1531510776000
        },
        "period": {
          "id": 5,
          "startTime": 1514764800000,
          "endTime": 1546214400000,
          "title": "2015 Year",
          "message": "2015 Period : 1/1/2015 - 31/12/2015",
          "subPeriods": [
          ]
        },
        "status": "SUBMITTED"
      },
      {
        "id": 24,
        "creationTime": 1527702446000,
        "updateTime": 1527702446000,
        "submissionTime": 1527702446000,
        "dateTimeFrom": 1514765000,
        "dateTimeTo": 1546301000,
        "title": "Assessment 2016",
        "evaluator": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "oospovnrixlhxmcicdag_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oospovnrixlhxmcicdag_png/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Argentina"
        },
        "evaluee": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Director",
          "profileImage": {
            "code": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oyxzvdxpxhsljtvsvzbc_png/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "type": "EVALUATION",
        "score": {
          "message": "Not Achieved",
          "value": 1,
          "manualScore": false
        },
        "comment": "There were some issues when the mayor part of the Deliveries.",
        "period": {
          "id": 6,
          "startTime": 1514764800000,
          "endTime": 1546214400000,
          "title": "2016 Year",
          "message": "2016 Period : 1/1/2016 - 31/12/2016",
          "subPeriods": [
          ]
        },
        "status": "SUBMITTED"
      },
      {
        "id": 35,
        "creationTime": 1527702452000,
        "updateTime": 1527702452000,
        "submissionTime": 1527702452000,
        "dateTimeFrom": 1514765000,
        "dateTimeTo": 1546301000,
        "title": "Assessment 2017",
        "evaluator": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "oospovnrixlhxmcicdag_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oospovnrixlhxmcicdag_png/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Argentina"
        },
        "evaluee": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Director",
          "profileImage": {
            "code": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oyxzvdxpxhsljtvsvzbc_png/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "type": "EVALUATION",
        "score": {
          "message": "Exceed Expectations",
          "value": 2,
          "manualScore": false
        },
        "comment": "It is so nice work with you.",
        "period": {
          "id": 7,
          "startTime": 1514764800000,
          "endTime": 1546214400000,
          "title": "2017 Year",
          "message": "2017 Period : 1/1/2017 - 31/12/2017",
          "subPeriods": [
          ]
        },
        "status": "SUBMITTED"
      },
      {
        "id": 46,
        "creationTime": 1527702458000,
        "updateTime": 1527702458000,
        "submissionTime": 1527702458000,
        "dateTimeFrom": 1514765000,
        "dateTimeTo": 1546301000,
        "title": "Assessment 2018",
        "evaluator": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "oospovnrixlhxmcicdag_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oospovnrixlhxmcicdag_png/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Argentina"
        },
        "evaluee": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Director",
          "profileImage": {
            "code": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oyxzvdxpxhsljtvsvzbc_png/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "type": "EVALUATION",
        "score": {
          "message": "Achieved",
          "value": 3,
          "manualScore": false
        },
        "comment": "Nice job.",
        "period": {
          "id": 8,
          "startTime": 1514764800000,
          "endTime": 1546214400000,
          "title": "2018 Year",
          "message": "2018 Period : 1/1/2018 - 31/12/2018",
          "subPeriods": [
          ]
        },
        "status": "SUBMITTED"
      },
      {
        "id": 57,
        "creationTime": 1527702463000,
        "updateTime": 1527702463000,
        "submissionTime": 1527702463000,
        "dateTimeFrom": 1514765000,
        "dateTimeTo": 1546301000,
        "title": "Assessment 2019",
        "evaluator": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "oospovnrixlhxmcicdag_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oospovnrixlhxmcicdag_png/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Argentina"
        },
        "evaluee": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Director",
          "profileImage": {
            "code": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oyxzvdxpxhsljtvsvzbc_png/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "type": "EVALUATION",
        "score": {
          "message": "Exceeded Expectations",
          "value": 4,
          "manualScore": false
        },
        "comment": "Very good worker.",
        "answer": {
          "approved": true,
          "comment": "Good worker.",
          "creationTime": 1528723382000
        },
        "period": {
          "id": 9,
          "startTime": 1514764800000,
          "endTime": 1546214400000,
          "title": "2019 Year",
          "message": "2019 Period : 1/1/2019 - 31/12/2019",
          "subPeriods": [
          ]
        },
        "status": "SUBMITTED"
      },
      {
        "id": 68,
        "creationTime": 1527703127000,
        "updateTime": 1527703127000,
        "submissionTime": 1527703127000,
        "dateTimeFrom": 1514765000,
        "dateTimeTo": 1546301000,
        "title": "Assessment 2015",
        "evaluator": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "Manager",
          "job": "Director",
          "profileImage": {
            "code": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oyxzvdxpxhsljtvsvzbc_png/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "evaluee": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "oospovnrixlhxmcicdag_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oospovnrixlhxmcicdag_png/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Argentina"
        },
        "type": "EVALUATION",
        "score": {
          "message": "Not Achieved",
          "value": 1,
          "manualScore": false
        },
        "comment": "It is so nice work with you.",
        "period": {
          "id": 5,
          "startTime": 1514764800000,
          "endTime": 1546214400000,
          "title": "2015 Year",
          "message": "2015 Period : 1/1/2015 - 31/12/2015",
          "subPeriods": [
          ]
        },
        "status": "SUBMITTED"
      },
      {
        "id": 79,
        "creationTime": 1527703140000,
        "updateTime": 1527703140000,
        "submissionTime": 1527703140000,
        "dateTimeFrom": 1514765000,
        "dateTimeTo": 1546301000,
        "title": "Assessment 2016",
        "evaluator": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "Manager",
          "job": "Director",
          "profileImage": {
            "code": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oyxzvdxpxhsljtvsvzbc_png/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "evaluee": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "oospovnrixlhxmcicdag_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oospovnrixlhxmcicdag_png/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Argentina"
        },
        "type": "EVALUATION",
        "score": {
          "message": "Achieved",
          "value": 2,
          "manualScore": false
        },
        "comment": "Nice job.",
        "period": {
          "id": 6,
          "startTime": 1514764800000,
          "endTime": 1546214400000,
          "title": "2016 Year",
          "message": "2016 Period : 1/1/2016 - 31/12/2016",
          "subPeriods": [
          ]
        },
        "status": "SUBMITTED"
      },
      {
        "id": 80,
        "creationTime": 1527703146000,
        "updateTime": 1527703146000,
        "submissionTime": 1527703146000,
        "dateTimeFrom": 1514765000,
        "dateTimeTo": 1546301000,
        "title": "Assessment 2017",
        "evaluator": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "Manager",
          "job": "Director",
          "profileImage": {
            "code": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oyxzvdxpxhsljtvsvzbc_png/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "evaluee": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "oospovnrixlhxmcicdag_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oospovnrixlhxmcicdag_png/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Argentina"
        },
        "type": "EVALUATION",
        "score": {
          "message": "Achieved",
          "value": 3,
          "manualScore": false
        },
        "comment": "Very good worker.",
        "period": {
          "id": 7,
          "startTime": 1514764800000,
          "endTime": 1546214400000,
          "title": "2017 Year",
          "message": "2017 Period : 1/1/2017 - 31/12/2017",
          "subPeriods": [
          ]
        },
        "status": "SUBMITTED"
      },
      {
        "id": 91,
        "creationTime": 1527703160000,
        "updateTime": 1527703160000,
        "submissionTime": 1527703160000,
        "dateTimeFrom": 1514765000,
        "dateTimeTo": 1546301000,
        "title": "Assessment 2018",
        "evaluator": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "Manager",
          "job": "Director",
          "profileImage": {
            "code": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oyxzvdxpxhsljtvsvzbc_png/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "evaluee": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "oospovnrixlhxmcicdag_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oospovnrixlhxmcicdag_png/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Argentina"
        },
        "type": "EVALUATION",
        "score": {
          "message": "Exceeded Expectations",
          "value": 4,
          "manualScore": false
        },
        "comment": "Well done.",
        "period": {
          "id": 8,
          "startTime": 1514764800000,
          "endTime": 1546214400000,
          "title": "2018 Year",
          "message": "2018 Period : 1/1/2018 - 31/12/2018",
          "subPeriods": [
          ]
        },
        "status": "SUBMITTED"
      },
      {
        "id": 102,
        "creationTime": 1527703170000,
        "updateTime": 1527703170000,
        "submissionTime": 1527703170000,
        "dateTimeFrom": 1514765000,
        "dateTimeTo": 1546301000,
        "title": "Assessment 2019",
        "evaluator": {
          "id": 135,
          "identification": "jane.doe@qastarmeup.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "project": "Manager",
          "job": "Director",
          "profileImage": {
            "code": "oyxzvdxpxhsljtvsvzbc_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oyxzvdxpxhsljtvsvzbc_png/80/80/1"
          },
          "enabled": true,
          "area": "Product Management",
          "account": "Globant",
          "office": "Colombia"
        },
        "evaluee": {
          "id": 246,
          "identification": "john.doe@qastarmeup.com",
          "firstName": "John",
          "lastName": "Doe",
          "project": "StarMeUp OS",
          "job": "Developer",
          "profileImage": {
            "code": "oospovnrixlhxmcicdag_png",
            "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image",
            "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/oospovnrixlhxmcicdag_png/80/80/1"
          },
          "enabled": true,
          "area": "Development",
          "account": "Globant",
          "office": "Argentina"
        },
        "type": "EVALUATION",
        "score": {
          "message": "Not Achieved",
          "value": 5,
          "manualScore": false
        },
        "comment": "Nice job.",
        "period": {
          "id": 9,
          "startTime": 1514764800000,
          "endTime": 1546214400000,
          "title": "2019 Year",
          "message": "2019 Period : 1/1/2019 - 31/12/2019",
          "subPeriods": [
          ]
        },
        "status": "SUBMITTED"
      }
    ],
    "page": {
      "number": 0,
      "size": 10,
      "totalElements": 784,
      "totalPages": 79,
      "numberOfElements": 10
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The user wasn’t found",
    "type": "uri=/betterme/public-api/v1/evaluations",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Leaders

Find Leaders

Returns all Leaders for the given User’s Identification.

Resource URL

GET /betterme/public-api/v1/users/{identification}/leaders

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The expected language of the response. If this is not present or is invalid then the response will be returned using the user’s language or the Community’s language default language.

Path Parameters

Parameter Optional/Required Description

identification

Required

The user’s identification who is wanted to get its Leaders.

URL Parameters

Parameter Optional/Required Description

pageNumber

Optional

Page to find the records. It starts at 1. Default 1.

pageSize

Optional

The amount of records wanted to be returned in the page. Default 10.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": [
      {
        "identification": "john.doe@qastarmeup.com",
        "firstName": "John",
        "lastName": "Doe",
        "project": "StarMeUp OS",
        "job": "Developer",
        "profileImage": {
          "code": "tdstjgeoqowriusiqhow_jpg",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
        },
        "account": "Globant",
        "office": "United States of America",
        "seniority": "SSr",
        "asMain": false,
        "asSecondary": true
      },
      {
        "identification": "jane.doe@qastarmeup.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "project": "StarMeUp OS",
        "job": "Director",
        "profileImage": {
          "code": "tdstjgeoqowriusiqhow_jpg",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
        },
        "account": "Globant",
        "office": "Colombia",
        "seniority": "SSr Adv",
        "asMain": true,
        "asSecondary": true
      }
    ],
    "page": {
      "totalElements": 2
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The Leaders were not found",
    "type": "uri=/betterme/public-api/v1/leaders/",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Find Collaborators

Returns all Collaborators for the given User’s Identification.

Resource URL

GET /betterme/public-api/v1/users/{identification}/collaborators

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Path Parameters

Parameter Optional/Required Description

identification

Required

The user’s identification who is wanted to get its Leaders.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": [
      {
        "identification": "john.doe@qastarmeup.com",
        "firstName": "John",
        "lastName": "Doe",
        "project": "StarMeUp OS",
        "job": "Developer",
        "profileImage": {
          "code": "tdstjgeoqowriusiqhow_jpg",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
        },
        "account": "Globant",
        "office": "United States of America",
        "seniority": "Jr",
        "asMain": true,
        "asSecondary": false
      },
      {
        "identification": "jane.doe@qastarmeup.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "project": "StarMeUp OS",
        "job": "Director",
        "profileImage": {
          "code": "tdstjgeoqowriusiqhow_jpg",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
        },
        "account": "Globant",
        "office": "Colombia",
        "seniority": "Sr",
        "asMain": true,
        "asSecondary": true
      }
    ]
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The Leaders were not found",
    "type": "uri=/betterme/public-api/v1/leaders/",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Skills

Find Skill by Name

Returns a specific Skill given the name and the Language used for writing the name.

Resource URL

GET: /betterme/public-api/v1/skills/{name}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The language used for writing the Skill information.

Path Parameters

Parameter Optional/Required Description

name

Required

Text that represents the name of the Skill.

Response

HTTP/1.1 200 OK

Example: 

  {
    "isHard": true,
    "referenceNumber": 123456,
    "internationalizationValues": [
      {
        "name": "Developer",
        "description": "Software Developer.",
        "locale": "en"
      }
    ]
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The user wasn’t found",
    "type": "uri=/betterme/public-api/v1/skills/developer",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Find Skills by Filters

Returns a list of Skills that fits the filters criteria.

  • The Page of the records list is given by the "pageNumber" parameter.

  • The Size of the Page is given by the "pageSize" parameter.

  • If you want to sort the records in a specific way, the value "sort" must be defined. It makes reference to the field name in the Database.

Resource URL

GET: /betterme/public-api/v1/skills

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The language used for writing the Skill information.

URL Parameters

Parameter Optional/Required Description

name

Optional

Text that represents the name of the Skill.

description

Optional

Text that represents the description of the Skill.

isHard

Optional

Boolean value that indicates if the query is for Soft or Hard Skills.

referenceNumber

Optional

Number that represents the identificator value of the source for the Skill.

pageNumber

Optional

Page to find the records. It starts at 0. Default 0.

pageSize

Optional

The amount of records wanted to be returned in the page.

sort

Optional

Field name used for sorting the records in a DESC way.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": [
      {
        "name": "Java",
        "description": "Java Software Developer.",
        "isHard": true,
        "locale": "en",
        "referenceNumber": 123456
      },
      {
        "name": ".NET",
        "description": ".NET Software Developer.",
        "isHard": true,
        "locale": "en",
        "referenceNumber": 654321
      }
    ],
    "page": {
      "totalElements": 2,
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The user wasn’t found",
    "type": "uri=/betterme/public-api/v1/skills?",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Create Skill

Create a Skill based on the information sent in the body request and its internationalization values.

Resource URL

POST /betterme/public-api/v1/skills

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Body Parameters

Parameter Optional/Required Description

isHard

Required

Boolean value that indicates if the Skill is related to a Soft or Hard Skill

referenceNumber

Optional

Number that represents the identificator value of the source for the Skill.

internationalizationValues

Required

Array that contains the information of the Skill for all Langague internationalizations.

name

Required

Text that represents the name of the Skill.

description

Required

Text that represents the description of the Skill.

locale

Required

Number code used for creating the internationalization for the Skill.

Request

Example: 

  {
    "isHard": true,
    "referenceNumber": 123456,
    "internationalizationValues": [
      {
        "name": "Java",
        "description": "Java Software Developer.",
        "locale": "en"
      },
      {
        "name": "Java",
        "description": "Desarrollador de Software Java.",
        "locale": "es"
      }
    ]
  }

Response

HTTP/1.1 201 Created

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "It was not able to create the Skill.",
    "type": "uri=/betterme/public-api/v1/feedback/requests",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Update Skill

Update a Skill based on the information sent in the body request and its internationalization values.

Resource URL

PUT /betterme/public-api/v1/skills/{name}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The language used for finding the Skill information.

Path Parameters

Parameter Optional/Required Description

name

Required

Text that represents the name of the Skill to be updated.

Body Parameters

Parameter Optional/Required Description

isHard

Required

Boolean value that indicates if the Skill is related to a Soft or Hard Skill.

referenceNumber

Optional

Number that represents the identificator value of the source for the Skill.

internationalizationValues

Required

Array that contains the information of the Skill for all Langague internationalizations.

name

Required

Text that represents the new or updated name of the Skill.

description

Required

Text that represents the new or updated description of the Skill.

locale

Required

Language code used for creating the internationalization for the Skill.

Request

Example: 

  {
    "isHard": true,
    "referenceNumber": 123456,
    "internationalizationValues": [
      {
        "name": "Java",
        "description": "Java Software Developer.",
        "locale": "en"
      },
      {
        "name": "Java",
        "description": "Desarrollador de Software Java.",
        "locale": "es"
      }
    ]
  }

Response

HTTP/1.1 200 OK

Example: 

  {
    "isHard": true,
    "referenceNumber": 123456,
    "internationalizationValues": [
      {
        "name": "Java",
        "description": "Java Software Developer.",
        "locale": "en"
      },
      {
        "name": "Java",
        "description": "Desarrollador de Software Java.",
        "locale": "en"
      }
    ]
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "It was not able to update the Skill.",
    "type": "uri=/betterme/public-api/v1/skills/developer",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Delete Skill

Deletes a specific Skill given the name and the Language used for writing the name.

Resource URL

DELETE: /betterme/public-api/v1/skills/{name}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The language used for writing the Skill information.

Path Parameters

Parameter Optional/Required Description

name

Required

Text that represents the name of the Skill.

Response

HTTP/1.1 204 No Content

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The user wasn’t found",
    "type": "uri=/betterme/public-api/v1/skills/developer",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Periods

Find Period by Name

Returns a specific Period given the Period’s name.

Resource URL

GET: /betterme/public-api/v1/periods/{name}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Path Parameters

Parameter Optional/Required Description

name

Required

String value that represents the Period’s name.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": {
      "name": "2020",
      "description": "The 2020 year.",
      "startDate": "2020-01-01",
      "endDate": "2018-12-31",
      "subPeriods": [
        {
          "name": "2020Q1",
          "startDate": "2020-01-01",
          "endDate": "2020-06-30"
        },
        {
          "name": "2020Q2",
          "startDate": "2020-07-01",
          "endDate": "2020-12-31"
        }
      ]
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The Period does not exist.",
    "type": "uri=/betterme/public-api/v1/periods/2020",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Create Period

Create a Period based on the information sent in the body request.

Resource URL

POST /betterme/public-api/v1/periods

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Body Parameters

Parameter Optional/Required Description

name

Required

String value that represents the Name of the Period.

description

Optional

Text that represents the description of the Period.

startDate

Required

Date value that represents when the Period stars.

endTDate

Required

Date value that represents the Period ends. It must be after startDate.

Request

Example: 

  {
    "name": "2020",
    "description": "The 2020 year.",
    "startTime": "2020-01-01",
    "endTime": "2020-12-31"
  }

Response

HTTP/1.1 201 Created

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "It was not able to create the Period.",
    "type": "uri=/betterme/public-api/v1/periods",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Update Period

Update a Period based on the information sent in the body request and using the given name.

Resource URL

PUT /betterme/public-api/v1/periods/{name}

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Path Parameters

Parameter Optional/Required Description

name

Required

String value that represents the Period’s name.

Body Parameters

Parameter Optional/Required Description

name

Required

String value that represents the new name for the Period.

description

Optional

Text that represents the new description for the Period.

startDate

Required

Date value that represents the new time when the Period stars.

endDate

Required

Date value that represents the new time when the Period ends. It must be after startDate.

Request

Example: 

  {
    "name": "2020",
    "description": "The 2020 year.",
    "startTime": "2020-01-01",
    "endTime": "2020-12-31"
  }

Response

HTTP/1.1 200 OK

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "Updating Period had an unexpected error.",
    "type": "uri=/betterme/public-api/v1/periods/2020",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Scales

Find Scales by Filters

Returns a list of Scales associated with the Community.

  • The Page of the records list is given by the "pageNumber" parameter.

  • The Size of the Page is given by the "pageSize" parameter.

Resource URL

GET: /betterme/public-api/v1/scales

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Accept-Language

Required

The expected language of the response and used for searching the Scales. If this is not present or is invalid then the response will be returned using the user’s language or the Community’s language or the Scale’s default language.

URL Parameters

Parameter Optional/Required Description

pageNumber

Optional

Page to find the records. It starts at 0. Default 0.

pageSize

Optional

The amount of records wanted to be returned in the page.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": [
      {
        "name": "Not Achieved",
        "description": "When the Goal was not achieved successfully.",
        "min": 1,
        "max": 10
      },
      {
        "name": "Achieved",
        "description": "When the Goal was achieved successfully.",
        "min": 1,
        "max": 20
      }
    ],
    "page": {
      "totalElements": 2,
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "There was an unexpected error.",
    "type": "uri=/betterme/public-api/v1/scales",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Back to index