CHcharthop
assessment

Complete a assessment

post/v1/org/{orgId}/assessment/{assessmentId}/complete

Request

Path parameters

orgIdstring required

Org identifier (either id or slug)

assessmentIdstring required

Assessment id

Response

successful operation

idstring required

globally unique id

orgIdstring required

parent organization id

labelstring required

human-readable label of assessment

slugstring required

unique slug of assessment

type'REVIEW' | 'COMP_REVIEW' | 'SURVEY' required

type of assessment

fieldsobject

assessment fields (description)

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE'

view sensitivity of this assessment

colorstring

color of assessment

startDatestring date

Date this assessment begins. In the context of REVIEW goals, the date the review cycle begins.

endDatestring date

Date this assessment ends, or is completed. In the context of REVIEW assessment, the date the review cycle ends.

status'DRAFT' | 'ACTIVE' | 'DONE'

status of this assessment - DRAFT, ACTIVE, DONE

doneAtstring

timestamp when the status of this assessment was set to done

taskCountinteger

number of tasks associated with this assessment

taskDoneCountinteger

number of tasks associated with this assessment that are done

peopleIncludedCountinteger

number of people included in this assessment

querystring

Query for which people/jobs can be included in the review.

showDatesInCalendarboolean

True if user wants dates to show on company calendar

calibrationHighlightedQuestionIdsstring[]

Form questions to highlight during calibration. Only applies to REVIEW assessments.

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "label": "Engineering Budget Q2 2019",
  "slug": "engineering-budget-q2-2019",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "doneAt": "2017-01-24T13:57:52Z",
  "calibrationHighlightedQuestionIds": [
    "588f7ee98f138b19220041a7"
  ],
  "calibrationNBoxes": [
    {
      "horizontalFieldId": "588f7ee98f138b19220041a7",
      "verticalFieldId": "588f7ee98f138b19220041a7"
    }
  ],
  "peerReviewerCap": {
    "fieldId": "588f7ee98f138b19220041a7"
  },
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}

Changes

No recorded changes to this operation across all 34 revisions of this API.