VT Scientific Discipline Classification API

From EGIWiki
Jump to: navigation, search
EGI Activity groups Special Interest groups Policy groups Virtual teams Distributed Competence Centres


EGI Virtual teams: Main Active Projects Closed Projects Guidelines
VT Scientific Discipline Classification: Home Scientific Disciplines Change Management Query API Tasks/Actions/Plans Meetings

The table below provides the details for extracting the last classification.

Resource: GET classification/versions/?format= Returns a list of high-level metadata for each existing scientific classification version
Parameter(s):
Query Parameter Type Optional Description
format ENUM ('xml', 'json')
Default: 'xml'
Yes Response's format
Example request: GET https://appdb-pi.egi.eu/rest/1.0/classification/versions
Example response (in pseudo-XML format):
<appdb:appdb> 
<classification:version id="1" version="1.1" createdon="..." publishedon="..." archivedon="..." state="archived"/>
<classification:version id="2" version="1.2" createdon="..." publishedon="..." archivedon="..." state="archived"/>
<classification:version id="3" version="1.3" createdon="..." publishedon="..." archivedon="..." state="archived"/>
<classification:version id="4" version="2.0" createdon="..." publishedon="..." archivedon="..." state="archived"/>
<classification:version id="5" version="2.1" createdon="..." publishedon="..." archivedon="..." state="stable"/>
<classification:version id="6" version="2.2" createdon="..." publishedon="..." archivedon="..." state="under-devel"/>
.................................
</appdb:appdb> 
Response details:
Element Attribute Type Description
classification:version id
Integer
A unique version id.
version String The version tag.
createdon Datetime Version creation date-time.
publishedon Datetime Version publication date-time. This attribute appears only if the state of the given version becomes 'stable'.
archivedon Datetime
state ENUM('stable', 'under-devel', 'archived')

'stable': indicates the stable/production-grade scientific classification version.

'under-devel': indicates a version that is under development

'archived': older versions



Resource: GET classification/version/:id/?format= Returns the full metadata of a specific (:id) scientific classification version
Parameter(s):
Segment Parameters Type Optional Description
id Integer No A specific version id.
Query Parameters Type Optional Description
format ENUM ('xml', 'json')
Default: 'xml'
Yes Response's format
Example request: GET https://appdb-pi.egi.eu/rest/1.0/classification/version/1
Example response (in pseudo-XML format):
<appdb:appdb> 
<classification:version id="1" version="1.0" createdon="..." publishedon="..." archivedon="..." state="stable">
<classification:discipline id="1078" parentid="1138" order="1" value="Level2"/>
<classification:discipline id="1079" parentid="1138" order="2" value="Level2"/>
<classification:discipline id="1047" parentid="1138" order="3" value="Level2"/>
<classification:discipline id="1139" parentid="1201" order="2" value="Level2"/>
<classification:discipline id="1080" parentid="1201" order="1" value="Level2"/>
<classification:discipline id="1138" parentid="1252" order="1" value="Level1"/>
<classification:discipline id="1201" parentid="1252" order="2" value="Level1"/>
<classification:discipline id="1252" parentid="0" order="1" value="Level0"/>
.................................
</classification:version>
</appdb:appdb> 
Response details:
Element Attribute Type Description
classification:version id Integer A unique version id.
version String The version tag.
createdon Datetime Version creation date-time.
publishedon Datetime Version publication date-time. This attribute appears only if the state of the given version becomes 'stable'.
archivedon Datetime Version archival date-time. This attribute appears only if the state of the given version becomes 'archived'.
state ENUM('stable', 'under-level', 'stable') 'stable': indicates the stable/production-grade scientific classification version.
'under-level': indicates a version that is under development.
'archived': older versions.
classification:discipline id Integer The discipline unique id.
parentid Integer The parent discipline unique id. '0' indicates a top-level discipline.
order Integer An integer that defines the order of the given discipline within the tree branch.
value String The discipline name/title.