Briefcase OAuth REST API Example performed with the Virtuoso OAuth Testing Tool

The following example demonstrates adding a resource and getting resource info by the ODS REST APIs briefcase.resource.store and briefcase.resource.get using the OAuth Test Tool. Full list of the ODS REST APIs for ODS Briefcase you can find here.

  1. Go to http://demo.openlinksw.com/ods
  2. Log in as user demo with password demo
  3. Go to Settings->OAuth Keys
  4. Copy the Token value for an Briefcase instance or create such in not existing. For ex.: 32e2a8fdddb69cb76b0e8309c42e5a7d008fdefc
  5. Go to http://demo.openlinksw.com/ods/oauth_test.vsp
  6. In the shown form enter for:
    1. Server: http://demo.openlinksw.com/ods/api
    2. Consumer Key: 32e2a8fdddb69cb76b0e8309c42e5a7d008fdefc
    3. API method: briefcase.resource.store
    4. API parameters: path=/DAV/home/demo/Public/mytest&content=TEST
    5. Select for Query options: "Generate URI and Submit".
  7. Click the "Execute" button.
  8. In the shown authorization form click the "Authorize" button.
  9. As result will be shown the generated URI and the output message of executing the ODS REST API. In our case, the id of the new created resource will be: 110997
  10. Now lets get the data for the created resource. In the form enter:
    1. API method: briefcase.resource.get
    2. API parameters: path=/DAV/home/demo/Public/mytest
    3. Select for Query options: "Generate URI and Submit".
  11. Click the "Execute" button.
  12. As result in the "Response Body" text-area will be shown the retrieved content for the resource with the given above id.

Related

CategoryBriefcase CategoryODS