Versions Compared

Key

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

...

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


Knowsn Known issues:

  • authentication is still to be implemented (this very first pass uses no authentication). This will most likely be HTTP BasicAuth over HTTPS
  • 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)
  • DELETE is not yet implemented
  • This is not thoroughly tested

...

InstanceUpdateResponse in JSON, indicating successes and failures

Authentication and headers

These RESTful services use Http Basic Authentication, that is, they expect the eagle-i credentials to be passed in the authorization header of each request. 

The POST service expects content to be passed as a multi-part form, with type=application/json set for the exchangeInstance part.

REST clients should handle all of this out-of-the box.

Example GET CURL command, substitute your own credentials:

No Format

curl --get -v -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

cat json.txt | curl -v -u eagle-i-user:password -F 'exchangeInstance=@-;type=application/json'  https://montana.dev.eagle-i.net/sweet/api/externalResource


ei-x examples

Detailed examples to come. In the meantime, use the GET service to obtain an EIExchangeInstance representation of a resource.