Machine Annotation Service Terms
Open Digital Specimen List of Terms
Machine Annotation Service List of Terms
Title : Machine Annotation Service List of Terms
Date version issued : 2024-10-15
Date created : 2024-10-15
This version : 0.4.0
Latest version : 0.4.0
Abstract
: The Machine Annotation Service (MAS) object describe the Machine Agent which generated automated annotations for DiSSCo.
The object contains fields for describing the service, the container image and the container version.
The image tag cannot be latests
as it needs to be clear which version of the container was used to generate the annotations.
Updating the image tag will also generate a new version of the MAS, providing provenance and traceability.
The hasTargetDigitalObjectFilter
can be used to specifics which Digital Object the MAS should be applied to.
It uses json path for the filtering and can be used to filter on any field in the Digital Object.
At the moment MAS can only be run on Digital Specimen and Digital Media objects.
Main contributors : Sam Leeflang, Soulaine Theocharides, Tom Dijkema
Creator : Distributed Infrastructure for Scientific Collections (DiSSCo)
Bibliographic citation : Distributed Infrastructure for Scientific Collections. 2024. Machine Annotation Service List of Terms List of Terms.
1 Introduction
1.1 Status of the content of this document
The openDS data specification is in active development. This document is work in progres and might change until version 1.0.0 is released. Its main function at the moment is to inform the community about the current state of the data model and to gather feedback. We hope to include the feedback from the community and reach a first major version of the data model by the end of 2024.
1.2 RFC 2119 key words
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 RFC 2119 and RFC 8174 when, and only when, they appear in all capitals, as shown here.
2 Borrowed Vocabulary
When terms are borrowed from other vocabularies, openDS uses the IRIs, common abbreviations, and namespace prefixes in use in those vocabularies. The IRIs are normative, but abbreviations and namespace prefixes have no impact except as an aid to reading the documentation.
Table 1. Vocabularies from which terms have been borrowed (non-normative)
Vocabulary | Abbreviation | Namespaces and abbreviations |
---|---|---|
Schema.org | Schema | schema: = https://schema.org/version/latest/schemaorg-current-https.rdf |
Activity Streams | AS | as: = https://www.w3.org/ns/activitystreams# |
3 Namespaces, Prefixes and Term Names
The namespace of terms borrowed from other vocabularies is that of the original. The namespace of de openDS terms is http://rs.dissco.eu/opends/terms/. In the table of terms, each term entry has a row with the term name. This term name is generally an “unqualified name” preceded by a widely accepted prefix designating an abbreviation for the namespace It is RECOMMENDED that implementers who need a namespace prefix for the openDS namespace use ods. In this web document, hovering over a term in the Index By Term Name list below will reveal a complete URL that can be used in other web documents to link to this document’s treatment of that term, even if it is from a borrowed vocabulary.
4 Term index
4.1 Index By Term Name
Classes
ods:Agent
ods:EnvironmentalVariable
ods:Identifier
ods:MachineAnnotationService
- ods:MachineAnnotationService
- schema:identifier
- ods:fdoType
- ods:status
- schema:version
- schema:name
- schema:description
- schema:dateCreated
- schema:dateModified
- schema:creator
- ods:containerImage
- ods:containerTag
- ods:hasTargetDigitalObjectFilter
- schema:creativeWorkStatus
- schema:codeRepository
- schema:programmingLanguage
- ods:serviceAvailability
- schema:maintainer
- schema:license
- schema:ContactPoint
- ods:slaDocumentation
- ods:topicName
- ods:maxReplicas
- ods:batchingPermitted
- ods:timeToLive
- ods:hasTombstoneMetadata
- ods:hasEnvironmentalVariables
- ods:hasSecretVariables
ods:RelatedPID
ods:SecretVariable
ods:TombstoneMetadata
ods:schema:ContactPoint
5 Vocabulary
Term Name schema:url | |
---|---|
Qualified Term | schema:url |
Term IRI | http://schema.org/url |
Label | URL |
Definition | URL to a website of the agent |
Examples |
|
Datatype | string |
Belongs to Class | ods:Agent |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name Agent | |
---|---|
Qualified Term | ods:Agent |
Term IRI | http://rs.dissco.eu/opends/terms/Agent |
Label | Agent |
Definition | A generic agent class, containing information about the actor who performed an activity. This could be a person, an organization or a machine. |
Required | False |
Repeatable | True |
RDF Type | rdfs:Class |
Term Name schema:identifier | |
---|---|
Qualified Term | schema:identifier |
Term IRI | http://schema.org/identifier |
Label | Identifier |
Definition | The primary unique identifier of the Agent object. All identifiers will also be added to the ods:hasIdentifiers array |
Examples |
|
Datatype | string |
Belongs to Class | ods:Agent |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:name | |
---|---|
Qualified Term | schema:name |
Term IRI | http://schema.org/name |
Label | Name |
Definition | Full name of the agent |
Examples |
|
Datatype | string |
Belongs to Class | ods:Agent |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:hasRoles | |
---|---|
Qualified Term | ods:hasRoles |
Term IRI | http://rs.dissco.eu/opends/terms/hasRoles |
Label | Has Roles |
Definition | Contains all roles associated with the agent in the context of the Digital Object. Should always contain at least one role |
Datatype | array<ods:Role> |
Belongs to Class | ods:Agent |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:email | |
---|---|
Qualified Term | schema:email |
Term IRI | http://schema.org/email |
Label | |
Definition | Email of the agent |
Examples |
|
Datatype | string |
Belongs to Class | ods:Agent |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:hasIdentifiers | |
---|---|
Qualified Term | ods:hasIdentifiers |
Term IRI | http://rs.dissco.eu/opends/terms/hasIdentifiers |
Label | Has Identifiers |
Definition | Contains all identifiers associated with the agent |
Datatype | array<ods:Identifier> |
Belongs to Class | ods:Agent |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:value | |
---|---|
Qualified Term | schema:value |
Term IRI | http://schema.org/value |
Label | Value |
Definition | Value to be stored in the "name" field. NOT for sensitive information. |
Examples |
|
Datatype | ['string', 'integer', 'boolean'] |
Belongs to Class | ods:EnvironmentalVariable |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:name | |
---|---|
Qualified Term | schema:name |
Term IRI | http://schema.org/name |
Label | Name |
Definition | The name of a non-sensitive property or environmental variable |
Examples |
|
Datatype | string |
Belongs to Class | ods:EnvironmentalVariable |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name EnvironmentalVariable | |
---|---|
Qualified Term | ods:EnvironmentalVariable |
Term IRI | http://rs.dissco.eu/opends/terms/EnvironmentalVariable |
Label | Environmental Variable |
Definition | A class containing information about which (non-secret) environmental values the application requires. |
Required | False |
Repeatable | True |
RDF Type | rdfs:Class |
Term Name ods:gupriLevel | |
---|---|
Qualified Term | ods:gupriLevel |
Term IRI | http://rs.dissco.eu/opends/terms/gupriLevel |
Label | GUPRI Level |
Definition | Indicates whether the identifier is a persistent identifier |
Controlled Vocabulary |
|
Datatype | string |
Belongs to Class | ods:Identifier |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:identifierStatus | |
---|---|
Qualified Term | ods:identifierStatus |
Term IRI | http://rs.dissco.eu/opends/terms/identifierStatus |
Label | Identifier Status |
Definition | Indicates the status of the identifier |
Controlled Vocabulary |
|
Datatype | string |
Belongs to Class | ods:Identifier |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name dcterms:title | |
---|---|
Qualified Term | dcterms:title |
Term IRI | http://purl.org/dc/terms/title |
Label | Title |
Definition | A name for the identifier |
Examples |
|
Datatype | string |
Belongs to Class | ods:Identifier |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name dcterms:type | |
---|---|
Qualified Term | dcterms:type |
Term IRI | http://purl.org/dc/terms/type |
Label | Type |
Definition | The type of the value in the `dcterms:identifier` field |
Examples |
|
Controlled Vocabulary |
|
Datatype | string |
Belongs to Class | ods:Identifier |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name dcterms:identifier | |
---|---|
Qualified Term | dcterms:identifier |
Term IRI | http://purl.org/dc/terms/identifier |
Label | Identifier |
Definition | The value for the identifier |
Examples |
|
Datatype | string |
Belongs to Class | ods:Identifier |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name dcterms:format | |
---|---|
Qualified Term | dcterms:format |
Term IRI | http://purl.org/dc/terms/format |
Label | Format |
Definition | All possible mime types of content that can be returned by identifier in case the identifier is resolvable. Plain UUIDs for example do not have a dc:format return type, as they are not resolvable on their own. For a list of MIME types see the list maintained by IANA: http://www.iana.org/assignments/media-types/index.html, in particular the text http://www.iana.org/assignments/media-types/text/ and application http://www.iana.org/assignments/media-types/application/ types. Frequently used values are text/html, text/xml, application/rdf+xml, application/json |
Examples |
|
Datatype | array<string> |
Belongs to Class | ods:Identifier |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name dcterms:subject | |
---|---|
Qualified Term | dcterms:subject |
Term IRI | http://purl.org/dc/terms/subject |
Label | Subject |
Definition | Additional keywords that the publisher may prefer to be attached to the identifier |
Examples |
|
Datatype | array<string> |
Belongs to Class | ods:Identifier |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:isPartOfLabel | |
---|---|
Qualified Term | ods:isPartOfLabel |
Term IRI | http://rs.dissco.eu/opends/terms/isPartOfLabel |
Label | Is Part Of Label |
Definition | Indicates whether the identifier is part of the physical label |
Datatype | boolean |
Belongs to Class | ods:Identifier |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name Identifier | |
---|---|
Qualified Term | ods:Identifier |
Term IRI | http://rs.dissco.eu/opends/terms/Identifier |
Label | Identifier |
Definition | A generic Identifier class which can be attached to multiple classes. It captures information about any identifier of the class. |
Required | False |
Repeatable | True |
RDF Type | rdfs:Class |
Term Name ods:batchingPermitted | |
---|---|
Qualified Term | ods:batchingPermitted |
Term IRI | http://rs.dissco.eu/opends/terms/batchingPermitted |
Label | Batching Permitted |
Definition | Whether or not this Machine Annotation Service can create Batch Annotations. Machine Annotations Service outputs must then comply with batchMetadata, see https://schemas.dissco.tech/schemas/annotations/0.1.0/annotation-event.json |
Datatype | boolean |
Belongs to Class | ods:MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:hasSecretVariables | |
---|---|
Qualified Term | ods:hasSecretVariables |
Term IRI | http://rs.dissco.eu/opends/terms/hasSecretVariables |
Label | Has Secret Variables |
Definition | Secret variables to supply to the Machine Annotation Service, sensitive |
Datatype | array<ods:SecretVariable> |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:hasEnvironmentalVariables | |
---|---|
Qualified Term | ods:hasEnvironmentalVariables |
Term IRI | http://rs.dissco.eu/opends/terms/hasEnvironmentalVariables |
Label | Has Environmental Variables |
Definition | Environmental variables to supply to the Machine Annotation Service, non-sensitive |
Datatype | array<ods:EnvironmentalVariable> |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:hasTombstoneMetadata | |
---|---|
Qualified Term | ods:hasTombstoneMetadata |
Term IRI | http://rs.dissco.eu/opends/terms/hasTombstoneMetadata |
Label | Has Tombstone Metadata |
Definition | Object containing the tombstone metadata of the object |
Datatype | object |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:timeToLive | |
---|---|
Qualified Term | ods:timeToLive |
Term IRI | http://rs.dissco.eu/opends/terms/timeToLive |
Label | Time To Live |
Definition | Time in milliseconds the MAS message may remain in the Kafka Queue before being marked as timed out. Min 1 hour. |
Examples |
|
Datatype | integer |
Belongs to Class | ods:MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:maxReplicas | |
---|---|
Qualified Term | ods:maxReplicas |
Term IRI | http://rs.dissco.eu/opends/terms/maxReplicas |
Label | Max Replicas |
Definition | The maximum amount of this MAS that can simultaneously run without causing issues |
Examples |
|
Datatype | integer |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name MachineAnnotationService | |
---|---|
Qualified Term | ods:MachineAnnotationService |
Term IRI | http://rs.dissco.eu/opends/terms/MachineAnnotationService |
Label | Machine Annotation Service |
Definition | A machine agent which will perform an action on the Digital Object potentially resulting in a new annotation on the object |
Required | True |
Repeatable | True |
RDF Type | rdfs:Class |
Term Name ods:slaDocumentation | |
---|---|
Qualified Term | ods:slaDocumentation |
Term IRI | http://rs.dissco.eu/opends/terms/slaDocumentation |
Label | Sla Documentation |
Definition | Link to SLA documentation of the Machine Annotation Service |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:containerTag | |
---|---|
Qualified Term | ods:containerTag |
Term IRI | http://rs.dissco.eu/opends/terms/containerTag |
Label | Container Tag |
Definition | The image tag of the container image. This should not be `latest` but point to a specific version. On an update of the application a new image tag should be generated and the Digital Object should be updated |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:containerImage | |
---|---|
Qualified Term | ods:containerImage |
Term IRI | http://rs.dissco.eu/opends/terms/containerImage |
Label | Container Image |
Definition | The URI to the location of the image in a public container repository. Should only contain the image name and not the tag |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:topicName | |
---|---|
Qualified Term | ods:topicName |
Term IRI | http://rs.dissco.eu/opends/terms/topicName |
Label | Topic Name |
Definition | Kafka topic through which the MAS receives messages. Defaults to PID of the Machine Annotation Service |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:creator | |
---|---|
Qualified Term | schema:creator |
Term IRI | http://schema.org/creator |
Label | Creator |
Definition | Contains information about the creator of this MachineAnnotationService Digital Object, the agent creating this record in DiSSCo's system |
Datatype | object |
Belongs to Class | ods:MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:codeRepository | |
---|---|
Qualified Term | schema:codeRepository |
Term IRI | http://schema.org/codeRepository |
Label | Code Repository |
Definition | Link to the repository where the un-compiled, human readable code and related code is located (SVN, GitHub, CodePlex) |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:programmingLanguage | |
---|---|
Qualified Term | schema:programmingLanguage |
Term IRI | http://schema.org/programmingLanguage |
Label | Programming Language |
Definition | The primary programming language used by the MAS |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:serviceAvailability | |
---|---|
Qualified Term | ods:serviceAvailability |
Term IRI | http://rs.dissco.eu/opends/terms/serviceAvailability |
Label | Service Availability |
Definition | Availability commitment in uptime percentage of the service provider as described in the SLA |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:maintainer | |
---|---|
Qualified Term | schema:maintainer |
Term IRI | http://schema.org/maintainer |
Label | Maintainer |
Definition | Party maintaining the code, could be an schema:Organisation or a schema:Person |
Datatype | object |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:hasTargetDigitalObjectFilter | |
---|---|
Qualified Term | ods:hasTargetDigitalObjectFilter |
Term IRI | http://rs.dissco.eu/opends/terms/hasTargetDigitalObjectFilter |
Label | Has Target Digital Object Filter |
Definition | Filters describing the criteria that a Digital Object must meet in order to apply the MAS. No filters implies the MAS may run on *any* digital object. Field names are given in JSON paths, and accepted values for that field are provided as an arrays. An `*` can be used as a wildcard, indicating any value is seen as valid |
Examples |
|
Datatype | object |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:creativeWorkStatus | |
---|---|
Qualified Term | schema:creativeWorkStatus |
Term IRI | http://schema.org/creativeWorkStatus |
Label | Creative Work Status |
Definition | The current status of the service in terms of its service lifecycle |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:dateCreated | |
---|---|
Qualified Term | schema:dateCreated |
Term IRI | http://schema.org/dateCreated |
Label | Date Created |
Definition | Timestamp of creation. Internally generated, following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:description | |
---|---|
Qualified Term | schema:description |
Term IRI | http://schema.org/description |
Label | Description |
Definition | Description of the Machine Annotation Service as provided by the user, https://schema.org/description |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:license | |
---|---|
Qualified Term | schema:license |
Term IRI | http://schema.org/license |
Label | License |
Definition | A license document which applies to this Machine Annotation Service |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:name | |
---|---|
Qualified Term | schema:name |
Term IRI | http://schema.org/name |
Label | Name |
Definition | Name of the Machine Annotation Service as provided by the user, https://schema.org/name |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:ContactPoint | |
---|---|
Qualified Term | schema:ContactPoint |
Term IRI | http://schema.org/ContactPoint |
Label | Contact Point |
Definition | The contact point for support and information for the Machine Annotation Service |
Datatype | object |
Required | False |
Repeatable | False |
RDF Type | rdfs:Class |
Term Name schema:version | |
---|---|
Qualified Term | schema:version |
Term IRI | http://schema.org/version |
Label | Version |
Definition | The version of the object, each change generates a new version. The version starts at 1 and each change will increment the version number with 1 |
Datatype | integer |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:status | |
---|---|
Qualified Term | ods:status |
Term IRI | http://rs.dissco.eu/opends/terms/status |
Label | Status |
Definition | The status of the Digital Object. A digital object can be in Draft, when it is not published yet. Active when it is published and the object is active and Tombstone which means the object has been archived. |
Controlled Vocabulary |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:fdoType | |
---|---|
Qualified Term | ods:fdoType |
Term IRI | http://rs.dissco.eu/opends/terms/fdoType |
Label | Fdo Type |
Definition | The DOI to the FDO type of the object |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:identifier | |
---|---|
Qualified Term | schema:identifier |
Term IRI | http://schema.org/identifier |
Label | Identifier |
Definition | Handle of the Machine Annotation Service |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:dateModified | |
---|---|
Qualified Term | schema:dateModified |
Term IRI | http://schema.org/dateModified |
Label | Date Modified |
Definition | Timestamp of last modification. Internally generated, following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
Examples |
|
Datatype | string |
Belongs to Class | ods:MachineAnnotationService |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name RelatedPID | |
---|---|
Qualified Term | ods:RelatedPID |
Term IRI | http://rs.dissco.eu/opends/terms/RelatedPID |
Label | Related PID |
Definition | Indicates to which other Digital Object the tombstoned record is related to. This can be used when a digital object has been split or merged into other Digital Objects. |
Required | False |
Repeatable | True |
RDF Type | rdfs:Class |
Term Name schema:identifier | |
---|---|
Qualified Term | schema:identifier |
Term IRI | http://schema.org/identifier |
Label | Identifier |
Definition | The PID of the related object, used in cases of `ods:DataMapping`, `ods:SourceSystem` and `ods:MachineAnnotationService` |
Examples |
|
Datatype | string |
Belongs to Class | ods:RelatedPID |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:relationshipType | |
---|---|
Qualified Term | ods:relationshipType |
Term IRI | http://rs.dissco.eu/opends/terms/relationshipType |
Label | Relationship Type |
Definition | The type of relationship between the tombstoned object and the related object |
Examples |
|
Datatype | string |
Belongs to Class | ods:RelatedPID |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name dcterms:identifier | |
---|---|
Qualified Term | dcterms:identifier |
Term IRI | http://purl.org/dc/terms/identifier |
Label | Identifier |
Definition | The PID of the related object, used in cases of `ods:Annotation`, `ods:DigitalMedia` and `ods:DigitalSpecimen` |
Examples |
|
Datatype | string |
Belongs to Class | ods:RelatedPID |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:roleName | |
---|---|
Qualified Term | schema:roleName |
Term IRI | http://schema.org/roleName |
Label | Role Name |
Definition | The category that best matches the nature of a role of an Agent |
Examples |
|
Datatype | string |
Belongs to Class | ods:Role |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:endDate | |
---|---|
Qualified Term | schema:endDate |
Term IRI | http://schema.org/endDate |
Label | End Date |
Definition | Date the agent ended the role |
Examples |
|
Datatype | string |
Belongs to Class | ods:Role |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:startDate | |
---|---|
Qualified Term | schema:startDate |
Term IRI | http://schema.org/startDate |
Label | Start Date |
Definition | Date the agent began the role |
Examples |
|
Datatype | string |
Belongs to Class | ods:Role |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name Role | |
---|---|
Qualified Term | ods:Role |
Term IRI | http://rs.dissco.eu/opends/terms/Role |
Label | Role |
Definition | A role is a named entity that can be assigned to an agent. It is used to describe the function of an agent in a specific context. |
Required | False |
Repeatable | True |
RDF Type | rdfs:Class |
Term Name schema:position | |
---|---|
Qualified Term | schema:position |
Term IRI | http://schema.org/position |
Label | Position |
Definition | Can be used to indicate the order of importance when there are multiple agents with the same role. Lower order means higher importance. |
Examples |
|
Datatype | integer |
Belongs to Class | ods:Role |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name SecretVariable | |
---|---|
Qualified Term | ods:SecretVariable |
Term IRI | http://rs.dissco.eu/opends/terms/SecretVariable |
Label | Secret Variable |
Definition | A class containing information about which secret the Machine Annotation Service requires. The secret value will be supplied separately to DiSSCo. |
Required | False |
Repeatable | True |
RDF Type | rdfs:Class |
Term Name schema:name | |
---|---|
Qualified Term | schema:name |
Term IRI | http://schema.org/name |
Label | Name |
Definition | The name of an environmental variable stored remotely |
Examples |
|
Datatype | string |
Belongs to Class | ods:SecretVariable |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:secretKeyRef | |
---|---|
Qualified Term | ods:secretKeyRef |
Term IRI | http://rs.dissco.eu/opends/terms/secretKeyRef |
Label | Secret Key Ref |
Definition | The name of the key stored in the secret store. NOT the secret's value. |
Examples |
|
Datatype | string |
Belongs to Class | ods:SecretVariable |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:hasRelatedPIDs | |
---|---|
Qualified Term | ods:hasRelatedPIDs |
Term IRI | http://rs.dissco.eu/opends/terms/hasRelatedPIDs |
Label | Has Related Pi Ds |
Definition | The PIDs of the object the tombstoned object is related to |
Datatype | array<ods:RelatedPID> |
Belongs to Class | ods:TombstoneMetadata |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:hasAgents | |
---|---|
Qualified Term | ods:hasAgents |
Term IRI | http://rs.dissco.eu/opends/terms/hasAgents |
Label | Has Agents |
Definition | The agent(s) who tombstoned the Digital Object, contains an ods:Agent object |
Datatype | object |
Belongs to Class | ods:TombstoneMetadata |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name ods:tombstoneText | |
---|---|
Qualified Term | ods:tombstoneText |
Term IRI | http://rs.dissco.eu/opends/terms/tombstoneText |
Label | Tombstone Text |
Definition | A reason why the Digital Object was tombstoned |
Examples |
|
Datatype | string |
Belongs to Class | ods:TombstoneMetadata |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name TombstoneMetadata | |
---|---|
Qualified Term | ods:TombstoneMetadata |
Term IRI | http://rs.dissco.eu/opends/terms/TombstoneMetadata |
Label | Tombstone Metadata |
Definition | The tombstone metadata about the tombstoned digital object, including the what, who and when of the tombstoning. |
Required | False |
Repeatable | True |
RDF Type | rdfs:Class |
Term Name ods:tombstoneDate | |
---|---|
Qualified Term | ods:tombstoneDate |
Term IRI | http://rs.dissco.eu/opends/terms/tombstoneDate |
Label | Tombstone Date |
Definition | Timestamp the Digital Object was tombstoned and no longer active. Following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
Examples |
|
Datatype | string |
Belongs to Class | ods:TombstoneMetadata |
Required | True |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:description | |
---|---|
Qualified Term | schema:description |
Term IRI | http://schema.org/description |
Label | Description |
Definition | General description of the contact point |
Datatype | string |
Belongs to Class | ods:schema:ContactPoint |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:email | |
---|---|
Qualified Term | schema:email |
Term IRI | http://schema.org/email |
Label | |
Definition | Email of the contact point |
Datatype | string |
Belongs to Class | ods:schema:ContactPoint |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:url | |
---|---|
Qualified Term | schema:url |
Term IRI | http://schema.org/url |
Label | URL |
Definition | URL of the contact point, this could be a link to a contact form or a link to a github issues page |
Datatype | string |
Belongs to Class | ods:schema:ContactPoint |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |
Term Name schema:telephone | |
---|---|
Qualified Term | schema:telephone |
Term IRI | http://schema.org/telephone |
Label | Telephone |
Definition | Telephone number of the contact point |
Datatype | string |
Belongs to Class | ods:schema:ContactPoint |
Required | False |
Repeatable | False |
RDF Type | rdf:Property |