pid4cat-model
A LinkML model for persistent identifiers for resources in catalysis (pid4cat). pid4cat are handle based persistent identifiers (PIDs) for digital or physical resources used in the catalysis research process. PID-related metadata besides the obligatory landing page URL are stored directly in the handle records. The model describes metadata for the PID itself and how to access the identified resource. It does not describe the resource itself with the exception of the resource category, which is a high-level description of what is identified by the pid4cat handle, e.g. a sample or a device.
URI: https://w3id.org/nfdi4cat/pid4cat-model
Name: pid4cat-model
Classes
| Class | Description |
|---|---|
| Agent | Data class for a person who plays a role relative to PID creation or curation. |
| HandleAPIRecord | A class representing a handle record query response of the REST (json) API of a handle server. |
| HandleRecord | A base class for handle-data classes that represent a handle record in the same way as in the REST (json) API of a handle server. |
| CHANGES | The data element in the handle API for the change log. |
| The data element in the handle API for the contact email. | |
| METADATALICENSE | The data element in the handle API for the PID metadata license. |
| RELATED | The data element in the handle API for related identifiers. |
| RESOURCE | The data element in the handle API for the resource info. |
| SCHEMAVER | The data element in the handle API for the schema version. |
| STATUS | The data element in the handle API for the PID status information. |
| URL | The data element in the handle API for the landing page URL. |
| HandleRecordContainer | A container for all HandleRecords. |
| HdlDataContact | The data class for the handle-record contact email. |
| HdlDataLicense | The data class for the PID metadata license. |
| HdlDataLog | The data class for the change log. |
| HdlDataRelated | The data class for related identifiers. |
| HdlDataResourceInfo | The data class for the resource info. |
| HdlDataSchemaVer | The data class for the schema version. |
| HdlDataStatus | The data class for the PID status information. |
| HdlDataUrl | The data class for the redirect url. |
| LogRecord | Data class for a change log of modification made on a pid4cat handle record starting from its registration. |
| Pid4CatRecord | A class representing pid4cat identifiers with its metadata as objects. This is a neutral object-oriented representation that does not mirror the record structure of the handle system but is provided as representation that is more convenient to use in programming languages. |
| Pid4CatRelation | Data class for a relation to another resource identified by a pid4cat handle or another PID type. |
| RelatedIdentifier | A base class for all types of related identifiers. |
| ArkIdentifier | An ARK (Archival Resource Key). |
| DoiIdentifier | A digital object identifier (DOI). |
| ExampleIdentifier | An example.org test identifier. |
| GtinIdentifier | A Global Trade Item Number (GTIN) previously called European Article Number (EAN) often encoded as EAN13 barcode. The identifier is used to identify products. GTINs don't have a resolvable URL. |
| HandleIdentifier | A handle identifier. |
| PurlIdentifier | A PURL (permanent uniform resource locator). |
| UrnIdentifier | A URN (Uniform Resource Name). |
| RepresentationVariant | Data class for representations of the resource in other media types than text/html which is the default for landing_page_url. |
| ResourceInfo | Data class to hold information about the resource and its representation. |
Slots
| Slot | Description |
|---|---|
| affiliation_ror | The ROR of the agent's affiliation. |
| change_log | The change log of the pid4cat record. The change log contains information about the changes made to the pid4cat record. |
| changed_field | The field that was changed. |
| contains_pids | The HandleRecords contained in the container. |
| curation_contact | The email address of the person responsible for the curation of the pid4cat record. |
| data | The data in the handle record. |
| datetime_log | The date and time of a log record. |
| description | A human-readable description for a resource. |
| email_address | Email address of the agent that created or modified the PID record. |
| encoding_format | The encoding of the representation. https://encoding.spec.whatwg.org/#names-and-labels |
| format | The format of the handle data. |
| handle | The handle of the pid4cat record. |
| has_agent | The person who registered or modified the PID record. |
| identifier | The identifier in recommended notation. |
| index | The index of the handle record. |
| label | A human-readable name for a resource. |
| landing_page_url | The URL of the landing page of the resource identified by the PID. |
| media_type | The media type of the representation as defined by IANA |
| metadata_license | The license of the metadata of the pid4cat record. The license is set to "CC0-1.0" by default. |
| name | The name of the agent that created or modified the PID record. |
| orcid | The ORCID of the person |
| related_identifier | The related identifier. |
| related_identifiers | The related identifiers for the pid4cat record. The related identifiers are used to link the pid4cat record to other resources. |
| relation_type | Relation type between the resources. |
| representation_variants | The representations of the resource in other media types than text/html. |
| resolving_url | The URL that resolves the identifier. |
| resource_category | The category of the resource. |
| resource_info | The resource info of the pid4cat record. The resource info contains information about the resource identified by the PID. |
| responseCode | The response code of the handle API. |
| role | The role of the agent relative to the resource |
| schema_version | The version of the pid4cat-model used to create the pid4cat record. |
| size | The size of the representation in bytes. |
| status | The status of the pid4cat record. The status is set to "SUBMITTED" when the handle is reserved but the resource is not yet linked. The status is set to "REGISTERED" when the handle is linked to a concrete resource. |
| timestamp | The iso datetime for the last update of the handle data. |
| ttl | A time to live in seconds for the handle record. Typically: 86400 => 1 day |
| type | The type of the handle record data. |
| value | The value of the handle data. |
| values | The values of the pid4cat record. |
| variant_url | The URL of the representation variant. |
Enumerations
| Enumeration | Description |
|---|---|
| ChangeLogField | The field of the pid4cat record that was changed. |
| MediaTypesEnum | IANA media types are used to specify the type of data. |
| Pid4CatAgentRole | The role of an agent relative to the resource. |
| Pid4CatStatus | The usage status of the pid4cat record. |
| RelationType | The type of relation between two resources referenced by their PIDs. |
| ResourceCategory | The ResourceCategory expresses for which type of resource the PID is used, e.g. if the PID is for a sample or a device. |
Types
| Type | Description |
|---|---|
| Boolean | A binary (true or false) value |
| Curie | a compact URI |
| Date | a date (year, month and day) in an idealized calendar |
| DateOrDatetime | Either a date or a datetime |
| Datetime | The combination of a date and time |
| Decimal | A real number with arbitrary precision that conforms to the xsd:decimal specification |
| Double | A real number that conforms to the xsd:double specification |
| Float | A real number that conforms to the xsd:float specification |
| Integer | An integer |
| Jsonpath | A string encoding a JSON Path. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded in tree form. |
| Jsonpointer | A string encoding a JSON Pointer. The value of the string MUST conform to JSON Point syntax and SHOULD dereference to a valid object within the current instance document when encoded in tree form. |
| Ncname | Prefix part of CURIE |
| Nodeidentifier | A URI, CURIE or BNODE that represents a node in a model. |
| Objectidentifier | A URI or CURIE that represents an object in the model. |
| Sparqlpath | A string encoding a SPARQL Property Path. The value of the string MUST conform to SPARQL syntax and SHOULD dereference to zero or more valid objects within the current instance document when encoded as RDF. |
| String | A character string |
| Time | A time object represents a (local) time of day, independent of any particular day |
| Uri | a complete URI |
| Uriorcurie | a URI or a CURIE |
Subsets
| Subset | Description |
|---|---|