Symbolic Purposes

This resource allows you to retrieve and manipulate symbolic purposes.

Symbolic purpose is a label with a predefined type that can be associated with a job, reviewer list, request subtype, or a rule in order to apply additional filtering logic. Symbolic purposes replace reviewer purposes.

Operations

---

Create Symbolic Purpose
POST /v1/commons/symbolic_purposes

---

Delete Symbolic Purpose by ID
DELETE /v1/commons/symbolic_purposes/{id}

---

Retrieve All Symbolic Purposes or by Name
GET /v1/commons/symbolic_purposes

---

Retrieve Symbolic Purpose by ID
GET /v1/commons/symbolic_purposes/{id}

---

Update Symbolic Purpose by ID
PUT /v1/commons/symbolic_purposes/{id}