Pragmatic MDR API documentation version v1
Welcome to the pragmatic metadata repository based on medical data models contained in the portal of medical-data-models.org. You can access entities of these models via the REST API documented below. It was automatically generated with the tool: raml2html.
https://medical-data-models.org/MDR/api/{version}
- version: required (v1)
/protocols
get /protocols
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of ProtocolType)
Items: ProtocolType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- studyevents: required(array of StudyEventRefType)
Items: StudyEventRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- type: required(one of Scheduled, Unscheduled, Common)
- category: required(string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- forms: required(array of FormRefType)
Items: FormRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /protocols
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of ProtocolType)
Items: ProtocolType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- studyevents: required(array of StudyEventRefType)
Items: StudyEventRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- type: required(one of Scheduled, Unscheduled, Common)
- category: required(string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- forms: required(array of FormRefType)
Items: FormRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /protocols/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- studyevents: required(array of StudyEventRefType)
Items: StudyEventRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- type: required(one of Scheduled, Unscheduled, Common)
- category: required(string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- forms: required(array of FormRefType)
Items: FormRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /protocols/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- studyevents: required(array of StudyEventRefType)
Items: StudyEventRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- type: required(one of Scheduled, Unscheduled, Common)
- category: required(string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- forms: required(array of FormRefType)
Items: FormRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /protocols/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /protocols/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
/studyevents
get /studyevents
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of StudyEventType)
Items: StudyEventType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- type: required(one of Scheduled, Unscheduled, Common)
- category: required(string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- forms: required(array of FormRefType)
Items: FormRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /studyevents
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of StudyEventType)
Items: StudyEventType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- type: required(one of Scheduled, Unscheduled, Common)
- category: required(string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- forms: required(array of FormRefType)
Items: FormRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /studyevents/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- type: required(one of Scheduled, Unscheduled, Common)
- category: required(string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- forms: required(array of FormRefType)
Items: FormRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /studyevents/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- type: required(one of Scheduled, Unscheduled, Common)
- category: required(string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- forms: required(array of FormRefType)
Items: FormRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /studyevents/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /studyevents/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
/forms
get /forms
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of FormType)
Items: FormType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /forms
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of FormType)
Items: FormType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /forms/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /forms/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- itemgroups: required(array of ItemGroupRefType)
Items: ItemGroupRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- mandatory: required(one of Yes, No)
- resource: required(object)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /forms/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /forms/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
/itemgroups
get /itemgroups
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of ItemGroupType)
Items: ItemGroupType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /itemgroups
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of ItemGroupType)
Items: ItemGroupType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /itemgroups/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /itemgroups/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- repeating: required(one of Yes, No)
- isreferencedata: (one of Yes, No)
- sasdatasetname: (string)
- domain: (string)
- origin: (string)
- purpose: (string)
- comment: (string)
- description: (object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- items: required(array of ItemRefType)
Items: ItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- mandatory: required(one of Yes, No)
- keysequence: required(integer)
- role: required(string)
- resource: required(object)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /itemgroups/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /itemgroups/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
/items
get /items
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of ItemType)
Items: ItemType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /items
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of ItemType)
Items: ItemType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /items/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /items/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /items/codes
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: CodingType
- identifier: required(string)
- occurrences: required(integer)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- coding: required(array of UMLSCodingType)
Items: UMLSCodingType
- umls: required(string)
- meaning: required(string)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /items/codes
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: CodingType
- identifier: required(string)
- occurrences: required(integer)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- coding: required(array of UMLSCodingType)
Items: UMLSCodingType
- umls: required(string)
- meaning: required(string)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /items/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /items/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /items/related
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- numItems: (integer)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of FrequencyItemType)
Items: FrequencyItemType
- count: required(integer)
- item: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /items/related
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- numItems: (integer)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of FrequencyItemType)
Items: FrequencyItemType
- count: required(integer)
- item: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /items/related/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of FrequencyItemType)
Items: FrequencyItemType
- count: required(integer)
- item: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /items/related/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of FrequencyItemType)
Items: FrequencyItemType
- count: required(integer)
- item: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of text, integer, float, date, time, datetime, string, boolean, double, hexBinary, base64Binary, hexFloat, base64Float, partialDate, partialTime, partialDatetime, durationDatetime, intervalDatetime, incompleteDatetime, incompleteDate, incompleteTime, URI)
- length: (integer)
- significantdigits: (integer)
- sasfieldname: (string)
- sdsvarname: (string)
- origin: (string)
- comment: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- question: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelists: required(object)
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- resource: required(object)
- measurementunits: required(array of MeasurementUnitRefType)
Items: MeasurementUnitRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- rangechecks: required(array of RangeCheckType)
Items: RangeCheckType
- comparator: (string)
- softhard: required(one of Soft, Hard)
- checkvalue: (string)
- formalexpression: (string)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
/measurementunits
get /measurementunits
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of MeasurementUnitType)
Items: MeasurementUnitType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /measurementunits
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of MeasurementUnitType)
Items: MeasurementUnitType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /measurementunits/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /measurementunits/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- symbol: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /measurementunits/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /measurementunits/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
/codelists
get /codelists
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of CodeListType)
Items: CodeListType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /codelists
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of CodeListType)
Items: CodeListType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /codelists/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /codelists/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- name: required(string)
- datatype: required(one of integer, float, text, string)
- sasformatname: (string)
- description: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- codelistitems: required(array of CodeListItemRefType)
Items: CodeListItemRefType
- resource: required(object)
- url: required(string)
- definition: required(object)
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- resource: required(object)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /codelists/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /codelists/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
/codelistitems
get /codelistitems
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of CodeListItemType)
Items: CodeListItemType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /codelistitems
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of CodeListItemType)
Items: CodeListItemType
- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
- entity: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /codelistitems/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /codelistitems/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- entity: required(object)
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- codedvalue: required(string)
- rank: required(number)
- decode: required(object)
- texts: required(array of TranslatedTextType)
Items: TranslatedTextType
- languagetag: required(string)
- text: required(string)
- texts: required(array of TranslatedTextType)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /codelistitems/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /codelistitems/count
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- count: required(integer)
- unique: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
/entities
get /entities
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of EntityType)
Items: EntityType
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /entities
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of EntityType)
Items: EntityType
- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- resource: required(object)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /entities/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /entities/{id}
Authentication by API key
URI Parameters
- id: required(string)
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- resource: required(object)
- url: required(string)
- metadata: required(object)
- url: required(string)
- aliases: required(array of AliasType)
Items: AliasType
- context: required(string)
- name: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
/concepts
get /concepts
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of ConceptType)
Items: ConceptType
- value: required(string)
- concepts: required(array of UMLSConceptType)
Items: UMLSConceptType
- concept: required(string)
- def: required(string)
- string: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /concepts
Authentication by API key
Query Parameters
- apiKey: (string)
- query: (string)
- sort: (string)
- page: (string)
- size: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- content: required(array of ConceptType)
Items: ConceptType
- value: required(string)
- concepts: required(array of UMLSConceptType)
Items: UMLSConceptType
- concept: required(string)
- def: required(string)
- string: required(string)
- occurrences: required(array of OccurrenceType)
Items: OccurrenceType
- url: required(string)
- oid: (string)
- totalPages: required(integer)
- last: required(boolean)
- totalElements: required(integer)
- first: required(boolean)
- numberOfElements: required(integer)
- sort: required(string)
- size: required(integer)
- number: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
/statistics
get /statistics
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocols: required(integer)
- uniqueProtocols: required(integer)
- studyevents: required(integer)
- uniqueStudyevents: required(integer)
- forms: required(integer)
- uniqueForms: required(integer)
- itemgroups: required(integer)
- uniqueItemgroups: required(integer)
- items: required(integer)
- uniqueItems: required(integer)
- measurementunits: required(integer)
- uniqueMeasurementunits: required(integer)
- codelists: required(integer)
- uniqueCodelists: required(integer)
- codelistitems: required(integer)
- uniqueCodelistitems: required(integer)
- entities: required(integer)
- concepts: required(integer)
- uniqueAnnotatedTexts: required(integer)
- texts: required(integer)
- languages: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /statistics
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- protocols: required(integer)
- uniqueProtocols: required(integer)
- studyevents: required(integer)
- uniqueStudyevents: required(integer)
- forms: required(integer)
- uniqueForms: required(integer)
- itemgroups: required(integer)
- uniqueItemgroups: required(integer)
- items: required(integer)
- uniqueItems: required(integer)
- measurementunits: required(integer)
- uniqueMeasurementunits: required(integer)
- codelists: required(integer)
- uniqueCodelists: required(integer)
- codelistitems: required(integer)
- uniqueCodelistitems: required(integer)
- entities: required(integer)
- concepts: required(integer)
- uniqueAnnotatedTexts: required(integer)
- texts: required(integer)
- languages: required(integer)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
get /statistics/occurrences
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: OccurrenceType
- url: required(string)
- oid: (string)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
post /statistics/occurrences
Authentication by API key
Query Parameters
- apiKey: (string)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: OccurrenceType
- url: required(string)
- oid: (string)
HTTP status code 401
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 404
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)
HTTP status code 500
Body
Media type: application/json
Type: object
Properties- timestamp: required(integer)
- status: required(integer)
- error: required(string)
- message: (string)
- path: required(string)