Difference between revisions of "OJ Break v2 Media Reference"
Jump to navigation
Jump to search
(→Elements) |
(→API Information and Access) |
||
| (7 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
'''Introduction''' | '''Introduction''' | ||
| − | OJ_Break is the name of the xBio:D RESTful API service which enables the discovery of data within the xBio:D database. The API can respond with | + | OJ_Break is the name of the xBio:D RESTful API service which enables the discovery of data within the xBio:D database. The API can respond with HTML, 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. | 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. | ||
| Line 8: | Line 8: | ||
This page specifies the data defined by OJ_Break Version 2, more precisely those that are defined by the '''Media''' data domain. To get information on any of the other data domains defined in OJ_Break Version 2, visit the [[#See_also|See also]] section. | This page specifies the data defined by OJ_Break Version 2, more precisely those that are defined by the '''Media''' data domain. To get information on any of the other data domains defined in OJ_Break Version 2, visit the [[#See_also|See also]] section. | ||
| + | |||
| + | [[File:OJ_Break Data Model - Media.png|none|frame|Media Data Model]] | ||
== Media Data Type Glossary == | == Media Data Type Glossary == | ||
=== Classes === | === Classes === | ||
| − | ==== ImageExtended (extends [[# | + | ==== ImageExtended (extends [[#MediaExtended (extends MediaBasic)|MediaExtended]]) ==== |
* ''thumb'': URL | * ''thumb'': URL | ||
* ''raw'': URL | * ''raw'': URL | ||
| − | ==== LocalityImageExtended (realizes [[# | + | ==== LocalityImageExtended (realizes [[#ImageExtended (extends MediaExtended)|ImageExtended]]) ==== |
* ''locality'': [[OJ_Break v2 Locality Reference#LocalityBasic|LocalityBasic]] | * ''locality'': [[OJ_Break v2 Locality Reference#LocalityBasic|LocalityBasic]] | ||
==== MediaBasic ==== | ==== MediaBasic ==== | ||
| − | * ''media_id'': ''[[#media_id|media_id]]'' | + | * ''media_id'': ''[[#media_id|media_id]]'' |
| − | * ''media_type'': ''[[#media_type|media_type]]'' | + | * ''media_type'': ''[[#media_type|media_type]]'' |
| − | * ''media_url'': ''[[#media_url|media_url]]'' | + | * ''media_url'': ''[[#media_url|media_url]]'' |
| − | * ''media_source'': ''[[#media_source|media_source]]'' | + | * ''media_source'': ''[[#media_source|media_source]]'' |
| − | * ''public'': ''[[#public|public]]'' | + | * ''public'': ''[[#public|public]]'' |
==== MediaExtended (extends [[#MediaBasic|MediaBasic]]) ==== | ==== MediaExtended (extends [[#MediaBasic|MediaBasic]]) ==== | ||
| − | * ''caption'': ''[[#caption|caption]]'' | + | * ''caption'': ''[[#caption|caption]]'' |
| − | * ''copyright'': ''[[#copyright|copyright]]'' | + | * ''copyright'': ''[[#copyright|copyright]]'' |
| − | * ''license'': ''[[#license|license]]'' | + | * ''license'': ''[[#license|license]]'' |
| − | * ''enterer'': ''[[#enterer|enterer]]'' | + | * ''enterer'': ''[[#enterer|enterer]]'' |
| − | ==== OccurrenceImageExtended (realizes [[# | + | ==== OccurrenceImageExtended (realizes [[#ImageExtended (extends MediaExtended)|ImageExtended]]) ==== |
| − | * ''occurrence'': [[OJ_Break v2 Occurrence Reference#OccurrenceTrimmed|OccurrenceTrimmed]] | + | * ''occurrence'': [[OJ_Break v2 Occurrence Reference#OccurrenceTrimmed (extends OccurrenceBasic)|OccurrenceTrimmed]] |
| − | * ''parts'': array of ''[[#part|part]]'' | + | * ''parts'': array of ''[[#part|part]]'' |
* ''angle'': ''[[#angle|angle]]'' | * ''angle'': ''[[#angle|angle]]'' | ||
| − | * ''technique'': ''[[#technique|technique]]'' | + | * ''technique'': ''[[#technique|technique]]'' |
* ''notes'': String | * ''notes'': String | ||
| − | ==== OccurrenceRecordingExtended (realizes [[# | + | ==== OccurrenceRecordingExtended (realizes [[#MediaExtended (extends MediaBasic)|MediaExtended]]) ==== |
* ''occurrence'': [[OJ_Break v2 Occurrence Reference#OccurrenceTrimmed|OccurrenceTrimmed]] | * ''occurrence'': [[OJ_Break v2 Occurrence Reference#OccurrenceTrimmed|OccurrenceTrimmed]] | ||
| − | ==== TaxonImageExtended (realizes [[# | + | ==== TaxonImageExtended (realizes [[#ImageExtended (extends MediaExtended)|ImageExtended]]) ==== |
* ''taxon'': [[OJ_Break v2 Taxon Reference#TaxonBasic|TaxonBasic]] | * ''taxon'': [[OJ_Break v2 Taxon Reference#TaxonBasic|TaxonBasic]] | ||
| − | ==== VideaExtended (realizes [[# | + | ==== VideaExtended (realizes [[#ImageExtended extends MediaExtended)|ImageExtended]]) ==== |
* ''taxon'': [[OJ_Break v2 Taxon Reference#TaxonBasic|TaxonBasic]] | * ''taxon'': [[OJ_Break v2 Taxon Reference#TaxonBasic|TaxonBasic]] | ||
| Line 66: | Line 68: | ||
==== media_url ==== | ==== media_url ==== | ||
URL - The location to the media file. | URL - The location to the media file. | ||
| + | ==== part ==== | ||
| + | String - A description of the body part of the specimen the image shows. | ||
| + | |||
==== public ==== | ==== public ==== | ||
| − | Boolean_flag - | + | Boolean_flag - A flag that specifies whether or not the media is public. |
==== technique ==== | ==== technique ==== | ||
String - A description of the method by which the media was taken. | String - A description of the method by which the media was taken. | ||
| Line 82: | Line 87: | ||
* [[OJ_Break v2 Occurrence Reference|Occurrence]] | * [[OJ_Break v2 Occurrence Reference|Occurrence]] | ||
* [[OJ_Break v2 Search Reference|Search]] | * [[OJ_Break v2 Search Reference|Search]] | ||
| + | * [[OJ_Break v2 Taxon Reference|Taxon]] | ||
Latest revision as of 16:38, 9 June 2015
Introduction
OJ_Break is the name of the xBio:D RESTful API service which enables the discovery of data within the xBio:D database. The API can respond with HTML, 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
- 1 API Information and Access
- 2 Media Data Type Glossary
- 2.1 Classes
- 2.1.1 ImageExtended (extends MediaExtended)
- 2.1.2 LocalityImageExtended (realizes ImageExtended)
- 2.1.3 MediaBasic
- 2.1.4 MediaExtended (extends MediaBasic)
- 2.1.5 OccurrenceImageExtended (realizes ImageExtended)
- 2.1.6 OccurrenceRecordingExtended (realizes MediaExtended)
- 2.1.7 TaxonImageExtended (realizes ImageExtended)
- 2.1.8 VideaExtended (realizes ImageExtended)
- 2.2 Elements
- 2.1 Classes
- 3 See also
API Information and Access
This page specifies the data defined by OJ_Break Version 2, more precisely those that are defined by the Media data domain. To get information on any of the other data domains defined in OJ_Break Version 2, visit the See also section.
Media Data Model
Media Data Type Glossary
Classes
ImageExtended (extends MediaExtended)
- thumb: URL
- raw: URL
LocalityImageExtended (realizes ImageExtended)
- locality: LocalityBasic
MediaBasic
- media_id: media_id
- media_type: media_type
- media_url: media_url
- media_source: media_source
- public: public
MediaExtended (extends MediaBasic)
OccurrenceImageExtended (realizes ImageExtended)
- occurrence: OccurrenceTrimmed
- parts: array of part
- angle: angle
- technique: technique
- notes: String
OccurrenceRecordingExtended (realizes MediaExtended)
- occurrence: OccurrenceTrimmed
TaxonImageExtended (realizes ImageExtended)
- taxon: TaxonBasic
VideaExtended (realizes ImageExtended)
- taxon: TaxonBasic
Elements
angle
String - A description of the angle the media was taken.
caption
String - A summary of the media.
copyright
String - Copyright information.
enterer
String - The media enterer's name.
license
String - Licensing information.
media_id
Number - A numeric identifier that uniquely identifies a media piece.
media_source
String - The name of the source of the media.
media_type
String - A description of the type of the media.
media_url
URL - The location to the media file.
part
String - A description of the body part of the specimen the image shows.
public
Boolean_flag - A flag that specifies whether or not the media is public.
technique
String - A description of the method by which the media was taken.
See also
Visit any of the below links to find information about the other data domains defined by OJ_Break Version 2.
