Skip to content

Commit

Permalink
source system profile
Browse files Browse the repository at this point in the history
  • Loading branch information
southeo committed Apr 29, 2024
1 parent cf707ac commit 55336b3
Show file tree
Hide file tree
Showing 2 changed files with 165 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
{
"$id": "https://schemas.dissco.tech/schemas/fdo-profiles/0.1.0/source-system-request.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"description": "Kernel from which all DiSSCo FAIR Digital Object profiles are derived",
"$comment":"FDO Profile Version 0.1.0",
"properties": {
"fdoProfile" : {
"type": "string",
"description": "PID to a machine readable description of the attributes in the FDO record",
"example": "https://hdl.handle.net/21.T11148/d8de0819e144e4096645",
"$comment": "idx = 1"
},
"digitalObjectType": {
"type": "string",
"description": "PID to a description of the Type of digital object that defines the metadata, bit sequences (if any) and operations for the object",
"example": "https://hdl.handle.net/21.T11148/894b1e6cad57e921764e",
"$comment": "idx = 3"
},
"pidIssuer": {
"type": "string",
"description": "In case of a DOI this is a PID for the DOI Registration Agency",
"example": "https://hdl.handle.net/10.17183",
"$comment": "idx = 6"
},
"issuedForAgent": {
"type": "string",
"description": "In the case of a digital specimen, this is a PID for DiSSCo as the agent responsible for serving the digital specimen object",
"example": "https://hdl.handle.net/10.22",
"$comment": "idx = 8"
},
"structuralType": {
"enum": ["digital", "physical", "performance", "abstraction"],
"description": "Nature of the digital object, compatible with DOI schema requirements. The nature of a digital specimen object is always \"digital\". Other digital objects (outside DiSSCo) could be of physical, performance or abstraction nature.",
"$comment": "idx = 12"
},
"locations": {
"type": "array",
"items": {
"type": "string"
},
"description": "Additional URLs to be appended to the 10320/loc field"
},
"sourceSystemName": {
"type": "string",
"description": "Name of source system",
"$comment": "idx = 600"
}
},
"required": [
"fdoProfile",
"digitalObjectType",
"issuedForAgent",
"sourceSystemName"
]
}
109 changes: 109 additions & 0 deletions data-model/fdo-profiles/0.1.0/source-system/schema/source-system.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
{
"$id": "https://schemas.dissco.tech/schemas/fdo-profiles/0.1.0/source-system.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"description": "Kernel from which all DiSSCo FAIR Digital Object profiles are derived",
"$comment":"FDO Profile Version 0.1.0",
"properties": {
"fdoProfile" : {
"type": "string",
"description": "PID to a machine readable description of the attributes in the FDO record",
"example": "https://hdl.handle.net/21.T11148/d8de0819e144e4096645",
"$comment": "idx = 1"
},
"fdoRecordLicense": {
"const": "https://creativecommons.org/publicdomain/zero/1.0/",
"description": "The licence for the FDO record, required to be always public domain",
"$comment": "idx = 2"
},
"digitalObjectType": {
"type": "string",
"description": "PID to a description of the Type of digital object that defines the metadata, bit sequences (if any) and operations for the object",
"example": "https://hdl.handle.net/21.T11148/894b1e6cad57e921764e",
"$comment": "idx = 3"
},
"digitalObjectName": {
"type": "string",
"description": "Name of the object type for humans\n",
"example": "digital specimen type 1",
"$comment": "idx = 4"
},
"pid": {
"type": "string",
"description": "The PID of which the FDO record is part, in DiSSCo this is a Handle or DOI. It is recommended to store this pid also in the local collection management system for the specimen.",
"example": "https://doi.org/10.22/GEE-W3J-HL2",
"$comment": "idx = 5"
},
"pidIssuer": {
"type": "string",
"description": "In case of a DOI this is a PID for the DOI Registration Agency",
"example": "https://hdl.handle.net/10.17183",
"$comment": "idx = 6"
},
"pidIssuerName": {
"type": "string",
"description": "Human-readable name of the PID issuer",
"example": "DataCite",
"$comment": "idx = 7"
},
"issuedForAgent": {
"type": "string",
"description": "In the case of a digital specimen, this is a PID for DiSSCo as the agent responsible for serving the digital specimen object",
"example": "https://hdl.handle.net/10.22",
"$comment": "idx = 8"
},
"issuedForAgentName": {
"type": "string",
"description": "Human-readable agent name",
"example": "DiSSCo",
"$comment": "idx = 9"
},
"pidRecordIssueDate": {
"type": "string",
"description": "Date the PID record was created",
"example": "2023-10-16T12:08:37.494Z",
"$comment": "idx = 10"
},
"pidRecordIssueNumber": {
"type": "integer",
"description": "Starts with 1 and is incrementally increased by 1 every time the pid record is updated. Compatible with DOI schema requirements.",
"example": "2",
"$comment": "idx = 11"
},
"structuralType": {
"enum": ["digital", "physical", "performance", "abstraction"],
"description": "Nature of the digital object, compatible with DOI schema requirements. The nature of a digital specimen object is always \"digital\". Other digital objects (outside DiSSCo) could be of physical, performance or abstraction nature.",
"$comment": "idx = 12"
},
"pidStatus": {
"enum": ["DRAFT", "ACTIVE", "RETIRED", "OBSOLETE", "FAILED", "MERGED", "SPLIT", "TEST"],
"description": "A PID is considered to have a lifecycle, PID status indicates the status in the life cycle, e.g. draft, active, retired. PID statuses are described further in the PID infrastructure design.",
"$comment": "idx = 13"
},
"HS_ADMIN": {
"type": "string",
"description": "Administrative information for PID profile",
"$comment": "idx = 100"
},
"sourceSystemName": {
"type": "string",
"description": "Name of source system",
"$comment": "idx = 600"
}
},
"required": [
"fdoProfile",
"fdoRecordLicense",
"digitalObjectType",
"digitalObjectName",
"pid",
"pidIssuer",
"pidIssuerName",
"issuedForAgent",
"pidRecordIssueDate",
"pidRecordIssueNumber",
"structuralType",
"pidStatus",
"sourceSystemName"
]
}

0 comments on commit 55336b3

Please sign in to comment.