Error retrieving metadata
An error occurred while retrieving the service metadata.
Species With Recovery Documents Data Explorer
Report of Species with Recovery Documents.
Data Explorer
The easiest way to begin using the Species With Recovery Documents Data Explorer REST API is via the ECOS Data Explorer's
point-and-click user interface. As you join data and create filters within the explorer, it captures your interactions as
REST API parameters.
Use the explorer's Export Link button to view and copy the valid REST API URL.
See the Help tab with the Data Explorer for
additional assistance using data explorer interface.
REST API
Parameters
Read the full Pull Reports parameter documentation for a description of valid parameter values.
Usage
Requests into the API always export at least one column from the service's base table: Species With Recovery Document. Use the columns parameter to join additional columns from supportive tables into your request result.
For example, to include all columns from a supportive table with path /table/path into the result, specify the table path within the columns parameter:
&columns=/table/path
To include a subset of columns, include a comma separated list of column id's after the table path:
&columns=/table/path@columnId1,columnId2
Use one or more filter parameters on any column to restrict the result to just rows which match the filter condition(s).
For instance, the following filter restricts the results to all records in which columnId1 in supportive table /table/path has a value greater than 1000:
&filter=/table/path@columnId1 > 1000
See the Pull Reports Export Report API for a complete description of all API parameter format and capabilities.
Base Table
Species With Recovery Document
Path: /recoveryDocs
The base table is the originating table for all report joins.
Description: List of species with recovery documents
Example service requests: Return the first 10 rows.
Child relationships
- Species With Supporting Documents [ left join] [to-many]
| Name | Id | Description | Type | Exportable? |
|---|---|---|---|---|
| Species Common Name | comname | Common Name | String | true |
| Species Scientific Name | sciname | Species' scientific name | String | true |
| ECOS Species ID | species_id | ECOS species ID | Integer | true |
| Species Population | pop_abbrev | Population location of the species | String | true |
| ECOS Species Group | group_text | ECOS species' group name | String | true |
| Recovery Document Title | plan_title | Recovery document title | String | true |
| Recovery Document Date | datesort | Date in a format used to sort | Timestamp | true |
| Plan Stage for Species | plan_stage | The current Plan Stage for Species | String | true |
| Recovery Document Action Status | plan_action_status | Entity ID | Integer | true |
| ESA Listing Status | species_status | The current species status | String | true |
| Lead Region | lead_region | Lead region number | Integer | true |
| Region Name | recovery_region_name | Name of the region the species is in | String | true |
| Recovery Document Type | doc_type | The document type: Recovery Plan, Addendum, or Exempt | String | true |
| PDF File Name | recovery_plan_pdf | Name of the recovery document pdf associated with species | String | true |
| Recovery Document ID | document_id | Document ID | Integer | true |
| Number of Recovery Actions | num_recovery_actions | Number of recovery actions associated with species | Long | true |
Supportive Tables
The following tables may be joined to the base table to add additional information to the data service.
Species With Supporting Documents
Path: /recoveryDocs/species_with_supporting_docs
Example service requests: Return the first 10 rows from the result of joining this table to the report's base table.
Child relationships
None
| Name | Id | Description | Type | Exportable? |
|---|---|---|---|---|
| Entity ID | entity_id | Entity ID | Integer | true |
| Supporting Document | supporting_doc_title | Title of the supporting document | String | true |
| Supporting Doc Type | supporting_doc_type | The type of supporting document | String | true |
| Supporting Document Version | supporting_doc_version | The version of the document if applicable | String | true |
| Supporting Document ID | supporting_document_id | Supporting Document ID | Integer | true |
| Supporting PDF File Name | supporting_pdf | Name of the supporting document pdf file | String | true |
| Document URL | url | String |
