Documentation Powered by ReDoc

OpenObs REST API (1.0.0)

Download OpenAPI specification:Download

occurrences

Retourne les statistiques sur les occurrences

query Parameters
observationStatus
string (ObservationStatus)
Default: "PRESENT"
Enum: "PRESENT" "ABSENT" "ALL"

Statut de l'observation (présent, absent, tous)

validationLevelNationale
Array of strings (ValidationLevel)
Default: ["CERTAIN","PROBABLE","NON_REALISABLE"]
Items Enum: "CERTAIN" "PROBABLE" "DOUTEUX" "INVALIDE" "NON_REALISABLE" "NON_EVALUE"

Niveau de validation nationale

validationLevelRegionale
Array of strings (ValidationLevel)
Default: ["CERTAIN","PROBABLE","NON_REALISABLE","NON_EVALUE"]
Items Enum: "CERTAIN" "PROBABLE" "DOUTEUX" "INVALIDE" "NON_REALISABLE" "NON_EVALUE"

Niveau de validation régionale

cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
{
  • "occurrenceCount": 0
}

Retourne les statistiques sur les occurrences pour un taxon, ses synonymes et ses enfants

path Parameters
taxrefId
required
integer

Identifiant unique dans le référentiel TAXREF du taxon (correspond au CD_REF)

query Parameters
observationStatus
string (ObservationStatus)
Default: "PRESENT"
Enum: "PRESENT" "ABSENT" "ALL"

Statut de l'observation (présent, absent, tous)

validationLevelNationale
Array of strings (ValidationLevel)
Default: ["CERTAIN","PROBABLE","NON_REALISABLE"]
Items Enum: "CERTAIN" "PROBABLE" "DOUTEUX" "INVALIDE" "NON_REALISABLE" "NON_EVALUE"

Niveau de validation nationale

validationLevelRegionale
Array of strings (ValidationLevel)
Default: ["CERTAIN","PROBABLE","NON_REALISABLE","NON_EVALUE"]
Items Enum: "CERTAIN" "PROBABLE" "DOUTEUX" "INVALIDE" "NON_REALISABLE" "NON_EVALUE"

Niveau de validation régionale

cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
{
  • "occurrenceCount": 0
}

Retourne les statistiques par mois sur les occurrences

query Parameters
observationStatus
string (ObservationStatus)
Default: "PRESENT"
Enum: "PRESENT" "ABSENT" "ALL"

Statut de l'observation (présent, absent, tous)

validationLevelNationale
Array of strings (ValidationLevel)
Default: ["CERTAIN","PROBABLE","NON_REALISABLE"]
Items Enum: "CERTAIN" "PROBABLE" "DOUTEUX" "INVALIDE" "NON_REALISABLE" "NON_EVALUE"

Niveau de validation nationale

validationLevelRegionale
Array of strings (ValidationLevel)
Default: ["CERTAIN","PROBABLE","NON_REALISABLE","NON_EVALUE"]
Items Enum: "CERTAIN" "PROBABLE" "DOUTEUX" "INVALIDE" "NON_REALISABLE" "NON_EVALUE"

Niveau de validation régionale

cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retourne les statistiques par mois sur les occurrences pour un taxon, ses synonymes et ses enfants

path Parameters
taxrefId
required
integer

Identifiant unique dans le référentiel TAXREF du taxon (correspond au CD_REF)

query Parameters
observationStatus
string (ObservationStatus)
Default: "PRESENT"
Enum: "PRESENT" "ABSENT" "ALL"

Statut de l'observation (présent, absent, tous)

validationLevelNationale
Array of strings (ValidationLevel)
Default: ["CERTAIN","PROBABLE","NON_REALISABLE"]
Items Enum: "CERTAIN" "PROBABLE" "DOUTEUX" "INVALIDE" "NON_REALISABLE" "NON_EVALUE"

Niveau de validation nationale

validationLevelRegionale
Array of strings (ValidationLevel)
Default: ["CERTAIN","PROBABLE","NON_REALISABLE","NON_EVALUE"]
Items Enum: "CERTAIN" "PROBABLE" "DOUTEUX" "INVALIDE" "NON_REALISABLE" "NON_EVALUE"

Niveau de validation régionale

cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retourne les occurrences depuis les identifiants SINP (insensible à la casse)

query Parameters
id
required
string

Identifiant SINP de l'occurrence

datasetId
string

Identifiant SINP du jeu de données

Responses

Response samples

Content type
application/json
[
  • {
    }
]

datasets

Retourne la liste des jeux de données

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des producteurs de jeux de données

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des fournisseurs de jeux de données

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des objectifs des jeux de données

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des mots-clefs des jeux de données

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des processus de collecte des jeux de données

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne les statistiques sur les jeux de données

query Parameters
cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
{
  • "datasetCount": 0
}

Retourne les statistiques sur les jeux de données pour un taxon, ses synonymes et ses enfants

path Parameters
taxrefId
required
integer

Identifiant unique dans le référentiel TAXREF du taxon (correspond au CD_REF)

query Parameters
cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
{
  • "datasetCount": 0
}

Retourne le jeux de données depuis l'identifiant SINP (insensible à la casse)

query Parameters
id
required
string

Identifiant SINP du jeu de données

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "sinpId": "string"
}

taxa

Retourne les statistiques sur les taxons

query Parameters
ranks
Array of strings (TaxonRank)
Items Enum: "KINGDOM" "PHYLUM" "CLASS" "ORDER" "FAMILY" "GENUS" "SPECIES" "SUB_SPECIES" "VARIETY" "SUB_VARIETY" "FORM" "SUB_FORM" "CULTIVAR"

Filtrer par une liste de rangs taxonomiques

cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
{
  • "taxonCount": 0
}

Retourne les statistiques sur les taxons par statuts de protection

query Parameters
ranks
Array of strings (TaxonRank)
Items Enum: "KINGDOM" "PHYLUM" "CLASS" "ORDER" "FAMILY" "GENUS" "SPECIES" "SUB_SPECIES" "VARIETY" "SUB_VARIETY" "FORM" "SUB_FORM" "CULTIVAR"

Filtrer par une liste de rangs taxonomiques

cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
{
  • "protectedTaxonCount": 0,
  • "regulatedTaxonCount": 0,
  • "redListTaxonCount": 0,
  • "znieffTaxonCount": 0
}

Retourne les statistiques sur les taxons par groupe grand public

query Parameters
ranks
Array of strings (TaxonRank)
Items Enum: "KINGDOM" "PHYLUM" "CLASS" "ORDER" "FAMILY" "GENUS" "SPECIES" "SUB_SPECIES" "VARIETY" "SUB_VARIETY" "FORM" "SUB_FORM" "CULTIVAR"

Filtrer par une liste de rangs taxonomiques

cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retourne les statistiques sur les taxons par groupe grand public et statuts de protection

query Parameters
ranks
Array of strings (TaxonRank)
Items Enum: "KINGDOM" "PHYLUM" "CLASS" "ORDER" "FAMILY" "GENUS" "SPECIES" "SUB_SPECIES" "VARIETY" "SUB_VARIETY" "FORM" "SUB_FORM" "CULTIVAR"

Filtrer par une liste de rangs taxonomiques

cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retourne les statistiques sur les taxons par habitats

query Parameters
ranks
Array of strings (TaxonRank)
Items Enum: "KINGDOM" "PHYLUM" "CLASS" "ORDER" "FAMILY" "GENUS" "SPECIES" "SUB_SPECIES" "VARIETY" "SUB_VARIETY" "FORM" "SUB_FORM" "CULTIVAR"

Filtrer par une liste de rangs taxonomiques

cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retourne les statistiques sur les taxons par statuts biologiques

query Parameters
ranks
Array of strings (TaxonRank)
Items Enum: "KINGDOM" "PHYLUM" "CLASS" "ORDER" "FAMILY" "GENUS" "SPECIES" "SUB_SPECIES" "VARIETY" "SUB_VARIETY" "FORM" "SUB_FORM" "CULTIVAR"

Filtrer par une liste de rangs taxonomiques

cityInseeId
Array of strings

Code INSEE de commune

departmentInseeId
Array of strings

Code INSEE de département

regionInseeId
Array of strings

Code INSEE de région

startDate
string

Date de début au format YYYY-MM-DD

endDate
string

Date de fin au format YYYY-MM-DD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retourne la liste des groupes taxonomiques"avancé"

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des statuts biogéographiques"

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des habitats"

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

acquisitionScopes

Retourne la liste des cadres d'aqcuisition

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des objectifs des cadres d'acquisition

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des mots-clefs des cadres d'acquisition

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des maîtres d'ouvrage

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des maîtres d'oeuvre

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des financeurs

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne le cadre d'acquisition depuis l'identifiant SINP (insensible à la casse)

query Parameters
id
required
string

Identifiant SINP du cadre d'acquisition

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string"
}

additionalProperties

Retourne la liste des stades de vie

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des statuts biologique

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des comportements

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

locations

Retourne la liste des communes

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des départements

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des régions

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

Retourne la liste des epci

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

locationsInsee

Retourne la liste des communes ainsi que code INSEE

query Parameters
page
integer <int64> >= 0
Default: 0

Numéro de la page.

size
integer <int64> >= 1
Default: 10

Nombre de résultats par page.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "page": {
    }
}

cache

Retourne le statut des caches

Responses

Response samples

Content type
application/json
{
  • "datasets": 0,
  • "taxaAdvancedGroups": 0,
  • "taxaBiogeographicalStatus": 0,
  • "taxaHabitats": 0,
  • "datasetsGoals": 0,
  • "datasetsKeywords": 0,
  • "datasetsCollectionProcess": 0,
  • "datasetsProducers": 0,
  • "datasetsProviders": 0,
  • "additionalPropertiesLifeStage": 0,
  • "additionalPropertiesReproductiveCondition": 0,
  • "additionalPropertiesBehavior": 0,
  • "locationCities": 0,
  • "locationDepartments": 0,
  • "locationRegions": 0,
  • "locationEPCI": 0,
  • "acquisitionScopes": 0,
  • "acquisitionScopesGoals": 0,
  • "acquisitionScopesKeywords": 0,
  • "acquisitionScopesProjectOwner": 0,
  • "acquisitionScopesProjectManager": 0,
  • "acquisitionScopesFunder": 0
}