Versions Compared

Key

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

These web services uses a JSON exchange format (ei-x) to allow external parties to create and update resources in eagle-i. They are currently deployed in the development server:

http://montana.dev.eagle-i.net

The ei-x format

ei-x is a simplified container for the RDF of an eagle-i resource *and* its linked resources. It is the serialization of the following Java class:

https://open.med.harvard.edu/svn/eagle-i-dev/apps/trunk/datatools/catalyst/src/main/java/org/eaglei/datatools/services/EIExchangeInstance.javaImage Added

Field descriptions:

instanceEntity (EIEntity)

A container for the resource's EIURI and Label; when requesting creation of a new resource, The ID field of the EIURI should be empty, in which case the 

specificTypeUri (EIURI)

The most specific ontology type assigned to the resource. The type EIURI can be obtained from the ontology browser (grab it from the URL bar), e.g. DNA Sequencer: http://purl.obolibrary.org/obo/OBI_0400103Image Added

rootType (EIURI)

The root type of the resource (one of the eagle-i Primary Types), e.g. Instrument: http://purl.obolibrary.org/obo/ERO_0000004Image Added

foreignKey (String)

A string that uniquely identifies the resource in its external location (format determined by the source)

source (String)

A string that uniquely identifies the source of the resource (format TBD)

Obtain an ei-x representation of a resource

URL:

 /sweet/api/externalResource

Method:

GET 

Args:

uri  -- the eagle-i identifier of the resource

pretty -- true | false, return prettified JSON (useful for debugging)

Example:

No Format

http://montana.dev.eagle-i.net/sweet/api/externalResource?uri=http://montana.dev.eagle-i.net/i/0000012f-989d-df6c-b822-788380000000

Result:

resource information in ei-exf

Create or update a resource in eagle-i

...