Purpose

Get all observation purposes

get

Retrieves all observation purposes with their labels

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters
organizationIdnumberOptional
resourcesobjectOptional
Responses
200Success
application/json
get
/api/observations/purpose
200Success

Create observation purpose

post

Creates a new observation purpose with labels

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body
namestringRequired

Name of the observation purpose

Example: Height Percentile
resourcesobjectOptional

Resource criteria for the purpose

Example: {"gender":"MALE","ageGroup":"ADULT"}
organizationIdnumberOptional

Organization ID

Example: 1
labelsstring[]Optional

Array of label names

Example: ["P3","P10","P25","P50","P75","P90","P97"]
Responses
200Success
application/json
post
/api/observations/purpose
200Success

Get observation purpose by ID

get

Retrieves a specific observation purpose with its labels

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Responses
200Success
application/json
get
/api/observations/purpose/{id}
200Success

Update observation purpose

put

Updates an existing observation purpose and its labels

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Body
namestringOptional

Updated name of the observation purpose

Example: Updated Height Percentile
resourcesanyOptional

Updated resource criteria

Example: {"gender":"FEMALE","ageGroup":["ADULT","ELDERLY"]}
organizationIdnumberOptional

Organization ID

Example: 1
labelsstring[]Optional

Updated array of label names

Example: ["P3","P5","P10","P25","P50","P75","P90","P95","P97"]
Responses
200Success
application/json
put
/api/observations/purpose/{id}
200Success