Difference between revisions of "GOCDB/PI/Technical Documentation"
m |
m |
||
Line 53: | Line 53: | ||
! Method name !! type !! description !! Protection level | ! Method name !! type !! description !! Protection level | ||
|- | |- | ||
|get_site || read - generic || Returns site information including contacts, grouped by site || 2 | |[[GOCDB_PI_get_site_method get_site]] || read - generic || Returns site information including contacts, grouped by site || 2 | ||
|- | |- | ||
| | | | ||
|} | |} |
Revision as of 10:57, 10 November 2010
GOCDB Programmatic Interface
Important information about using the GOCDBPI
Releases, changes and announcements
All client tool using GOCDB should register someone to the GOCDB discussion mailing list: gocdb-discuss_at_mailtalk.ac.uk. Releases, new features, changes in methods and general announcements related to this interface are made on this list.
If your application is using the GOCDB Programmatic interface please request to join this mailing list by sending us a mail to gocdb-admins@mailtalk.ac.uk.
Interface description
Interface type
GOCDB Programmatic Interface is a REST (Representational State Transfer) based interface over https. The use of https guarantees URLs are properly secured when transiting. Some of the methods are nonetheless public and don't require client side authentication (see #Data protection and access).
Entry point
Enter GOCDB here https://goc.gridops.org/ or directly at https://goc.gridops.org/portal/ to browse the global EGI information or at https://gocdb4.esc.rl.ac.uk/portal to update information.
Entry point for every single method is given on method definition pages listed below.
Outputs
Output format is XML. Calling any implemented method will return you a valid DOM document that can be parsed by any tool on client side.
Schemas
The associated XML schema for each method is available by calling the method with "&output=xmlschema", e.g. https://goc.gridops.org/gocdbpi/private/?method=get_site&output=xmlschema
Data protection and access
Protection levels
There are currently 3 protection levels for all methods of the interface
- Level 1: public methods (no critical information, no mail, no personal details)
- Level 2: protected methods (contain mails or personal details)
- Level 3: private methods (contains security or critical information)
Methods at level 1 are available without restrictions. Level 2 requires client to present a valid recognized X509 certificate (reference CA list is the officially agreed EGEE/LCG EUGridPMA list). Level 3 requires client to present a known, registered certificate (certificate DN needs to be stored on GOCDB side for authentication)
How to gain access?
If you need to access protected methods, a valid certificate will be enough. If you need to access private methods, please send a mail to gocdb-admins@mailtalk.ac.uk, indicating:
- Your name and affiliation
- The name and purpose of the tool that need to access the data
- certificate DN of the machine(s) that will retrieve the information
- An e-mail contact for your application, that will be subscribed to the GOCDB-discussion and announcement mailing list if it is not already there.
Available methods
Method name | type | description | Protection level |
---|---|---|---|
GOCDB_PI_get_site_method get_site | read - generic | Returns site information including contacts, grouped by site | 2 |