OBJECT
Query

GraphQL Schema definition

type Query {
#   Search FairsharingRecords with a where clause
# 
# Arguments
#   q: a search query string
#   modifiedSince: a date in YYYY-MM-DD format
#   where: the where clause
#   id: only search amongst these record ids
advancedSearch(
q: String,
modifiedSince: String,
where: AdvancedSearchAttributes!,
id: [Int!]
): [FairsharingRecord!]! 
#   Search FairsharingRecords with a where clause, but using only Elasticsearch for 
#   speed
# 
# Arguments
#   q: a search query string
#   modifiedSince: a date in YYYY-MM-DD format
#   where: the where clause
#   id: only search amongst these record ids
advancedSearchFast(
q: String,
modifiedSince: String,
where: AdvancedSearchAttributes!,
id: [Int!]
): [FairsharingRecordSummary!]! 
#   Search FairsharingRecords via elasticsearch
# 
# Arguments
#   q: a search query string
#   searchAnd: true if all tags must be present
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","name","abbreviation"],"order_by":["asc","desc"]}
#   objectTypes: array of object types to facet on
#   fairsharingRegistry: array of registry names to facet on
#   recordType: array of record type names to facet on
#   status: array of status values to facet on
allFairsharingRecords(
q: String,
searchAnd: Boolean,
orderBy: [String!],
objectTypes: [String!],
fairsharingRegistry: [String!],
recordType: [String!],
status: [String!]
): [FairsharingRecordSummary!]! 
#   get information on all users
allOrganisations: [Organisation!]! 
#   get information on all users
# 
# Arguments
#   q: a search query string
allUsers(q: String): [User!]! 
#   show which associations are allowed between two records
# 
# Arguments
#   from: the record doing the linking
#   to: the record linked to
allowedAssociations(from: Int!, to: Int!): [RecordAssociationLabel!]! 
#   Get data for browsing through the Subjects
browseSubjects: SubjectBrowser! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
countries(page: Int, perPage: Int): CountryCollection! 
#   Find a Country  by ID
# 
# Arguments
#   id: unique ID of the country
country(id: Int!): Country! 
#   A list of unapproved records last edited by curators
curatorApprovalsRequired: [RecordsByCurator!]! 
#   A list of curators
curatorList: [User!]! 
#   Stats on what curators have been up to
curatorSummaryStatistics: [Json!]! 
#   Find a Domain  by ID
# 
# Arguments
#   id: unique ID of the domain
#   load: whether to load from postgres or not
domain(id: Int!, load: Boolean): Domain! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
domains(page: Int, perPage: Int): DomainCollection! 
#   Download results of a searchFairsharingRecords query
# 
# Arguments
#   includeOrgs: whether or not to include organisations in the 
#   results
#   q: a search query string
#   searchAnd: true if all tags must be present
#   status: array of status values to facet on
#   fairsharingRegistry: array of registry names to facet on
#   recordType: array of record type names to facet on
#   id: fairsharing_record id
#   ids: multple fairsharing_record ids
#   excludeId: fairsharing_record id to exclude
#   countries: array of countries to facet on
#   subjects: array of subjects to facet on
#   domains: array of domains to facet on
#   taxonomies: array of taxonomies to facet on
#   userDefinedTags: array of user defined tags to facet on
#   licences: array of licence names to facet on
#   organisations: array of organisation names to facet on
#   grants: array of grant names to facet on
#   journals: array of journals titles to facet on
#   isRecommended: whether or not the record has been recommended, 
#   for faceting
#   isApproved: is the record approved by a curator
#   isMaintained: does the record have at least one maintainer
#   searchUrl: URL of the original search
downloadSearchResults(
includeOrgs: Boolean,
q: String,
searchAnd: Boolean,
status: [String!],
fairsharingRegistry: [String!],
recordType: [String!],
id: Int,
ids: [Int!],
excludeId: Int,
countries: [String!],
subjects: [String!],
domains: [String!],
taxonomies: [String!],
userDefinedTags: [String!],
licences: [String!],
organisations: [String!],
grants: [String!],
journals: [String!],
isRecommended: Boolean,
isApproved: Boolean,
isMaintained: Boolean,
searchUrl: String!
): SearchDownload! 
# Arguments
#   fields: The terms to use to check for duplicates
duplicateCheck(fields: [String!]!): [FairsharingRecord!] 
#   Display a graph by starting node ID
# 
# Arguments
#   id: unique ID of node 0
fairsharingGraph(id: Int!): FairsharingGraph! 
#   Find a FairsharingRecord  by ID
# 
# Arguments
#   id: id/doi/legacy_id of the fairsharing record to be found
fairsharingRecord(id: ID!): FairsharingRecord! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
fairsharingRecords(page: Int, perPage: Int): FairsharingRecordCollection! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
fairsharingRegistries(page: Int, perPage: Int): FairsharingRegistryCollection! 
#   Find a FairsharingRegistry  by ID
# 
# Arguments
#   id: id of the fairsharing registry to be found
fairsharingRegistry(id: Int!): FairsharingRegistry! 
#   Get all principles which are part_of the id supplied
# 
# Arguments
#   id: unique ID of the top level principle
getPrinciples(id: Int!): [FairsharingRecord!]! 
#   Find a Grant by ID
# 
# Arguments
#   id: id of the grant to be found
grant(id: Int!): Grant! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
grants(page: Int, perPage: Int): GrantCollection! 
#   Show all hidden records
hiddenRecords: [FairsharingRecord!]! 
#   A list of records which are incomplete
incompleteRecords: [FairsharingRecord!]! 
#   Get most recent FAIRsharing stats
latestStats: RecordStats! 
#   Least recently updated record. Use with caution!
leastRecentlyUpdated: LeastRecentlyUpdated! 
#   Find a Licence by ID
# 
# Arguments
#   id: id of the licence to be found
licence(id: Int!): Licence! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
licences(page: Int, perPage: Int): LicenceCollection! 
#   Return all messages which are to be shown to the user 
messages: [Message!]! 
#   Metadata fields for building switches
# 
# Arguments
#   name: name of the registry for which fields are needed
metadataFields(name: String!): MetadataFields! 
#   Filter fairsharing_records by type, domain and subject
# 
# Arguments
#   q: a search query string
#   fairsharingRegistry: Return FairsharingRecords of these 
#   registries
#   status: Return FairsharingRecords of these statuses
#   recordType: Return FairsharingRecords of these types
#   domainsExact: Return only matching Domains
#   subjectsExact: Return only matching Subjects
#   domains: Return matching Domains and their children
#   subjects: Return matching Subjects and their children
#   taxonomies: Return matching taxonomies and their children
#   userDefinedTags: Return matching user-defined tags and their 
#   children
#   isRecommended: whether or not the record has been recommended, 
#   for faceting
#   isApproved: is the record approved by a curator
#   isMaintained: does the record have at least one maintainer
#   hasPublication: Is there at least one publication or not
#   isImplemented: Is it implemented by >= 1 database
#   usesPersistentIdentifier: Does it use persistent identifiers
#   dataPreservationPolicy: Is there a policy or not
#   resourceSustainability: Is there any sustainability or not
#   dataAccessCondition: open, partially-open or controlled?
#   dataCuration: manual, automated, manual/automated or none
#   dataDepositionCondition: open or controlled
#   citationToRelatedPublications: yes or no
#   dataAccessForPrePublicationReview: yes or no
#   dataContactInformation: yes or no
#   dataVersioning: yes or no
#   dataFormatsAndTerminologies: IDs of implemented standards 
#   (model/format and terminology artefact)
#   policyRecommendations: IDs of recommending policies
#   recommendsDatabase: recommends at least one database
#   recommendsStandard: recommends at least one standard
#   mandatedDataSharing: is data sharing required
#   exceptionsToDataSharing: yes or no
#   sharingMetadata: is metadata sharing required
#   sharingResearchSoftware: is research software sharing required
#   mandatedDmpCreation: is creating a dmp required
#   timingOfDmp: when must a dmp be created
#   updatingOfDmp: yes or no
#   dataProtection: yes or no
#   licencesForOutputs: yes or no
#   dataCitation: yes or no
#   dataPreservation: yes or no
#   guidanceToHelpEnableCompliance: yes or no
#   monitoringOfCompliance: yes or no
#   dataAvailabilityStatement: yes or no
#   region: region/continent etc. of the record
#   load: whether to load from postgres or not
multiTagFilter(
q: String,
fairsharingRegistry: [String!],
status: [String!],
recordType: [String!],
domainsExact: [String!],
subjectsExact: [String!],
domains: [String!],
subjects: [String!],
taxonomies: [String!],
userDefinedTags: [String!],
isRecommended: Boolean,
isApproved: Boolean,
isMaintained: Boolean,
hasPublication: Boolean,
isImplemented: Boolean,
usesPersistentIdentifier: Boolean,
dataPreservationPolicy: Boolean,
resourceSustainability: Boolean,
dataAccessCondition: [String!],
dataCuration: [String!],
dataDepositionCondition: [String!],
citationToRelatedPublications: [String!],
dataAccessForPrePublicationReview: [String!],
dataContactInformation: [String!],
dataVersioning: [String!],
dataFormatsAndTerminologies: [Int!],
policyRecommendations: [Int!],
recommendsDatabase: Boolean,
recommendsStandard: Boolean,
mandatedDataSharing: [String!],
exceptionsToDataSharing: Boolean,
sharingMetadata: [String!],
sharingResearchSoftware: [String!],
mandatedDmpCreation: [String!],
timingOfDmp: [String!],
updatingOfDmp: Boolean,
dataProtection: Boolean,
licencesForOutputs: Boolean,
dataCitation: Boolean,
dataPreservation: Boolean,
guidanceToHelpEnableCompliance: Boolean,
monitoringOfCompliance: Boolean,
dataAvailabilityStatement: Boolean,
region: [String!],
load: Boolean
): [FairsharingRecord!]! 
myFairsharingRecords: [FairsharingRecord!]! 
#   A list of records needing review
needsReview: [Json!]! 
#   Find a ObjectType by ID
# 
# Arguments
#   id: id of the object_type to be found
#   load: whether to load from postgres or not
objectType(id: Int!, load: Boolean): ObjectType! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
objectTypes(page: Int, perPage: Int): ObjectTypeCollection! 
#   Find a Organisation by ID
# 
# Arguments
#   id: FAIRsharing id of the organisation to be found, or ROR URL
organisation(id: ID!): Organisation! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
organisations(page: Int, perPage: Int): OrganisationCollection! 
#   Show summary of pending maintenance requests
pendingMaintenanceRequests: [MaintenanceRequest!]! 
# Arguments
#   id: Numeric ID the publication. Omit if querying DOI. 
#   doi: Numeric DOI of the publication, format 12.3456/ABX.XYZ 
#   (i.e. omit domain).
publication(id: Int, doi: String): Publication! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
publications(page: Int, perPage: Int): PublicationCollection! 
#   Records created by curators in the past 8 days
recentCuratorCreations: [FairsharingRecord!]! 
#   Show most recently updated content
recentlyUpdatedContent: [RecentlyUpdatedContent!]! 
#   get information on all record association labels
recordAssociationLabels: [RecordAssociationLabel!]! 
#   Find a RecordType  by ID
# 
# Arguments
#   id: id of the record_type to be found
recordType(id: Int!): RecordType! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
recordTypes(page: Int, perPage: Int): RecordTypeCollection! 
#   Records currently undergoing curation
recordsInCuration: [RecordsByCurator!]! 
#   Records without DOIs
recordsWithoutDois: [FairsharingRecord!]! 
# Arguments
#   term: term to be tested against regular expressions
#   secondary: also test the term against secondary regexes
regex(term: String!, secondary: Boolean): RegexSearchResult! 
#   Find a Domain  by ID
# 
# Arguments
#   id: unique ID of the saved search
#   load: whether to load from postgres or not
savedSearch(id: Int!, load: Boolean): SavedSearch! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
savedSearches(page: Int, perPage: Int): SavedSearchCollection! 
#   Search Countries via elasticsearch
# 
# Arguments
#   q: a search query string
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","name","alternative_names"],"order_by":["asc","desc"]}
searchCountries(q: String, orderBy: [String!]): [Country!]! 
#   Search Domains via elasticsearch
# 
# Arguments
#   q: a search query string
#   inFairsharing: used by fairsharing_records. Normally this 
#   should never set to be false.
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","label","iri"],"order_by":["asc","desc"]}
searchDomains(q: String, inFairsharing: Boolean, orderBy: [String!]): [Domain!]! 
#   Search FairsharingRecords via elasticsearch
# 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
#   q: a search query string
#   searchAnd: true if all tags must be present
#   status: array of status values to facet on
#   fairsharingRegistry: array of registry names to facet on
#   recordType: array of record type names to facet on
#   id: fairsharing_record id
#   ids: multple fairsharing_record ids
#   excludeId: fairsharing_record id to exclude
#   countries: array of countries to facet on
#   subjects: array of subjects to facet on
#   domains: array of domains to facet on
#   taxonomies: array of taxonomies to facet on
#   userDefinedTags: array of user defined tags to facet on
#   objectTypes: array of object types to facet on
#   licences: array of licence names to facet on
#   organisations: array of organisation names to facet on
#   grants: array of grant names to facet on
#   journals: array of journals titles to facet on
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","name","abbreviation"],"order_by":["asc","desc"]}
#   isRecommended: whether or not the record has been recommended, 
#   for faceting
#   isApproved: is the record approved by a curator
#   isMaintained: does the record have at least one maintainer
#   hasPublication: Is there at least one publication or not
#   isImplemented: Is it implemented by >= 1 database
#   usesPersistentIdentifier: Does it use persistent identifiers
#   dataPreservationPolicy: Is there a policy or not
#   resourceSustainability: Is there any sustainability or not
#   dataAccessCondition: open, partially-open or controlled?
#   dataCuration: manual, automated, manual/automated or none
#   dataDepositionCondition: open or controlled
#   citationToRelatedPublications: yes or no
#   dataAccessForPrePublicationReview: yes or no
#   dataContactInformation: yes or no
#   dataVersioning: yes or no
searchFairsharingRecords(
page: Int,
perPage: Int,
q: String,
searchAnd: Boolean,
status: [String!],
fairsharingRegistry: [String!],
recordType: [String!],
id: Int,
ids: [Int!],
excludeId: Int,
countries: [String!],
subjects: [String!],
domains: [String!],
taxonomies: [String!],
userDefinedTags: [String!],
objectTypes: [String!],
licences: [String!],
organisations: [String!],
grants: [String!],
journals: [String!],
orderBy: [String!],
isRecommended: Boolean,
isApproved: Boolean,
isMaintained: Boolean,
hasPublication: Boolean,
isImplemented: Boolean,
usesPersistentIdentifier: Boolean,
dataPreservationPolicy: Boolean,
resourceSustainability: Boolean,
dataAccessCondition: String,
dataCuration: String,
dataDepositionCondition: String,
citationToRelatedPublications: String,
dataAccessForPrePublicationReview: String,
dataContactInformation: String,
dataVersioning: String
): ElasticsearchPaginatedCollection! 
#   Search Grants via elasticsearch
# 
# Arguments
#   q: a search query string
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","label","iri"],"order_by":["asc","desc"]}
#   load: whether to load from postgres or not
searchGrants(q: String, orderBy: [String!], load: Boolean): [Grant!]! 
#   Search Licences via elasticsearch
# 
# Arguments
#   q: a search query string
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","name","url"],"order_by":["asc","desc"]}
searchLicences(q: String, orderBy: [String!]): [Licence!]! 
#   Search OrganisationTypes via elasticsearch
# 
# Arguments
#   q: a search query string
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","name"],"order_by":["asc","desc"]}
#   load: whether to load from postgres or not
searchOrganisationTypes(
q: String,
orderBy: [String!],
load: Boolean
): [OrganisationType!]! 
#   Search Organisations via elasticsearch
# 
# Arguments
#   q: a search query string
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","name","homepage"],"order_by":["asc","desc"]}
#   load: whether to load from postgres or not
searchOrganisations(q: String, orderBy: [String!], load: Boolean): [Organisation!]! 
#   Search Publications via elasticsearch
# 
# Arguments
#   q: a search query string
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","title","year","journal","url"],"order_by":["asc","desc"]}
searchPublications(q: String, orderBy: [String!]): [Publication!]! 
#   Search Subjects via elasticsearch
# 
# Arguments
#   q: a search query string
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","label","iri"],"order_by":["asc","desc"]}
searchSubjects(q: String, orderBy: [String!]): [Subject!]! 
#   Search all tags via elasticsearch
# 
# Arguments
#   q: a search query string
#   taggedRecords: IDs of records tagged with this tag
searchTags(q: String, taggedRecords: [Int!]): [Tag!]! 
#   Search Taxonomies via elasticsearch
# 
# Arguments
#   q: a search query string
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","label","iri"],"order_by":["asc","desc"]}
searchTaxonomies(q: String, orderBy: [String!]): [Taxonomy!]! 
#   Search UserDefinedTags via elasticsearch
# 
# Arguments
#   q: a search query string
#   orderBy: {"description":"Pass values as an array; sort_field, 
#   order_by","sort_fields":["_score","label"],"order_by":["asc","desc"]}
searchUserDefinedTags(q: String, orderBy: [String!]): [UserDefinedTag!]! 
#   Find a Subject by ID
# 
# Arguments
#   id: id of the subject to be found
#   load: whether to load from postgres or not
subject(id: Int!, load: Boolean): Subject! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
subjects(page: Int, perPage: Int): SubjectCollection! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
taxonomies(page: Int, perPage: Int): TaxonomyCollection! 
#   Find a Taxonomy by ID
# 
# Arguments
#   id: id of the taxonomy to be found
taxonomy(id: Int!): Taxonomy! 
#   Find a User by ID
# 
# Arguments
#   id: id of the user to be found
user(id: Int!): User 
#   A list of unapproved records last edited by users
userApprovalsRequired: [RecordsByCurator!]! 
#   Find a UserDefinedTag by ID
# 
# Arguments
#   id: id of the user defined tag to be found
userDefinedTag(id: Int!): UserDefinedTag! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
userDefinedTags(page: Int, perPage: Int): UserDefinedTagCollection! 
# Arguments
#   page: page of the results required
#   perPage: number of results per page
users(page: Int, perPage: Int): UserCollection! 
}
Require by

This element is not required by anyone
Query

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
