Connexions de données

Le registre de l{0} maintient les métadonnées qui décrivent:

  • collections - collections d'histoire naturelle;
  • institutions - institutions et organisations qui gèrent des collections;
  • dataProviders - fournisseurs d'information sur la biodiversité sous forme électronique, par exemple enregistrement d'occurrence, sites Web;
  • dataResources - ressources spécifiques mis à disposition par les fournisseurs de données;
  • tempDataResources - ressources temporaires détenant des enregistrements téléchargés vers le bac à sable;
  • dataHubs - agrégateurs de données sur la biodiversité ; et
  • contacts - pour chaqu'une des ressources ci-dessus.

L'accès à cette métadonnée est fourni par services web axés sur les ressources qui adhèrent à RESTful principes. Les charges utiles de réponse sont généralement au format JSON bien que certains services proposent d'autres formats grâce à la négociation de contenu.

Les détails pour savoir comment ces services peuvent être utilisés comme fournisseurs dans le projet wiki, et en particulier ici.

Venant de URIs

Tous les services URIs sont basés sur l'URI de la page: https://collections.ala.org.au/ws
Les URI pour les ressources énumérées ci-dessus sont cette racine ainsi que le nom du type de ressource, par exemple: https://collections.ala.org.au/ws/institution
L'URI pour une instance spécifique d'une ressource est la même suivie par l'UID de l'instance. Par exemple, la ressource représentant l'Institut de recherche de vin Aust (UID = in72) est: https://collections.ala.org.au/ws/institution/in72
L'URI pour obtenir un nombre total d'une ressource spécifique est le nom de la ressource suivi par « count». Par exemple, le nombre d'établissements est donné par: https://collections.ala.org.au/ws/institution/count
Comptes pour une ressource spécifique peuvent être regroupés par n'importe quel attribut de la ressource. Par exemple, la répartition des institutions de l'État est donnée par: https://collections.ala.org.au/ws/institution/count/state
Les ressources qui sont les attributs d'une ressource, comme la liste de contacts pour une collection, sont adressé en ajoutant le type de ressource à l'uri qui représente la principale ressource, par exemple: https://collections.ala.org.au/ws/institution/in72/contacts

Méthodes

Services de données prennent en charge les méthodes GET, HEAD, POST, PUT, OPTIONS et DELETE.

GET retourne la représentation json de la ressource spécifiée ou la liste de toutes les ressources du type de ressource spécifié.

HEAD ne retournera aucun contenu mais confirmera l'existence de la ressource spécifiée.

POST met à jour la ressource spécifiée, basée sur les informations contenues dans le corps de la requête. Si aucune ressource n'est spécifié, les informations contenues dans le corps servira à créer une nouvelle ressource. Le corps doit être json valide et vous devez spécifier au moins ces propriétés:

  • utilisateur - le nom de l'application qui demande la mise à jour ; et
  • api_key - une clé valide pour vérifier que vous êtes autorisé à modifier la ressource.

Si une ressource est créée, vous devez également spécifier au moins:

  • nom - le nom de la ressource

Autres propriétés sont traitées comme les propriétés à mettre à jour. Les noms de propriété sont les mêmes que ceux utilisés dans la représentation GET.

PUT se comporte comme POST.

OPTIONS retourne une liste des méthodes autorisées.

DELETE supprime la ressource spécifiée. Le corps doit être json valide et vous devez spécifier ces propriétés:

  • utilisateur - le nom de l'application qui est requis pour la mise à jour ; et
  • api_key - une clé valide pour vérifier que vous êtes autorisé à modifier la ressource.

Contacts

Des contacts existent en tant que ressources dans leur propre droit. Ils sont accessibles sous la forme standard.

Lister tous les contacts: https://collections.ala.org.au/ws/contacts
Obtenir des renseignements concernant un contact spécifique https://collections.ala.org.au/ws/contacts/31
Rechercher un contact par son adresse mail https://collections.ala.org.au/ws/contacts/email/dave.martin@csiro.au

Contacts d'édition suit le même schéma que les entités principales. PUT et POST met à jour un contact si un id est spécifié dans l'url, sinon un nouveau contact est ajouté. DELETE supprime un contact.

Le corps doit être json valide et vous devez spécifier au moins ces propriétés:

  • utilisateur - le nom de l'application qui est requis pour la mise à jour ; et
  • api_key - une clé valide pour vérifier que vous êtes autorisé à modifier la ressource.

et peut en outre préciser

  • prénom
  • nom
  • fax
  • téléphone
  • portable
  • notes
  • public (vrai ou faux) - contrôle si le contact sera affiché sur une page web publique

Notez que les contacts n'ont pas d'IUDs. Ils utilisent à la place l'ID attribué par la Base de Données.

L'e-mail de l'utilisateur est effectivement la clé primaire pour un contact. Toujours vérifier si un contact existe (en recherchant son adresse e-mail) avant de créer un.

Relations du contact

Un contact peut être associé à n'importe quel nombre de ressources. Une ressource peut avoir n'importe quel nombre de contacts. La relation entre un contact et une ressource a ses propres métadonnées telles que le rôle que le contact a dans la relation qui l'unit avec les ressources, les droits de modification du contact, etc.

Ces métadonnées sont accessible en ajoutant contacts à l'uri d'une ressource en utilisant le formulaire:
GET https://collections.ala.org.au/ws/{resource type}/{resource uid}/contacts
Par exemple: https://collections.ala.org.au/ws/collection/co13/contacts
Les métadonnées d'une relation pour un contact spécifique a la forme:
GET https://collections.ala.org.au/ws/{resource type}/{resource uid}/contacts/{id}
Par exemple: https://collections.ala.org.au/ws/collection/co13/contacts/20
Les principaux contacts pour toutes les instances d'un type de ressource sont accessibles en utilisant le formulaire:
GET https://collections.ala.org.au/ws/{resource type}/contacts
Par exemple: https://collections.ala.org.au/ws/collection/contacts
Contacts peuvent choisir d'être averti lorsque des événements importants se produisent à une ressource. La liste de contacts qui seront averti pour une ressource spécifique peut être récupérée à partir d'une uri de la forme:
GET https://collections.ala.org.au/ws/{resource type}/{resource uid}/contacts/notifiable
Par exemple: https://collections.ala.org.au/ws/collection/co13/contacts/notifiable
Vous pouvez récupérer toutes les entités que le contact spécifié est autorisé à modifier. L'uri a la forme:
GET https://collections.ala.org.au/ws/contacts/{contact id}/authorised
Par exemple: https://collections.ala.org.au/ws/contacts/132/authorised

Tous les services du contact peuvent retourner l'emport comme CSV, XML ou JSON via le contenu.
Plus d'informations.

Les relations du contact peuvent être mis à jour en suivant les règles habituelles. Le contact doit déjà exister.

POST va ajouter le contact à une ressource, si elle n'existe pas déjà, ou met à jour la relation en utilisant les données json dans le corps de la requête.

Le corps doit être json valide et vous devez spécifier au moins ces propriétés:

  • utilisateur - le nom de l'application qui est requis pour la mise à jour ; et
  • api_key - une clé valide pour vérifier que vous êtes autorisé à modifier la ressource.

et peut en outre préciser

  • rôle - le rôle que le contact a pour cette ressource, par exemple, « Manager »
  • notifier (vrai ou faux) - si le contact souhaite être informé sur les événements significatifs (Ceci a été remplacé par des alertes)
  • administrateur - si le contact n'est autorisé à administrer cette ressource
  • primaryContact - si le contact est le contact principal pour ce jeu de données

La forme de l'url est https://collections.ala.org.au/ws/{resource type}/{resource uid}/contacts/{contact id}

PUT identique à POST.

DELETE supprime le contact d'un jeu de données.

Le corps doit être json valide et vous devez spécifier au moins ces propriétés:

  • utilisateur - le nom de l'application qui est requis pour la mise à jour ; et
  • api_key - une clé valide pour vérifier que vous êtes autorisé à modifier la ressource.

L'url a la même forme que ci-dessus.

Échange de métadonnées EML

Le registre fournit un service pour extraire les métadonnées des ressources au format EML. La réponse est conforme avec Schéma EML du GBIF. Ce document est conçu pour être inclus dans une Archive Darwin Core en tant que description des métadonnées des enregistrements qu'elle contient. La forme est:

GET https://collections.ala.org.au/ws/eml/{uid}
Cet exemple uri retourne un document XML qui décrit l'ensemble d'enregistrements de l'occurrence pour l'atlas DECCW de la flore & Faune NSW: https://collections.ala.org.au/ws/eml/dr368

Services de référence

Le services de référence retourne l'attribution et la licence d'information pour les documents numérisés qui sont accessibles par le biais de l'Atlas.

Citations pour obtenir la liste des fournisseurs de données

Ce service accepte une liste d'entité UIDs et retourne des informations de référence pour chaque entité. Tout types d'entité peuvent être spécifiées mais seulement des ressources de données ont des information sur les citations significatives. Pour chaque entité, le service retourne le nom de l'entité, son texte de référence, son texte de droits et une chapine de caractères « plus informations » contenant un lien vers la page collectory pour l'entité. La forme est:

GET https://collections.ala.org.au/ws/citations/{listOfUIDs}
listeDeUIDs est une liste des UID séparés par des virgules.
Cet exemple uri retourne une liste de citations pour les ressources de trois données spécifiées: https://collections.ala.org.au/ws/citations/dr368,dr105,dr357

Le service peut retourner les informations comme une liste JSON ou un fichier CSV ou TSV avec les en-têtes appropriés. Le format est spécifié par http content-negotiation.
Plus d'informations.

Services de recherche

Ces services soutiennent explicitement l'Inter-opération avec d'autres composants de l'Atlas comme bio-cache et BIE. Ils ne sont pas tous conformes totalement avec les principes REST mais vont être progressivement refactorisés pour ce faire.

Situer un enregistrement bio-cache à une collection

Ce service prend une collection de code et un code de l'institution depuis un enregistrement d'un l'échantillon brut et situe la combinaison avec une seule collection. La forme est:

GET https://collections.ala.org.au/lookup/inst/{institution-code}/coll/{collection-code}
Cet exemple uri retourne les métadonnées pour la Collection d'insectes nationale australienne: https://collections.ala.org.au/lookup/inst/ANIC/coll/Insects
More information.

Obtenez un résumé pour une entité

Ce service renvoie uniquement un sous-ensemble des métadonnées pour une entité. La forme est:

GET https://collections.ala.org.au/lookup/summary/{uid}
Cet exemple uri retourne les métadonnées abrégées pour le fournisseur de données Birds Australia: https://collections.ala.org.au/lookup/summary/dp28

Les services analytiques sont moins utiles, maintenant que nous avons des services métadonnées complet RESTmais sont conservés pour la compatibilité descendante. Ils fournissent également une petite efficacité lorsque le service est appelé à plusieurs reprises comme au cours de l'indexation des opérations. Plus d'informations.

Recherchez le nom d'une entité

Ce service est encore plus réduit que le résumé. Elle retourne uniquement le nom d'une entité en renseignant son UID. La forme est:

GET https://collections.ala.org.au/lookup/name/{uid}

Plus d'informations.

Obtenir des conseils de couverture taxonomique d'une entité

Ce service joue un rôle dans la correspondance de nom taxonomique lors du traitement d'enregistrement brut bio-cache. Lorsqu'un enregistrement est mappé à une collection, les métadonnées de lacollection peuvent servir à éclairer le processus correspondant en ajoutant des poids aux similaritées au sein de groupes taxonomiques particuliers. La forme est:

GET https://collections.ala.org.au/lookup/taxonomicCoverageHints/{uid}
Cet exemple uri retourne une liste de paires de rang-nom qui désigne un éventail taxonomique: https://collections.ala.org.au/lookup/taxonomyCoverageHints/co12
More information.

Liste des limites de téléchargement pour toutes les ressources de données

Les limites peuvent être appliqués au nombre d'enregistrements qui peuvent être téléchargés à partir d'une ressource particulière par requête. If [ ] est retourné, il n'y a pas de limites actuellement définies. La forme est:

GET https://collections.ala.org.au/lookup/downloadLimits

Générer un UID pour une nouvelle entité

Il s'agit d'un service temporaire utilisé lorsque de nouvelles ressources de données sont découverts au cours de la récolte des enregistrements. Ce service disparaît lorsque le processus de récolte est remaniée. Les services de données standard servira à créer la nouvelle ressource et retourner l'UID assigné par le collectory. La forme est:

GET https://collections.ala.org.au/lookup/generateDataResourceUid

Plus d'informations.