DefinedTerm

trompace.mutations.definedterm.create_defined_term(*, creator: str, termcode: str, additionaltype: List[str], broader_url: str = None, broader_schema: trompace.mutations.annotation.AnnotationSchemaMotivation = None, image: str = None)

Return a mutation for making a DefinedTerm. A DefinedTerm (https://schema.org/DefinedTerm) is a word, name, acronym, phrase, etc. with a formal definition. It is part of a DefinedTermSet.

Parameters

• creator – a URI to the identity of the user who created this DefinedTerm

• termcode – The name of this term

• additionaltype – A list of schema.org additionalTypes used to categorise this DefinedTerm

• broader_url (optional) – a type to be related with skos:broader

• broader_schema (optional) – an annotation motivation to be related with skos:broader

• image (optional) – an image to describe this DefinedTerm

Returns

A GraphQL Mutation to create a DefinedTerm in the Trompa CE

trompace.mutations.definedterm.create_defined_term_set(*, creator: str, name: str, additionaltype: List[str], image: str = None)

Return a mutation for making a DefinedTermSet. A DefinedTermSet (https://schema.org/DefinedTermSet) is a group of defined terms, e.g. categories or labels.

Parameters

• creator – a URI to the identity of the user who created this DefinedTermSet

• name – the name of this DefinedTermSet

• additionaltype – A list of schema.org additionalTypes used to categorise this DefinedTermSet

• image (optional) – an image to describe this DefinedTermSet

Returns

A GraphQL Mutation to create a DefinedTermSet in the Trompa CE

trompace.mutations.definedterm.defined_term_add_to_defined_term_set(*, defined_term_set: str, defined_term: str)

Return a mutation for adding a DefinedTerm to a DefinedTermSet.

Parameters

• defined_term_set – The identifier of the DefinedTermSet to add to

• defined_term – The identifier of the DefinedTermSet to add

Returns

A GraphQL Mutation to add a DefinedTerm to the DefinedTermSet

trompace.mutations.definedterm.delete_defined_term(identifier: str)

Return a mutation for deleting a DefinedTermSet.

Parameters

identifier – The identifier of the DefinedTerm to delete

Returns

A GraphQL Mutation to delete a DefinedTerm from the Trompa CE

trompace.mutations.definedterm.delete_defined_term_set(identifier: str)

Return a mutation for deleting a DefinedTermSet.

Parameters

identifier – The identifier of the DefinedTermSet to delete

Returns

A GraphQL Mutation to delete a DefinedTermSet from the Trompa CE

trompace.mutations.definedterm.update_defined_term(identifier: str, *, creator: str = None, termcode: str = None, additionaltype: List[str] = None, broader_url: str = None, broader_schema: trompace.mutations.annotation.AnnotationSchemaMotivation = None, image: str = None)

Return a mutation for updating a DefinedTerm.

TODO: Copy arguments from create_

Returns

A GraphQL Mutation to update a DefinedTerm in the Trompa CE

trompace.mutations.definedterm.update_defined_term_set(identifier: str, *, creator: str = None, name: str = None, additionaltype: List[str] = None, image: str = None)

Return a mutation for updating a DefinedTermSet.

TODO: Copy arguments from create_

Returns

A GraphQL Mutation to update a DefinedTermSet in the Trompa CE