NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 1

changes.mady.by.user Frost, Ruth (NIH/NCI) [C]

Saved on

compared with

New Version Current

changes.mady.by.user Frost, Ruth (NIH/NCI) [C]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Enclosed contents of page in Lorenzo's custom macro instead of the standard numbered headings macro.

Include Page
caDSR API Examples Overview include
caDSR API Examples Overview include

This page includes the following topics. An administered component in the API is equivalent to an administered item in OneData. 

Custom nh
start-numbering-with4
start-numbering-ath2
Panel
titleContents of This Page

Table of Contents
maxLevel3

Retrieve All Administered Components Associated with ClassSchemeClassSchemeItem with Particular ID

HTML Comment
hiddentrue
Retrieve All ClassSchemeClassSchemeItem Associated with ClassificationSchemeItem and ClassificationScheme

The following example gets retrieves all Administered Components for ClassSchemeClassSchemeItem for ClassificationSchemeItem with longName starting with 2014r1 and ClassificationScheme with preferredName starting with NMDP.

Info
titleSpecifying an Association
The association can be specified either through using square brackets '[]' or by using the backslash '\' however, association within the square brackets cannot have further associations as attributes.
Legacy

with ID = A55C551C-1866-5ED1-E034-080020C9C0E0. This retrieves all ACs and sorts them according to type (Form, DE, DEC, and so on).

The URL for the results from the caDSR 4.1.x II REST API is

Code Block
https://cadsrapi.nci.nihcancer.gov/invoke/cadsrapi4caDSR/GetXML?query=ClassSchemeClassSchemeItemAdministeredComponent,AdministeredComponentClassSchemeItem&ClassSchemeClassSchemeItem[ClassificationScheme[@preferredName=NMDP*]]\ClassificationSchemeItem[@longName=2014r1*]
@id=A55C551C-1866-5ED1-E034-080020C9C0E0]

Retrieving Any Administered Component by Public ID

The following example retrieves any administered component by public ID.

Code Block
https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=AdministeredComponent[@publicId=62]