VicFlora GraphQL API
Documentation for the VicFlora GraphQL API
You'll find the GraphQL endpoint for VicFlora at https://vicflora.rbg.vic.gov.au/graphql.
This endpoint can be queried by GraphQL clients like GraphiQL and Altair, as well as general API platforms like Postman and Insomnia. The developer personally recommends the Altair GraphQL client extension for Chrome.
API Endpoints
https://vicflora.rbg.vic.gov.au/graphqlVersion
1.0.0
Queries
agent
Example
Query
query agent($id: ID!) {
agent(id: $id) {
id
name
lastName
firstName
initials
email
legalName
agentType
members {
...GroupPersonFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"agent": {
"id": 4,
"name": "abc123",
"lastName": "xyz789",
"firstName": "xyz789",
"initials": "abc123",
"email": Email,
"legalName": "xyz789",
"agentType": "PERSON",
"members": [GroupPerson]
}
}
}
agentAutocomplete
Example
Query
query agentAutocomplete($q: String!) {
agentAutocomplete(q: $q) {
id
name
lastName
firstName
initials
email
legalName
agentType
members {
...GroupPersonFragment
}
}
}
Variables
{"q": "xyz789"}
Response
{
"data": {
"agentAutocomplete": [
{
"id": "4",
"name": "xyz789",
"lastName": "xyz789",
"firstName": "xyz789",
"initials": "xyz789",
"email": Email,
"legalName": "xyz789",
"agentType": "PERSON",
"members": [GroupPerson]
}
]
}
}
agentTypes
Response
Returns [AgentType!]!
Example
Query
query agentTypes {
agentTypes {
id
name
uri
label
description
}
}
Response
{
"data": {
"agentTypes": [
{
"id": "4",
"name": "xyz789",
"uri": "abc123",
"label": "abc123",
"description": "abc123"
}
]
}
}
bioregion
Response
Returns a BioregionFeature
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query bioregion($id: ID!) {
bioregion(id: $id) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...BioregionPropertiesFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"bioregion": {
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": BioregionProperties
}
}
}
bioregionByName
Response
Returns a BioregionFeature
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query bioregionByName($name: String!) {
bioregionByName(name: $name) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...BioregionPropertiesFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"bioregionByName": {
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": BioregionProperties
}
}
}
bioregionBySlug
Response
Returns a BioregionFeature
Arguments
| Name | Description |
|---|---|
slug - String!
|
Example
Query
query bioregionBySlug($slug: String!) {
bioregionBySlug(slug: $slug) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...BioregionPropertiesFragment
}
}
}
Variables
{"slug": "xyz789"}
Response
{
"data": {
"bioregionBySlug": {
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": BioregionProperties
}
}
}
bioregionsByName
Response
Returns [BioregionFeature]
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query bioregionsByName($name: String!) {
bioregionsByName(name: $name) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...BioregionPropertiesFragment
}
}
}
Variables
{"name": "xyz789"}
Response
{
"data": {
"bioregionsByName": [
{
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": BioregionProperties
}
]
}
}
bioregionsByPoint
Response
Returns [BioregionFeature]
Example
Query
query bioregionsByPoint(
$latitude: Float!,
$longitude: Float!
) {
bioregionsByPoint(
latitude: $latitude,
longitude: $longitude
) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...BioregionPropertiesFragment
}
}
}
Variables
{"latitude": 987.65, "longitude": 987.65}
Response
{
"data": {
"bioregionsByPoint": [
{
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": BioregionProperties
}
]
}
}
bookAutocomplete
Response
Returns [Reference]
Arguments
| Name | Description |
|---|---|
q - String!
|
Example
Query
query bookAutocomplete($q: String!) {
bookAutocomplete(q: $q) {
id
quickRef
author {
...AgentFragment
}
referenceType
publicationYear
title
shortTitle
edition
volume
issue
pageStart
pageEnd
pages
numberOfPages
publisher
placeOfPublication
shortDescription
abstract
isbn
issn
doi
parent {
...ReferenceFragment
}
isPartOf {
...ReferenceFragment
}
journal {
...ReferenceFragment
}
book {
...ReferenceFragment
}
contributors {
...ContributorFragment
}
citation
referenceString
citationHtml
referenceStringHtml
citationMarkdown
referenceStringMarkdown
taxonNames {
...TaxonNameFragment
}
taxonConcepts {
...TaxonConceptReferenceFragment
}
}
}
Variables
{"q": "abc123"}
Response
{
"data": {
"bookAutocomplete": [
{
"id": "4",
"quickRef": "abc123",
"author": Agent,
"referenceType": "ARTICLE",
"publicationYear": "xyz789",
"title": "xyz789",
"shortTitle": "abc123",
"edition": "abc123",
"volume": "xyz789",
"issue": "xyz789",
"pageStart": 987,
"pageEnd": 123,
"pages": "abc123",
"numberOfPages": "abc123",
"publisher": "xyz789",
"placeOfPublication": "xyz789",
"shortDescription": "xyz789",
"abstract": "abc123",
"isbn": "abc123",
"issn": "abc123",
"doi": "xyz789",
"parent": Reference,
"isPartOf": Reference,
"journal": Reference,
"book": Reference,
"contributors": [Contributor],
"citation": "abc123",
"referenceString": "xyz789",
"citationHtml": "xyz789",
"referenceStringHtml": "abc123",
"citationMarkdown": "xyz789",
"referenceStringMarkdown": "abc123",
"taxonNames": [TaxonName],
"taxonConcepts": [TaxonConceptReference]
}
]
}
}
download
Response
Returns a Download
Arguments
| Name | Description |
|---|---|
input - DownloadInput
|
Example
Query
query download($input: DownloadInput) {
download(input: $input) {
data
}
}
Variables
{"input": DownloadInput}
Response
{"data": {"download": {"data": "xyz789"}}}
facetField
Response
Returns a SearchResultFacetField
Arguments
| Name | Description |
|---|---|
input - FieldFacetInput
|
Example
Query
query facetField($input: FieldFacetInput) {
facetField(input: $input) {
fieldName
fieldLabel
facets {
...SearchResultFacetFragment
}
}
}
Variables
{"input": FieldFacetInput}
Response
{
"data": {
"facetField": {
"fieldName": "xyz789",
"fieldLabel": "abc123",
"facets": [SearchResultFacet]
}
}
}
glossaryTerm
Response
Returns a GlossaryTerm
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query glossaryTerm($id: ID!) {
glossaryTerm(id: $id) {
id
name
definition
isDiscouraged
language
nameAddendum
relationships {
...GlossaryRelationshipFragment
}
inverseRelationships {
...GlossaryRelationshipFragment
}
images {
...GlossaryTermImageFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"glossaryTerm": {
"id": 4,
"name": "xyz789",
"definition": "abc123",
"isDiscouraged": false,
"language": "abc123",
"nameAddendum": "abc123",
"relationships": [GlossaryRelationship],
"inverseRelationships": [GlossaryRelationship],
"images": [GlossaryTermImage]
}
}
}
glossaryTermFirstLetters
Response
Returns [String!]!
Example
Query
query glossaryTermFirstLetters {
glossaryTermFirstLetters
}
Response
{
"data": {
"glossaryTermFirstLetters": ["abc123"]
}
}
glossaryTermsByName
Response
Returns [GlossaryTerm]
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query glossaryTermsByName($name: String!) {
glossaryTermsByName(name: $name) {
id
name
definition
isDiscouraged
language
nameAddendum
relationships {
...GlossaryRelationshipFragment
}
inverseRelationships {
...GlossaryRelationshipFragment
}
images {
...GlossaryTermImageFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"glossaryTermsByName": [
{
"id": "4",
"name": "xyz789",
"definition": "xyz789",
"isDiscouraged": true,
"language": "xyz789",
"nameAddendum": "xyz789",
"relationships": [GlossaryRelationship],
"inverseRelationships": [GlossaryRelationship],
"images": [GlossaryTermImage]
}
]
}
}
glossaryTermsInString
Response
Returns [GlossaryTermInString]
Arguments
| Name | Description |
|---|---|
string - String!
|
Example
Query
query glossaryTermsInString($string: String!) {
glossaryTermsInString(string: $string) {
substring
term {
...GlossaryTermFragment
}
}
}
Variables
{"string": "abc123"}
Response
{
"data": {
"glossaryTermsInString": [
{
"substring": "xyz789",
"term": GlossaryTerm
}
]
}
}
identificationKey
Response
Returns an IdentificationKey!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query identificationKey($id: ID!) {
identificationKey(id: $id) {
id
title
taxonomicScope
geographicScope
created
modified
}
}
Variables
{"id": "4"}
Response
{
"data": {
"identificationKey": {
"id": "4",
"title": "xyz789",
"taxonomicScope": "xyz789",
"geographicScope": "xyz789",
"created": "2007-12-03",
"modified": "2007-12-03"
}
}
}
indexFields
Response
Returns [IndexFields]
Example
Query
query indexFields {
indexFields {
name
type
indexed
stored
required
multiValued
}
}
Response
{
"data": {
"indexFields": [
{
"name": "abc123",
"type": "abc123",
"indexed": false,
"stored": false,
"required": true,
"multiValued": false
}
]
}
}
journalAutocomplete
Response
Returns [Reference]
Arguments
| Name | Description |
|---|---|
q - String!
|
Example
Query
query journalAutocomplete($q: String!) {
journalAutocomplete(q: $q) {
id
quickRef
author {
...AgentFragment
}
referenceType
publicationYear
title
shortTitle
edition
volume
issue
pageStart
pageEnd
pages
numberOfPages
publisher
placeOfPublication
shortDescription
abstract
isbn
issn
doi
parent {
...ReferenceFragment
}
isPartOf {
...ReferenceFragment
}
journal {
...ReferenceFragment
}
book {
...ReferenceFragment
}
contributors {
...ContributorFragment
}
citation
referenceString
citationHtml
referenceStringHtml
citationMarkdown
referenceStringMarkdown
taxonNames {
...TaxonNameFragment
}
taxonConcepts {
...TaxonConceptReferenceFragment
}
}
}
Variables
{"q": "xyz789"}
Response
{
"data": {
"journalAutocomplete": [
{
"id": "4",
"quickRef": "abc123",
"author": Agent,
"referenceType": "ARTICLE",
"publicationYear": "abc123",
"title": "abc123",
"shortTitle": "xyz789",
"edition": "abc123",
"volume": "xyz789",
"issue": "xyz789",
"pageStart": 987,
"pageEnd": 987,
"pages": "abc123",
"numberOfPages": "xyz789",
"publisher": "abc123",
"placeOfPublication": "xyz789",
"shortDescription": "abc123",
"abstract": "abc123",
"isbn": "abc123",
"issn": "xyz789",
"doi": "xyz789",
"parent": Reference,
"isPartOf": Reference,
"journal": Reference,
"book": Reference,
"contributors": [Contributor],
"citation": "xyz789",
"referenceString": "abc123",
"citationHtml": "xyz789",
"referenceStringHtml": "xyz789",
"citationMarkdown": "abc123",
"referenceStringMarkdown": "abc123",
"taxonNames": [TaxonName],
"taxonConcepts": [TaxonConceptReference]
}
]
}
}
localGovernmentArea
Response
Returns a LocalGovernmentAreaFeature
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query localGovernmentArea($id: ID!) {
localGovernmentArea(id: $id) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...LocalGovernmentAreaPropertiesFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"localGovernmentArea": {
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": LocalGovernmentAreaProperties
}
}
}
localGovernmentAreaByName
Response
Returns a LocalGovernmentAreaFeature
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query localGovernmentAreaByName($name: String!) {
localGovernmentAreaByName(name: $name) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...LocalGovernmentAreaPropertiesFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"localGovernmentAreaByName": {
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": LocalGovernmentAreaProperties
}
}
}
localGovernmentAreaBySlug
Response
Returns a LocalGovernmentAreaFeature
Arguments
| Name | Description |
|---|---|
slug - String!
|
Example
Query
query localGovernmentAreaBySlug($slug: String!) {
localGovernmentAreaBySlug(slug: $slug) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...LocalGovernmentAreaPropertiesFragment
}
}
}
Variables
{"slug": "abc123"}
Response
{
"data": {
"localGovernmentAreaBySlug": {
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": LocalGovernmentAreaProperties
}
}
}
localGovernmentAreasByName
Response
Returns [LocalGovernmentAreaFeature]
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query localGovernmentAreasByName($name: String!) {
localGovernmentAreasByName(name: $name) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...LocalGovernmentAreaPropertiesFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"localGovernmentAreasByName": [
{
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": LocalGovernmentAreaProperties
}
]
}
}
localGovernmentAreasByPoint
Response
Returns [LocalGovernmentAreaFeature]
Example
Query
query localGovernmentAreasByPoint(
$latitude: Float!,
$longitude: Float!
) {
localGovernmentAreasByPoint(
latitude: $latitude,
longitude: $longitude
) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...LocalGovernmentAreaPropertiesFragment
}
}
}
Variables
{"latitude": 987.65, "longitude": 987.65}
Response
{
"data": {
"localGovernmentAreasByPoint": [
{
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": LocalGovernmentAreaProperties
}
]
}
}
matrixKey
Example
Query
query matrixKey($path: String!) {
matrixKey(path: $path) {
id
title
relativePath
taxonConcepts {
...TaxonConceptFragment
}
}
}
Variables
{"path": "abc123"}
Response
{
"data": {
"matrixKey": {
"id": "4",
"title": "abc123",
"relativePath": "xyz789",
"taxonConcepts": [TaxonConcept]
}
}
}
multiAccessKey
Response
Returns a MultiAccessKey!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query multiAccessKey($id: ID!) {
multiAccessKey(id: $id) {
id
title
description
location
characterGroups {
...MultiAccessKeyCharacterFragment
}
characters {
...MultiAccessKeyCharacterFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"multiAccessKey": {
"id": 4,
"title": "abc123",
"description": "xyz789",
"location": "abc123",
"characterGroups": [MultiAccessKeyCharacter],
"characters": [MultiAccessKeyCharacter]
}
}
}
multiAccessKeyCharacter
Response
Returns a MultiAccessKeyCharacter!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query multiAccessKeyCharacter($id: ID!) {
multiAccessKeyCharacter(id: $id) {
id
name
type
characterType
description
parent {
...MultiAccessKeyCharacterFragment
}
children {
...MultiAccessKeyCharacterFragment
}
key {
...MultiAccessKeyFragment
}
states {
...MultiAccessKeyStateFragment
}
unit {
...MultiAccessKeyCharacterFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"multiAccessKeyCharacter": {
"id": "4",
"name": "xyz789",
"type": 123,
"characterType": "ORDERED",
"description": "xyz789",
"parent": MultiAccessKeyCharacter,
"children": [MultiAccessKeyCharacter],
"key": MultiAccessKey,
"states": [MultiAccessKeyState],
"unit": MultiAccessKeyCharacter
}
}
}
multiAccessKeys
Response
Returns [MultiAccessKey!]!
Example
Query
query multiAccessKeys {
multiAccessKeys {
id
title
description
location
characterGroups {
...MultiAccessKeyCharacterFragment
}
characters {
...MultiAccessKeyCharacterFragment
}
}
}
Response
{
"data": {
"multiAccessKeys": [
{
"id": 4,
"title": "xyz789",
"description": "xyz789",
"location": "abc123",
"characterGroups": [MultiAccessKeyCharacter],
"characters": [MultiAccessKeyCharacter]
}
]
}
}
nameTypeAhead
nameTypes
Response
Returns [NameType!]!
Example
Query
query nameTypes {
nameTypes {
id
name
uri
label
description
taxonNames {
...TaxonNameFragment
}
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
}
}
Response
{
"data": {
"nameTypes": [
{
"id": "4",
"name": "xyz789",
"uri": "xyz789",
"label": "xyz789",
"description": "abc123",
"taxonNames": [TaxonName],
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987
}
]
}
}
nomenclaturalStatuses
Response
Returns [NomenclaturalStatus!]!
Example
Query
query nomenclaturalStatuses {
nomenclaturalStatuses {
id
guid
name
uri
label
description
taxonNames {
...TaxonNameFragment
}
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
}
}
Response
{
"data": {
"nomenclaturalStatuses": [
{
"id": 4,
"guid": "f96ccca6-10f1-4749-a923-a38ede8ea0b6",
"name": "abc123",
"uri": "xyz789",
"label": "abc123",
"description": "xyz789",
"taxonNames": [TaxonName],
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123
}
]
}
}
occurrence
Response
Returns an OccurrenceFeature
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query occurrence($id: ID!) {
occurrence(id: $id) {
type
geometry {
...OccurrenceGeometryFragment
}
properties {
...OccurrencePropertiesFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"occurrence": {
"type": "xyz789",
"geometry": OccurrenceGeometry,
"properties": OccurrenceProperties
}
}
}
parkReserve
Response
Returns a ParkReserveFeature
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query parkReserve($id: ID!) {
parkReserve(id: $id) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...ParkReservePropertiesFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"parkReserve": {
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": ParkReserveProperties
}
}
}
parkReserveByName
Response
Returns a ParkReserveFeature
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query parkReserveByName($name: String!) {
parkReserveByName(name: $name) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...ParkReservePropertiesFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"parkReserveByName": {
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": ParkReserveProperties
}
}
}
parkReserveBySlug
Response
Returns a ParkReserveFeature
Arguments
| Name | Description |
|---|---|
slug - String!
|
Example
Query
query parkReserveBySlug($slug: String!) {
parkReserveBySlug(slug: $slug) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...ParkReservePropertiesFragment
}
}
}
Variables
{"slug": "xyz789"}
Response
{
"data": {
"parkReserveBySlug": {
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": ParkReserveProperties
}
}
}
parkReservesByName
Response
Returns [ParkReserveFeature]
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query parkReservesByName($name: String!) {
parkReservesByName(name: $name) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...ParkReservePropertiesFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"parkReservesByName": [
{
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": ParkReserveProperties
}
]
}
}
parkReservesByPoint
Response
Returns [ParkReserveFeature]
Example
Query
query parkReservesByPoint(
$latitude: Float!,
$longitude: Float!
) {
parkReservesByPoint(
latitude: $latitude,
longitude: $longitude
) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...ParkReservePropertiesFragment
}
}
}
Variables
{"latitude": 123.45, "longitude": 987.65}
Response
{
"data": {
"parkReservesByPoint": [
{
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": ParkReserveProperties
}
]
}
}
personAutocomplete
Example
Query
query personAutocomplete($q: String) {
personAutocomplete(q: $q) {
id
name
lastName
firstName
initials
email
legalName
agentType
members {
...GroupPersonFragment
}
}
}
Variables
{"q": "abc123"}
Response
{
"data": {
"personAutocomplete": [
{
"id": 4,
"name": "xyz789",
"lastName": "xyz789",
"firstName": "xyz789",
"initials": "xyz789",
"email": Email,
"legalName": "abc123",
"agentType": "PERSON",
"members": [GroupPerson]
}
]
}
}
reference
Example
Query
query reference($id: ID!) {
reference(id: $id) {
id
quickRef
author {
...AgentFragment
}
referenceType
publicationYear
title
shortTitle
edition
volume
issue
pageStart
pageEnd
pages
numberOfPages
publisher
placeOfPublication
shortDescription
abstract
isbn
issn
doi
parent {
...ReferenceFragment
}
isPartOf {
...ReferenceFragment
}
journal {
...ReferenceFragment
}
book {
...ReferenceFragment
}
contributors {
...ContributorFragment
}
citation
referenceString
citationHtml
referenceStringHtml
citationMarkdown
referenceStringMarkdown
taxonNames {
...TaxonNameFragment
}
taxonConcepts {
...TaxonConceptReferenceFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"reference": {
"id": "4",
"quickRef": "abc123",
"author": Agent,
"referenceType": "ARTICLE",
"publicationYear": "abc123",
"title": "abc123",
"shortTitle": "xyz789",
"edition": "abc123",
"volume": "xyz789",
"issue": "xyz789",
"pageStart": 987,
"pageEnd": 987,
"pages": "abc123",
"numberOfPages": "xyz789",
"publisher": "abc123",
"placeOfPublication": "abc123",
"shortDescription": "abc123",
"abstract": "abc123",
"isbn": "xyz789",
"issn": "abc123",
"doi": "abc123",
"parent": Reference,
"isPartOf": Reference,
"journal": Reference,
"book": Reference,
"contributors": [Contributor],
"citation": "abc123",
"referenceString": "xyz789",
"citationHtml": "xyz789",
"referenceStringHtml": "abc123",
"citationMarkdown": "abc123",
"referenceStringMarkdown": "abc123",
"taxonNames": [TaxonName],
"taxonConcepts": [TaxonConceptReference]
}
}
}
referenceAutocomplete
Response
Returns [Reference]
Arguments
| Name | Description |
|---|---|
q - String!
|
Example
Query
query referenceAutocomplete($q: String!) {
referenceAutocomplete(q: $q) {
id
quickRef
author {
...AgentFragment
}
referenceType
publicationYear
title
shortTitle
edition
volume
issue
pageStart
pageEnd
pages
numberOfPages
publisher
placeOfPublication
shortDescription
abstract
isbn
issn
doi
parent {
...ReferenceFragment
}
isPartOf {
...ReferenceFragment
}
journal {
...ReferenceFragment
}
book {
...ReferenceFragment
}
contributors {
...ContributorFragment
}
citation
referenceString
citationHtml
referenceStringHtml
citationMarkdown
referenceStringMarkdown
taxonNames {
...TaxonNameFragment
}
taxonConcepts {
...TaxonConceptReferenceFragment
}
}
}
Variables
{"q": "abc123"}
Response
{
"data": {
"referenceAutocomplete": [
{
"id": 4,
"quickRef": "abc123",
"author": Agent,
"referenceType": "ARTICLE",
"publicationYear": "xyz789",
"title": "xyz789",
"shortTitle": "xyz789",
"edition": "abc123",
"volume": "xyz789",
"issue": "abc123",
"pageStart": 123,
"pageEnd": 987,
"pages": "abc123",
"numberOfPages": "abc123",
"publisher": "abc123",
"placeOfPublication": "abc123",
"shortDescription": "abc123",
"abstract": "abc123",
"isbn": "xyz789",
"issn": "xyz789",
"doi": "xyz789",
"parent": Reference,
"isPartOf": Reference,
"journal": Reference,
"book": Reference,
"contributors": [Contributor],
"citation": "xyz789",
"referenceString": "xyz789",
"citationHtml": "abc123",
"referenceStringHtml": "xyz789",
"citationMarkdown": "xyz789",
"referenceStringMarkdown": "abc123",
"taxonNames": [TaxonName],
"taxonConcepts": [TaxonConceptReference]
}
]
}
}
referenceTypes
Response
Returns [ReferenceType!]!
Example
Query
query referenceTypes {
referenceTypes {
id
name
uri
label
description
}
}
Response
{
"data": {
"referenceTypes": [
{
"id": 4,
"name": "abc123",
"uri": "xyz789",
"label": "abc123",
"description": "xyz789"
}
]
}
}
registeredAboriginalPartiesByName
Response
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query registeredAboriginalPartiesByName($name: String!) {
registeredAboriginalPartiesByName(name: $name) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...RegisteredAboriginalPartyPropertiesFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"registeredAboriginalPartiesByName": [
{
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": RegisteredAboriginalPartyProperties
}
]
}
}
registeredAboriginalPartiesByPoint
Response
Example
Query
query registeredAboriginalPartiesByPoint(
$latitude: Float!,
$longitude: Float!
) {
registeredAboriginalPartiesByPoint(
latitude: $latitude,
longitude: $longitude
) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...RegisteredAboriginalPartyPropertiesFragment
}
}
}
Variables
{"latitude": 987.65, "longitude": 123.45}
Response
{
"data": {
"registeredAboriginalPartiesByPoint": [
{
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": RegisteredAboriginalPartyProperties
}
]
}
}
registeredAboriginalPartiesByTraditionalOwners
Response
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query registeredAboriginalPartiesByTraditionalOwners($name: String!) {
registeredAboriginalPartiesByTraditionalOwners(name: $name) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...RegisteredAboriginalPartyPropertiesFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"registeredAboriginalPartiesByTraditionalOwners": [
{
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": RegisteredAboriginalPartyProperties
}
]
}
}
registeredAboriginalParty
Response
Returns a RegisteredAboriginalPartyFeature
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query registeredAboriginalParty($id: ID!) {
registeredAboriginalParty(id: $id) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...RegisteredAboriginalPartyPropertiesFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"registeredAboriginalParty": {
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": RegisteredAboriginalPartyProperties
}
}
}
registeredAboriginalPartyByName
Response
Returns a RegisteredAboriginalPartyFeature
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query registeredAboriginalPartyByName($name: String!) {
registeredAboriginalPartyByName(name: $name) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...RegisteredAboriginalPartyPropertiesFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"registeredAboriginalPartyByName": {
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": RegisteredAboriginalPartyProperties
}
}
}
registeredAboriginalPartyBySlug
Response
Returns a RegisteredAboriginalPartyFeature
Arguments
| Name | Description |
|---|---|
slug - String!
|
Example
Query
query registeredAboriginalPartyBySlug($slug: String!) {
registeredAboriginalPartyBySlug(slug: $slug) {
type
geometry {
...GeoJSONGeometryFragment
}
properties {
...RegisteredAboriginalPartyPropertiesFragment
}
}
}
Variables
{"slug": "abc123"}
Response
{
"data": {
"registeredAboriginalPartyBySlug": {
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": RegisteredAboriginalPartyProperties
}
}
}
search
Response
Returns a SearchResult
Arguments
| Name | Description |
|---|---|
input - SearchInput
|
Example
Query
query search($input: SearchInput) {
search(input: $input) {
meta {
...SearchMetadataFragment
}
docs {
...SearchResultDocumentFragment
}
facetFields {
...SearchResultFacetFieldFragment
}
}
}
Variables
{"input": SearchInput}
Response
{
"data": {
"search": {
"meta": SearchMetadata,
"docs": [SearchResultDocument],
"facetFields": [SearchResultFacetField]
}
}
}
taxonConcept
Response
Returns a TaxonConcept
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query taxonConcept($id: ID!) {
taxonConcept(id: $id) {
id
remarks
taxonName {
...TaxonNameFragment
}
accordingTo {
...ReferenceFragment
}
acceptedConcept {
...TaxonConceptFragment
}
parent {
...TaxonConceptFragment
}
children {
...TaxonConceptFragment
}
siblings {
...TaxonConceptFragment
}
ancestors {
...TaxonConceptFragment
}
descendants {
...TaxonConceptFragment
}
higherClassification {
...TaxonConceptFragment
}
taxonRank
taxonTreeDefItem {
...TaxonTreeDefItemFragment
}
taxonomicStatus
occurrenceStatus
establishmentMeans
degreeOfEstablishment
endemic
hasIntroducedOccurrences
epbc
ffg
vernacularNames {
...VernacularNameFragment
}
preferredVernacularName {
...VernacularNameFragment
}
profiles {
...ProfileFragment
}
currentProfile {
...CurrentProfileFragment
}
heroImage {
...ImageFragment
}
hasImages
hasSpecimenImages
bioregions {
...TaxonBioregionFragment
}
localGovernmentAreas {
...TaxonLocalGovernmentAreaFragment
}
parkReserves {
...TaxonParkReserveFragment
}
phenology {
...PhenologyItemFragment
}
hasReproductiveStructures
mapLinks {
...MapLinksFragment
}
identificationKeys {
...IdentificationKeyFragment
}
matrixKeys {
...MatrixKeyFragment
}
synonyms {
...TaxonNameFragment
}
synonymUsages {
...TaxonConceptFragment
}
misapplications {
...TaxonConceptFragment
}
references {
...TaxonConceptReferenceFragment
}
floraLinks {
...TaxonConceptFloraLinkFragment
}
changes {
...ChangeFragment
}
publicationStatus
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
images {
...ImagePaginatorFragment
}
specimenImages {
...SpecimenImagePaginatorFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"taxonConcept": {
"id": 4,
"remarks": "xyz789",
"taxonName": TaxonName,
"accordingTo": Reference,
"acceptedConcept": TaxonConcept,
"parent": TaxonConcept,
"children": [TaxonConcept],
"siblings": [TaxonConcept],
"ancestors": [TaxonConcept],
"descendants": [TaxonConcept],
"higherClassification": [TaxonConcept],
"taxonRank": "LIFE",
"taxonTreeDefItem": TaxonTreeDefItem,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": false,
"hasIntroducedOccurrences": true,
"epbc": "EX",
"ffg": "EX",
"vernacularNames": [VernacularName],
"preferredVernacularName": VernacularName,
"profiles": [Profile],
"currentProfile": CurrentProfile,
"heroImage": Image,
"hasImages": true,
"hasSpecimenImages": false,
"bioregions": [TaxonBioregion],
"localGovernmentAreas": [TaxonLocalGovernmentArea],
"parkReserves": [TaxonParkReserve],
"phenology": [PhenologyItem],
"hasReproductiveStructures": true,
"mapLinks": MapLinks,
"identificationKeys": [IdentificationKey],
"matrixKeys": [MatrixKey],
"synonyms": [TaxonName],
"synonymUsages": [TaxonConcept],
"misapplications": [TaxonConcept],
"references": [TaxonConceptReference],
"floraLinks": [TaxonConceptFloraLink],
"changes": [Change],
"publicationStatus": "DRAFT",
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123,
"images": ImagePaginator,
"specimenImages": SpecimenImagePaginator
}
}
}
taxonConceptAutocomplete
Response
Returns [TaxonConcept]
Arguments
| Name | Description |
|---|---|
q - String!
|
Example
Query
query taxonConceptAutocomplete($q: String!) {
taxonConceptAutocomplete(q: $q) {
id
remarks
taxonName {
...TaxonNameFragment
}
accordingTo {
...ReferenceFragment
}
acceptedConcept {
...TaxonConceptFragment
}
parent {
...TaxonConceptFragment
}
children {
...TaxonConceptFragment
}
siblings {
...TaxonConceptFragment
}
ancestors {
...TaxonConceptFragment
}
descendants {
...TaxonConceptFragment
}
higherClassification {
...TaxonConceptFragment
}
taxonRank
taxonTreeDefItem {
...TaxonTreeDefItemFragment
}
taxonomicStatus
occurrenceStatus
establishmentMeans
degreeOfEstablishment
endemic
hasIntroducedOccurrences
epbc
ffg
vernacularNames {
...VernacularNameFragment
}
preferredVernacularName {
...VernacularNameFragment
}
profiles {
...ProfileFragment
}
currentProfile {
...CurrentProfileFragment
}
heroImage {
...ImageFragment
}
hasImages
hasSpecimenImages
bioregions {
...TaxonBioregionFragment
}
localGovernmentAreas {
...TaxonLocalGovernmentAreaFragment
}
parkReserves {
...TaxonParkReserveFragment
}
phenology {
...PhenologyItemFragment
}
hasReproductiveStructures
mapLinks {
...MapLinksFragment
}
identificationKeys {
...IdentificationKeyFragment
}
matrixKeys {
...MatrixKeyFragment
}
synonyms {
...TaxonNameFragment
}
synonymUsages {
...TaxonConceptFragment
}
misapplications {
...TaxonConceptFragment
}
references {
...TaxonConceptReferenceFragment
}
floraLinks {
...TaxonConceptFloraLinkFragment
}
changes {
...ChangeFragment
}
publicationStatus
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
images {
...ImagePaginatorFragment
}
specimenImages {
...SpecimenImagePaginatorFragment
}
}
}
Variables
{"q": "xyz789"}
Response
{
"data": {
"taxonConceptAutocomplete": [
{
"id": 4,
"remarks": "abc123",
"taxonName": TaxonName,
"accordingTo": Reference,
"acceptedConcept": TaxonConcept,
"parent": TaxonConcept,
"children": [TaxonConcept],
"siblings": [TaxonConcept],
"ancestors": [TaxonConcept],
"descendants": [TaxonConcept],
"higherClassification": [TaxonConcept],
"taxonRank": "LIFE",
"taxonTreeDefItem": TaxonTreeDefItem,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": false,
"hasIntroducedOccurrences": false,
"epbc": "EX",
"ffg": "EX",
"vernacularNames": [VernacularName],
"preferredVernacularName": VernacularName,
"profiles": [Profile],
"currentProfile": CurrentProfile,
"heroImage": Image,
"hasImages": false,
"hasSpecimenImages": true,
"bioregions": [TaxonBioregion],
"localGovernmentAreas": [
TaxonLocalGovernmentArea
],
"parkReserves": [TaxonParkReserve],
"phenology": [PhenologyItem],
"hasReproductiveStructures": false,
"mapLinks": MapLinks,
"identificationKeys": [IdentificationKey],
"matrixKeys": [MatrixKey],
"synonyms": [TaxonName],
"synonymUsages": [TaxonConcept],
"misapplications": [TaxonConcept],
"references": [TaxonConceptReference],
"floraLinks": [TaxonConceptFloraLink],
"changes": [Change],
"publicationStatus": "DRAFT",
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123,
"images": ImagePaginator,
"specimenImages": SpecimenImagePaginator
}
]
}
}
taxonConceptBioregions
Response
Returns [TaxonBioregion]
Arguments
| Name | Description |
|---|---|
taxonConceptId - ID!
|
Example
Query
query taxonConceptBioregions($taxonConceptId: ID!) {
taxonConceptBioregions(taxonConceptId: $taxonConceptId) {
id
taxonConcept {
...TaxonConceptFragment
}
bioregion {
...BioregionFeatureFragment
}
occurrenceStatus
establishmentMeans
bioregionName
bioregionCode
}
}
Variables
{"taxonConceptId": 4}
Response
{
"data": {
"taxonConceptBioregions": [
{
"id": 4,
"taxonConcept": TaxonConcept,
"bioregion": BioregionFeature,
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"bioregionName": "abc123",
"bioregionCode": "abc123"
}
]
}
}
taxonConceptChildren
Description
Get children of a TaxonConcept
Response
Returns [TaxonConcept]
Arguments
| Name | Description |
|---|---|
taxonConceptId - ID!
|
Example
Query
query taxonConceptChildren($taxonConceptId: ID!) {
taxonConceptChildren(taxonConceptId: $taxonConceptId) {
id
remarks
taxonName {
...TaxonNameFragment
}
accordingTo {
...ReferenceFragment
}
acceptedConcept {
...TaxonConceptFragment
}
parent {
...TaxonConceptFragment
}
children {
...TaxonConceptFragment
}
siblings {
...TaxonConceptFragment
}
ancestors {
...TaxonConceptFragment
}
descendants {
...TaxonConceptFragment
}
higherClassification {
...TaxonConceptFragment
}
taxonRank
taxonTreeDefItem {
...TaxonTreeDefItemFragment
}
taxonomicStatus
occurrenceStatus
establishmentMeans
degreeOfEstablishment
endemic
hasIntroducedOccurrences
epbc
ffg
vernacularNames {
...VernacularNameFragment
}
preferredVernacularName {
...VernacularNameFragment
}
profiles {
...ProfileFragment
}
currentProfile {
...CurrentProfileFragment
}
heroImage {
...ImageFragment
}
hasImages
hasSpecimenImages
bioregions {
...TaxonBioregionFragment
}
localGovernmentAreas {
...TaxonLocalGovernmentAreaFragment
}
parkReserves {
...TaxonParkReserveFragment
}
phenology {
...PhenologyItemFragment
}
hasReproductiveStructures
mapLinks {
...MapLinksFragment
}
identificationKeys {
...IdentificationKeyFragment
}
matrixKeys {
...MatrixKeyFragment
}
synonyms {
...TaxonNameFragment
}
synonymUsages {
...TaxonConceptFragment
}
misapplications {
...TaxonConceptFragment
}
references {
...TaxonConceptReferenceFragment
}
floraLinks {
...TaxonConceptFloraLinkFragment
}
changes {
...ChangeFragment
}
publicationStatus
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
images {
...ImagePaginatorFragment
}
specimenImages {
...SpecimenImagePaginatorFragment
}
}
}
Variables
{"taxonConceptId": 4}
Response
{
"data": {
"taxonConceptChildren": [
{
"id": 4,
"remarks": "abc123",
"taxonName": TaxonName,
"accordingTo": Reference,
"acceptedConcept": TaxonConcept,
"parent": TaxonConcept,
"children": [TaxonConcept],
"siblings": [TaxonConcept],
"ancestors": [TaxonConcept],
"descendants": [TaxonConcept],
"higherClassification": [TaxonConcept],
"taxonRank": "LIFE",
"taxonTreeDefItem": TaxonTreeDefItem,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": false,
"hasIntroducedOccurrences": false,
"epbc": "EX",
"ffg": "EX",
"vernacularNames": [VernacularName],
"preferredVernacularName": VernacularName,
"profiles": [Profile],
"currentProfile": CurrentProfile,
"heroImage": Image,
"hasImages": true,
"hasSpecimenImages": false,
"bioregions": [TaxonBioregion],
"localGovernmentAreas": [
TaxonLocalGovernmentArea
],
"parkReserves": [TaxonParkReserve],
"phenology": [PhenologyItem],
"hasReproductiveStructures": false,
"mapLinks": MapLinks,
"identificationKeys": [IdentificationKey],
"matrixKeys": [MatrixKey],
"synonyms": [TaxonName],
"synonymUsages": [TaxonConcept],
"misapplications": [TaxonConcept],
"references": [TaxonConceptReference],
"floraLinks": [TaxonConceptFloraLink],
"changes": [Change],
"publicationStatus": "DRAFT",
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987,
"images": ImagePaginator,
"specimenImages": SpecimenImagePaginator
}
]
}
}
taxonConceptHigherClassifcation
Description
Get higher classification of a TaxonConcept
Response
Returns [TaxonConcept]
Arguments
| Name | Description |
|---|---|
taxonConceptId - ID!
|
Example
Query
query taxonConceptHigherClassifcation($taxonConceptId: ID!) {
taxonConceptHigherClassifcation(taxonConceptId: $taxonConceptId) {
id
remarks
taxonName {
...TaxonNameFragment
}
accordingTo {
...ReferenceFragment
}
acceptedConcept {
...TaxonConceptFragment
}
parent {
...TaxonConceptFragment
}
children {
...TaxonConceptFragment
}
siblings {
...TaxonConceptFragment
}
ancestors {
...TaxonConceptFragment
}
descendants {
...TaxonConceptFragment
}
higherClassification {
...TaxonConceptFragment
}
taxonRank
taxonTreeDefItem {
...TaxonTreeDefItemFragment
}
taxonomicStatus
occurrenceStatus
establishmentMeans
degreeOfEstablishment
endemic
hasIntroducedOccurrences
epbc
ffg
vernacularNames {
...VernacularNameFragment
}
preferredVernacularName {
...VernacularNameFragment
}
profiles {
...ProfileFragment
}
currentProfile {
...CurrentProfileFragment
}
heroImage {
...ImageFragment
}
hasImages
hasSpecimenImages
bioregions {
...TaxonBioregionFragment
}
localGovernmentAreas {
...TaxonLocalGovernmentAreaFragment
}
parkReserves {
...TaxonParkReserveFragment
}
phenology {
...PhenologyItemFragment
}
hasReproductiveStructures
mapLinks {
...MapLinksFragment
}
identificationKeys {
...IdentificationKeyFragment
}
matrixKeys {
...MatrixKeyFragment
}
synonyms {
...TaxonNameFragment
}
synonymUsages {
...TaxonConceptFragment
}
misapplications {
...TaxonConceptFragment
}
references {
...TaxonConceptReferenceFragment
}
floraLinks {
...TaxonConceptFloraLinkFragment
}
changes {
...ChangeFragment
}
publicationStatus
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
images {
...ImagePaginatorFragment
}
specimenImages {
...SpecimenImagePaginatorFragment
}
}
}
Variables
{"taxonConceptId": "4"}
Response
{
"data": {
"taxonConceptHigherClassifcation": [
{
"id": 4,
"remarks": "xyz789",
"taxonName": TaxonName,
"accordingTo": Reference,
"acceptedConcept": TaxonConcept,
"parent": TaxonConcept,
"children": [TaxonConcept],
"siblings": [TaxonConcept],
"ancestors": [TaxonConcept],
"descendants": [TaxonConcept],
"higherClassification": [TaxonConcept],
"taxonRank": "LIFE",
"taxonTreeDefItem": TaxonTreeDefItem,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": true,
"hasIntroducedOccurrences": false,
"epbc": "EX",
"ffg": "EX",
"vernacularNames": [VernacularName],
"preferredVernacularName": VernacularName,
"profiles": [Profile],
"currentProfile": CurrentProfile,
"heroImage": Image,
"hasImages": true,
"hasSpecimenImages": false,
"bioregions": [TaxonBioregion],
"localGovernmentAreas": [
TaxonLocalGovernmentArea
],
"parkReserves": [TaxonParkReserve],
"phenology": [PhenologyItem],
"hasReproductiveStructures": true,
"mapLinks": MapLinks,
"identificationKeys": [IdentificationKey],
"matrixKeys": [MatrixKey],
"synonyms": [TaxonName],
"synonymUsages": [TaxonConcept],
"misapplications": [TaxonConcept],
"references": [TaxonConceptReference],
"floraLinks": [TaxonConceptFloraLink],
"changes": [Change],
"publicationStatus": "DRAFT",
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987,
"images": ImagePaginator,
"specimenImages": SpecimenImagePaginator
}
]
}
}
taxonConceptImages
Response
Returns an ImagePaginator
Example
Query
query taxonConceptImages(
$taxonConceptId: ID!,
$first: Int,
$page: Int
) {
taxonConceptImages(
taxonConceptId: $taxonConceptId,
first: $first,
page: $page
) {
paginatorInfo {
...PaginatorInfoFragment
}
data {
...ImageFragment
}
}
}
Variables
{"taxonConceptId": 4, "first": 20, "page": 987}
Response
{
"data": {
"taxonConceptImages": {
"paginatorInfo": PaginatorInfo,
"data": [Image]
}
}
}
taxonConceptLocalGovernmentAreas
Response
Returns [TaxonLocalGovernmentArea]
Arguments
| Name | Description |
|---|---|
taxonConceptId - ID!
|
Example
Query
query taxonConceptLocalGovernmentAreas($taxonConceptId: ID!) {
taxonConceptLocalGovernmentAreas(taxonConceptId: $taxonConceptId) {
id
taxonConcept {
...TaxonConceptFragment
}
localGovernmentArea {
...LocalGovernmentAreaFeatureFragment
}
localGovernmentAreaName
localGovernmentAreaAbbreviatedName
occurrenceStatus
establishmentMeans
}
}
Variables
{"taxonConceptId": 4}
Response
{
"data": {
"taxonConceptLocalGovernmentAreas": [
{
"id": "4",
"taxonConcept": TaxonConcept,
"localGovernmentArea": LocalGovernmentAreaFeature,
"localGovernmentAreaName": "xyz789",
"localGovernmentAreaAbbreviatedName": "abc123",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE"
}
]
}
}
taxonConceptParkReserves
Response
Returns [TaxonParkReserve]
Arguments
| Name | Description |
|---|---|
taxonConceptId - ID!
|
Example
Query
query taxonConceptParkReserves($taxonConceptId: ID!) {
taxonConceptParkReserves(taxonConceptId: $taxonConceptId) {
id
taxonConcept {
...TaxonConceptFragment
}
parkReserve {
...ParkReserveFeatureFragment
}
parkReserveName
parkReserveShortName
parkReserveAreaType
occurrenceStatus
establishmentMeans
}
}
Variables
{"taxonConceptId": 4}
Response
{
"data": {
"taxonConceptParkReserves": [
{
"id": 4,
"taxonConcept": TaxonConcept,
"parkReserve": ParkReserveFeature,
"parkReserveName": "xyz789",
"parkReserveShortName": "xyz789",
"parkReserveAreaType": "xyz789",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE"
}
]
}
}
taxonConceptPhenology
Response
Returns [PhenologyItem]!
Arguments
| Name | Description |
|---|---|
taxonConceptId - ID!
|
Example
Query
query taxonConceptPhenology($taxonConceptId: ID!) {
taxonConceptPhenology(taxonConceptId: $taxonConceptId) {
taxonConceptId
month
total
buds
flowers
fruit
}
}
Variables
{"taxonConceptId": "4"}
Response
{
"data": {
"taxonConceptPhenology": [
{
"taxonConceptId": "xyz789",
"month": "JANUARY",
"total": 987,
"buds": 123,
"flowers": 123,
"fruit": 123
}
]
}
}
taxonConceptProfiles
Example
Query
query taxonConceptProfiles($taxonConceptId: ID!) {
taxonConceptProfiles(taxonConceptId: $taxonConceptId) {
id
guid
profile
taxonConcept {
...TaxonConceptFragment
}
acceptedConcept {
...TaxonConceptFragment
}
source {
...ReferenceFragment
}
creator {
...AgentFragment
}
updatedBy {
...AgentFragment
}
created
modified
createdAt
updatedAt
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
version
}
}
Variables
{"taxonConceptId": "4"}
Response
{
"data": {
"taxonConceptProfiles": [
{
"id": 4,
"guid": "f96ccca6-10f1-4749-a923-a38ede8ea0b6",
"profile": "xyz789",
"taxonConcept": TaxonConcept,
"acceptedConcept": TaxonConcept,
"source": Reference,
"creator": Agent,
"updatedBy": Agent,
"created": "2007-12-03",
"modified": "2007-12-03",
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"createdBy": Agent,
"modifiedBy": Agent,
"version": 123
}
]
}
}
taxonConceptRegisteredAboriginalParties
Response
Returns [TaxonRegisteredAboriginalParty]
Arguments
| Name | Description |
|---|---|
taxonConceptId - ID!
|
Example
Query
query taxonConceptRegisteredAboriginalParties($taxonConceptId: ID!) {
taxonConceptRegisteredAboriginalParties(taxonConceptId: $taxonConceptId) {
id
taxonConcept {
...TaxonConceptFragment
}
registeredAboriginalParty {
...RegisteredAboriginalPartyFeatureFragment
}
registeredAboriginalPartyName
registeredAnoriginalPartyShortName
registeredAnoriginalPartyTraditionalOwners
occurrenceStatus
establishmentMeans
}
}
Variables
{"taxonConceptId": 4}
Response
{
"data": {
"taxonConceptRegisteredAboriginalParties": [
{
"id": 4,
"taxonConcept": TaxonConcept,
"registeredAboriginalParty": RegisteredAboriginalPartyFeature,
"registeredAboriginalPartyName": "abc123",
"registeredAnoriginalPartyShortName": "xyz789",
"registeredAnoriginalPartyTraditionalOwners": "xyz789",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE"
}
]
}
}
taxonConceptSiblings
Description
Get siblings of a TaxonConcept
Response
Returns [TaxonConcept]
Arguments
| Name | Description |
|---|---|
taxonConceptId - ID!
|
Example
Query
query taxonConceptSiblings($taxonConceptId: ID!) {
taxonConceptSiblings(taxonConceptId: $taxonConceptId) {
id
remarks
taxonName {
...TaxonNameFragment
}
accordingTo {
...ReferenceFragment
}
acceptedConcept {
...TaxonConceptFragment
}
parent {
...TaxonConceptFragment
}
children {
...TaxonConceptFragment
}
siblings {
...TaxonConceptFragment
}
ancestors {
...TaxonConceptFragment
}
descendants {
...TaxonConceptFragment
}
higherClassification {
...TaxonConceptFragment
}
taxonRank
taxonTreeDefItem {
...TaxonTreeDefItemFragment
}
taxonomicStatus
occurrenceStatus
establishmentMeans
degreeOfEstablishment
endemic
hasIntroducedOccurrences
epbc
ffg
vernacularNames {
...VernacularNameFragment
}
preferredVernacularName {
...VernacularNameFragment
}
profiles {
...ProfileFragment
}
currentProfile {
...CurrentProfileFragment
}
heroImage {
...ImageFragment
}
hasImages
hasSpecimenImages
bioregions {
...TaxonBioregionFragment
}
localGovernmentAreas {
...TaxonLocalGovernmentAreaFragment
}
parkReserves {
...TaxonParkReserveFragment
}
phenology {
...PhenologyItemFragment
}
hasReproductiveStructures
mapLinks {
...MapLinksFragment
}
identificationKeys {
...IdentificationKeyFragment
}
matrixKeys {
...MatrixKeyFragment
}
synonyms {
...TaxonNameFragment
}
synonymUsages {
...TaxonConceptFragment
}
misapplications {
...TaxonConceptFragment
}
references {
...TaxonConceptReferenceFragment
}
floraLinks {
...TaxonConceptFloraLinkFragment
}
changes {
...ChangeFragment
}
publicationStatus
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
images {
...ImagePaginatorFragment
}
specimenImages {
...SpecimenImagePaginatorFragment
}
}
}
Variables
{"taxonConceptId": 4}
Response
{
"data": {
"taxonConceptSiblings": [
{
"id": 4,
"remarks": "xyz789",
"taxonName": TaxonName,
"accordingTo": Reference,
"acceptedConcept": TaxonConcept,
"parent": TaxonConcept,
"children": [TaxonConcept],
"siblings": [TaxonConcept],
"ancestors": [TaxonConcept],
"descendants": [TaxonConcept],
"higherClassification": [TaxonConcept],
"taxonRank": "LIFE",
"taxonTreeDefItem": TaxonTreeDefItem,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": false,
"hasIntroducedOccurrences": true,
"epbc": "EX",
"ffg": "EX",
"vernacularNames": [VernacularName],
"preferredVernacularName": VernacularName,
"profiles": [Profile],
"currentProfile": CurrentProfile,
"heroImage": Image,
"hasImages": false,
"hasSpecimenImages": true,
"bioregions": [TaxonBioregion],
"localGovernmentAreas": [
TaxonLocalGovernmentArea
],
"parkReserves": [TaxonParkReserve],
"phenology": [PhenologyItem],
"hasReproductiveStructures": true,
"mapLinks": MapLinks,
"identificationKeys": [IdentificationKey],
"matrixKeys": [MatrixKey],
"synonyms": [TaxonName],
"synonymUsages": [TaxonConcept],
"misapplications": [TaxonConcept],
"references": [TaxonConceptReference],
"floraLinks": [TaxonConceptFloraLink],
"changes": [Change],
"publicationStatus": "DRAFT",
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123,
"images": ImagePaginator,
"specimenImages": SpecimenImagePaginator
}
]
}
}
taxonConceptSpecimenImages
Response
Returns a SpecimenImagePaginator
Example
Query
query taxonConceptSpecimenImages(
$taxonConceptId: ID!,
$first: Int,
$page: Int
) {
taxonConceptSpecimenImages(
taxonConceptId: $taxonConceptId,
first: $first,
page: $page
) {
paginatorInfo {
...PaginatorInfoFragment
}
data {
...SpecimenImageFragment
}
}
}
Variables
{
"taxonConceptId": "4",
"first": 20,
"page": 987
}
Response
{
"data": {
"taxonConceptSpecimenImages": {
"paginatorInfo": PaginatorInfo,
"data": [SpecimenImage]
}
}
}
taxonConceptsByWkt
Response
Returns a TaxonConceptPaginator
Example
Query
query taxonConceptsByWkt(
$wkt: String!,
$first: Int,
$page: Int
) {
taxonConceptsByWkt(
wkt: $wkt,
first: $first,
page: $page
) {
paginatorInfo {
...PaginatorInfoFragment
}
data {
...TaxonConceptFragment
}
}
}
Variables
{"wkt": "abc123", "first": 20, "page": 987}
Response
{
"data": {
"taxonConceptsByWkt": {
"paginatorInfo": PaginatorInfo,
"data": [TaxonConcept]
}
}
}
taxonName
Example
Query
query taxonName($id: ID!) {
taxonName(id: $id) {
id
rank
parent {
...TaxonNameFragment
}
namePart
fullName
authorship
fullNameWithAuthorship
nomenclaturalNote
remarks
nameType
basionym {
...TaxonNameFragment
}
replacedSynonym {
...TaxonNameFragment
}
publishedIn {
...ReferenceFragment
}
protologue {
...ReferenceFragment
}
taxonConcepts {
...TaxonConceptFragment
}
apniName {
...ApniNameFragment
}
vbaTaxaListItem {
...VbaTaxaListItemFragment
}
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
}
}
Variables
{"id": "4"}
Response
{
"data": {
"taxonName": {
"id": 4,
"rank": "LIFE",
"parent": TaxonName,
"namePart": "xyz789",
"fullName": "xyz789",
"authorship": "abc123",
"fullNameWithAuthorship": "abc123",
"nomenclaturalNote": "abc123",
"remarks": "abc123",
"nameType": "SCIENTIFIC",
"basionym": TaxonName,
"replacedSynonym": TaxonName,
"publishedIn": Reference,
"protologue": Reference,
"taxonConcepts": [TaxonConcept],
"apniName": ApniName,
"vbaTaxaListItem": VbaTaxaListItem,
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123
}
}
}
taxonNameAutocomplete
Response
Returns [TaxonName]
Arguments
| Name | Description |
|---|---|
q - String!
|
Example
Query
query taxonNameAutocomplete($q: String!) {
taxonNameAutocomplete(q: $q) {
id
rank
parent {
...TaxonNameFragment
}
namePart
fullName
authorship
fullNameWithAuthorship
nomenclaturalNote
remarks
nameType
basionym {
...TaxonNameFragment
}
replacedSynonym {
...TaxonNameFragment
}
publishedIn {
...ReferenceFragment
}
protologue {
...ReferenceFragment
}
taxonConcepts {
...TaxonConceptFragment
}
apniName {
...ApniNameFragment
}
vbaTaxaListItem {
...VbaTaxaListItemFragment
}
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
}
}
Variables
{"q": "abc123"}
Response
{
"data": {
"taxonNameAutocomplete": [
{
"id": 4,
"rank": "LIFE",
"parent": TaxonName,
"namePart": "abc123",
"fullName": "abc123",
"authorship": "xyz789",
"fullNameWithAuthorship": "xyz789",
"nomenclaturalNote": "xyz789",
"remarks": "abc123",
"nameType": "SCIENTIFIC",
"basionym": TaxonName,
"replacedSynonym": TaxonName,
"publishedIn": Reference,
"protologue": Reference,
"taxonConcepts": [TaxonConcept],
"apniName": ApniName,
"vbaTaxaListItem": VbaTaxaListItem,
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123
}
]
}
}
taxonOccurrences
Response
Returns an OccurrenceFeaturePaginator
Example
Query
query taxonOccurrences(
$taxonConceptId: ID!,
$first: Int,
$page: Int
) {
taxonOccurrences(
taxonConceptId: $taxonConceptId,
first: $first,
page: $page
) {
paginatorInfo {
...PaginatorInfoFragment
}
data {
...OccurrenceFeatureFragment
}
}
}
Variables
{
"taxonConceptId": "4",
"first": 100,
"page": 123
}
Response
{
"data": {
"taxonOccurrences": {
"paginatorInfo": PaginatorInfo,
"data": [OccurrenceFeature]
}
}
}
taxonOccurrencesAtPoint
Response
Returns an OccurrenceFeaturePaginator
Example
Query
query taxonOccurrencesAtPoint(
$taxonConceptId: ID!,
$latitude: Float!,
$longitude: Float!,
$distance: Float,
$first: Int,
$page: Int
) {
taxonOccurrencesAtPoint(
taxonConceptId: $taxonConceptId,
latitude: $latitude,
longitude: $longitude,
distance: $distance,
first: $first,
page: $page
) {
paginatorInfo {
...PaginatorInfoFragment
}
data {
...OccurrenceFeatureFragment
}
}
}
Variables
{
"taxonConceptId": 4,
"latitude": 987.65,
"longitude": 123.45,
"distance": 0.02,
"first": 100,
"page": 987
}
Response
{
"data": {
"taxonOccurrencesAtPoint": {
"paginatorInfo": PaginatorInfo,
"data": [OccurrenceFeature]
}
}
}
vbaTaxaListItem
Response
Returns a VbaTaxaListItem
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query vbaTaxaListItem($id: ID!) {
vbaTaxaListItem(id: $id) {
id
scientificName
commonName
authority
restriction
origin
taxonType
lifeForm
nvisGrowthForm
fireResponse
treaty
discipline
taxonLevel
fisSpeciesNumber
recordModificationDate
versionDate
taxonName {
...TaxonNameFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"vbaTaxaListItem": {
"id": "4",
"scientificName": "xyz789",
"commonName": "xyz789",
"authority": "abc123",
"restriction": "xyz789",
"origin": "xyz789",
"taxonType": "xyz789",
"lifeForm": "xyz789",
"nvisGrowthForm": "abc123",
"fireResponse": "xyz789",
"treaty": "abc123",
"discipline": "abc123",
"taxonLevel": "xyz789",
"fisSpeciesNumber": 123,
"recordModificationDate": "2007-12-03",
"versionDate": "2007-12-03",
"taxonName": TaxonName
}
}
}
vbaTaxaListItems
Response
Returns a VbaTaxaListItemPaginator
Example
Query
query vbaTaxaListItems(
$first: Int,
$page: Int
) {
vbaTaxaListItems(
first: $first,
page: $page
) {
paginatorInfo {
...PaginatorInfoFragment
}
data {
...VbaTaxaListItemFragment
}
}
}
Variables
{"first": 20, "page": 987}
Response
{
"data": {
"vbaTaxaListItems": {
"paginatorInfo": PaginatorInfo,
"data": [VbaTaxaListItem]
}
}
}
vbaTaxaListItemsMatched
Response
Returns a VbaTaxaListItemPaginator
Example
Query
query vbaTaxaListItemsMatched(
$first: Int,
$page: Int
) {
vbaTaxaListItemsMatched(
first: $first,
page: $page
) {
paginatorInfo {
...PaginatorInfoFragment
}
data {
...VbaTaxaListItemFragment
}
}
}
Variables
{"first": 20, "page": 123}
Response
{
"data": {
"vbaTaxaListItemsMatched": {
"paginatorInfo": PaginatorInfo,
"data": [VbaTaxaListItem]
}
}
}
vbaTaxaListItemsUnmatched
Response
Returns a VbaTaxaListItemPaginator
Example
Query
query vbaTaxaListItemsUnmatched(
$first: Int,
$page: Int
) {
vbaTaxaListItemsUnmatched(
first: $first,
page: $page
) {
paginatorInfo {
...PaginatorInfoFragment
}
data {
...VbaTaxaListItemFragment
}
}
}
Variables
{"first": 20, "page": 123}
Response
{
"data": {
"vbaTaxaListItemsUnmatched": {
"paginatorInfo": PaginatorInfo,
"data": [VbaTaxaListItem]
}
}
}
Mutations
createAgent
Response
Returns an Agent
Arguments
| Name | Description |
|---|---|
input - CreateAgentInput!
|
Example
Query
mutation createAgent($input: CreateAgentInput!) {
createAgent(input: $input) {
id
name
lastName
firstName
initials
email
legalName
agentType
members {
...GroupPersonFragment
}
}
}
Variables
{"input": CreateAgentInput}
Response
{
"data": {
"createAgent": {
"id": "4",
"name": "xyz789",
"lastName": "xyz789",
"firstName": "abc123",
"initials": "abc123",
"email": Email,
"legalName": "xyz789",
"agentType": "PERSON",
"members": [GroupPerson]
}
}
}
createContributors
Response
Returns a Reference
Arguments
| Name | Description |
|---|---|
reference - ID!
|
|
contributors - [CreateContributorInput!]!
|
Example
Query
mutation createContributors(
$reference: ID!,
$contributors: [CreateContributorInput!]!
) {
createContributors(
reference: $reference,
contributors: $contributors
) {
id
quickRef
author {
...AgentFragment
}
referenceType
publicationYear
title
shortTitle
edition
volume
issue
pageStart
pageEnd
pages
numberOfPages
publisher
placeOfPublication
shortDescription
abstract
isbn
issn
doi
parent {
...ReferenceFragment
}
isPartOf {
...ReferenceFragment
}
journal {
...ReferenceFragment
}
book {
...ReferenceFragment
}
contributors {
...ContributorFragment
}
citation
referenceString
citationHtml
referenceStringHtml
citationMarkdown
referenceStringMarkdown
taxonNames {
...TaxonNameFragment
}
taxonConcepts {
...TaxonConceptReferenceFragment
}
}
}
Variables
{
"reference": "4",
"contributors": [CreateContributorInput]
}
Response
{
"data": {
"createContributors": {
"id": 4,
"quickRef": "abc123",
"author": Agent,
"referenceType": "ARTICLE",
"publicationYear": "xyz789",
"title": "abc123",
"shortTitle": "abc123",
"edition": "abc123",
"volume": "xyz789",
"issue": "xyz789",
"pageStart": 123,
"pageEnd": 987,
"pages": "abc123",
"numberOfPages": "abc123",
"publisher": "abc123",
"placeOfPublication": "xyz789",
"shortDescription": "xyz789",
"abstract": "xyz789",
"isbn": "abc123",
"issn": "abc123",
"doi": "xyz789",
"parent": Reference,
"isPartOf": Reference,
"journal": Reference,
"book": Reference,
"contributors": [Contributor],
"citation": "abc123",
"referenceString": "xyz789",
"citationHtml": "abc123",
"referenceStringHtml": "abc123",
"citationMarkdown": "abc123",
"referenceStringMarkdown": "abc123",
"taxonNames": [TaxonName],
"taxonConcepts": [TaxonConceptReference]
}
}
}
createGroupPerson
Response
Returns a GroupPerson!
Arguments
| Name | Description |
|---|---|
input - CreateGroupPersonInput!
|
Example
Query
mutation createGroupPerson($input: CreateGroupPersonInput!) {
createGroupPerson(input: $input) {
id
group {
...AgentFragment
}
member {
...AgentFragment
}
sequence
}
}
Variables
{"input": CreateGroupPersonInput}
Response
{
"data": {
"createGroupPerson": {
"id": 4,
"group": Agent,
"member": Agent,
"sequence": 987
}
}
}
createMultiAccessKey
Description
Create a new multi-access key record.
Response
Returns a MultiAccessKey!
Arguments
| Name | Description |
|---|---|
input - CreateMultiAccessKeyInput!
|
Example
Query
mutation createMultiAccessKey($input: CreateMultiAccessKeyInput!) {
createMultiAccessKey(input: $input) {
id
title
description
location
characterGroups {
...MultiAccessKeyCharacterFragment
}
characters {
...MultiAccessKeyCharacterFragment
}
}
}
Variables
{"input": CreateMultiAccessKeyInput}
Response
{
"data": {
"createMultiAccessKey": {
"id": "4",
"title": "abc123",
"description": "abc123",
"location": "xyz789",
"characterGroups": [MultiAccessKeyCharacter],
"characters": [MultiAccessKeyCharacter]
}
}
}
createMultiAccessKeyCharacter
Description
Create a new multi-access key feature.
Response
Returns a MultiAccessKeyCharacter!
Arguments
| Name | Description |
|---|---|
input - CreateMultiAccessKeyCharacterInput!
|
Example
Query
mutation createMultiAccessKeyCharacter($input: CreateMultiAccessKeyCharacterInput!) {
createMultiAccessKeyCharacter(input: $input) {
id
name
type
characterType
description
parent {
...MultiAccessKeyCharacterFragment
}
children {
...MultiAccessKeyCharacterFragment
}
key {
...MultiAccessKeyFragment
}
states {
...MultiAccessKeyStateFragment
}
unit {
...MultiAccessKeyCharacterFragment
}
}
}
Variables
{"input": CreateMultiAccessKeyCharacterInput}
Response
{
"data": {
"createMultiAccessKeyCharacter": {
"id": 4,
"name": "abc123",
"type": 987,
"characterType": "ORDERED",
"description": "abc123",
"parent": MultiAccessKeyCharacter,
"children": [MultiAccessKeyCharacter],
"key": MultiAccessKey,
"states": [MultiAccessKeyState],
"unit": MultiAccessKeyCharacter
}
}
}
createMultiAccessKeyState
Description
Create a multi-access key state record.
Response
Returns a MultiAccessKeyState!
Arguments
| Name | Description |
|---|---|
input - CreateMultiAccessKeyStateInput!
|
Example
Query
mutation createMultiAccessKeyState($input: CreateMultiAccessKeyStateInput!) {
createMultiAccessKeyState(input: $input) {
id
name
description
feature {
...MultiAccessKeyCharacterFragment
}
images {
...ImageFragment
}
}
}
Variables
{"input": CreateMultiAccessKeyStateInput}
Response
{
"data": {
"createMultiAccessKeyState": {
"id": "4",
"name": "abc123",
"description": "xyz789",
"feature": MultiAccessKeyCharacter,
"images": [Image]
}
}
}
createProfile
Response
Returns a Profile
Arguments
| Name | Description |
|---|---|
input - CreateProfileInput!
|
Example
Query
mutation createProfile($input: CreateProfileInput!) {
createProfile(input: $input) {
id
guid
profile
taxonConcept {
...TaxonConceptFragment
}
acceptedConcept {
...TaxonConceptFragment
}
source {
...ReferenceFragment
}
creator {
...AgentFragment
}
updatedBy {
...AgentFragment
}
created
modified
createdAt
updatedAt
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
version
}
}
Variables
{"input": CreateProfileInput}
Response
{
"data": {
"createProfile": {
"id": "4",
"guid": "f96ccca6-10f1-4749-a923-a38ede8ea0b6",
"profile": "abc123",
"taxonConcept": TaxonConcept,
"acceptedConcept": TaxonConcept,
"source": Reference,
"creator": Agent,
"updatedBy": Agent,
"created": "2007-12-03",
"modified": "2007-12-03",
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"createdBy": Agent,
"modifiedBy": Agent,
"version": 987
}
}
}
createReference
Response
Returns a Reference
Arguments
| Name | Description |
|---|---|
input - CreateReferenceInput!
|
Example
Query
mutation createReference($input: CreateReferenceInput!) {
createReference(input: $input) {
id
quickRef
author {
...AgentFragment
}
referenceType
publicationYear
title
shortTitle
edition
volume
issue
pageStart
pageEnd
pages
numberOfPages
publisher
placeOfPublication
shortDescription
abstract
isbn
issn
doi
parent {
...ReferenceFragment
}
isPartOf {
...ReferenceFragment
}
journal {
...ReferenceFragment
}
book {
...ReferenceFragment
}
contributors {
...ContributorFragment
}
citation
referenceString
citationHtml
referenceStringHtml
citationMarkdown
referenceStringMarkdown
taxonNames {
...TaxonNameFragment
}
taxonConcepts {
...TaxonConceptReferenceFragment
}
}
}
Variables
{"input": CreateReferenceInput}
Response
{
"data": {
"createReference": {
"id": 4,
"quickRef": "abc123",
"author": Agent,
"referenceType": "ARTICLE",
"publicationYear": "abc123",
"title": "abc123",
"shortTitle": "abc123",
"edition": "abc123",
"volume": "xyz789",
"issue": "abc123",
"pageStart": 987,
"pageEnd": 987,
"pages": "xyz789",
"numberOfPages": "abc123",
"publisher": "xyz789",
"placeOfPublication": "xyz789",
"shortDescription": "abc123",
"abstract": "xyz789",
"isbn": "xyz789",
"issn": "abc123",
"doi": "xyz789",
"parent": Reference,
"isPartOf": Reference,
"journal": Reference,
"book": Reference,
"contributors": [Contributor],
"citation": "xyz789",
"referenceString": "xyz789",
"citationHtml": "abc123",
"referenceStringHtml": "xyz789",
"citationMarkdown": "xyz789",
"referenceStringMarkdown": "xyz789",
"taxonNames": [TaxonName],
"taxonConcepts": [TaxonConceptReference]
}
}
}
createTaxonConcept
Response
Returns a TaxonConcept
Arguments
| Name | Description |
|---|---|
input - CreateTaxonConceptInput!
|
Example
Query
mutation createTaxonConcept($input: CreateTaxonConceptInput!) {
createTaxonConcept(input: $input) {
id
remarks
taxonName {
...TaxonNameFragment
}
accordingTo {
...ReferenceFragment
}
acceptedConcept {
...TaxonConceptFragment
}
parent {
...TaxonConceptFragment
}
children {
...TaxonConceptFragment
}
siblings {
...TaxonConceptFragment
}
ancestors {
...TaxonConceptFragment
}
descendants {
...TaxonConceptFragment
}
higherClassification {
...TaxonConceptFragment
}
taxonRank
taxonTreeDefItem {
...TaxonTreeDefItemFragment
}
taxonomicStatus
occurrenceStatus
establishmentMeans
degreeOfEstablishment
endemic
hasIntroducedOccurrences
epbc
ffg
vernacularNames {
...VernacularNameFragment
}
preferredVernacularName {
...VernacularNameFragment
}
profiles {
...ProfileFragment
}
currentProfile {
...CurrentProfileFragment
}
heroImage {
...ImageFragment
}
hasImages
hasSpecimenImages
bioregions {
...TaxonBioregionFragment
}
localGovernmentAreas {
...TaxonLocalGovernmentAreaFragment
}
parkReserves {
...TaxonParkReserveFragment
}
phenology {
...PhenologyItemFragment
}
hasReproductiveStructures
mapLinks {
...MapLinksFragment
}
identificationKeys {
...IdentificationKeyFragment
}
matrixKeys {
...MatrixKeyFragment
}
synonyms {
...TaxonNameFragment
}
synonymUsages {
...TaxonConceptFragment
}
misapplications {
...TaxonConceptFragment
}
references {
...TaxonConceptReferenceFragment
}
floraLinks {
...TaxonConceptFloraLinkFragment
}
changes {
...ChangeFragment
}
publicationStatus
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
images {
...ImagePaginatorFragment
}
specimenImages {
...SpecimenImagePaginatorFragment
}
}
}
Variables
{"input": CreateTaxonConceptInput}
Response
{
"data": {
"createTaxonConcept": {
"id": "4",
"remarks": "abc123",
"taxonName": TaxonName,
"accordingTo": Reference,
"acceptedConcept": TaxonConcept,
"parent": TaxonConcept,
"children": [TaxonConcept],
"siblings": [TaxonConcept],
"ancestors": [TaxonConcept],
"descendants": [TaxonConcept],
"higherClassification": [TaxonConcept],
"taxonRank": "LIFE",
"taxonTreeDefItem": TaxonTreeDefItem,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": true,
"hasIntroducedOccurrences": true,
"epbc": "EX",
"ffg": "EX",
"vernacularNames": [VernacularName],
"preferredVernacularName": VernacularName,
"profiles": [Profile],
"currentProfile": CurrentProfile,
"heroImage": Image,
"hasImages": true,
"hasSpecimenImages": true,
"bioregions": [TaxonBioregion],
"localGovernmentAreas": [TaxonLocalGovernmentArea],
"parkReserves": [TaxonParkReserve],
"phenology": [PhenologyItem],
"hasReproductiveStructures": true,
"mapLinks": MapLinks,
"identificationKeys": [IdentificationKey],
"matrixKeys": [MatrixKey],
"synonyms": [TaxonName],
"synonymUsages": [TaxonConcept],
"misapplications": [TaxonConcept],
"references": [TaxonConceptReference],
"floraLinks": [TaxonConceptFloraLink],
"changes": [Change],
"publicationStatus": "DRAFT",
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123,
"images": ImagePaginator,
"specimenImages": SpecimenImagePaginator
}
}
}
createTaxonConceptReference
Response
Returns a TaxonConceptReference
Arguments
| Name | Description |
|---|---|
input - CreateTaxonConceptReferenceInput!
|
Example
Query
mutation createTaxonConceptReference($input: CreateTaxonConceptReferenceInput!) {
createTaxonConceptReference(input: $input) {
id
taxonConcept {
...TaxonConceptFragment
}
reference {
...ReferenceFragment
}
createdAt
updatedAt
createdBy {
...AgentFragment
}
updatedBy {
...AgentFragment
}
}
}
Variables
{"input": CreateTaxonConceptReferenceInput}
Response
{
"data": {
"createTaxonConceptReference": {
"id": "4",
"taxonConcept": TaxonConcept,
"reference": Reference,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"createdBy": Agent,
"updatedBy": Agent
}
}
}
createTaxonName
Response
Returns a TaxonName
Arguments
| Name | Description |
|---|---|
input - CreateTaxonNameInput!
|
Example
Query
mutation createTaxonName($input: CreateTaxonNameInput!) {
createTaxonName(input: $input) {
id
rank
parent {
...TaxonNameFragment
}
namePart
fullName
authorship
fullNameWithAuthorship
nomenclaturalNote
remarks
nameType
basionym {
...TaxonNameFragment
}
replacedSynonym {
...TaxonNameFragment
}
publishedIn {
...ReferenceFragment
}
protologue {
...ReferenceFragment
}
taxonConcepts {
...TaxonConceptFragment
}
apniName {
...ApniNameFragment
}
vbaTaxaListItem {
...VbaTaxaListItemFragment
}
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
}
}
Variables
{"input": CreateTaxonNameInput}
Response
{
"data": {
"createTaxonName": {
"id": "4",
"rank": "LIFE",
"parent": TaxonName,
"namePart": "xyz789",
"fullName": "xyz789",
"authorship": "xyz789",
"fullNameWithAuthorship": "xyz789",
"nomenclaturalNote": "xyz789",
"remarks": "abc123",
"nameType": "SCIENTIFIC",
"basionym": TaxonName,
"replacedSynonym": TaxonName,
"publishedIn": Reference,
"protologue": Reference,
"taxonConcepts": [TaxonConcept],
"apniName": ApniName,
"vbaTaxaListItem": VbaTaxaListItem,
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987
}
}
}
createUserPreferences
Response
Returns a UserPreferences!
Arguments
| Name | Description |
|---|---|
input - CreateUserPreferencesInput!
|
Example
Query
mutation createUserPreferences($input: CreateUserPreferencesInput!) {
createUserPreferences(input: $input) {
defaultPublicationStatus
}
}
Variables
{"input": CreateUserPreferencesInput}
Response
{"data": {"createUserPreferences": {"defaultPublicationStatus": "DRAFT"}}}
createVernacularName
Response
Returns a VernacularName
Arguments
| Name | Description |
|---|---|
input - CreateVernacularNameInput!
|
Example
Query
mutation createVernacularName($input: CreateVernacularNameInput!) {
createVernacularName(input: $input) {
id
name
isPreferred
nameUsage
remarks
taxonConcept {
...TaxonConceptFragment
}
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
}
}
Variables
{"input": CreateVernacularNameInput}
Response
{
"data": {
"createVernacularName": {
"id": 4,
"name": "abc123",
"isPreferred": true,
"nameUsage": "xyz789",
"remarks": "xyz789",
"taxonConcept": TaxonConcept,
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987
}
}
}
deleteContributors
Example
Query
mutation deleteContributors($reference: ID!) {
deleteContributors(reference: $reference) {
id
quickRef
author {
...AgentFragment
}
referenceType
publicationYear
title
shortTitle
edition
volume
issue
pageStart
pageEnd
pages
numberOfPages
publisher
placeOfPublication
shortDescription
abstract
isbn
issn
doi
parent {
...ReferenceFragment
}
isPartOf {
...ReferenceFragment
}
journal {
...ReferenceFragment
}
book {
...ReferenceFragment
}
contributors {
...ContributorFragment
}
citation
referenceString
citationHtml
referenceStringHtml
citationMarkdown
referenceStringMarkdown
taxonNames {
...TaxonNameFragment
}
taxonConcepts {
...TaxonConceptReferenceFragment
}
}
}
Variables
{"reference": 4}
Response
{
"data": {
"deleteContributors": {
"id": "4",
"quickRef": "xyz789",
"author": Agent,
"referenceType": "ARTICLE",
"publicationYear": "xyz789",
"title": "abc123",
"shortTitle": "abc123",
"edition": "xyz789",
"volume": "abc123",
"issue": "abc123",
"pageStart": 123,
"pageEnd": 987,
"pages": "abc123",
"numberOfPages": "abc123",
"publisher": "abc123",
"placeOfPublication": "xyz789",
"shortDescription": "xyz789",
"abstract": "abc123",
"isbn": "xyz789",
"issn": "xyz789",
"doi": "abc123",
"parent": Reference,
"isPartOf": Reference,
"journal": Reference,
"book": Reference,
"contributors": [Contributor],
"citation": "abc123",
"referenceString": "abc123",
"citationHtml": "xyz789",
"referenceStringHtml": "abc123",
"citationMarkdown": "abc123",
"referenceStringMarkdown": "xyz789",
"taxonNames": [TaxonName],
"taxonConcepts": [TaxonConceptReference]
}
}
}
deleteGroupPerson
Response
Returns a GroupPerson
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteGroupPerson($id: ID!) {
deleteGroupPerson(id: $id) {
id
group {
...AgentFragment
}
member {
...AgentFragment
}
sequence
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteGroupPerson": {
"id": 4,
"group": Agent,
"member": Agent,
"sequence": 987
}
}
}
deleteMultiAccessKey
Description
Delete a multi-access key. This mutation will fail if the key has any features. Use deleteMultiAccessKeyCascade to delete a key with all its features and states.
Response
Returns a MultiAccessKey!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteMultiAccessKey($id: ID!) {
deleteMultiAccessKey(id: $id) {
id
title
description
location
characterGroups {
...MultiAccessKeyCharacterFragment
}
characters {
...MultiAccessKeyCharacterFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteMultiAccessKey": {
"id": "4",
"title": "abc123",
"description": "abc123",
"location": "xyz789",
"characterGroups": [MultiAccessKeyCharacter],
"characters": [MultiAccessKeyCharacter]
}
}
}
deleteMultiAccessKeyCascade
Description
Delete a multi-access key with all its features and states.
Response
Returns a MultiAccessKey!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteMultiAccessKeyCascade($id: ID!) {
deleteMultiAccessKeyCascade(id: $id) {
id
title
description
location
characterGroups {
...MultiAccessKeyCharacterFragment
}
characters {
...MultiAccessKeyCharacterFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteMultiAccessKeyCascade": {
"id": "4",
"title": "xyz789",
"description": "xyz789",
"location": "abc123",
"characterGroups": [MultiAccessKeyCharacter],
"characters": [MultiAccessKeyCharacter]
}
}
}
deleteMultiAccessKeyCharacter
Description
Delete a multi-access key feature. This mutation will fail if the feature has any states or children. Use deleteMultiAccessKeyCharacterCascade to delete a feature with all its states or children.
Response
Returns a MultiAccessKeyCharacter!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteMultiAccessKeyCharacter($id: ID!) {
deleteMultiAccessKeyCharacter(id: $id) {
id
name
type
characterType
description
parent {
...MultiAccessKeyCharacterFragment
}
children {
...MultiAccessKeyCharacterFragment
}
key {
...MultiAccessKeyFragment
}
states {
...MultiAccessKeyStateFragment
}
unit {
...MultiAccessKeyCharacterFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteMultiAccessKeyCharacter": {
"id": "4",
"name": "xyz789",
"type": 987,
"characterType": "ORDERED",
"description": "xyz789",
"parent": MultiAccessKeyCharacter,
"children": [MultiAccessKeyCharacter],
"key": MultiAccessKey,
"states": [MultiAccessKeyState],
"unit": MultiAccessKeyCharacter
}
}
}
deleteMultiAccessKeyCharacterCascade
Description
Delete a multi-access key feature with all its states or children
Response
Returns a MultiAccessKeyCharacter!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteMultiAccessKeyCharacterCascade($id: ID!) {
deleteMultiAccessKeyCharacterCascade(id: $id) {
id
name
type
characterType
description
parent {
...MultiAccessKeyCharacterFragment
}
children {
...MultiAccessKeyCharacterFragment
}
key {
...MultiAccessKeyFragment
}
states {
...MultiAccessKeyStateFragment
}
unit {
...MultiAccessKeyCharacterFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteMultiAccessKeyCharacterCascade": {
"id": 4,
"name": "xyz789",
"type": 987,
"characterType": "ORDERED",
"description": "xyz789",
"parent": MultiAccessKeyCharacter,
"children": [MultiAccessKeyCharacter],
"key": MultiAccessKey,
"states": [MultiAccessKeyState],
"unit": MultiAccessKeyCharacter
}
}
}
deleteMultiAccessKeyState
Description
Delete a multi-access key feature state.
Response
Returns a MultiAccessKeyState!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteMultiAccessKeyState($id: ID!) {
deleteMultiAccessKeyState(id: $id) {
id
name
description
feature {
...MultiAccessKeyCharacterFragment
}
images {
...ImageFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteMultiAccessKeyState": {
"id": "4",
"name": "abc123",
"description": "abc123",
"feature": MultiAccessKeyCharacter,
"images": [Image]
}
}
}
deleteProfile
Example
Query
mutation deleteProfile($id: ID!) {
deleteProfile(id: $id) {
id
guid
profile
taxonConcept {
...TaxonConceptFragment
}
acceptedConcept {
...TaxonConceptFragment
}
source {
...ReferenceFragment
}
creator {
...AgentFragment
}
updatedBy {
...AgentFragment
}
created
modified
createdAt
updatedAt
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
version
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteProfile": {
"id": 4,
"guid": "f96ccca6-10f1-4749-a923-a38ede8ea0b6",
"profile": "xyz789",
"taxonConcept": TaxonConcept,
"acceptedConcept": TaxonConcept,
"source": Reference,
"creator": Agent,
"updatedBy": Agent,
"created": "2007-12-03",
"modified": "2007-12-03",
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"createdBy": Agent,
"modifiedBy": Agent,
"version": 123
}
}
}
deleteReference
Example
Query
mutation deleteReference($id: ID!) {
deleteReference(id: $id) {
id
quickRef
author {
...AgentFragment
}
referenceType
publicationYear
title
shortTitle
edition
volume
issue
pageStart
pageEnd
pages
numberOfPages
publisher
placeOfPublication
shortDescription
abstract
isbn
issn
doi
parent {
...ReferenceFragment
}
isPartOf {
...ReferenceFragment
}
journal {
...ReferenceFragment
}
book {
...ReferenceFragment
}
contributors {
...ContributorFragment
}
citation
referenceString
citationHtml
referenceStringHtml
citationMarkdown
referenceStringMarkdown
taxonNames {
...TaxonNameFragment
}
taxonConcepts {
...TaxonConceptReferenceFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteReference": {
"id": "4",
"quickRef": "abc123",
"author": Agent,
"referenceType": "ARTICLE",
"publicationYear": "abc123",
"title": "xyz789",
"shortTitle": "abc123",
"edition": "xyz789",
"volume": "abc123",
"issue": "abc123",
"pageStart": 987,
"pageEnd": 987,
"pages": "abc123",
"numberOfPages": "abc123",
"publisher": "abc123",
"placeOfPublication": "abc123",
"shortDescription": "xyz789",
"abstract": "xyz789",
"isbn": "abc123",
"issn": "abc123",
"doi": "xyz789",
"parent": Reference,
"isPartOf": Reference,
"journal": Reference,
"book": Reference,
"contributors": [Contributor],
"citation": "abc123",
"referenceString": "xyz789",
"citationHtml": "abc123",
"referenceStringHtml": "xyz789",
"citationMarkdown": "abc123",
"referenceStringMarkdown": "xyz789",
"taxonNames": [TaxonName],
"taxonConcepts": [TaxonConceptReference]
}
}
}
deleteTaxonConcept
Response
Returns a TaxonConcept
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteTaxonConcept($id: ID!) {
deleteTaxonConcept(id: $id) {
id
remarks
taxonName {
...TaxonNameFragment
}
accordingTo {
...ReferenceFragment
}
acceptedConcept {
...TaxonConceptFragment
}
parent {
...TaxonConceptFragment
}
children {
...TaxonConceptFragment
}
siblings {
...TaxonConceptFragment
}
ancestors {
...TaxonConceptFragment
}
descendants {
...TaxonConceptFragment
}
higherClassification {
...TaxonConceptFragment
}
taxonRank
taxonTreeDefItem {
...TaxonTreeDefItemFragment
}
taxonomicStatus
occurrenceStatus
establishmentMeans
degreeOfEstablishment
endemic
hasIntroducedOccurrences
epbc
ffg
vernacularNames {
...VernacularNameFragment
}
preferredVernacularName {
...VernacularNameFragment
}
profiles {
...ProfileFragment
}
currentProfile {
...CurrentProfileFragment
}
heroImage {
...ImageFragment
}
hasImages
hasSpecimenImages
bioregions {
...TaxonBioregionFragment
}
localGovernmentAreas {
...TaxonLocalGovernmentAreaFragment
}
parkReserves {
...TaxonParkReserveFragment
}
phenology {
...PhenologyItemFragment
}
hasReproductiveStructures
mapLinks {
...MapLinksFragment
}
identificationKeys {
...IdentificationKeyFragment
}
matrixKeys {
...MatrixKeyFragment
}
synonyms {
...TaxonNameFragment
}
synonymUsages {
...TaxonConceptFragment
}
misapplications {
...TaxonConceptFragment
}
references {
...TaxonConceptReferenceFragment
}
floraLinks {
...TaxonConceptFloraLinkFragment
}
changes {
...ChangeFragment
}
publicationStatus
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
images {
...ImagePaginatorFragment
}
specimenImages {
...SpecimenImagePaginatorFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteTaxonConcept": {
"id": "4",
"remarks": "xyz789",
"taxonName": TaxonName,
"accordingTo": Reference,
"acceptedConcept": TaxonConcept,
"parent": TaxonConcept,
"children": [TaxonConcept],
"siblings": [TaxonConcept],
"ancestors": [TaxonConcept],
"descendants": [TaxonConcept],
"higherClassification": [TaxonConcept],
"taxonRank": "LIFE",
"taxonTreeDefItem": TaxonTreeDefItem,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": true,
"hasIntroducedOccurrences": true,
"epbc": "EX",
"ffg": "EX",
"vernacularNames": [VernacularName],
"preferredVernacularName": VernacularName,
"profiles": [Profile],
"currentProfile": CurrentProfile,
"heroImage": Image,
"hasImages": false,
"hasSpecimenImages": true,
"bioregions": [TaxonBioregion],
"localGovernmentAreas": [TaxonLocalGovernmentArea],
"parkReserves": [TaxonParkReserve],
"phenology": [PhenologyItem],
"hasReproductiveStructures": false,
"mapLinks": MapLinks,
"identificationKeys": [IdentificationKey],
"matrixKeys": [MatrixKey],
"synonyms": [TaxonName],
"synonymUsages": [TaxonConcept],
"misapplications": [TaxonConcept],
"references": [TaxonConceptReference],
"floraLinks": [TaxonConceptFloraLink],
"changes": [Change],
"publicationStatus": "DRAFT",
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123,
"images": ImagePaginator,
"specimenImages": SpecimenImagePaginator
}
}
}
deleteTaxonConceptReference
Response
Returns a TaxonConceptReference
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteTaxonConceptReference($id: ID!) {
deleteTaxonConceptReference(id: $id) {
id
taxonConcept {
...TaxonConceptFragment
}
reference {
...ReferenceFragment
}
createdAt
updatedAt
createdBy {
...AgentFragment
}
updatedBy {
...AgentFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteTaxonConceptReference": {
"id": "4",
"taxonConcept": TaxonConcept,
"reference": Reference,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"createdBy": Agent,
"updatedBy": Agent
}
}
}
deleteVernacularName
Response
Returns a VernacularName
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteVernacularName($id: ID!) {
deleteVernacularName(id: $id) {
id
name
isPreferred
nameUsage
remarks
taxonConcept {
...TaxonConceptFragment
}
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteVernacularName": {
"id": 4,
"name": "abc123",
"isPreferred": false,
"nameUsage": "xyz789",
"remarks": "xyz789",
"taxonConcept": TaxonConcept,
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987
}
}
}
linkUserToAgent
Response
Returns an Agent
Arguments
| Name | Description |
|---|---|
input - LinkUserInput!
|
Example
Query
mutation linkUserToAgent($input: LinkUserInput!) {
linkUserToAgent(input: $input) {
id
name
lastName
firstName
initials
email
legalName
agentType
members {
...GroupPersonFragment
}
}
}
Variables
{"input": LinkUserInput}
Response
{
"data": {
"linkUserToAgent": {
"id": 4,
"name": "xyz789",
"lastName": "xyz789",
"firstName": "xyz789",
"initials": "xyz789",
"email": Email,
"legalName": "xyz789",
"agentType": "PERSON",
"members": [GroupPerson]
}
}
}
updateAgent
Response
Returns an Agent
Arguments
| Name | Description |
|---|---|
input - UpdateAgentInput!
|
Example
Query
mutation updateAgent($input: UpdateAgentInput!) {
updateAgent(input: $input) {
id
name
lastName
firstName
initials
email
legalName
agentType
members {
...GroupPersonFragment
}
}
}
Variables
{"input": UpdateAgentInput}
Response
{
"data": {
"updateAgent": {
"id": "4",
"name": "abc123",
"lastName": "abc123",
"firstName": "abc123",
"initials": "xyz789",
"email": Email,
"legalName": "xyz789",
"agentType": "PERSON",
"members": [GroupPerson]
}
}
}
updateGroupPerson
Response
Returns a GroupPerson!
Arguments
| Name | Description |
|---|---|
input - UpdateGroupPersonInput!
|
Example
Query
mutation updateGroupPerson($input: UpdateGroupPersonInput!) {
updateGroupPerson(input: $input) {
id
group {
...AgentFragment
}
member {
...AgentFragment
}
sequence
}
}
Variables
{"input": UpdateGroupPersonInput}
Response
{
"data": {
"updateGroupPerson": {
"id": "4",
"group": Agent,
"member": Agent,
"sequence": 123
}
}
}
updateMultiAccessKey
Description
Update a multi-access key record.
Response
Returns a MultiAccessKey!
Arguments
| Name | Description |
|---|---|
input - UpdateMultiAccessKeyInput
|
Example
Query
mutation updateMultiAccessKey($input: UpdateMultiAccessKeyInput) {
updateMultiAccessKey(input: $input) {
id
title
description
location
characterGroups {
...MultiAccessKeyCharacterFragment
}
characters {
...MultiAccessKeyCharacterFragment
}
}
}
Variables
{"input": UpdateMultiAccessKeyInput}
Response
{
"data": {
"updateMultiAccessKey": {
"id": "4",
"title": "abc123",
"description": "abc123",
"location": "xyz789",
"characterGroups": [MultiAccessKeyCharacter],
"characters": [MultiAccessKeyCharacter]
}
}
}
updateMultiAccessKeyCharacter
Description
Update a multi-access key feature. Changes made here will be able to be added to a deployed key.
Response
Returns a MultiAccessKeyCharacter!
Arguments
| Name | Description |
|---|---|
input - UpdateMultiAccessKeyCharacterInput!
|
Example
Query
mutation updateMultiAccessKeyCharacter($input: UpdateMultiAccessKeyCharacterInput!) {
updateMultiAccessKeyCharacter(input: $input) {
id
name
type
characterType
description
parent {
...MultiAccessKeyCharacterFragment
}
children {
...MultiAccessKeyCharacterFragment
}
key {
...MultiAccessKeyFragment
}
states {
...MultiAccessKeyStateFragment
}
unit {
...MultiAccessKeyCharacterFragment
}
}
}
Variables
{"input": UpdateMultiAccessKeyCharacterInput}
Response
{
"data": {
"updateMultiAccessKeyCharacter": {
"id": 4,
"name": "xyz789",
"type": 123,
"characterType": "ORDERED",
"description": "abc123",
"parent": MultiAccessKeyCharacter,
"children": [MultiAccessKeyCharacter],
"key": MultiAccessKey,
"states": [MultiAccessKeyState],
"unit": MultiAccessKeyCharacter
}
}
}
updateMultiAccessKeyState
Description
Update a multi-access key state record. Changes made here will be able to be added to the deployed key.
Response
Returns a MultiAccessKeyState!
Arguments
| Name | Description |
|---|---|
input - UpdateMultiAccessKeyStateInput!
|
Example
Query
mutation updateMultiAccessKeyState($input: UpdateMultiAccessKeyStateInput!) {
updateMultiAccessKeyState(input: $input) {
id
name
description
feature {
...MultiAccessKeyCharacterFragment
}
images {
...ImageFragment
}
}
}
Variables
{"input": UpdateMultiAccessKeyStateInput}
Response
{
"data": {
"updateMultiAccessKeyState": {
"id": 4,
"name": "abc123",
"description": "abc123",
"feature": MultiAccessKeyCharacter,
"images": [Image]
}
}
}
updateProfile
Response
Returns a Profile
Arguments
| Name | Description |
|---|---|
input - UpdateProfileInput!
|
Example
Query
mutation updateProfile($input: UpdateProfileInput!) {
updateProfile(input: $input) {
id
guid
profile
taxonConcept {
...TaxonConceptFragment
}
acceptedConcept {
...TaxonConceptFragment
}
source {
...ReferenceFragment
}
creator {
...AgentFragment
}
updatedBy {
...AgentFragment
}
created
modified
createdAt
updatedAt
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
version
}
}
Variables
{"input": UpdateProfileInput}
Response
{
"data": {
"updateProfile": {
"id": 4,
"guid": "f96ccca6-10f1-4749-a923-a38ede8ea0b6",
"profile": "xyz789",
"taxonConcept": TaxonConcept,
"acceptedConcept": TaxonConcept,
"source": Reference,
"creator": Agent,
"updatedBy": Agent,
"created": "2007-12-03",
"modified": "2007-12-03",
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"createdBy": Agent,
"modifiedBy": Agent,
"version": 987
}
}
}
updateReference
Response
Returns a Reference
Arguments
| Name | Description |
|---|---|
input - UpdateReferenceInput!
|
Example
Query
mutation updateReference($input: UpdateReferenceInput!) {
updateReference(input: $input) {
id
quickRef
author {
...AgentFragment
}
referenceType
publicationYear
title
shortTitle
edition
volume
issue
pageStart
pageEnd
pages
numberOfPages
publisher
placeOfPublication
shortDescription
abstract
isbn
issn
doi
parent {
...ReferenceFragment
}
isPartOf {
...ReferenceFragment
}
journal {
...ReferenceFragment
}
book {
...ReferenceFragment
}
contributors {
...ContributorFragment
}
citation
referenceString
citationHtml
referenceStringHtml
citationMarkdown
referenceStringMarkdown
taxonNames {
...TaxonNameFragment
}
taxonConcepts {
...TaxonConceptReferenceFragment
}
}
}
Variables
{"input": UpdateReferenceInput}
Response
{
"data": {
"updateReference": {
"id": 4,
"quickRef": "abc123",
"author": Agent,
"referenceType": "ARTICLE",
"publicationYear": "abc123",
"title": "abc123",
"shortTitle": "abc123",
"edition": "xyz789",
"volume": "abc123",
"issue": "xyz789",
"pageStart": 123,
"pageEnd": 987,
"pages": "abc123",
"numberOfPages": "xyz789",
"publisher": "abc123",
"placeOfPublication": "abc123",
"shortDescription": "xyz789",
"abstract": "xyz789",
"isbn": "xyz789",
"issn": "xyz789",
"doi": "xyz789",
"parent": Reference,
"isPartOf": Reference,
"journal": Reference,
"book": Reference,
"contributors": [Contributor],
"citation": "abc123",
"referenceString": "abc123",
"citationHtml": "xyz789",
"referenceStringHtml": "abc123",
"citationMarkdown": "xyz789",
"referenceStringMarkdown": "abc123",
"taxonNames": [TaxonName],
"taxonConcepts": [TaxonConceptReference]
}
}
}
updateSolrIndex
Response
Returns a SearchResultDocument
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateSolrIndex($id: ID!) {
updateSolrIndex(id: $id) {
id
taxonRank
scientificNameId
scientificName
scientificNameAuthorship
nameType
namePublishedInId
namePublishedIn
namePublishedInYear
nameAccordingTo
kingdom
phylum
class
order
family
genus
specificEpithet
infraspecificEpithet
parentNameUsageId
parentNameUsage
acceptedNameUsageId
acceptedNameUsage
acceptedNameUsageAuthorship
taxonomicStatus
occurrenceStatus
establishmentMeans
degreeOfEstablishment
endemic
hasIntroducedOccurrences
ffg
epbc
vicAdvisory
taxonRemarks
vernacularName
preferredVernacularName
description
media
publicationStatus
created
modified
}
}
Variables
{"id": 4}
Response
{
"data": {
"updateSolrIndex": {
"id": "4",
"taxonRank": "abc123",
"scientificNameId": "abc123",
"scientificName": "xyz789",
"scientificNameAuthorship": "abc123",
"nameType": "xyz789",
"namePublishedInId": "xyz789",
"namePublishedIn": "abc123",
"namePublishedInYear": "abc123",
"nameAccordingTo": "xyz789",
"kingdom": "xyz789",
"phylum": "abc123",
"class": "abc123",
"order": "xyz789",
"family": "abc123",
"genus": "abc123",
"specificEpithet": "abc123",
"infraspecificEpithet": "xyz789",
"parentNameUsageId": "abc123",
"parentNameUsage": "abc123",
"acceptedNameUsageId": "abc123",
"acceptedNameUsage": "xyz789",
"acceptedNameUsageAuthorship": "abc123",
"taxonomicStatus": "abc123",
"occurrenceStatus": "abc123",
"establishmentMeans": "abc123",
"degreeOfEstablishment": "abc123",
"endemic": true,
"hasIntroducedOccurrences": false,
"ffg": "xyz789",
"epbc": "abc123",
"vicAdvisory": "abc123",
"taxonRemarks": "abc123",
"vernacularName": ["xyz789"],
"preferredVernacularName": "abc123",
"description": "xyz789",
"media": ["abc123"],
"publicationStatus": "xyz789",
"created": DateTimeTz,
"modified": DateTimeTz
}
}
}
updateTaxonConcept
Response
Returns a TaxonConcept
Arguments
| Name | Description |
|---|---|
input - UpdateTaxonConceptInput!
|
Example
Query
mutation updateTaxonConcept($input: UpdateTaxonConceptInput!) {
updateTaxonConcept(input: $input) {
id
remarks
taxonName {
...TaxonNameFragment
}
accordingTo {
...ReferenceFragment
}
acceptedConcept {
...TaxonConceptFragment
}
parent {
...TaxonConceptFragment
}
children {
...TaxonConceptFragment
}
siblings {
...TaxonConceptFragment
}
ancestors {
...TaxonConceptFragment
}
descendants {
...TaxonConceptFragment
}
higherClassification {
...TaxonConceptFragment
}
taxonRank
taxonTreeDefItem {
...TaxonTreeDefItemFragment
}
taxonomicStatus
occurrenceStatus
establishmentMeans
degreeOfEstablishment
endemic
hasIntroducedOccurrences
epbc
ffg
vernacularNames {
...VernacularNameFragment
}
preferredVernacularName {
...VernacularNameFragment
}
profiles {
...ProfileFragment
}
currentProfile {
...CurrentProfileFragment
}
heroImage {
...ImageFragment
}
hasImages
hasSpecimenImages
bioregions {
...TaxonBioregionFragment
}
localGovernmentAreas {
...TaxonLocalGovernmentAreaFragment
}
parkReserves {
...TaxonParkReserveFragment
}
phenology {
...PhenologyItemFragment
}
hasReproductiveStructures
mapLinks {
...MapLinksFragment
}
identificationKeys {
...IdentificationKeyFragment
}
matrixKeys {
...MatrixKeyFragment
}
synonyms {
...TaxonNameFragment
}
synonymUsages {
...TaxonConceptFragment
}
misapplications {
...TaxonConceptFragment
}
references {
...TaxonConceptReferenceFragment
}
floraLinks {
...TaxonConceptFloraLinkFragment
}
changes {
...ChangeFragment
}
publicationStatus
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
images {
...ImagePaginatorFragment
}
specimenImages {
...SpecimenImagePaginatorFragment
}
}
}
Variables
{"input": UpdateTaxonConceptInput}
Response
{
"data": {
"updateTaxonConcept": {
"id": 4,
"remarks": "abc123",
"taxonName": TaxonName,
"accordingTo": Reference,
"acceptedConcept": TaxonConcept,
"parent": TaxonConcept,
"children": [TaxonConcept],
"siblings": [TaxonConcept],
"ancestors": [TaxonConcept],
"descendants": [TaxonConcept],
"higherClassification": [TaxonConcept],
"taxonRank": "LIFE",
"taxonTreeDefItem": TaxonTreeDefItem,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": false,
"hasIntroducedOccurrences": false,
"epbc": "EX",
"ffg": "EX",
"vernacularNames": [VernacularName],
"preferredVernacularName": VernacularName,
"profiles": [Profile],
"currentProfile": CurrentProfile,
"heroImage": Image,
"hasImages": false,
"hasSpecimenImages": false,
"bioregions": [TaxonBioregion],
"localGovernmentAreas": [TaxonLocalGovernmentArea],
"parkReserves": [TaxonParkReserve],
"phenology": [PhenologyItem],
"hasReproductiveStructures": true,
"mapLinks": MapLinks,
"identificationKeys": [IdentificationKey],
"matrixKeys": [MatrixKey],
"synonyms": [TaxonName],
"synonymUsages": [TaxonConcept],
"misapplications": [TaxonConcept],
"references": [TaxonConceptReference],
"floraLinks": [TaxonConceptFloraLink],
"changes": [Change],
"publicationStatus": "DRAFT",
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123,
"images": ImagePaginator,
"specimenImages": SpecimenImagePaginator
}
}
}
updateTaxonName
Response
Returns a TaxonName
Arguments
| Name | Description |
|---|---|
input - UpdateTaxonNameInput!
|
Example
Query
mutation updateTaxonName($input: UpdateTaxonNameInput!) {
updateTaxonName(input: $input) {
id
rank
parent {
...TaxonNameFragment
}
namePart
fullName
authorship
fullNameWithAuthorship
nomenclaturalNote
remarks
nameType
basionym {
...TaxonNameFragment
}
replacedSynonym {
...TaxonNameFragment
}
publishedIn {
...ReferenceFragment
}
protologue {
...ReferenceFragment
}
taxonConcepts {
...TaxonConceptFragment
}
apniName {
...ApniNameFragment
}
vbaTaxaListItem {
...VbaTaxaListItemFragment
}
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
}
}
Variables
{"input": UpdateTaxonNameInput}
Response
{
"data": {
"updateTaxonName": {
"id": "4",
"rank": "LIFE",
"parent": TaxonName,
"namePart": "xyz789",
"fullName": "abc123",
"authorship": "abc123",
"fullNameWithAuthorship": "xyz789",
"nomenclaturalNote": "xyz789",
"remarks": "xyz789",
"nameType": "SCIENTIFIC",
"basionym": TaxonName,
"replacedSynonym": TaxonName,
"publishedIn": Reference,
"protologue": Reference,
"taxonConcepts": [TaxonConcept],
"apniName": ApniName,
"vbaTaxaListItem": VbaTaxaListItem,
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123
}
}
}
updateUserPreferences
Response
Returns a UserPreferences!
Arguments
| Name | Description |
|---|---|
input - UpdateUserPreferencesInput!
|
Example
Query
mutation updateUserPreferences($input: UpdateUserPreferencesInput!) {
updateUserPreferences(input: $input) {
defaultPublicationStatus
}
}
Variables
{"input": UpdateUserPreferencesInput}
Response
{"data": {"updateUserPreferences": {"defaultPublicationStatus": "DRAFT"}}}
updateVernacularName
Response
Returns a VernacularName
Arguments
| Name | Description |
|---|---|
input - UpdateVernacularNameInput!
|
Example
Query
mutation updateVernacularName($input: UpdateVernacularNameInput!) {
updateVernacularName(input: $input) {
id
name
isPreferred
nameUsage
remarks
taxonConcept {
...TaxonConceptFragment
}
createdBy {
...AgentFragment
}
modifiedBy {
...AgentFragment
}
createdAt
updatedAt
version
}
}
Variables
{"input": UpdateVernacularNameInput}
Response
{
"data": {
"updateVernacularName": {
"id": 4,
"name": "xyz789",
"isPreferred": false,
"nameUsage": "abc123",
"remarks": "abc123",
"taxonConcept": TaxonConcept,
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123
}
}
}
Types
Agent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String
|
Name of the agent |
lastName - String
|
|
firstName - String
|
|
initials - String
|
|
email - Email
|
|
legalName - String
|
|
agentType - AgentTypeEnum
|
Type of agent |
members - [GroupPerson]
|
Example
{
"id": "4",
"name": "abc123",
"lastName": "xyz789",
"firstName": "xyz789",
"initials": "abc123",
"email": Email,
"legalName": "abc123",
"agentType": "PERSON",
"members": [GroupPerson]
}
AgentBelongsTo
Fields
| Input Field | Description |
|---|---|
connect - ID
|
Example
{"connect": "4"}
AgentType
AgentTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
A named group of people, like 'Angiosperm Phylogeny Group', the composition of which might change over time, is treated here as an ORGANIZATION |
|
|
Example
"PERSON"
ApniName
Attribute
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
uri - String
|
|
description - String
|
|
remarks - String
|
|
attributeValues - [AttributeValue]
|
|
createdBy - Agent
|
|
modifiedBy - Agent
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
version - Int
|
Example
{
"id": 4,
"name": "abc123",
"uri": "xyz789",
"description": "xyz789",
"remarks": "abc123",
"attributeValues": [AttributeValue],
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987
}
AttributeValue
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
value - String!
|
|
uri - String
|
|
description - String
|
|
attribute - Attribute!
|
|
createdBy - Agent
|
|
modifiedBy - Agent
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
version - Int
|
Example
{
"id": "4",
"value": "xyz789",
"uri": "abc123",
"description": "xyz789",
"attribute": Attribute,
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123
}
BioregionFeature
Description
Victorian bioregion. Will return GeoJSON-compliant Feature if at least type and geometry with both its properties are used.
Fields
| Field Name | Description |
|---|---|
type - String
|
|
geometry - GeoJSONGeometry
|
|
properties - BioregionProperties
|
Example
{
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": BioregionProperties
}
BioregionProperties
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Change
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdBy - Agent
|
|
createdAt - DateTimeTz
|
|
from - TaxonConcept!
|
|
to - TaxonConcept
|
|
changeType - TaxonomicStatusEnum
|
|
changeSource - Reference
|
Example
{
"id": "4",
"createdBy": Agent,
"createdAt": DateTimeTz,
"from": TaxonConcept,
"to": TaxonConcept,
"changeType": "ACCEPTED",
"changeSource": Reference
}
CharacterTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ORDERED"
Contributor
Fields
| Field Name | Description |
|---|---|
agent - Agent!
|
|
reference - Reference!
|
|
contributorRole - ContributorRoleEnum
|
|
sequence - Int!
|
Example
{
"agent": Agent,
"reference": Reference,
"contributorRole": "AUTHOR",
"sequence": 987
}
ContributorRoleEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AUTHOR"
CreateAgentInput
Fields
| Input Field | Description |
|---|---|
agentType - AgentTypeEnum
|
|
name - String
|
|
lastName - String
|
|
firstName - String
|
|
initials - String
|
|
email - Email
|
|
legalName - String
|
|
members - [CreateGroupPersonInput]
|
Example
{
"agentType": "PERSON",
"name": "xyz789",
"lastName": "xyz789",
"firstName": "abc123",
"initials": "abc123",
"email": Email,
"legalName": "xyz789",
"members": [CreateGroupPersonInput]
}
CreateContributorInput
Fields
| Input Field | Description |
|---|---|
agent - AgentBelongsTo
|
|
sequence - Int!
|
|
contributorRole - ContributorRoleEnum
|
Example
{
"agent": AgentBelongsTo,
"sequence": 987,
"contributorRole": "AUTHOR"
}
CreateGroupPersonInput
Fields
| Input Field | Description |
|---|---|
sequence - Int
|
|
group - AgentBelongsTo
|
|
member - AgentBelongsTo!
|
Example
{
"sequence": 123,
"group": AgentBelongsTo,
"member": AgentBelongsTo
}
CreateMultiAccessKeyCharacterInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
type - Int!
|
|
characterType - CharacterTypeEnum
|
|
description - String
|
|
parent - MultiAccessKeyCharacterBelongsTo
|
|
key - MultiAccessKeyBelongsTo!
|
Example
{
"name": "abc123",
"type": 987,
"characterType": "ORDERED",
"description": "xyz789",
"parent": MultiAccessKeyCharacterBelongsTo,
"key": MultiAccessKeyBelongsTo
}
CreateMultiAccessKeyInput
CreateMultiAccessKeyStateInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
description - String
|
|
feature - MultiAccessKeyCharacterBelongsTo!
|
Example
{
"name": "xyz789",
"description": "xyz789",
"feature": MultiAccessKeyCharacterBelongsTo
}
CreateProfileInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
profile - String!
|
|
taxonConcept - TaxonConceptBelongsTo!
|
|
source - ReferenceBelongsTo
|
Example
{
"id": 4,
"profile": "abc123",
"taxonConcept": TaxonConceptBelongsTo,
"source": ReferenceBelongsTo
}
CreateReferenceInput
Fields
| Input Field | Description |
|---|---|
author - AgentBelongsTo
|
|
publicationYear - String
|
|
title - String!
|
|
shortTitle - String
|
|
journal - ReferenceBelongsTo
|
|
book - ReferenceBelongsTo
|
|
edition - String
|
|
volume - String
|
|
issue - String
|
|
pageStart - Int
|
|
pageEnd - Int
|
|
pages - String
|
|
numberOfPages - String
|
|
publisher - String
|
|
placeOfPublication - String
|
|
shortDescription - String
|
|
abstract - String
|
|
isbn - String
|
|
issn - String
|
|
doi - String
|
|
referenceType - ReferenceTypeEnum
|
|
parent - ReferenceBelongsTo
|
Example
{
"author": AgentBelongsTo,
"publicationYear": "abc123",
"title": "abc123",
"shortTitle": "xyz789",
"journal": ReferenceBelongsTo,
"book": ReferenceBelongsTo,
"edition": "xyz789",
"volume": "xyz789",
"issue": "xyz789",
"pageStart": 987,
"pageEnd": 123,
"pages": "xyz789",
"numberOfPages": "abc123",
"publisher": "abc123",
"placeOfPublication": "abc123",
"shortDescription": "abc123",
"abstract": "xyz789",
"isbn": "xyz789",
"issn": "abc123",
"doi": "abc123",
"referenceType": "ARTICLE",
"parent": ReferenceBelongsTo
}
CreateTaxonConceptInput
Fields
| Input Field | Description |
|---|---|
taxonName - TaxonNameBelongsTo!
|
|
accordingTo - ReferenceBelongsTo
|
|
taxonRank - TaxonRankEnum!
|
|
acceptedConcept - TaxonConceptBelongsTo
|
|
parent - TaxonConceptBelongsTo
|
|
taxonomicStatus - TaxonomicStatusEnum
|
|
occurrenceStatus - OccurrenceStatusEnum
|
|
establishmentMeans - EstablishmentMeansEnum
|
|
degreeOfEstablishment - DegreeOfEstablishmentEnum
|
|
endemic - Boolean
|
|
hasIntroducedOccurrences - Boolean
|
|
remarks - String
|
|
publicationStatus - PublicationStatusEnum!
|
Example
{
"taxonName": TaxonNameBelongsTo,
"accordingTo": ReferenceBelongsTo,
"taxonRank": "LIFE",
"acceptedConcept": TaxonConceptBelongsTo,
"parent": TaxonConceptBelongsTo,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": false,
"hasIntroducedOccurrences": true,
"remarks": "xyz789",
"publicationStatus": "DRAFT"
}
CreateTaxonConceptReferenceInput
Fields
| Input Field | Description |
|---|---|
taxonConcept - TaxonConceptBelongsTo!
|
|
reference - ReferenceBelongsTo!
|
Example
{
"taxonConcept": TaxonConceptBelongsTo,
"reference": ReferenceBelongsTo
}
CreateTaxonNameInput
Fields
| Input Field | Description |
|---|---|
nameType - NameTypeEnum
|
|
rank - TaxonRankEnum
|
|
parent - TaxonNameBelongsTo
|
|
namePart - String
|
|
fullName - String
|
|
authorship - String
|
|
nomenclaturalNote - String
|
|
remarks - String
|
|
protologue - ReferenceBelongsTo
|
Example
{
"nameType": "SCIENTIFIC",
"rank": "LIFE",
"parent": TaxonNameBelongsTo,
"namePart": "xyz789",
"fullName": "xyz789",
"authorship": "abc123",
"nomenclaturalNote": "abc123",
"remarks": "abc123",
"protologue": ReferenceBelongsTo
}
CreateUserPreferencesInput
Fields
| Input Field | Description |
|---|---|
user - UserBelongsTo!
|
|
defaultPublicationStatus - PublicationStatusEnum!
|
Example
{
"user": UserBelongsTo,
"defaultPublicationStatus": "DRAFT"
}
CreateVernacularNameInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
isPreferred - Boolean
|
|
nameUsage - String
|
|
remarks - String
|
|
taxonConcept - TaxonConceptBelongsTo!
|
Example
{
"name": "abc123",
"isPreferred": true,
"nameUsage": "abc123",
"remarks": "abc123",
"taxonConcept": TaxonConceptBelongsTo
}
CurrentProfile
Description
CurrentProfile is different from Profile in that we dynamically add the Victorian bioregions, based on occurrence data from the Australasian Virtual Herbarium (AVH) and Victorian Biodiversity Atlas (VBA). We also link the taxa mentioned in the notes to their profiles in VicFlora. The creation date (created) and creator are those of the first version, if no source is present, and the modification date (modified) and updated by are the creation date and the creator respectively of the current version.
Example
{
"id": 4,
"guid": "f96ccca6-10f1-4749-a923-a38ede8ea0b6",
"profile": "xyz789",
"taxonConcept": TaxonConcept,
"acceptedConcept": TaxonConcept,
"source": Reference,
"creator": Agent,
"updatedBy": Agent,
"created": "2007-12-03",
"modified": "2007-12-03",
"version": 123
}
Date
Description
A date string with format Y-m-d, e.g. 2011-05-23.
Example
"2007-12-03"
DateTime
Description
A datetime string with format Y-m-d H:i:s, e.g. 2018-05-23 13:43:32.
Example
"2007-12-03T10:15:30Z"
DateTimeTz
Description
A datetime and timezone string in ISO 8601 format Y-m-dTH:i:sP, e.g. 2020-04-20T13:53:12+02:00.
Example
DateTimeTz
DegreeOfEstablishmentEnum
Description
Controlled vocabulary for degreeOfEstablishment
Values
| Enum Value | Description |
|---|---|
|
|
Native – Not transported beyond limits of native range. Considered native and naturally occurring. |
|
|
Cultivated – Individuals in cultivation (i.e., individuals provided with conditions suitable for them, but explicit measures to prevent dispersal are limited at best). Examples include gardens, parks and farms. |
|
|
Casual – Individuals surviving outside of captivity or cultivation in a location with no reproduction. Trees planted in the wild for forestry or ornament may come under this category. |
|
|
Reproducing – Individuals surviving outside of captivity or cultivation in a location. Reproduction is occurring, but population not self-sustaining. Offspring are produced, but these either do not survive or are not fertile enough to maintain the population. |
|
|
Established – Individuals surviving outside of captivity or cultivation in a location. Reproduction occurring, and population self-sustaining. The population is maintained by reproduction, but is not spreading. |
|
|
Colonising – Self-sustaining population outside of captivity or cultivation, with individuals surviving a significant distance from the original point of introduction. The population is maintained by reproduction and is spreading. |
|
|
Invasive – Self-sustaining population outside of captivity or cultivation, with individuals surviving and reproducing a significant distance from the original point of introduction. |
|
|
Widespread invasive – Fully invasive species, with individuals dispersing, surviving and reproducing at multiple sites across a spectrum of habitats and geographic range. |
Example
"NATIVE"
Download
Fields
| Field Name | Description |
|---|---|
data - String
|
Example
{"data": "abc123"}
DownloadInput
Description
A RFC 5321 compliant email.
Example
Email
EstablishmentMeansEnum
Description
Controlled vocabulary for establishmentMeans. We use the Darwin Core vocabulary (https://dwc.tdwg.org/em/).
Values
| Enum Value | Description |
|---|---|
|
|
Native – Occurring within its natural range. |
|
|
Native: reintroduced – Re-established by direct introduction by humans into an area that was once part of its natural range, but from where it had become extinct. |
|
|
Introduced – Established by human agency into an area that is not part of its natural range. |
|
|
Uncertain – The origin of the occurrence in an area is obscure. |
Example
"NATIVE"
FieldFacetInput
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
GeoJSONGeometry
GlossaryRelationship
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
term - GlossaryTerm
|
|
relatedTerm - GlossaryTerm!
|
|
relationshipType - GlossaryRelationshipType!
|
|
isMisapplied - Boolean
|
|
isDiscouraged - Boolean
|
Example
{
"id": "4",
"term": GlossaryTerm,
"relatedTerm": GlossaryTerm,
"relationshipType": GlossaryRelationshipType,
"isMisapplied": false,
"isDiscouraged": true
}
GlossaryRelationshipType
GlossaryTerm
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
name - String!
|
|
definition - String!
|
|
isDiscouraged - Boolean
|
|
language - String
|
|
nameAddendum - String
|
|
relationships - [GlossaryRelationship]
|
|
inverseRelationships - [GlossaryRelationship]
|
|
images - [GlossaryTermImage]
|
Example
{
"id": "4",
"name": "xyz789",
"definition": "xyz789",
"isDiscouraged": true,
"language": "abc123",
"nameAddendum": "xyz789",
"relationships": [GlossaryRelationship],
"inverseRelationships": [GlossaryRelationship],
"images": [GlossaryTermImage]
}
GlossaryTermImage
Example
{
"id": "4",
"terms": GlossaryTerm,
"imageUrl": "abc123",
"creator": "abc123",
"rights": "abc123",
"title": "xyz789",
"caption": "xyz789",
"source": "xyz789"
}
GlossaryTermInString
Fields
| Field Name | Description |
|---|---|
substring - String!
|
|
term - GlossaryTerm!
|
Example
{
"substring": "xyz789",
"term": GlossaryTerm
}
GroupPerson
GroupPersonInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
sequence - Int!
|
|
group - AgentBelongsTo
|
|
member - AgentBelongsTo!
|
Example
{
"id": "4",
"sequence": 123,
"group": AgentBelongsTo,
"member": AgentBelongsTo
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
IUCNThreatStatusEnum
Description
The IUCN Red List Categories and Criteria were developed for assessing extinction risk at the global level, considering the global population of a taxon. The threat statuses in this vocabulary also include two additional regional statuses from IUCN used for non-endemic species at regional or national levels (RE & NA).
Values
| Enum Value | Description |
|---|---|
|
|
Extinct – A taxon is Extinct when there is no reasonable doubt that the last individual has died. A taxon is presumed Extinct when exhaustive surveys in known and/or expected habitat, at appropriate times (diurnal, seasonal, annual), throughout its historic range have failed to record an individual. Surveys should be over a time frame appropriate to the taxon's life cycle and life form. |
|
|
Extinct in the wild – A taxon is Extinct in the Wild when it is known only to survive in cultivation, in captivity or as a naturalized population (or populations) well outside the past range. A taxon is presumed Extinct in the Wild when exhaustive surveys in known and/or expected habitat, at appropriate times (diurnal, seasonal, annual), throughout its historic range have failed to record an individual. Surveys should be over a time frame appropriate to the taxon's life cycle and life form. |
|
|
Regionally extinct – Category for a taxon when there is no reasonable doubt that the last individual potentially capable of reproduction within the region has died or has disappeared from the wild in the region, or when, if it is a former visiting taxon, the last individual has died or disappeared in the wild from the region. The setting of any time limit for listing under RE is left to the discretion of the regional Red List authority, but should not normally pre-date 1500 AD. |
|
|
Critically Endangered – A taxon is Critically Endangered when the best available evidence indicates that it meets any of the criteria A to E for Critically Endangered (see Section V), and it is therefore considered to be facing an extremely high risk of extinction in the wild. |
|
|
Endangered – A taxon is Endangered when the best available evidence indicates that it meets any of the criteria A to E for Endangered (see Section V), and it is therefore considered to be facing a very high risk of extinction in the wild. |
|
|
Vulnerable – A taxon is Vulnerable when the best available evidence indicates that it meets any of the criteria A to E for Vulnerable (see Section V), and it is therefore considered to be facing a high risk of extinction in the wild. |
|
|
Near Threatened – A taxon is Near Threatened when it has been evaluated against the criteria but does not qualify for Critically Endangered, Endangered or Vulnerable now, but is close to qualifying for or is likely to qualify for a threatened category in the near future. |
|
|
Least Concern – A taxon is Least Concern when it has been evaluated against the criteria and does not qualify for Critically Endangered, Endangered, Vulnerable or Near Threatened. Widespread and abundant taxa are included in this category. |
|
|
Data Deficient – A taxon is Data Deficient when there is inadequate information to make a direct, or indirect, assessment of its risk of extinction based on its distribution and/or population status. A taxon in this category may be well studied, and its biology well known, but appropriate data on abundance and/or distribution are lacking. Data Deficient is therefore not a category of threat. Listing of taxa in this category indicates that more information is required and acknowledges the possibility that future research will show that threatened classification is appropriate. It is important to make positive use of whatever data are available. In many cases great care should be exercised in choosing between DD and a threatened status. If the range of a taxon is suspected to be relatively circumscribed, and a considerable period of time has elapsed since the last record of the taxon, threatened status may well be justified. |
|
|
Not Applicable – Category for a taxon deemed to be ineligible for assessment at a regional level. A taxon may be NA because it is not a wild population or not within its natural range in the region, or because it is a vagrant to the region. It may also be NA because it occurs at very low numbers in the region (i.e. when the regional Red List authority has decided to use a filter to exclude taxa before the assessment procedure) or the taxon may be classified at a lower taxonomic level (e.g. below the level of species or subspecies) than considered eligible by the regional Red List authority. In contrast to other Red List Categories, it is not mandatory to use NA for all taxa to which it applies; but is recommended for taxa where its use is informative. |
|
|
Not Evaluated – A taxon is Not Evaluated when it is has not yet been evaluated against the criteria. |
|
|
Threatened – This is a category made up in FFG: we do not know what it means. |
Example
"EX"
IdentificationKey
Image
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uid - String!
|
|
assetCreationDate - DateTime
|
|
caption - String
|
|
catalogNumber - String
|
|
copyrightOwner - String
|
|
country - String
|
|
countryCode - String
|
|
creationDate - DateTime
|
|
creator - String
|
|
cumulusCatalog - String!
|
|
cumulusRecordId - Int!
|
|
cumulusRecordName - String
|
|
decimalLatitude - Float
|
|
decimalLongitude - Float
|
|
heroImage - Boolean
|
|
license - String
|
|
locality - String
|
|
modified - String
|
|
originatingProgram - String
|
|
pixelXDimension - Int
|
|
pixelYDimension - Int
|
|
rating - Int
|
|
recordedBy - String
|
|
recordNumber - String
|
|
rights - String
|
|
scientificName - String
|
|
originalScientificName - String
|
|
source - String
|
|
stateProvince - String
|
|
subjectCategory - String
|
|
subjectOrientation - String
|
|
subjectPart - String
|
|
subtype - String
|
|
title - String
|
|
type - String
|
|
taxonConcepts - [TaxonConcept!]
|
|
thumbnailUrl - String
|
|
previewUrl - String
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
version - Int
|
Example
{
"id": 4,
"uid": "abc123",
"assetCreationDate": "2007-12-03T10:15:30Z",
"caption": "abc123",
"catalogNumber": "abc123",
"copyrightOwner": "abc123",
"country": "xyz789",
"countryCode": "abc123",
"creationDate": "2007-12-03T10:15:30Z",
"creator": "abc123",
"cumulusCatalog": "abc123",
"cumulusRecordId": 987,
"cumulusRecordName": "abc123",
"decimalLatitude": 123.45,
"decimalLongitude": 123.45,
"heroImage": false,
"license": "xyz789",
"locality": "abc123",
"modified": "abc123",
"originatingProgram": "xyz789",
"pixelXDimension": 987,
"pixelYDimension": 987,
"rating": 987,
"recordedBy": "abc123",
"recordNumber": "abc123",
"rights": "xyz789",
"scientificName": "xyz789",
"originalScientificName": "xyz789",
"source": "abc123",
"stateProvince": "xyz789",
"subjectCategory": "xyz789",
"subjectOrientation": "xyz789",
"subjectPart": "xyz789",
"subtype": "xyz789",
"title": "xyz789",
"type": "abc123",
"taxonConcepts": [TaxonConcept],
"thumbnailUrl": "abc123",
"previewUrl": "abc123",
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987
}
ImagePaginator
Description
A paginated list of Image items.
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
Pagination information about the list of items. |
data - [Image!]!
|
A list of Image items. |
Example
{
"paginatorInfo": PaginatorInfo,
"data": [Image]
}
IndexFields
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
JSON
Description
Arbitrary data encoded in JavaScript Object Notation. See https://www.json.org/.
Example
{}
LinkUserInput
LocalGovernmentAreaFeature
Fields
| Field Name | Description |
|---|---|
type - String
|
|
geometry - GeoJSONGeometry
|
|
properties - LocalGovernmentAreaProperties
|
Example
{
"type": "abc123",
"geometry": GeoJSONGeometry,
"properties": LocalGovernmentAreaProperties
}
LocalGovernmentAreaProperties
MapLinks
MatrixKey
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
title - String!
|
|
relativePath - String!
|
|
taxonConcepts - [TaxonConcept]
|
Example
{
"id": "4",
"title": "abc123",
"relativePath": "xyz789",
"taxonConcepts": [TaxonConcept]
}
MonthEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"JANUARY"
MultiAccessKey
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
title - String!
|
|
description - String
|
|
location - String!
|
|
characterGroups - [MultiAccessKeyCharacter]
|
|
characters - [MultiAccessKeyCharacter!]!
|
Example
{
"id": "4",
"title": "abc123",
"description": "xyz789",
"location": "abc123",
"characterGroups": [MultiAccessKeyCharacter],
"characters": [MultiAccessKeyCharacter]
}
MultiAccessKeyBelongsTo
Fields
| Input Field | Description |
|---|---|
connect - ID!
|
Example
{"connect": 4}
MultiAccessKeyCharacter
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
type - Int!
|
|
characterType - CharacterTypeEnum
|
|
description - String
|
|
parent - MultiAccessKeyCharacter
|
|
children - [MultiAccessKeyCharacter]
|
|
key - MultiAccessKey!
|
|
states - [MultiAccessKeyState]
|
|
unit - MultiAccessKeyCharacter
|
Example
{
"id": 4,
"name": "xyz789",
"type": 987,
"characterType": "ORDERED",
"description": "abc123",
"parent": MultiAccessKeyCharacter,
"children": [MultiAccessKeyCharacter],
"key": MultiAccessKey,
"states": [MultiAccessKeyState],
"unit": MultiAccessKeyCharacter
}
MultiAccessKeyCharacterBelongsTo
Fields
| Input Field | Description |
|---|---|
connect - ID!
|
Example
{"connect": 4}
MultiAccessKeyState
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
description - String
|
|
feature - MultiAccessKeyCharacter!
|
|
images - [Image]
|
Example
{
"id": 4,
"name": "abc123",
"description": "abc123",
"feature": MultiAccessKeyCharacter,
"images": [Image]
}
NameType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
uri - String
|
|
label - String
|
|
description - String
|
|
taxonNames - [TaxonName]
|
|
createdBy - Agent
|
|
modifiedBy - Agent
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
version - Int
|
Example
{
"id": "4",
"name": "xyz789",
"uri": "abc123",
"label": "abc123",
"description": "abc123",
"taxonNames": [TaxonName],
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987
}
NameTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SCIENTIFIC"
NomenclaturalStatus
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
guid - UUID
|
|
name - String!
|
|
uri - String
|
|
label - String
|
|
description - String
|
|
taxonNames - [TaxonName]
|
|
createdBy - Agent
|
|
modifiedBy - Agent
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
version - Int
|
Example
{
"id": "4",
"guid": "f96ccca6-10f1-4749-a923-a38ede8ea0b6",
"name": "xyz789",
"uri": "abc123",
"label": "abc123",
"description": "abc123",
"taxonNames": [TaxonName],
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123
}
OccurrenceFeature
Description
Occurrence of a taxon at a certain place on a certain date. Will return GeoJSON-compliant Feature if at least type and geometry with both its properties are used.
Fields
| Field Name | Description |
|---|---|
type - String
|
|
geometry - OccurrenceGeometry
|
|
properties - OccurrenceProperties
|
Example
{
"type": "abc123",
"geometry": OccurrenceGeometry,
"properties": OccurrenceProperties
}
OccurrenceFeaturePaginator
Description
A paginated list of OccurrenceFeature items.
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
Pagination information about the list of items. |
data - [OccurrenceFeature!]!
|
A list of OccurrenceFeature items. |
Example
{
"paginatorInfo": PaginatorInfo,
"data": [OccurrenceFeature]
}
OccurrenceGeometry
OccurrenceProperties
Fields
| Field Name | Description |
|---|---|
uuid - ID!
|
|
dataSource - String
|
|
collection - String
|
|
catalogNumber - String
|
|
recordedBy - String
|
|
recordNumber - String
|
|
eventDate - String
|
|
scientificName - String
|
|
speciesName - String
|
|
decimalLatitude - Float
|
|
decimalLongitude - Float
|
|
occurrenceStatus - String
|
|
establishmentMeans - String
|
|
degreeOfEstablishment - String
|
Example
{
"uuid": 4,
"dataSource": "abc123",
"collection": "xyz789",
"catalogNumber": "abc123",
"recordedBy": "xyz789",
"recordNumber": "xyz789",
"eventDate": "xyz789",
"scientificName": "xyz789",
"speciesName": "abc123",
"decimalLatitude": 123.45,
"decimalLongitude": 123.45,
"occurrenceStatus": "xyz789",
"establishmentMeans": "abc123",
"degreeOfEstablishment": "xyz789"
}
OccurrenceStatusEnum
Description
Controlled vocabulary for occurrenceStatus. We use a previous version of the GBIF vocabulary (https://rs.gbif.org/vocabulary/gbif/occurrence_status.xml).
Values
| Enum Value | Description |
|---|---|
|
|
Present – There is at least one well-documented record of the taxon in the area. |
|
|
Extinct – There is no evidence that the taxon is still present in the area. |
|
|
Excluded – The taxon has been reported for the area, but the report is based on a misdetermination. A "taxon" that is solely identified by its name can also be considered 'excluded' because the taxonomy has changed. |
|
|
Doubtful – Presence of an organism in the area is doubtful. In VicFlora we do not use this term at the taxon level, nor at the scale of Victoria, but only at the occurrence record level. |
Example
"PRESENT"
PaginatorInfo
Description
Information about pagination using a fully featured paginator.
Fields
| Field Name | Description |
|---|---|
count - Int!
|
Number of items in the current page. |
currentPage - Int!
|
Index of the current page. |
firstItem - Int
|
Index of the first item in the current page. |
hasMorePages - Boolean!
|
Are there more pages after this one? |
lastItem - Int
|
Index of the last item in the current page. |
lastPage - Int!
|
Index of the last available page. |
perPage - Int!
|
Number of items per page. |
total - Int!
|
Number of total available items. |
Example
{
"count": 987,
"currentPage": 123,
"firstItem": 123,
"hasMorePages": false,
"lastItem": 987,
"lastPage": 987,
"perPage": 987,
"total": 123
}
ParkReserveFeature
Fields
| Field Name | Description |
|---|---|
type - String
|
|
geometry - GeoJSONGeometry
|
|
properties - ParkReserveProperties
|
Example
{
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": ParkReserveProperties
}
ParkReserveProperties
Example
{
"id": "4",
"name": "xyz789",
"label": "abc123",
"nameShort": "xyz789",
"areaType": "xyz789",
"areaSrc": "abc123",
"veacRec": "abc123",
"veacStudy": "abc123",
"iucn": "abc123",
"establishmentDate": "2007-12-03",
"areaSqm": 123.45,
"slug": "abc123"
}
PhenologyItem
Profile
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
guid - UUID
|
|
profile - String!
|
|
taxonConcept - TaxonConcept
|
|
acceptedConcept - TaxonConcept
|
|
source - Reference
|
|
creator - Agent
|
|
updatedBy - Agent
|
|
created - Date
|
|
modified - Date
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
createdBy - Agent
|
|
modifiedBy - Agent
|
|
version - Int
|
Example
{
"id": 4,
"guid": "f96ccca6-10f1-4749-a923-a38ede8ea0b6",
"profile": "abc123",
"taxonConcept": TaxonConcept,
"acceptedConcept": TaxonConcept,
"source": Reference,
"creator": Agent,
"updatedBy": Agent,
"created": "2007-12-03",
"modified": "2007-12-03",
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"createdBy": Agent,
"modifiedBy": Agent,
"version": 123
}
PublicationStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DRAFT"
Reference
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
quickRef - String
|
|
author - Agent
|
|
referenceType - ReferenceTypeEnum
|
|
publicationYear - String
|
|
title - String!
|
|
shortTitle - String
|
|
edition - String
|
|
volume - String
|
|
issue - String
|
|
pageStart - Int
|
|
pageEnd - Int
|
|
pages - String
|
|
numberOfPages - String
|
|
publisher - String
|
|
placeOfPublication - String
|
|
shortDescription - String
|
|
abstract - String
|
|
isbn - String
|
|
issn - String
|
|
doi - String
|
|
parent - Reference
|
|
isPartOf - Reference
|
|
journal - Reference
|
|
book - Reference
|
|
contributors - [Contributor]
|
|
citation - String
|
Reference as an unformatted string (deprecated; use referenceString instead) |
referenceString - String
|
Reference as an unformatted string |
citationHtml - String
|
Reference in HTML format (deprecated; use referenceStringHtml instead) |
referenceStringHtml - String
|
Reference in HTML format |
citationMarkdown - String
|
Reference in Markdown format (deprecated; use referenceStringMarkdown instead) |
referenceStringMarkdown - String
|
Reference in Markdown format |
taxonNames - [TaxonName]
|
Taxon Names for which this Reference is the protologue |
taxonConcepts - [TaxonConceptReference]
|
Taxon Concepts where this Reference is cited. Note: We have a Taxon Concept Reference type rather than a simple association to resolve the many-to-many relationship between Taxon Concept and Reference. At the moment it does not have any data properties, but we have the option to add them later. |
Example
{
"id": "4",
"quickRef": "abc123",
"author": Agent,
"referenceType": "ARTICLE",
"publicationYear": "abc123",
"title": "abc123",
"shortTitle": "xyz789",
"edition": "abc123",
"volume": "xyz789",
"issue": "xyz789",
"pageStart": 123,
"pageEnd": 987,
"pages": "abc123",
"numberOfPages": "xyz789",
"publisher": "xyz789",
"placeOfPublication": "abc123",
"shortDescription": "abc123",
"abstract": "abc123",
"isbn": "abc123",
"issn": "abc123",
"doi": "xyz789",
"parent": Reference,
"isPartOf": Reference,
"journal": Reference,
"book": Reference,
"contributors": [Contributor],
"citation": "xyz789",
"referenceString": "abc123",
"citationHtml": "abc123",
"referenceStringHtml": "abc123",
"citationMarkdown": "xyz789",
"referenceStringMarkdown": "abc123",
"taxonNames": [TaxonName],
"taxonConcepts": [TaxonConceptReference]
}
ReferenceBelongsTo
Fields
| Input Field | Description |
|---|---|
connect - ID
|
Example
{"connect": 4}
ReferenceType
ReferenceTypeEnum
Description
Reference types: values are subtypes of http://schema.org/CreativeWork
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Everything associated with a name at its valid publication, i.e. description or diagnosis, illustrations, references, synonyms, geographical data, citation of specimens, discussion and comments. 'Protologue' is not in schema.org, but we have it as a separate type, as protologue citations mostly come in abbreviated form, from which it is not always clear whether it is an Article or a Book, etc. and whether or not it coincides with other References. |
|
|
Abbreviated citations given as the according-to in misapplied names and informal names, e.g. Dianella tasmanica sensu Fl. Victoria 2:649 (1994). These still need to be replaced by full references. |
|
|
|
|
|
|
|
|
Example
"ARTICLE"
RegisteredAboriginalPartyFeature
Fields
| Field Name | Description |
|---|---|
type - String
|
|
geometry - GeoJSONGeometry
|
|
properties - RegisteredAboriginalPartyProperties
|
Example
{
"type": "xyz789",
"geometry": GeoJSONGeometry,
"properties": RegisteredAboriginalPartyProperties
}
RegisteredAboriginalPartyProperties
SearchInput
Example
{
"q": "xyz789",
"fq": ["abc123"],
"rows": 123,
"page": 123,
"sort": ["abc123"],
"facet": true,
"facetField": ["abc123"],
"facetSort": "xyz789",
"facetLimit": 987,
"facetOffset": 987
}
SearchMetadata
Fields
| Field Name | Description |
|---|---|
params - SearchParameters
|
|
query - String
|
|
pagination - PaginatorInfo
|
Example
{
"params": SearchParameters,
"query": "abc123",
"pagination": PaginatorInfo
}
SearchParameters
Example
{
"q": "abc123",
"fq": ["xyz789"],
"fl": ["xyz789"],
"rows": 987,
"page": 987,
"start": 123,
"facet": true,
"facetField": ["abc123"],
"facetSort": "abc123",
"facetLimit": 123,
"facetOffset": 987
}
SearchResult
Fields
| Field Name | Description |
|---|---|
meta - SearchMetadata
|
|
docs - [SearchResultDocument]
|
|
facetFields - [SearchResultFacetField]
|
Example
{
"meta": SearchMetadata,
"docs": [SearchResultDocument],
"facetFields": [SearchResultFacetField]
}
SearchResultDocument
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
taxonRank - String
|
|
scientificNameId - String
|
|
scientificName - String
|
|
scientificNameAuthorship - String
|
|
nameType - String
|
|
namePublishedInId - String
|
|
namePublishedIn - String
|
|
namePublishedInYear - String
|
|
nameAccordingTo - String
|
|
kingdom - String
|
|
phylum - String
|
|
class - String
|
|
order - String
|
|
family - String
|
|
genus - String
|
|
specificEpithet - String
|
|
infraspecificEpithet - String
|
|
parentNameUsageId - String
|
|
parentNameUsage - String
|
|
acceptedNameUsageId - String
|
|
acceptedNameUsage - String
|
|
acceptedNameUsageAuthorship - String
|
|
taxonomicStatus - String
|
|
occurrenceStatus - String
|
|
establishmentMeans - String
|
|
degreeOfEstablishment - String
|
|
endemic - Boolean
|
|
hasIntroducedOccurrences - Boolean
|
|
ffg - String
|
|
epbc - String
|
|
vicAdvisory - String
|
|
taxonRemarks - String
|
|
vernacularName - [String]
|
|
preferredVernacularName - String
|
|
description - String
|
|
media - [String]
|
|
publicationStatus - String
|
|
created - DateTimeTz
|
|
modified - DateTimeTz
|
Example
{
"id": 4,
"taxonRank": "xyz789",
"scientificNameId": "abc123",
"scientificName": "xyz789",
"scientificNameAuthorship": "abc123",
"nameType": "xyz789",
"namePublishedInId": "abc123",
"namePublishedIn": "abc123",
"namePublishedInYear": "xyz789",
"nameAccordingTo": "abc123",
"kingdom": "abc123",
"phylum": "abc123",
"class": "abc123",
"order": "abc123",
"family": "xyz789",
"genus": "xyz789",
"specificEpithet": "abc123",
"infraspecificEpithet": "xyz789",
"parentNameUsageId": "abc123",
"parentNameUsage": "xyz789",
"acceptedNameUsageId": "abc123",
"acceptedNameUsage": "xyz789",
"acceptedNameUsageAuthorship": "abc123",
"taxonomicStatus": "xyz789",
"occurrenceStatus": "xyz789",
"establishmentMeans": "xyz789",
"degreeOfEstablishment": "abc123",
"endemic": false,
"hasIntroducedOccurrences": false,
"ffg": "xyz789",
"epbc": "xyz789",
"vicAdvisory": "abc123",
"taxonRemarks": "xyz789",
"vernacularName": ["xyz789"],
"preferredVernacularName": "abc123",
"description": "xyz789",
"media": ["abc123"],
"publicationStatus": "xyz789",
"created": DateTimeTz,
"modified": DateTimeTz
}
SearchResultFacet
SearchResultFacetField
Fields
| Field Name | Description |
|---|---|
fieldName - String!
|
|
fieldLabel - String
|
|
facets - [SearchResultFacet!]!
|
Example
{
"fieldName": "abc123",
"fieldLabel": "xyz789",
"facets": [SearchResultFacet]
}
SpecimenImage
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
cumulusRecordId - Int!
|
|
recordName - String
|
|
catalogNumber - String
|
|
alaImageUuid - String
|
|
title - String
|
|
caption - String
|
|
originatingProgram - String
|
|
subjectCategory - String
|
|
pixelXDimension - Int
|
|
pixelYDimension - Int
|
|
scientificName - String
|
|
thumbnailUrl - String
|
|
taxonConcepts - [TaxonConcept!]
|
Example
{
"id": "4",
"cumulusRecordId": 987,
"recordName": "xyz789",
"catalogNumber": "xyz789",
"alaImageUuid": "xyz789",
"title": "abc123",
"caption": "abc123",
"originatingProgram": "xyz789",
"subjectCategory": "abc123",
"pixelXDimension": 123,
"pixelYDimension": 987,
"scientificName": "abc123",
"thumbnailUrl": "xyz789",
"taxonConcepts": [TaxonConcept]
}
SpecimenImagePaginator
Description
A paginated list of SpecimenImage items.
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
Pagination information about the list of items. |
data - [SpecimenImage!]!
|
A list of SpecimenImage items. |
Example
{
"paginatorInfo": PaginatorInfo,
"data": [SpecimenImage]
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
TaxonBioregion
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
taxonConcept - TaxonConcept
|
|
bioregion - BioregionFeature
|
|
occurrenceStatus - OccurrenceStatusEnum
|
|
establishmentMeans - EstablishmentMeansEnum
|
|
bioregionName - String
|
|
bioregionCode - String
|
Example
{
"id": 4,
"taxonConcept": TaxonConcept,
"bioregion": BioregionFeature,
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"bioregionName": "xyz789",
"bioregionCode": "abc123"
}
TaxonConcept
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
remarks - String
|
editorNotes about a taxon. We only use this for Taxon Concepts that are not currently recognised. For currently accepted taxa the notes are in the profile. |
taxonName - TaxonName!
|
Name of a taxon |
accordingTo - Reference
|
Source of the taxon name and application. This is currently only used with misapplications. |
acceptedConcept - TaxonConcept
|
Accepted name, e.g. for a synonym. We currently still deal with synonyms as Taxon Concepts. |
parent - TaxonConcept
|
Parent of a taxon, e.g. a genus a species belongs to. |
children - [TaxonConcept]
|
Children of a taxon, e.g. varieties of a species or species in a genus. |
siblings - [TaxonConcept]
|
Siblings of the taxon, e.g. species in the same genus. Also includes the current Taxon Concept itself. |
ancestors - [TaxonConcept]
|
All ancestors of Taxon |
descendants - [TaxonConcept]
|
All descendants of a taxon, e.g. genera, species and infraspecific taxa in a family. |
higherClassification - [TaxonConcept]
|
Higher classification of a taxon. Like ancestors, but ordered from higher to lower rank, and only including major ranks: kingdom, phylum, class, order, family, genus, species. |
taxonRank - TaxonRankEnum
|
The rank of a taxon, or rather its name. This is an enumeration, so output is a (all uppercase) string. |
taxonTreeDefItem - TaxonTreeDefItem
|
Rank of a taxon in the form of an object. |
taxonomicStatus - TaxonomicStatusEnum
|
The status of the use of the scientificName as a label for a taxon. Requires taxonomic opinion to define the scope of a taxon. Rules of priority then are used to define the taxonomic status of the nomenclature contained in that scope, combined with the experts opinion. It must be linked to a specific taxonomic reference that defines the concept (http://rs.tdwg.org/dwc/terms/taxonomicStatus). |
occurrenceStatus - OccurrenceStatusEnum
|
A statement about the presence or absence of a Taxon at a Location (http://rs.tdwg.org/dwc/terms/occurrenceStatus). |
establishmentMeans - EstablishmentMeansEnum
|
Statement about whether an organism or organisms have been introduced to a given place and time through the direct or indirect activity of modern humans (http://rs.tdwg.org/dwc/terms/establishmentMeans). |
degreeOfEstablishment - DegreeOfEstablishmentEnum
|
The degree to which an Organism survives, reproduces, and expands its range at the given place and time (http://rs.tdwg.org/dwc/terms/degreeOfEstablishment). |
endemic - Boolean
|
Endemic to Victoria; does not natively occur outside Victoria. |
hasIntroducedOccurrences - Boolean
|
Taxon is native to Victoria, but there are introduced occurrences in Victoria as well. This flag is used to deal with the 'dual status' from the old vascular plant censuses. |
epbc - IUCNThreatStatusEnum
|
Environment Protection and Biodiversity Conservation (EPBC) Act 1999 |
ffg - IUCNThreatStatusEnum
|
Flora and Fauna Guarantee (FFG) Act 1988 |
vernacularNames - [VernacularName]
|
Common or vernacular names |
preferredVernacularName - VernacularName
|
Preferred vernacular name. Often there are multiple vernacular names for the same taxon. The preferred vascular name is the one we use in VicFlora. |
profiles - [Profile]
|
Profiles for a Taxon Concept. We save previous profiles and versions of profiles. |
currentProfile - CurrentProfile
|
Current profile for a Taxon Concept. |
heroImage - Image
|
Hero image for a taxon, i.e. the image that is shown in the overview tab. |
hasImages - Boolean
|
Flag to indicate whether a Taxon Concept has images associated with it. Used in VicFlora to see if an Image tab needs to be created on the taxon page. Image metadata and thumbnails will be fetched once the Image tab is opened. |
hasSpecimenImages - Boolean
|
Flag to indicate whether a Taxon Concept has specimen images associated with it. Used in VicFlora to see if a Specimen Image tab needs to be created on the taxon page. Image metadata and thumbnails will be fetched once the Specimen Image tab is opened. |
bioregions - [TaxonBioregion]
|
Victorian bioregions where the taxon occurs. |
localGovernmentAreas - [TaxonLocalGovernmentArea]
|
Local Government Areas where the taxon occurs |
parkReserves - [TaxonParkReserve]
|
Parks and reserves where the taxon occurs. |
phenology - [PhenologyItem]
|
Occurrence and presence of reproductive structures at a particular time of the year |
hasReproductiveStructures - Boolean!
|
Check whether there are any specimens with reproductive structures |
mapLinks - MapLinks
|
Links to distribution maps for a taxon from the Geoserver instance, as well as the captions. |
identificationKeys - [IdentificationKey!]!
|
|
matrixKeys - [MatrixKey]
|
|
synonyms - [TaxonName]
|
Synonyms of the accepted name (taxonName). |
synonymUsages - [TaxonConcept]
|
This has been added, because currently the VicFlora system requires synonyms to be provided as usages (concepts). Once VicFlora is set up for concept alignments, we might not be able to provide synonyms this way anymore. |
misapplications - [TaxonConcept]
|
This has been added, because currently the VicFlora system requires misapplications to be provided as usages (concepts). Once VicFlora is set up for concept alignments, we might not be able to provide synonyms this way anymore. |
references - [TaxonConceptReference]
|
References cited in the profile of a Taxon Concept. We have a Taxon Concept Reference type rather than a simple association to resolve the many-to-many relationship between Taxon Concept and Reference. At the moment it does not have any data properties, but we have the option to add them later. |
floraLinks - [TaxonConceptFloraLink]
|
Links to other floras. We've got a type, Taxon Concept Flora Link, for this, so, in principle extra information can be added. |
changes - [Change]
|
|
publicationStatus - PublicationStatusEnum!
|
Publication status creates a rudimentary publication workflow. A Taxon Concept can be 'draft' or 'published'. 'draft' Taxon Concepts are only visible to VicFlora editors. |
createdBy - Agent
|
|
modifiedBy - Agent
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
version - Int
|
|
images - ImagePaginator
|
Images associated with a Taxon Concept |
specimenImages - SpecimenImagePaginator
|
|
Example
{
"id": 4,
"remarks": "xyz789",
"taxonName": TaxonName,
"accordingTo": Reference,
"acceptedConcept": TaxonConcept,
"parent": TaxonConcept,
"children": [TaxonConcept],
"siblings": [TaxonConcept],
"ancestors": [TaxonConcept],
"descendants": [TaxonConcept],
"higherClassification": [TaxonConcept],
"taxonRank": "LIFE",
"taxonTreeDefItem": TaxonTreeDefItem,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": true,
"hasIntroducedOccurrences": false,
"epbc": "EX",
"ffg": "EX",
"vernacularNames": [VernacularName],
"preferredVernacularName": VernacularName,
"profiles": [Profile],
"currentProfile": CurrentProfile,
"heroImage": Image,
"hasImages": false,
"hasSpecimenImages": false,
"bioregions": [TaxonBioregion],
"localGovernmentAreas": [TaxonLocalGovernmentArea],
"parkReserves": [TaxonParkReserve],
"phenology": [PhenologyItem],
"hasReproductiveStructures": true,
"mapLinks": MapLinks,
"identificationKeys": [IdentificationKey],
"matrixKeys": [MatrixKey],
"synonyms": [TaxonName],
"synonymUsages": [TaxonConcept],
"misapplications": [TaxonConcept],
"references": [TaxonConceptReference],
"floraLinks": [TaxonConceptFloraLink],
"changes": [Change],
"publicationStatus": "DRAFT",
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123,
"images": ImagePaginator,
"specimenImages": SpecimenImagePaginator
}
TaxonConceptBelongsTo
Fields
| Input Field | Description |
|---|---|
connect - ID!
|
Example
{"connect": "4"}
TaxonConceptFloraLink
TaxonConceptPaginator
Description
A paginated list of TaxonConcept items.
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
Pagination information about the list of items. |
data - [TaxonConcept!]!
|
A list of TaxonConcept items. |
Example
{
"paginatorInfo": PaginatorInfo,
"data": [TaxonConcept]
}
TaxonConceptReference
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
taxonConcept - TaxonConcept
|
|
reference - Reference
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
createdBy - Agent
|
|
updatedBy - Agent
|
Example
{
"id": 4,
"taxonConcept": TaxonConcept,
"reference": Reference,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"createdBy": Agent,
"updatedBy": Agent
}
TaxonLocalGovernmentArea
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
taxonConcept - TaxonConcept
|
|
localGovernmentArea - LocalGovernmentAreaFeature
|
|
localGovernmentAreaName - String
|
|
localGovernmentAreaAbbreviatedName - String
|
|
occurrenceStatus - OccurrenceStatusEnum
|
|
establishmentMeans - EstablishmentMeansEnum
|
Example
{
"id": "4",
"taxonConcept": TaxonConcept,
"localGovernmentArea": LocalGovernmentAreaFeature,
"localGovernmentAreaName": "abc123",
"localGovernmentAreaAbbreviatedName": "xyz789",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE"
}
TaxonName
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
rank - TaxonRankEnum
|
|
parent - TaxonName
|
|
namePart - String
|
|
fullName - String!
|
|
authorship - String
|
|
fullNameWithAuthorship - String
|
|
nomenclaturalNote - String
|
|
remarks - String
|
|
nameType - NameTypeEnum
|
|
basionym - TaxonName
|
|
replacedSynonym - TaxonName
|
|
publishedIn - Reference
|
|
protologue - Reference
|
Note: Deprecated in favour of publishedIn |
taxonConcepts - [TaxonConcept]
|
|
apniName - ApniName
|
Link to name record in APNI |
vbaTaxaListItem - VbaTaxaListItem
|
Link to taxon record in VBA |
createdBy - Agent
|
|
modifiedBy - Agent
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
version - Int
|
Example
{
"id": "4",
"rank": "LIFE",
"parent": TaxonName,
"namePart": "abc123",
"fullName": "xyz789",
"authorship": "abc123",
"fullNameWithAuthorship": "abc123",
"nomenclaturalNote": "xyz789",
"remarks": "abc123",
"nameType": "SCIENTIFIC",
"basionym": TaxonName,
"replacedSynonym": TaxonName,
"publishedIn": Reference,
"protologue": Reference,
"taxonConcepts": [TaxonConcept],
"apniName": ApniName,
"vbaTaxaListItem": VbaTaxaListItem,
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987
}
TaxonNameBelongsTo
Fields
| Input Field | Description |
|---|---|
connect - ID!
|
Example
{"connect": "4"}
TaxonParkReserve
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
taxonConcept - TaxonConcept
|
|
parkReserve - ParkReserveFeature
|
|
parkReserveName - String
|
|
parkReserveShortName - String
|
|
parkReserveAreaType - String
|
|
occurrenceStatus - OccurrenceStatusEnum
|
|
establishmentMeans - EstablishmentMeansEnum
|
Example
{
"id": "4",
"taxonConcept": TaxonConcept,
"parkReserve": ParkReserveFeature,
"parkReserveName": "abc123",
"parkReserveShortName": "xyz789",
"parkReserveAreaType": "abc123",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE"
}
TaxonRankEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LIFE"
TaxonRegisteredAboriginalParty
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
taxonConcept - TaxonConcept
|
|
registeredAboriginalParty - RegisteredAboriginalPartyFeature
|
|
registeredAboriginalPartyName - String
|
|
registeredAnoriginalPartyShortName - String
|
|
registeredAnoriginalPartyTraditionalOwners - String
|
|
occurrenceStatus - OccurrenceStatusEnum
|
|
establishmentMeans - EstablishmentMeansEnum
|
Example
{
"id": "4",
"taxonConcept": TaxonConcept,
"registeredAboriginalParty": RegisteredAboriginalPartyFeature,
"registeredAboriginalPartyName": "xyz789",
"registeredAnoriginalPartyShortName": "abc123",
"registeredAnoriginalPartyTraditionalOwners": "abc123",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE"
}
TaxonTreeDefItem
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
name - String!
|
|
textBefore - String
|
|
textAfter - String
|
|
fullNameSeparator - String
|
|
isEnforced - Boolean
|
|
isInFullName - Boolean
|
|
rankId - Int
|
|
parentItem - TaxonTreeDefItem
|
|
taxonConcepts - [TaxonConcept]
|
|
createdBy - Agent
|
|
modifiedBy - Agent
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
version - Int
|
Example
{
"id": 4,
"name": "abc123",
"textBefore": "abc123",
"textAfter": "abc123",
"fullNameSeparator": "xyz789",
"isEnforced": true,
"isInFullName": true,
"rankId": 987,
"parentItem": TaxonTreeDefItem,
"taxonConcepts": [TaxonConcept],
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 123
}
TaxonomicStatusEnum
Description
Enumeration for the dwc:taxonomicStatus term. We follow the GBIF Taxonomic Status Vocabulary, https://rs.gbif.org/vocabulary/gbif/taxonomic_status.xml
Values
| Enum Value | Description |
|---|---|
|
|
Accepted – The taxon is currently accepted in VicFlora. |
|
|
Synonym – The name is a synonym of the name of an accepted taxon. In VicFlora we tend to use this only for names that cannot be considered homotypic or heterotypic synonyms, like autonyms and phrase names. In the front end we call all synonyms just 'synonyms'. |
|
|
Homotypic synonym – The name is a homotypic (syn.: nomenclatural) synonym. |
|
|
Heterotypic synonym – The name is a heterotypic (syn.: taxonomic) synonym. |
|
|
Misapplication – The name has been misapplied. |
|
|
Not accepted – The name is not currently accepted in VicFlora, but can also not be considered a synonym or misapplication. |
Example
"ACCEPTED"
UUID
Description
A UUID string, e.g. 0c8e21a6-fe09-4835-84e1-d9531ad24728.
Example
"f96ccca6-10f1-4749-a923-a38ede8ea0b6"
UpdateAgentInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
agentType - AgentTypeEnum
|
|
name - String
|
|
lastName - String
|
|
firstName - String
|
|
initials - String
|
|
email - Email
|
|
legalName - String
|
|
members - [GroupPersonInput]
|
Example
{
"id": "4",
"agentType": "PERSON",
"name": "abc123",
"lastName": "abc123",
"firstName": "abc123",
"initials": "abc123",
"email": Email,
"legalName": "abc123",
"members": [GroupPersonInput]
}
UpdateGroupPersonInput
UpdateMultiAccessKeyCharacterInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
type - Int
|
|
characterType - CharacterTypeEnum
|
|
description - String
|
|
parent - MultiAccessKeyCharacterBelongsTo
|
Example
{
"id": 4,
"name": "abc123",
"type": 987,
"characterType": "ORDERED",
"description": "xyz789",
"parent": MultiAccessKeyCharacterBelongsTo
}
UpdateMultiAccessKeyInput
UpdateMultiAccessKeyStateInput
UpdateProfileInput
UpdateReferenceInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
author - AgentBelongsTo
|
|
publicationYear - String
|
|
title - String!
|
|
shortTitle - String
|
|
journal - ReferenceBelongsTo
|
|
book - ReferenceBelongsTo
|
|
edition - String
|
|
volume - String
|
|
issue - String
|
|
pageStart - Int
|
|
pageEnd - Int
|
|
pages - String
|
|
numberOfPages - String
|
|
publisher - String
|
|
placeOfPublication - String
|
|
shortDescription - String
|
|
abstract - String
|
|
isbn - String
|
|
issn - String
|
|
doi - String
|
|
referenceType - ReferenceTypeEnum
|
|
parent - ReferenceBelongsTo
|
Example
{
"id": 4,
"author": AgentBelongsTo,
"publicationYear": "abc123",
"title": "abc123",
"shortTitle": "abc123",
"journal": ReferenceBelongsTo,
"book": ReferenceBelongsTo,
"edition": "xyz789",
"volume": "abc123",
"issue": "xyz789",
"pageStart": 123,
"pageEnd": 987,
"pages": "abc123",
"numberOfPages": "abc123",
"publisher": "xyz789",
"placeOfPublication": "abc123",
"shortDescription": "xyz789",
"abstract": "xyz789",
"isbn": "abc123",
"issn": "xyz789",
"doi": "abc123",
"referenceType": "ARTICLE",
"parent": ReferenceBelongsTo
}
UpdateTaxonConceptInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
taxonName - TaxonNameBelongsTo!
|
|
accordingTo - ReferenceBelongsTo
|
|
taxonRank - TaxonRankEnum!
|
|
acceptedConcept - TaxonConceptBelongsTo
|
|
parent - TaxonConceptBelongsTo
|
|
taxonomicStatus - TaxonomicStatusEnum
|
|
occurrenceStatus - OccurrenceStatusEnum
|
|
establishmentMeans - EstablishmentMeansEnum
|
|
degreeOfEstablishment - DegreeOfEstablishmentEnum
|
|
endemic - Boolean
|
|
hasIntroducedOccurrences - Boolean
|
|
remarks - String
|
|
publicationStatus - PublicationStatusEnum
|
Example
{
"id": 4,
"taxonName": TaxonNameBelongsTo,
"accordingTo": ReferenceBelongsTo,
"taxonRank": "LIFE",
"acceptedConcept": TaxonConceptBelongsTo,
"parent": TaxonConceptBelongsTo,
"taxonomicStatus": "ACCEPTED",
"occurrenceStatus": "PRESENT",
"establishmentMeans": "NATIVE",
"degreeOfEstablishment": "NATIVE",
"endemic": true,
"hasIntroducedOccurrences": false,
"remarks": "abc123",
"publicationStatus": "DRAFT"
}
UpdateTaxonNameInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
nameType - NameTypeEnum
|
|
rank - TaxonRankEnum
|
|
parent - TaxonNameBelongsTo
|
|
namePart - String
|
|
fullName - String
|
|
authorship - String
|
|
nomenclaturalNote - String
|
|
remarks - String
|
|
protologue - ReferenceBelongsTo
|
Example
{
"id": 4,
"nameType": "SCIENTIFIC",
"rank": "LIFE",
"parent": TaxonNameBelongsTo,
"namePart": "abc123",
"fullName": "xyz789",
"authorship": "xyz789",
"nomenclaturalNote": "xyz789",
"remarks": "abc123",
"protologue": ReferenceBelongsTo
}
UpdateUserPreferencesInput
Fields
| Input Field | Description |
|---|---|
user - UserBelongsTo!
|
|
defaultPublicationStatus - PublicationStatusEnum!
|
Example
{
"user": UserBelongsTo,
"defaultPublicationStatus": "DRAFT"
}
UpdateVernacularNameInput
UserBelongsTo
Fields
| Input Field | Description |
|---|---|
connect - ID!
|
Example
{"connect": 4}
UserPreferences
Fields
| Field Name | Description |
|---|---|
defaultPublicationStatus - PublicationStatusEnum!
|
Example
{"defaultPublicationStatus": "DRAFT"}
VbaTaxaListItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
scientificName - String!
|
|
commonName - String
|
|
authority - String
|
|
restriction - String
|
|
origin - String
|
|
taxonType - String
|
|
lifeForm - String
|
|
nvisGrowthForm - String
|
|
fireResponse - String
|
|
treaty - String
|
|
discipline - String
|
|
taxonLevel - String
|
|
fisSpeciesNumber - Int
|
|
recordModificationDate - Date
|
|
versionDate - Date
|
|
taxonName - TaxonName
|
Example
{
"id": "4",
"scientificName": "xyz789",
"commonName": "abc123",
"authority": "abc123",
"restriction": "xyz789",
"origin": "abc123",
"taxonType": "xyz789",
"lifeForm": "abc123",
"nvisGrowthForm": "xyz789",
"fireResponse": "abc123",
"treaty": "xyz789",
"discipline": "xyz789",
"taxonLevel": "xyz789",
"fisSpeciesNumber": 123,
"recordModificationDate": "2007-12-03",
"versionDate": "2007-12-03",
"taxonName": TaxonName
}
VbaTaxaListItemPaginator
Description
A paginated list of VbaTaxaListItem items.
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
Pagination information about the list of items. |
data - [VbaTaxaListItem!]!
|
A list of VbaTaxaListItem items. |
Example
{
"paginatorInfo": PaginatorInfo,
"data": [VbaTaxaListItem]
}
VernacularName
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
isPreferred - Boolean
|
|
nameUsage - String
|
|
remarks - String
|
|
taxonConcept - TaxonConcept!
|
|
createdBy - Agent
|
|
modifiedBy - Agent
|
|
createdAt - DateTimeTz
|
|
updatedAt - DateTimeTz
|
|
version - Int
|
Example
{
"id": 4,
"name": "abc123",
"isPreferred": true,
"nameUsage": "xyz789",
"remarks": "abc123",
"taxonConcept": TaxonConcept,
"createdBy": Agent,
"modifiedBy": Agent,
"createdAt": DateTimeTz,
"updatedAt": DateTimeTz,
"version": 987
}