NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 123

changes.mady.by.user Unknown User (endlecm)

Saved on

compared with

New Version 124

changes.mady.by.user Unknown User (endlecm)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Generally returned summary lists are returned as Directories and single elements are returned as messages such as "EntryMsg"

Info

The following examples show how to have the output formatted to JSON with the "format=json" parameter.  When the format is not specified, it will default to XML.

DescriptionRESTModel Element Class
Code System Versions<base url>codesystemversions?format=jsonCodeSystemVersionCatalogEntryDirectory
Code System Read
<base url>/codesystem/NCI_Thesaurus/version/17.06d
CodeSystemVersionCatalogEntryMsg
Code System Version Query<base url>/codesystemversions?matchvalue=nci_thesaurus&filtercomponent=resourceName&format=jsonCodeSystemVersionCatalogEntryDirectory
Value Sets<base url>resolvedvaluesets?format=jsonResolvedValueSetDirectory
Value Set Definition Read<base url>/cts2/valueset/CDISC ADaM Terminology/definition/5f51c37b?format=jsonValueSetDefinitionMsg
Value Set Query
<base url>/resolvedvaluesets?matchvalue=imputation&filtercomponent=resourceName&format=json
ResolvedValueSetDirectory
Value Set Entries<base url>/valueset/valueset/CDISC Questionnaire Terminology/definition/aa5e7b3f/resolution/1?format=json
IteratableResolvedValueSet
Entities
<base url>/codesystem/NCI_Thesaurus/version/17.06d/entities?format=json
EntityDirectory
Entity Read<base url>/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399?format=jsonEntityDescriptionMsg
Entity Query
<base url>/codesystem/NCI_Thesaurus/version/17.06d/entities?matchvalue=swelling&format=json
EntityDirectory
Association parents<base url>/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399?format=json

EntityDescriptionMsg
with an instance entity with method calls:

entity.getEntityDescription().getNamedEntity().getParent()

returning an instance of URIAndEntityName[]

Association children
<base url>/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/children?format=json
EntityDirectory
Association subjectOf
<base url>/codesystem/npo/version/TestForMultiNamespace/entity/GO:NPO_1607/subjectof?format=json
AssociationDirectory
Association targetOf
<base url>/codesystem/NCI_Thesaurus/version/17.06d/entity/C3399/targetof?format=json
AssociationDirectory
Maps
<base url>/mapversions?format=json
MapVersionDirectory
Map Version Query<base url>/mapversions?matchvalue=ncit&filtercomponent=resourceSynopsis&format=jsonMapVersionDirectory
Map Version Read
<base url>/map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0?format=json
MapVersionMsg
Map Entities
<base url>/map/MA_to_NCIt_Mapping/version/MA_to_NCIt_Mapping-1.0/entries?format=json
 MapEntryDirectory 
Map Restriction To, From, or Both Role
<base url>/mapversions?codesystem=ICD10CM&codesystemsmaprole=MAP_TO_ROLE&format=json
MapVersionDirectory

...