Action.schema.json

{
    "@context": "http://www.w3.org/ns/csvw",
    "columns": [
        {
            "name": "id",
            "titles": {
                "en": [
                    "MBO Permanent Identifier*"
                ]
            },
            "dc:description": {
                "en": [
                    "Note that when inputting into CSV files this should not be the full URI, \nbut just the last part, e.g. `mbo_0000001`.\nThis is the identifier (mPID) for this row of the spreadsheet \nand for whatever information is being described in this row. \nIt should be unique in this column."
                ]
            },
            "required": true,
            "suppressOutput": true,
            "datatype": {
                "base": "string",
                "format": "^mbo_[_0-9a-z]+$"
            }
        },
        {
            "name": "metadataPublisherId",
            "titles": {
                "en": [
                    "Data Entry Person (mPID - you)*"
                ]
            },
            "dc:description": {
                "en": [
                    "Should be an mPID from the first column of Person.csv"
                ]
            },
            "required": true,
            "propertyUrl": "https://schema.org/creator",
            "aboutUrl": "https://w3id.org/marco-bolo/{+id}#input-metadata",
            "valueUrl": "https://w3id.org/marco-bolo/{+metadataPublisherId}"
        },
        {
            "name": "metadataDescribedForActionId",
            "titles": {
                "en": [
                    "Data Entered for Action (mPID)*"
                ]
            },
            "dc:description": {
                "en": [
                    "The mPID from the first column of the Action.csv. \nNote that you can reference the same mPID in multiple rows.\n\nUses the <https://w3id.org/marco-bolo/isResultOf> predicate but ultimately ends up being \nrepresented as a triple in the form `<action> schema:result <this-entity>`."
                ]
            },
            "required": true,
            "propertyUrl": "https://w3id.org/marco-bolo/isResultOf",
            "aboutUrl": "https://w3id.org/marco-bolo/{+id}#input-metadata",
            "valueUrl": "https://w3id.org/marco-bolo/{+metadataDescribedForActionId}"
        },
        {
            "name": "name",
            "titles": {
                "en": [
                    "Name*"
                ]
            },
            "dc:description": {
                "en": [
                    "The commonly used name. \nFor example: `MBA` for Marine Biological Association"
                ]
            },
            "required": true,
            "propertyUrl": "https://schema.org/name",
            "datatype": {
                "base": "string"
            }
        },
        {
            "name": "agentId",
            "titles": {
                "en": [
                    "Agent (mPID)*"
                ]
            },
            "dc:description": {
                "en": [
                    "This identifier must be defined in the CSV file Person.csv or Organization.csv"
                ]
            },
            "required": true,
            "propertyUrl": "https://schema.org/agent",
            "valueUrl": "https://w3id.org/marco-bolo/{+agentId}"
        },
        {
            "name": "abstract",
            "titles": {
                "en": [
                    "Abstract"
                ]
            },
            "dc:description": {
                "en": [
                    "A brief summary that captures the essence of this entity in ~ 1-5 sentences. \nThink of this as what would appear in search results or catalog listings,\nit should quickly convey the main purpose or key points without technical details."
                ]
            },
            "propertyUrl": "https://schema.org/abstract",
            "datatype": {
                "base": "string"
            }
        },
        {
            "name": "description",
            "titles": {
                "en": [
                    "Description"
                ]
            },
            "dc:description": {
                "en": [
                    "A concise one-sentence summary of the main point or purpose."
                ]
            },
            "propertyUrl": "https://schema.org/description",
            "datatype": {
                "base": "string"
            }
        },
        {
            "name": "howToPerformActionMboId",
            "titles": {
                "en": [
                    "How To (mPID)"
                ]
            },
            "dc:description": {
                "en": [
                    "This identifier must be defined in the CSV file HowTo.csv"
                ]
            },
            "propertyUrl": "https://schema.org/actionProcess",
            "valueUrl": "https://w3id.org/marco-bolo/{+howToPerformActionMboId}"
        },
        {
            "name": "participantIds",
            "titles": {
                "en": [
                    "Participants (mPIDs)"
                ]
            },
            "dc:description": {
                "en": [
                    "mPID(s) from the first column of either Person.csv or Organization.csv\nPipe-delimited when there are multiple values"
                ]
            },
            "propertyUrl": "https://schema.org/participant",
            "separator": "|",
            "datatype": {
                "@id": "https://w3id.org/marco-bolo/ConvertMboIdToNode",
                "base": "string"
            }
        },
        {
            "name": "actionInputPids",
            "titles": {
                "en": [
                    "Inputs (URL PIDs)"
                ]
            },
            "dc:description": {
                "en": [
                    "This should be a URL to a digital object (dataset, publication, etc)\nFor example: `https://example.com`, `http://example.com`, \n`ftp://ftp.example.org/data`, `doi:10.1000/example123`\n\nPipe-delimited when there are multiple values"
                ]
            },
            "propertyUrl": "https://schema.org/object",
            "separator": "|",
            "datatype": {
                "@id": "https://w3id.org/marco-bolo/ConvertIriToNode",
                "base": "string"
            }
        },
        {
            "name": "resultingDatasetMboIds",
            "titles": {
                "en": [
                    "Resulting Datasets (mPIDs)"
                ]
            },
            "dc:description": {
                "en": [
                    "mPID(s) from the first column of Dataset.csv\nPipe-delimited when there are multiple values"
                ]
            },
            "propertyUrl": "https://schema.org/result",
            "separator": "|",
            "datatype": {
                "@id": "https://w3id.org/marco-bolo/ConvertMboIdToNode",
                "base": "string"
            }
        },
        {
            "name": "childActionMboIds",
            "titles": {
                "en": [
                    "Child Actions (mPIDs)"
                ]
            },
            "dc:description": {
                "en": [
                    "This child action must be defined in the CSV file Action.csv. \nWhat defines a child action vs a subsequent action is up to you: \nfor example, if you are creating your own datasets from published data, \nfor 2 different parameters, the parent action could be \n`collating physical parameters` and the child actions could be, `...for CO2`, `...for Chla`\n\nPipe-delimited when there are multiple values"
                ]
            },
            "propertyUrl": "https://schema.org/result",
            "separator": "|",
            "datatype": {
                "@id": "https://w3id.org/marco-bolo/ConvertMboIdToNode",
                "base": "string"
            }
        },
        {
            "virtual": true,
            "propertyUrl": "rdf:type",
            "valueUrl": "https://schema.org/CreateAction"
        },
        {
            "virtual": true,
            "aboutUrl": "https://w3id.org/marco-bolo/{+id}#input-metadata",
            "propertyUrl": "rdf:type",
            "valueUrl": "https://schema.org/DataDownload"
        },
        {
            "virtual": true,
            "aboutUrl": "https://w3id.org/marco-bolo/{+id}#input-metadata",
            "propertyUrl": "rdf:type",
            "valueUrl": "https://w3id.org/marco-bolo/InputMetadataDescription"
        },
        {
            "virtual": true,
            "aboutUrl": "https://w3id.org/marco-bolo/{+id}#input-metadata",
            "propertyUrl": "https://schema.org/about",
            "valueUrl": "https://w3id.org/marco-bolo/{+id}"
        },
        {
            "virtual": true,
            "aboutUrl": "https://w3id.org/marco-bolo/{+id}#input-metadata",
            "propertyUrl": "https://schema.org/contentUrl",
            "valueUrl": "https://w3id.org/marco-bolo/mbo_0000004#row={_row}"
        }
    ],
    "aboutUrl": "https://w3id.org/marco-bolo/{+id}",
    "primaryKey": [
        "id"
    ],
    "foreignKeys": [
        {
            "columnReference": "metadataPublisherId",
            "reference": {
                "resource": "../out/validation/person-or-organization.csv",
                "columnReference": "id"
            }
        },
        {
            "columnReference": "metadataDescribedForActionId",
            "reference": {
                "resource": "../data/Action.csv",
                "columnReference": "id"
            }
        },
        {
            "columnReference": "agentId",
            "reference": {
                "resource": "../out/validation/person-or-organization.csv",
                "columnReference": "id"
            }
        }
    ]
}