REST Web Service Resources in OpenMRS 1.8
This page is generated automatically and must not be edited manually. It describes the urls/resources published by the REST Module.
For more information on conventions, authentication, and setup, see the main REST Web Services API For Clients page.
When a parameter has a bang "!" in front of it, it means that url will only be called if that parameter does NOT exist.
Properties listed in bold must not be null.
ActiveListType
URLs
url |
description |
---|---|
GET /ws/rest/v1/activelisttype |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/activelisttype/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/activelisttype |
Create with properties in request |
POST /ws/rest/v1/activelisttype/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/activelisttype/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/activelisttype/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
Allergy
URLs
url |
description |
---|---|
GET /ws/rest/v1/allergy |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/allergy/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/allergy |
Create with properties in request |
POST /ws/rest/v1/allergy/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/allergy/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/allergy/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
person |
person |
Cohort
URLs
url |
description |
---|---|
GET /ws/rest/v1/cohort |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/cohort/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/cohort |
Create with properties in request |
POST /ws/rest/v1/cohort/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/cohort/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/cohort/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
CohortMember
URLs
url |
description |
---|---|
GET /ws/rest/v1/cohort/{parentUuid}/member/{uuid} |
Fetch by unique uuid |
GET /ws/rest/v1/cohort/{parentUuid}/member |
Fetch all non-retired |
POST /ws/rest/v1/cohort/{parentUuid}/member |
Create with properties in request |
POST /ws/rest/v1/cohort/{parentUuid}/member/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/cohort/{parentUuid}/member/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/cohort/{parentUuid}/member/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
display |
display |
display |
patient |
patient |
Concept
URLs
url |
description |
---|---|
GET /ws/rest/v1/concept |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/concept/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/concept |
Create with properties in request |
POST /ws/rest/v1/concept/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/concept/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/concept/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
names |
datatype |
ConceptClass
URLs
url |
description |
---|---|
GET /ws/rest/v1/conceptclass |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/conceptclass/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/conceptclass |
Create with properties in request |
POST /ws/rest/v1/conceptclass/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/conceptclass/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/conceptclass/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
ConceptDatatype
URLs
url |
description |
---|---|
GET /ws/rest/v1/conceptdatatype |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/conceptdatatype/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/conceptdatatype |
Create with properties in request |
POST /ws/rest/v1/conceptdatatype/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/conceptdatatype/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/conceptdatatype/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
ConceptDescription
URLs
url |
description |
---|---|
GET /ws/rest/v1/concept/{parentUuid}/description/{uuid} |
Fetch by unique uuid |
GET /ws/rest/v1/concept/{parentUuid}/description |
Fetch all non-retired |
POST /ws/rest/v1/concept/{parentUuid}/description |
Create with properties in request |
POST /ws/rest/v1/concept/{parentUuid}/description/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/concept/{parentUuid}/description/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/concept/{parentUuid}/description/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
display |
uuid |
description |
description |
ConceptMap
URLs
url |
description |
---|---|
GET /ws/rest/v1/concept/{parentUuid}/mapping/{uuid} |
Fetch by unique uuid |
GET /ws/rest/v1/concept/{parentUuid}/mapping |
Fetch all non-retired |
POST /ws/rest/v1/concept/{parentUuid}/mapping |
Create with properties in request |
POST /ws/rest/v1/concept/{parentUuid}/mapping/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/concept/{parentUuid}/mapping/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/concept/{parentUuid}/mapping/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
display |
display |
source |
source |
ConceptName
URLs
url |
description |
---|---|
GET /ws/rest/v1/concept/{parentUuid}/name/{uuid} |
Fetch by unique uuid |
GET /ws/rest/v1/concept/{parentUuid}/name |
Fetch all non-retired |
POST /ws/rest/v1/concept/{parentUuid}/name |
Create with properties in request |
POST /ws/rest/v1/concept/{parentUuid}/name/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/concept/{parentUuid}/name/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/concept/{parentUuid}/name/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
display |
display |
name |
name |
ConceptSource
URLs
url |
description |
---|---|
GET /ws/rest/v1/conceptsource |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/conceptsource/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/conceptsource |
Create with properties in request |
POST /ws/rest/v1/conceptsource/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/conceptsource/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/conceptsource/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
Drug
URLs
url |
description |
---|---|
GET /ws/rest/v1/drug |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/drug/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/drug |
Create with properties in request |
POST /ws/rest/v1/drug/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/drug/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/drug/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
display |
display |
name |
name |
Encounter
URLs
url |
description |
---|---|
GET /ws/rest/v1/encounter |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/encounter/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/encounter |
Create with properties in request |
POST /ws/rest/v1/encounter/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/encounter/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/encounter/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
encounterDatetime |
encounterDatetime |
EncounterType
URLs
url |
description |
---|---|
GET /ws/rest/v1/encountertype |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/encountertype/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/encountertype |
Create with properties in request |
POST /ws/rest/v1/encountertype/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/encountertype/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/encountertype/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
Field
URLs
url |
description |
---|---|
GET /ws/rest/v1/field |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/field/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/field |
Create with properties in request |
POST /ws/rest/v1/field/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/field/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/field/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
FieldAnswer
URLs
url |
description |
---|---|
GET /ws/rest/v1/field/{parentUuid}/answer/{uuid} |
Fetch by unique uuid |
GET /ws/rest/v1/field/{parentUuid}/answer |
Fetch all non-retired |
POST /ws/rest/v1/field/{parentUuid}/answer |
Create with properties in request |
POST /ws/rest/v1/field/{parentUuid}/answer/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/field/{parentUuid}/answer/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/field/{parentUuid}/answer/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
field |
field |
FieldType
URLs
url |
description |
---|---|
GET /ws/rest/v1/fieldtype |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/fieldtype/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/fieldtype |
Create with properties in request |
POST /ws/rest/v1/fieldtype/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/fieldtype/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/fieldtype/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
Form
URLs
url |
description |
---|---|
GET /ws/rest/v1/form |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/form/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/form |
Create with properties in request |
POST /ws/rest/v1/form/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/form/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/form/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
FormField
URLs
url |
description |
---|---|
GET /ws/rest/v1/form/{parentUuid}/formfield/{uuid} |
Fetch by unique uuid |
GET /ws/rest/v1/form/{parentUuid}/formfield |
Fetch all non-retired |
POST /ws/rest/v1/form/{parentUuid}/formfield |
Create with properties in request |
POST /ws/rest/v1/form/{parentUuid}/formfield/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/form/{parentUuid}/formfield/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/form/{parentUuid}/formfield/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
form |
form |
HL7
URLs
url |
description |
---|---|
GET /ws/rest/v1/hl7 |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/hl7/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/hl7 |
Create with properties in request |
POST /ws/rest/v1/hl7/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/hl7/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/hl7/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
hl7 |
hl7 |
HL7Source
URLs
url |
description |
---|---|
GET /ws/rest/v1/hl7source |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/hl7source/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/hl7source |
Create with properties in request |
POST /ws/rest/v1/hl7source/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/hl7source/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/hl7source/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
Location
URLs
url |
description |
---|---|
GET /ws/rest/v1/location |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/location/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/location |
Create with properties in request |
POST /ws/rest/v1/location/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/location/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/location/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
LocationTag
URLs
url |
description |
---|---|
GET /ws/rest/v1/locationtag |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/locationtag/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/locationtag |
Create with properties in request |
POST /ws/rest/v1/locationtag/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/locationtag/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/locationtag/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
Obs
URLs
url |
description |
---|---|
GET /ws/rest/v1/obs |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/obs/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/obs |
Create with properties in request |
POST /ws/rest/v1/obs/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/obs/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/obs/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
person |
person |
Order
URLs
url |
description |
---|---|
GET /ws/rest/v1/order |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/order/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/order |
Create with properties in request |
POST /ws/rest/v1/order/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/order/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/order/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
orderType |
orderType |
DrugOrder subclass of Order
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
patient |
patient |
OrderType
URLs
url |
description |
---|---|
GET /ws/rest/v1/ordertype |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/ordertype/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/ordertype |
Create with properties in request |
POST /ws/rest/v1/ordertype/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/ordertype/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/ordertype/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
Patient
URLs
url |
description |
---|---|
GET /ws/rest/v1/patient |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/patient/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/patient |
Create with properties in request |
POST /ws/rest/v1/patient/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/patient/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/patient/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
person |
null |
PatientIdentifier
URLs
url |
description |
---|---|
GET /ws/rest/v1/patient/{parentUuid}/identifier/{uuid} |
Fetch by unique uuid |
GET /ws/rest/v1/patient/{parentUuid}/identifier |
Fetch all non-retired |
POST /ws/rest/v1/patient/{parentUuid}/identifier |
Create with properties in request |
POST /ws/rest/v1/patient/{parentUuid}/identifier/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/patient/{parentUuid}/identifier/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/patient/{parentUuid}/identifier/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
display |
display |
identifier |
identifier |
PatientIdentifierType
URLs
url |
description |
---|---|
GET /ws/rest/v1/patientidentifiertype |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/patientidentifiertype/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/patientidentifiertype |
Create with properties in request |
POST /ws/rest/v1/patientidentifiertype/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/patientidentifiertype/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/patientidentifiertype/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
Person
URLs
url |
description |
---|---|
GET /ws/rest/v1/person |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/person/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/person |
Create with properties in request |
POST /ws/rest/v1/person/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/person/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/person/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
names |
gender |
PersonAddress
URLs
url |
description |
---|---|
GET /ws/rest/v1/person/{parentUuid}/address/{uuid} |
Fetch by unique uuid |
GET /ws/rest/v1/person/{parentUuid}/address |
Fetch all non-retired |
POST /ws/rest/v1/person/{parentUuid}/address |
Create with properties in request |
POST /ws/rest/v1/person/{parentUuid}/address/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/person/{parentUuid}/address/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/person/{parentUuid}/address/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
display |
display |
preferred |
preferred |
PersonAttribute
URLs
url |
description |
---|---|
GET /ws/rest/v1/person/{parentUuid}/attribute/{uuid} |
Fetch by unique uuid |
GET /ws/rest/v1/person/{parentUuid}/attribute |
Fetch all non-retired |
POST /ws/rest/v1/person/{parentUuid}/attribute |
Create with properties in request |
POST /ws/rest/v1/person/{parentUuid}/attribute/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/person/{parentUuid}/attribute/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/person/{parentUuid}/attribute/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
display |
display |
value |
value |
PersonAttributeType
URLs
url |
description |
---|---|
GET /ws/rest/v1/personattributetype |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/personattributetype/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/personattributetype |
Create with properties in request |
POST /ws/rest/v1/personattributetype/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/personattributetype/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/personattributetype/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
name |
PersonName
URLs
url |
description |
---|---|
GET /ws/rest/v1/person/{parentUuid}/name/{uuid} |
Fetch by unique uuid |
GET /ws/rest/v1/person/{parentUuid}/name |
Fetch all non-retired |
POST /ws/rest/v1/person/{parentUuid}/name |
Create with properties in request |
POST /ws/rest/v1/person/{parentUuid}/name/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/person/{parentUuid}/name/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/person/{parentUuid}/name/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
display |
display |
givenName |
givenName |
Privilege
URLs
url |
description |
---|---|
GET /ws/rest/v1/privilege |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/privilege/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/privilege |
Create with properties in request |
POST /ws/rest/v1/privilege/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/privilege/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/privilege/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
description |
Problem
URLs
url |
description |
---|---|
GET /ws/rest/v1/problem |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/problem/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/problem |
Create with properties in request |
POST /ws/rest/v1/problem/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/problem/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/problem/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
person |
person |
Role
URLs
url |
description |
---|---|
GET /ws/rest/v1/role |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/role/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/role |
Create with properties in request |
POST /ws/rest/v1/role/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/role/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/role/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
name |
description |
User
URLs
url |
description |
---|---|
GET /ws/rest/v1/user |
Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/user/{uuid} |
Fetch by unique uuid |
POST /ws/rest/v1/user |
Create with properties in request |
POST /ws/rest/v1/user/{uuid} |
Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/user/{uuid}?!purge |
Retire/Void this object |
DELETE /ws/rest/v1/user/{uuid}?purge |
Delete this object from the database |
Representations
GET ref |
GET default |
GET full |
POST create |
POST update |
---|---|---|---|---|
uuid |
uuid |
uuid |
username |
username |