External Object Instance

*** An external data object, i.e. one that has comes from somewhere other than being generated as part of the modelling pipeline.***

Writable Fields:

identifier: Full URL of identifier (e.g. DataCite DOI) of the ExternalObject, unique in the context of the triple (identifier, title, version). At least one of identifier and alternate_identifier must be defined.

alternate_identifier: Name of the ExternalObject, unique in the context of the quadruple (alternate_identifier, alternate_identifier_type, title, version). Unlike identifier, this is free text, not a url. For instance, it can be a locally unique name for a data resource within the domain of issue. It is associated with a alternate_identifier_type which describes its origin.

alternate_identifier_type: Type of alternate_identifier, required if alternate_identifier is defined

primary_not_supplement (optional): Boolean flag to indicate that the ExternalObject is a primary source

release_date: Date-time the ExternalObject was released

title: Title of the ExternalObject

description (optional): Free text description of the ExternalObject

data_product: API URL of the associated DataProduct

original_store (optional): StorageLocation that references the original location of this ExternalObject. For example, if the original data location could be transient and so the data has been copied to a more robust location, this would be the reference to the original data location.

Read-only Fields:

url: Reference to the instance of the ExternalObject, final integer is the ExternalObject id

last_updated: Datetime that this record was last updated

updated_by: Reference to the user that updated this record

version: Version identifier of the DataProduct associated with this ExternalObject

GET /api/external_object/1/?format=api

HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "url": "https://data.fairdatapipeline.org/api/external_object/1/?format=api",
    "last_updated": "2024-02-09T15:36:32.043437Z",
    "identifier": "https://doi.org/10.1038/s41592-020-0856-2",
    "alternate_identifier": null,
    "alternate_identifier_type": null,
    "primary_not_supplement": true,
    "release_date": "2021-09-20T12:00:00Z",
    "title": "Static parameters of the model",
    "description": null,
    "version": "1.0.0",
    "updated_by": "https://data.fairdatapipeline.org/api/users/2/?format=api",
    "data_product": "https://data.fairdatapipeline.org/api/data_product/1/?format=api",
    "original_store": null
}