Page History
| Table of Contents |
|---|
These RESTful services use a JSON exchange format (ei-x) to allow external parties to create and update resources in an eagle-i repository. They are currently deployed in the development server:
...
- error codes not properly handled
- currently no ontology-level validation of externally-produced resource descriptions
- currently does not handle links to referenced taxonomy terms (as opposed to links to eagle-i resources). Example of record not handled due to the related technique field: http://montana.dev.eagle-i.net/i/0000012b-00be-dcdf-df3b-3fdc80000009
- we currently do not enforce the association URI-foreign key (this will come)
-
DELETEis not yet implemented - This is not thoroughly tested
The ei-x JSON request and response formats
...
EIExchangeInstance field descriptions:
...
A map that contains the value of text properties, keyed on the URI of the ontology property used to capture them.
InstanceUpdateResponse field descriptions
...
the eagle-i URI of the resource that failed, and an error message
REST service description
Obtain an ei-x representation of a resource
...
EIExchangeInstance in JSON
Create or update a resource in an eagle-i repository
...
Example GET CURL command, substitute your own credentials:
| No Format |
|---|
curl -v --get -u eagle-i-user:password -d uri=http://montana.dev.eagle-i.net/i/0000012f-989d-df6c-b822-788380000000 https://montana.dev.eagle-i.net/sweet/api/externalResource
|
Example POST CURL command, substitute your own credentials (assumes a valid json instance in the file json.txt):
| No Format |
|---|
curl -v -X POST -u eagle-i-user:password -H "Content-Type: application/json" -d @json.txt https://montana.dev.eagle-i.net/sweet/api/externalResource
|
ei-x examples
Sample New instance with new linked instances. New instances must contain a foreign key and no eagle-i uri.
| Code Block |
|---|
{ "source":"OfficialSourceString", "foreignKey":"OfficialForeignKey123", "linkedResources":{ "http://purl.obolibrary.org/obo/ERO_0000022":[ { "source":"OfficialSourceString", "foreignKey":"OfficialForeignKey456", "linkedResources":{ }, "instanceEntity":{ "uri":{ "id":"" }, "label":"Frog, Kermit, Ph.D." }, "specificTypeUri":{ "id":"http://xmlns.com/foaf/0.1/Person" }, "textProperties":{ "http://purl.obolibrary.org/obo/ERO_0000052":[ "Professor", "Specialist in CRCH" ], "http://purl.obolibrary.org/obo/ERO_0000042":[ "Kermit" ], "http://purl.obolibrary.org/obo/ERO_0000041":[ "kermit@hawaii.edu" ], "http://purl.obolibrary.org/obo/ERO_0000051":[ "(123) 456-3008" ], "http://purl.obolibrary.org/obo/ERO_0000049":[ "Frog" ], "http://purl.obolibrary.org/obo/ERO_0000040":[ "Cancer Research Center\n12345 Lauhala St.\nR504c\nHonolulu, HI 96813" ] }, "rootType":{ "id":"http://xmlns.com/foaf/0.1/Person" } } ], "http://purl.obolibrary.org/obo/ERO_0000066":[ { "source":"OfficialSourceString", "foreignKey":"OfficialForeignKey789", "linkedResources":{ }, "instanceEntity":{ "uri":{ "id":"" }, "label":"University of Hawaii at Manoa Organized Research Units" }, "specificTypeUri":{ "id":"http://vivoweb.org/ontology/core#Consortium" }, "textProperties":{ }, "rootType":{ "id":"http://xmlns.com/foaf/0.1/Organization" } }, { "source":"OfficialSourceString", "foreignKey":"OfficialForeignKey101112", "linkedResources":{ }, "instanceEntity":{ "uri":{ "id":"" }, "label":"University of Hawai'i Cancer Center" }, "specificTypeUri":{ "id":"http://vivoweb.org/ontology/core#Center" }, "textProperties":{ "http://purl.obolibrary.org/obo/ERO_0000480":[ "http://www.kermitcancercenter.org/" ], "http://purl.obolibrary.org/obo/ERO_0000051":[ "678-910-1112" ], "http://eagle-i.org/ont/app/1.0/synonym":[ "KCC" ], "http://purl.obolibrary.org/obo/ERO_0000040":[ "123 Ala Moana Blvd.\nHonolulu, Hawai‘i 96813" ] }, "rootType":{ "id":"http://xmlns.com/foaf/0.1/Organization" } } ] }, "instanceEntity":{ "uri":{ "id":"" }, "label":"Kermit Analytical Laboratory" }, "specificTypeUri":{ "id":"http://vivoweb.org/ontology/core#CoreLaboratory" }, "textProperties":{ "http://purl.obolibrary.org/obo/ERO_0000055":[ "Kermit Cancer Research Center, 1234 Lauhala St. R504c, Honolulu, HI 96813" ], "http://eagle-i.org/ont/app/1.0/resource_description":[ "\"Awesome facility.\"" ], "http://purl.obolibrary.org/obo/ERO_0000054":[ "Excel" ], "http://purl.obolibrary.org/obo/ERO_0000041":[ "kermit@hawaii.edu" ], "http://purl.obolibrary.org/obo/ERO_0000480":[ "http://www.kermit.org/" ], "http://eagle-i.org/ont/app/1.0/synonym":[ "Small molecule analysis lab" ], "http://purl.obolibrary.org/obo/ERO_0000040":[ "Kermit Cancer Research Center, 1236 Lauhala St. R504c, Honolulu, HI 96813" ] }, "rootType":{ "id":"http://xmlns.com/foaf/0.1/Organization" } } } |
Overview
Content Tools