D-Net
/
openaire-graph-docs
6
1
Fork 5
Code Issues 5 Pull Requests 2 Packages Projects Releases 67 Wiki Activity
openaire-graph-docs/docs/data-model/relationships.md

164 lines
8.8 KiB
Markdown
Raw Normal View History

Add basic structure
2022-09-01 13:35:24 +02:00
---
sidebar_position: 2
---
Add provision sample text
2022-09-09 17:38:08 +02:00
# Relationships
A relationship in the graph is represented by the following data type, which aims to model a directed edge between two nodes, providing information about the semantic of the relation, its provenance and validation.
---
## The `Relationship` object
### source
_Type: [Node](#the-node-object) • Cardinality: ONE_
Represents the source node in the relation.
Add example to all fields in entities and relationshipds
2022-09-23 16:19:32 +02:00
```json
"source": {
"id": "20|openorgs____::1cb75a3ad756e4c83e455e3e7347643b",
"type": "organization"
}
```
Add provision sample text
2022-09-09 17:38:08 +02:00
### target
_Type: [Node](#the-node-object) • Cardinality: ONE_
Represents the target node in the relation.
Add example to all fields in entities and relationshipds
2022-09-23 16:19:32 +02:00
```json
"target": {
"id": "10|doajarticles::022409068174087a003647ff46070f7f",
"type": "datasource"
}
```
Add provision sample text
2022-09-09 17:38:08 +02:00
### reltype
_Type: [RelType](#the-reltype-object) • Cardinality: ONE_
Represent the semantics of the relation between two nodes of the graph.
Add example to all fields in entities and relationshipds
2022-09-23 16:19:32 +02:00
```json
"reltype": {
"name": "provides",
"type": "provision"
}
```
Add provision sample text
2022-09-09 17:38:08 +02:00
### provenance
_Type: [Provenance](entities/other#provenance-1) • Cardinality: ONE_
Indicates the process that produced (or provided) the information.
Add example to all fields in entities and relationshipds
2022-09-23 16:19:32 +02:00
```json
"provenance": {
"provenance": "Harvested",
"trust":"0.900"
}
```
Add provision sample text
2022-09-09 17:38:08 +02:00
### validated
_Type: Boolean • Cardinality: ONE_
Indicates weather or not the relation was validated.
Add example to all fields in entities and relationshipds
2022-09-23 16:19:32 +02:00
```json
"validated": true
```
Add provision sample text
2022-09-09 17:38:08 +02:00
### validationDate
_Type: String • Cardinality: ONE_
Indicates the validation date of the relation - applies only when the validated flag is set to true.
Add example to all fields in entities and relationshipds
2022-09-23 16:19:32 +02:00
```json
"validationDate": "2022-09-02"
```
Add provision sample text
2022-09-09 17:38:08 +02:00
---
## The `Node` object
The Node data type contains the minimum information needed to identify a graph node, its identifier and entity type.
### id
_Type: String • Cardinality: ONE_
OpenAIRE identifier of the node in the graph.
Add example to all fields in entities and relationshipds
2022-09-23 16:19:32 +02:00
```json
"id": "10|doajarticles::022409068174087a003647ff46070f7f"
```
Add provision sample text
2022-09-09 17:38:08 +02:00
### type
_Type: String • Cardinality: ONE_
Graph node type.
Add example to all fields in entities and relationshipds
2022-09-23 16:19:32 +02:00
```json
"type": "datasource"
```
Add provision sample text
2022-09-09 17:38:08 +02:00
## The `RelType` object
The RelType data type models the semantic of the relationship among two nodes.
### type
_Type: String • Cardinality: ONE_
Relation category, e.g. affiliation, citation, see table Relation typologies.
Add example to all fields in entities and relationshipds
2022-09-23 16:19:32 +02:00
```json
"name": "provides"
```
Add provision sample text
2022-09-09 17:38:08 +02:00
### name
_Type: String • Cardinality: ONE_
Further specifies the relation semantic, indicating the relation direction, e.g. Cites, isCitedBy.
Add example to all fields in entities and relationshipds
2022-09-23 16:19:32 +02:00
```json
"type": "provision"
```
Add provision sample text
2022-09-09 17:38:08 +02:00
---
## Relationship types
The following table lists all the possible relation semantics found in the graph dump.
adding link to the DataCite metadata kernel
2023-01-13 14:14:07 +01:00
Note: the labels used to specify the semantic of the relationships are (for the large) inherited from the [DataCite metadata kernel](https://schema.datacite.org/meta/kernel-4.4/doc/DataCite-MetadataKernel_v4.4.pdf), which provides a description for them.
WIP adding provenance to relation types
2023-01-17 16:00:01 +01:00
| # | Source entity type | Target entity type | Relation name / inverse | Provenance |
|:--:|:--------------------------------------:|:--------------------------------------:|:----------------------------------------------------------:|:-----------------------------------------------:|
| 1 | [Project](entities/project) | [Result](entities/result) | produces / isProducedBy | Harvested, Inferred by OpenAIRE, Linked by user |
| 2 | [Project](entities/project) | [Organization](entities/organization) | hasParticipant / isParticipant | Harvested |
aligned relation labels with the data
2023-02-17 15:41:19 +01:00
| 3 | [Project](entities/project) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Linked by user |
| 4 | [Result](entities/result) | [Result](entities/result) | IsAmongTopNSimilarDocuments / HasAmongTopNSimilarDocuments | Inferred by OpenAIRE |
| 5 | [Result](entities/result) | [Result](entities/result) | IsSupplementTo / IsSupplementedBy | Harvested |
| 6 | [Result](entities/result) | [Result](entities/result) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user |
WIP adding provenance to relation types
2023-01-17 16:00:01 +01:00
| 7 | [Result](entities/result) | [Result](entities/result) | IsPartOf / HasPart | Harvested |
| 8 | [Result](entities/result) | [Result](entities/result) | IsDocumentedBy / Documents | Harvested |
| 9 | [Result](entities/result) | [Result](entities/result) | IsObsoletedBy / Obsoletes | Harvested |
| 10 | [Result](entities/result) | [Result](entities/result) | IsSourceOf / IsDerivedFrom | Harvested |
| 11 | [Result](entities/result) | [Result](entities/result) | IsCompiledBy / Compiles | Harvested |
| 12 | [Result](entities/result) | [Result](entities/result) | IsRequiredBy / Requires | Harvested |
| 13 | [Result](entities/result) | [Result](entities/result) | IsCitedBy / Cites | Harvested, Inferred by OpenAIRE |
| 14 | [Result](entities/result) | [Result](entities/result) | IsReferencedBy / References | Harvested |
| 15 | [Result](entities/result) | [Result](entities/result) | IsReviewedBy / Reviews | Harvested |
| 16 | [Result](entities/result) | [Result](entities/result) | IsOriginalFormOf / IsVariantFormOf | Harvested |
| 17 | [Result](entities/result) | [Result](entities/result) | IsVersionOf / HasVersion | Harvested |
| 18 | [Result](entities/result) | [Result](entities/result) | IsIdenticalTo / IsIdenticalTo | Harvested |
| 19 | [Result](entities/result) | [Result](entities/result) | IsPreviousVersionOf / IsNewVersionOf | Harvested |
| 20 | [Result](entities/result) | [Result](entities/result) | IsContinuedBy / Continues | Harvested |
| 21 | [Result](entities/result) | [Result](entities/result) | IsDescribedBy / Describes | Harvested |
Add placeholders for info to be updated regarding pids per entity && hasAuthorInstitution detailed page
2023-04-03 17:49:15 +02:00
| 22 | [Result](entities/result) | [Organization](entities/organization) | hasAuthorInstitution / isAuthorInstitutionOf | Harvested, Inferred by OpenAIRE [(more)](relationships/hasAuthorInstitution) |
WIP adding provenance to relation types
2023-01-17 16:00:01 +01:00
| 23 | [Result](entities/result) | [Data source](entities/data-source) | isHostedBy / hosts | Harvested, Inferred by OpenAIRE |
| 24 | [Result](entities/result) | [Data source](entities/data-source) | isProvidedBy / provides | Harvested |
aligned relation labels with the data
2023-02-17 15:41:19 +01:00
| 25 | [Result](entities/result) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user |
| 26 | [Organization](entities/organization) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Linked by user |
| 27 | [Organization](entities/organization) | [Organization](entities/organization) | IsChildOf / IsParentOf | Linked by user |
| 28 | [Data source](entities/data-source) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Linked by user |
| 29 | [Data source](entities/data-source) | [Organization](entities/organization) | isProvidedBy / provides | Harvested |
Add provision sample text
2022-09-09 17:38:08 +02:00