Difference between revisions of "OJ Break v2 Agent Reference"
(→Procedural Reference) |
(→Agent) |
||
| Line 19: | Line 19: | ||
===== Description ===== | ===== Description ===== | ||
===== Parameters ===== | ===== Parameters ===== | ||
| − | * ''agent_id'': | + | * ''agent_id'': ''agent_id'' |
* ''format'': string | * ''format'': string | ||
* ''key'': string | * ''key'': string | ||
| Line 32: | Line 32: | ||
===== Description ===== | ===== Description ===== | ||
===== Parameters ===== | ===== Parameters ===== | ||
| − | * ''agent_id'': number | + | * ''agent_id'': ''agent_id'' |
| + | * ''offset'': number (optional) | ||
| + | * ''limit'': number (optional) | ||
* ''format'': string | * ''format'': string | ||
* ''key'': string | * ''key'': string | ||
| Line 41: | Line 43: | ||
===== Example ===== | ===== Example ===== | ||
http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentLiterature?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2 | http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentLiterature?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2 | ||
| − | |||
==== getAgentTaxa ==== | ==== getAgentTaxa ==== | ||
===== Description ===== | ===== Description ===== | ||
===== Parameters ===== | ===== Parameters ===== | ||
| − | * ''agent_id'': number | + | * ''agent_id'': ''agent_id'' |
| + | * ''offset'': number (optional) | ||
| + | * ''limit'': number (optional) | ||
* ''format'': string | * ''format'': string | ||
* ''key'': string | * ''key'': string | ||
| Line 55: | Line 58: | ||
===== Example ===== | ===== Example ===== | ||
http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentTaxa?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2 | http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentTaxa?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2 | ||
| − | |||
==== getAgentOccurrences ==== | ==== getAgentOccurrences ==== | ||
===== Description ===== | ===== Description ===== | ||
===== Parameters ===== | ===== Parameters ===== | ||
| − | * ''agent_id'': number | + | * ''agent_id'': ''agent_id'' |
| + | * ''offset'': number (optional) | ||
| + | * ''limit'': number (optional) | ||
| + | * ''basic_only'': Boolean_flag (optional) | ||
* ''format'': string | * ''format'': string | ||
* ''key'': string | * ''key'': string | ||
Revision as of 21:31, 12 January 2015
Introduction
OJ_Break is the name of the xBio:D RESTful API service to facilitate discovery of data within the xBio:D database. The API can respond with JavaScript Object Notation (JSON), XML, or JSON with padding (JSONP) and accepts HTTP GET and POST requests indiscriminately. The backend of the API is written in Oracle's PL/SQL database language, which is fast but often inflexible, while a Python presentation layer mitigates request handling and authentication.
OJ_Break Version 2 is a new and improved edition of the work started in Version 1. Version 2 introduces a completely restructured and standardized data model to further enhance the functionality of the xBio:D database.
Contents
API Information and Access
This page specifies the methods and data defined by OJ_Break Version 2, more precisely those that are defined by the Agent data domain. To get information on any of the other data domains defined in OJ_Break Version 2, visit the See also section.
Using the OJ_Break Version 2 API requires calling methods with corresponding, method specific parameters (found on this page) and a few other required parameters. These required parameters include specifying a return format, an API access key, and a version number.
Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentInfo?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
Notice the specification of the version parameter at the end of the example method call. With the introduction of OJ_Break Version 2, the version parameter has a default value of 2 making the specification in the example unnecessary. To read more about using the OJ_Break Version 2 API, go to OJ_Break API Access.
Procedural Reference
Agent
getAgentInfo
Description
Parameters
- agent_id: agent_id
- format: string
- key: string
- version: number
Return
- AgentComplete
Example
getAgentLiterature
Description
Parameters
- agent_id: agent_id
- offset: number (optional)
- limit: number (optional)
- format: string
- key: string
- version: number
Return
- AgentReturnLiterature
Example
getAgentTaxa
Description
Parameters
- agent_id: agent_id
- offset: number (optional)
- limit: number (optional)
- format: string
- key: string
- version: number
Return
- AgentReturnTaxa
Example
getAgentOccurrences
Description
Parameters
- agent_id: agent_id
- offset: number (optional)
- limit: number (optional)
- basic_only: Boolean_flag (optional)
- format: string
- key: string
- version: number
Return
- AgentReturnOccurrences
Example
See also
Visit any of the below links to find information about the other data domains defined by OJ_Break Version 2.
