Assessment Formation

Read assessment schema definitions configured in Welkin Designer.

Assessment Formation endpoints return the schema definitions for assessments — their questions, field types, scoring rules, and associated CDTs. Use these endpoints to understand an assessment's structure before creating records via the Assessment Records endpoints.

Base path: /{tenantName}/{instanceName}/formation/assessments

---

Endpoints

GET Get All Assessments

GET /{tenantName}/{instanceName}/formation/assessments

Returns schema definitions for all assessments configured in the instance.

Query Parameters

Parameter	Type	Default	Description
page	integer	0	Page number
size	integer	20	Results per page

Example Request

GET /acme-health/live/formation/assessments
Authorization: Bearer <token>

Example Response 200 OK

{
  "data": [
    {
      "name": "phq9",
      "label": "PHQ-9 Depression Screening",
      "cdtName": "phq9-responses",
      "scoringEnabled": true,
      "questions": [...]
    }
  ],
  "metaInfo": { "page": 0, "pageSize": 20, "totalElements": 12 }
}

---

GET Get One Assessment

GET /{tenantName}/{instanceName}/formation/assessments/{assessmentName}

Returns the schema definition for a single assessment by name.

Path Parameters

Parameter	Type	Required	Description
assessmentName	string	Yes	Assessment name as defined in Designer

---

GET Get All CDTs Related to Assessment

GET /{tenantName}/{instanceName}/formation/assessments/{assessmentName}/cdts

Returns the list of Custom Data Types (CDTs) associated with a specific assessment. These CDTs store the assessment response data.

Path Parameters

Parameter	Type	Required	Description
assessmentName	string	Yes	Assessment name