Alert.png The wiki is deprecated and due to be decommissioned by the end of September 2022.
The content is being migrated to other supports, new updates will be ignored and lost.
If needed you can get in touch with EGI SDIS team using operations @ egi.eu.

Difference between revisions of "VT Scientific Discipline Classification API"

From EGIWiki
Jump to navigation Jump to search
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__ {{Template:ScientificDisciplineClassification_menubar}}  
{{EGI_Activity_groups_menubar}}
{{Menubar_VT}}
{{Template:ScientificDisciplineClassification_menubar}}  
{{TOC_right}} 
[[Category:Virtual_Teams]]


{| width="700" border="1" cellpadding="1" cellspacing="1"
The table below provides the details for extracting the last classification.
 
{| cellspacing="1" cellpadding="1" width="910" border="1"
|-
|-
| Resource: <br>GET classification/versions/?format=
| bgcolor="808080" colspan="2" | <span style="color:white">Resource: '''GET classification/versions/?format='''</span>
| Returns a list of high-level metadata for each existing scientific classification version
| colspan="2" | Returns a list of high-level metadata for each existing scientific classification version
|-
|-
| Parameter(s):
| colspan="4" | '''Parameter(s):'''
|-
|-
| Query Parameter
| bgcolor="D3D3D3" | Query Parameter  
| Type
| bgcolor="D3D3D3" | Type  
| Optional
| bgcolor="D3D3D3" | Optional  
| Description
| bgcolor="D3D3D3" | Description
|-
|-
| format
| format  
| ENUM ('xml', 'json')<br>Default: 'xml'
| ENUM ('xml', 'json')<br>Default: 'xml'  
| Yes
| Yes  
| Response's format
| Response's format
|-
|-
| Example response (in pseudo-XML format):
| colspan="4" |
|-
|-
| <appdb:appdb>
| colspan="4" | '''Example request''': GET https://appdb-pi.egi.eu/rest/1.0/classification/versions
  <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
| colspan="4" | '''Example response (in pseudo-XML format):'''
|-
|-
| Element
| bgcolor="D3D3D3" colspan="4" |
| Attribute
&lt;appdb:appdb&gt;
| Type
&lt;classification:version id="1" version="1.1" createdon="..." publishedon="..." archivedon="..." state="archived"/&gt;
| Description
&lt;classification:version id="2" version="1.2" createdon="..." publishedon="..." archivedon="..." state="archived"/&gt;
&lt;classification:version id="3" version="1.3" createdon="..." publishedon="..." archivedon="..." state="archived"/&gt;
&lt;classification:version id="4" version="2.0" createdon="..." publishedon="..." archivedon="..." state="archived"/&gt;
&lt;classification:version id="5" version="2.1" createdon="..." publishedon="..." archivedon="..." state="stable"/&gt;
&lt;classification:version id="6" version="2.2" createdon="..." publishedon="..." archivedon="..." state="under-devel"/&gt;
.................................
&lt;/appdb:appdb&gt;
 
|-
|-
| classification:version
| colspan="4" |
| id<br>version<br>createdon<br>publishedon
|-
| Integer<br>String<br>Datetime<br>Datetime
| colspan="4" | '''Response details:'''
| A unique version id.<br>The version tag.<br>Version creation date-time.<br>Version publication date-time. This attribute appears only if the state of the given version becomes 'stable'.
|-
| bgcolor="D3D3D3" | Element
| bgcolor="D3D3D3" | Attribute
| bgcolor="D3D3D3" | Type
| bgcolor="D3D3D3" | Description
|-
| classification:<span style="color:red">version</span>  
| id<br>  
| Integer<br>  
| A unique version id.<br>
|-
|-
|  
|  
| 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.
|
 
<span style="line-height: 1.5em;">'under-devel': indicates a version that is under development</span>
 
<span style="line-height: 1.5em;">'archived': older versions</span>
 
|-
|-
|  
| bgcolor="ffffff" colspan="4" |  
|
<br>
|
 
|
<br>
 
|-
|-
|  
| bgcolor="808080" colspan="2" | <span style="color:white">Resource:&nbsp;'''GET classification/version/:id/?format='''</span>
|  
| colspan="2" | Returns the full metadata of a specific (:id) scientific classification version
|  
|  
|-
|-
|  
| colspan="4" | '''Parameter(s):'''
|
|
|  
|-
|-
|  
| bgcolor="D3D3D3" | Segment Parameters
|  
| bgcolor="D3D3D3" | Type
|  
| bgcolor="D3D3D3" | Optional
|  
| bgcolor="D3D3D3" | Description
|-
|-
|  
| id
|  
| Integer
|  
| No
|  
| A specific version id.
|-
|-
|  
| bgcolor="D3D3D3" | Query Parameters
|  
| bgcolor="D3D3D3" | Type
|  
| bgcolor="D3D3D3" | Optional
|  
| bgcolor="D3D3D3" | Description
|-
|-
|  
| format
|  
| ENUM ('xml', 'json')<br>Default: 'xml'
|  
| Yes
|  
| Response's format
|-
|-
|  
| colspan="4" |  
|
|
|  
|-
|-
|  
| colspan="4" | '''Example request''': GET https://appdb-pi.egi.eu/rest/1.0/classification/version/1
|
|
|  
|-
|-
|  
| colspan="4" | '''Example response (in pseudo-XML format):'''
|
|
|  
|-
|-
|  
| bgcolor="D3D3D3" colspan="4" |
|
&lt;appdb:appdb&gt;
|
&lt;classification:version id="1" version="1.0" createdon="..." publishedon="..." archivedon="..." state="stable"&gt;
|
&lt;classification:discipline id="1078" parentid="1138" order="1" value="Level2"/&gt;
&lt;classification:discipline id="1079" parentid="1138" order="2" value="Level2"/&gt;
&lt;classification:discipline id="1047" parentid="1138" order="3" value="Level2"/&gt;
&lt;classification:discipline id="1139" parentid="1201" order="2" value="Level2"/&gt;
&lt;classification:discipline id="1080" parentid="1201" order="1" value="Level2"/&gt;
&lt;classification:discipline id="1138" parentid="1252" order="1" value="Level1"/&gt;
&lt;classification:discipline id="1201" parentid="1252" order="2" value="Level1"/&gt;
&lt;classification:discipline id="1252" parentid="0" order="1" value="Level0"/&gt;
.................................
&lt;/classification:version&gt;
&lt;/appdb:appdb&gt;
 
|-
|-
|  
| colspan="4" |  
|
|
|  
|-
|-
|  
| colspan="4" | '''Response details:'''
|
|
|  
|-
|-
|  
| bgcolor="D3D3D3" | Element
|  
| bgcolor="D3D3D3" | Attribute
|  
| bgcolor="D3D3D3" | Type
|  
| bgcolor="D3D3D3" | Description
|-
|-
|  
| classification:<span style="color:red">version</span>
|  
| 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.<br>'under-level': indicates a version that is under development.<br>'archived': older versions.
|-
|-
|  
| classification:<span style="color:red">discipline</span>
|  
| 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.
|}
|}


<br>  
<br>
 
<br>
 
&nbsp;Query Parameter Type Optional Description format ENUM ('xml', 'json') Default: 'xml' Yes Response's format Example response (in pseudo-XML format): &lt;appdb:appdb&gt;
 
  &lt;classification:version id="1" version="1.1" createdon="..." publishedon="..." archivedon="..." state="archived"/&gt;
&lt;classification:version id="2" version="1.2" createdon="..." publishedon="..." archivedon="..." state="archived"/&gt;
&lt;classification:version id="3" version="1.3" createdon="..." publishedon="..." archivedon="..." state="archived"/&gt;
&lt;classification:version id="4" version="2.0" createdon="..." publishedon="..." archivedon="..." state="archived"/&gt;
&lt;classification:version id="5" version="2.1" createdon="..." publishedon="..." archivedon="..." state="stable"/&gt;
&lt;classification:version id="6" version="2.2" createdon="..." publishedon="..." archivedon="..." state="under-devel"/&gt;
.................................
 
&lt;/appdb:appdb&gt; 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-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 Parameter Type Optional Description format ENUM ('xml', 'json') Default: 'xml' Yes Response's format Example response (in pseudo-XML format): &lt;appdb:appdb&gt;
 
  &lt;classification:version id="6" version="2.1" createdon="..." publishedon="..." archivedon="..."  state="stable"&gt;
 
&lt;classification:discipline id="1078" parentid="1138" order="1" value="Level2"/&gt; &lt;classification:discipline id="1079" parentid="1138" order="2" value="Level2"/&gt; &lt;classification:discipline id="1047" parentid="1138" order="3" value="Level2"/&gt; &lt;classification:discipline id="1139" parentid="1201" order="2" value="Level2"/&gt; &lt;classification:discipline id="1080" parentid="1201" order="1" value="Level2"/&gt; &lt;classification:discipline id="1138" parentid="1252" order="1" value="Level1"/&gt; &lt;classification:discipline id="1201" parentid="1252" order="2" value="Level1"/&gt; &lt;classification:discipline id="1252" parentid="0" order="1" value="Level0"/&gt; .................................
 
  &lt;/classification:version&gt;
 
&lt;/appdb:appdb&gt; 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.

Latest revision as of 14:15, 19 June 2015

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.