DLCM Solution v2.0.13, 2021-06-07

DLCM

1. Getting Started

An introduction of how the DLCM APIs are working is detailed in Integration Guide

2. DLCM Solution application

2.1. Description

DLCM application wrapping all modules, All-In-One

2.3. Dashboard

The Dashboard of the application is an HTML page with:

  • the list of available modules,

  • some system commands such as:

    • Info to get application information link,

    • Status to get application status link,

    • Metrics to get application metrics link,

    • Log File to get application log file link,

  • the available documentation:

    • the APIs documentation in HTML or PDF,

    • the integration Guide in HTML or PDF.

3. Modules

3.1. Admin Module

3.1.1. Response Structure

Path Type Mandatory Description Constraints

name

String

The name of the module, i.e. admin

_links

Object

The links list of the module, included its REST resources

Relation Description

self

Links to module itself

resources

REST Resource named application-roles
REST Resource named archive-acl
REST Resource named archive-ratings
REST Resource named archive-statistics
REST Resource named authorized-organizational-units
REST Resource named dissemination-policies
REST Resource named funding-agencies
REST Resource named institutions
REST Resource named languages
REST Resource named licenses
REST Resource named metadata-types
REST Resource named notifications
REST Resource named oauth2-clients
REST Resource named organizational-units
REST Resource named people
REST Resource named preservation-policies
REST Resource named rating-types
REST Resource named research-domains
REST Resource named roles
REST Resource named submission-agreements
REST Resource named submission-policies
REST Resource named system-properties
REST Resource named users

3.1.2. Resources

Application Roles

A role at the application level, one of USER, ADMIN, ROOT.

The URL of the REST resource is : http(s)://<root context>/admin/application-roles

Details
Path Type Mandatory Description Constraints

resId

String

The application-roles resource identifier [UUID]

creation

Object

The creation info of the application-roles resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the application-roles resource (see Change Information Detail)

_links

Object

The links list of the application-roles resource

level

Number

The level of the role

name

String

The name of the application role

Relation Description

self

Link to the application-roles resource

list

Link to the collection of application-roles resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the application-roles collection

module

Link to the admin module

lastCreated

Link to the application-roles collection sorted by creation date

lastUpdated

Link to the application-roles collection sorted by last updated date

Archive Access Control List

An archive access control list is used to grant users access to restricted or closed archives.

The URL of the REST resource is : http(s)://<root context>/admin/archive-acl

Details
Path Type Mandatory Description Constraints

resId

String

The archive-acl resource identifier [UUID]

creation

Object

The creation info of the archive-acl resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the archive-acl resource (see Change Information Detail)

_links

Object

The links list of the archive-acl resource

aipId

String

The ID of the archive ACL

expiration

String

The expiration date of the archive ACL

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

expired

Boolean

if the the archive ACL is expired

organizationalUnit

Object

The organizational unit of the archive ACL

organizationalUnit.resId

String

The organizational unit ID of the archive ACL

user

Object

The user of the archive ACL

user.resId

String

The user ID of the archive ACL

Relation Description

self

Link to the archive-acl resource

list

Link to the collection of archive-acl resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the archive-acl collection

module

Link to the admin module

lastCreated

Link to the archive-acl collection sorted by creation date

lastUpdated

Link to the archive-acl collection sorted by last updated date

Archive Ratings

Archive ratings are the grade assigned by an user to an archive.

The URL of the REST resource is : http(s)://<root context>/admin/archive-ratings

Details
Path Type Mandatory Description Constraints

resId

String

The archive-ratings resource identifier [UUID]

creation

Object

The creation info of the archive-ratings resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the archive-ratings resource (see Change Information Detail)

_links

Object

The links list of the archive-ratings resource

archiveId

String

The archive ID of the archive rating

grade

Number

The grade of the archive rating

ratingType

Object

The rating type of the archive rating

ratingType.resId

String

The rating type ID of the archive rating

user

Object

The user of the archive rating

user.resId

String

The user ID of the archive rating

Relation Description

self

Link to the archive-ratings resource

list

Link to the collection of archive-ratings resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the archive-ratings collection

module

Link to the admin module

lastCreated

Link to the archive-ratings collection sorted by creation date

lastUpdated

Link to the archive-ratings collection sorted by last updated date

Archive Statistics

Archive statistics are the number of view/download for an archive.

The URL of the REST resource is : http(s)://<root context>/admin/archive-statistics (Read-Only REST resource)

Details
Path Type Mandatory Description Constraints

resId

String

The archive-statistics resource identifier [UUID]

creation

Object

The creation info of the archive-statistics resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the archive-statistics resource (see Change Information Detail)

_links

Object

The links list of the archive-statistics resource

downloadNumber

Number

The download number of the archive

viewNumber

Number

The view number of the archive

Relation Description

self

Link to the archive-statistics resource

list

Link to the collection of archive-statistics resource

module

Link to the parent’s resource

add-view

Link to add-view action on the current archive-statistics resource

add-download

Link to add-download action on the current archive-statistics resource

statistics

Link to statistics action on the current archive-statistics resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the archive-statistics collection

module

Link to the admin module

lastCreated

Link to the archive-statistics collection sorted by creation date

lastUpdated

Link to the archive-statistics collection sorted by last updated date

Dissemination Policies

A dissemination policy defines how to disseminate archives.

The URL of the REST resource is : http(s)://<root context>/admin/dissemination-policies

Details
Path Type Mandatory Description Constraints

resId

String

The dissemination-policies resource identifier [UUID]

creation

Object

The creation info of the dissemination-policies resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the dissemination-policies resource (see Change Information Detail)

_links

Object

The links list of the dissemination-policies resource

destinationServer

String

The destinationServer of the dissemination policy

name

String

The name of the dissemination policy

subFolder

String

The subfolder of the dissemination policy

type

String

The type of the dissemination policy

Values: IIIF, WEB

useNumber

Number

Use number in organizational units of the dissemination policy

Relation Description

self

Link to the dissemination-policies resource

list

Link to the collection of dissemination-policies resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the dissemination-policies collection

module

Link to the admin module

lastCreated

Link to the dissemination-policies collection sorted by creation date

lastUpdated

Link to the dissemination-policies collection sorted by last updated date

Funding Agencies

A funding agency represents organizations or groups who provide funds for research projects.

The URL of the REST resource is : http(s)://<root context>/admin/funding-agencies

Details
Path Type Mandatory Description Constraints

resId

String

The funding-agencies resource identifier [UUID]

creation

Object

The creation info of the funding-agencies resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the funding-agencies resource (see Change Information Detail)

_links

Object

The links list of the funding-agencies resource

acronym

String

The acronym of the funding agency

description

String

The description of the funding agency

name

String

The name of the funding agency

url

String

The URL of the funding agency

Valid URL

Relation Description

self

Link to the funding-agencies resource

list

Link to the collection of funding-agencies resource

module

Link to the parent’s resource

organizational-units

Link to organizational-units action on the current funding-agencies resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the funding-agencies collection

module

Link to the admin module

lastCreated

Link to the funding-agencies collection sorted by creation date

lastUpdated

Link to the funding-agencies collection sorted by last updated date

Institutions

An institution represents academic institutions, such as UNIGE and HES-SO.

The URL of the REST resource is : http(s)://<root context>/admin/institutions

Details
Path Type Mandatory Description Constraints

resId

String

The institutions resource identifier [UUID]

creation

Object

The creation info of the institutions resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the institutions resource (see Change Information Detail)

_links

Object

The links list of the institutions resource

description

String

The description of the institution

emailSuffixes

Array

List of email suffixes

logo

Null

Logo of the institution

name

String

The name of the institution

url

String

The URL of the institution website

Valid URL

Relation Description

self

Link to the institutions resource

list

Link to the collection of institutions resource

module

Link to the parent’s resource

people

Link to people action on the current institutions resource

organizational-units

Link to organizational-units action on the current institutions resource

upload-logo

Link to upload-logo action on the current institutions resource

download-logo

Link to download-logo action on the current institutions resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the institutions collection

module

Link to the admin module

lastCreated

Link to the institutions collection sorted by creation date

lastUpdated

Link to the institutions collection sorted by last updated date

Languages

The URL of the REST resource is : http(s)://<root context>/admin/languages

Details
Path Type Mandatory Description Constraints

resId

String

The languages resource identifier [UUID]

creation

Object

The creation info of the languages resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the languages resource (see Change Information Detail)

_links

Object

The links list of the languages resource

code

String

The code of the language

code ISO 3166-2

Relation Description

self

Link to the languages resource

list

Link to the collection of languages resource

module

Link to the parent’s resource

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the languages collection

module

Link to the admin module

lastCreated

Link to the languages collection sorted by creation date

lastUpdated

Link to the languages collection sorted by last updated date

Licenses

A license represents software licenses (Academic Free License 3.0, Design Science License, MIT License…​).

The URL of the REST resource is : http(s)://<root context>/admin/licenses

Details
Path Type Mandatory Description Constraints

resId

String

The licenses resource identifier [UUID]

creation

Object

The creation info of the licenses resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the licenses resource (see Change Information Detail)

_links

Object

The links list of the licenses resource

description

String

The description of the license

<openLicense> (<title>)

domainContent

Boolean

The content of the domain

domainData

Boolean

The data domain

domainSoftware

Boolean

The domain software

family

String

The family license

isGeneric

Boolean

Give if it’s a generic license

maintainer

String

The maintainer of the license

odConformance

String

The OD conformance status

Values: approved, `, `not reviewed, rejected

openLicenseId

String

The open license identifier

osdConformance

String

The OSD conformance status

Values: approved, `, `not reviewed, rejected

status

String

The current status of the license

Values: active, retired, superseded

title

String

The title of the license

url

String

The URL source of the license

Valid URL

Relation Description

self

Link to the licenses resource

list

Link to the collection of licenses resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the licenses collection

module

Link to the admin module

lastCreated

Link to the licenses collection sorted by creation date

lastUpdated

Link to the licenses collection sorted by last updated date

import

Link to import action on the current licenses resource

Notifications

Notifications can be sent to organizational units managers in order to request access to closed archive, or to ask for membership.

The URL of the REST resource is : http(s)://<root context>/admin/notifications

Details
Path Type Mandatory Description Constraints

resId

String

The notifications resource identifier [UUID]

creation

Object

The creation info of the notifications resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the notifications resource (see Change Information Detail)

_links

Object

The links list of the notifications resource

emitter

Object

The emitter of the notification (User)

message

String

The message sent by the notification

notificationStatus

String

The status of the notification

Values: PROCESSED, PENDING, REFUSED

notificationType

Object

The type of the notification

notificationType.resId

String

The type of the notification

Valid JSON

notifiedOrgUnit

Object

The notified organizational unit

notifiedOrgUnit.resId

String

The ID of the notified organizational unit

objectId

String

The target object ID of the notification

statusMessage

String

The message related to the status

Relation Description

self

Link to the notifications resource

list

Link to the collection of notifications resource

module

Link to the parent’s resource

history

Link to history action on the current notifications resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the notifications collection

module

Link to the admin module

lastCreated

Link to the notifications collection sorted by creation date

lastUpdated

Link to the notifications collection sorted by last updated date

OAuth2 Clients

OAuth 2.0 is the industry standard for token-based authentication and authorization on the internet.

The URL of the REST resource is : http(s)://<root context>/admin/oauth2-clients

Details
Path Type Mandatory Description Constraints

resId

String

The oauth2-clients resource identifier [UUID]

creation

Object

The creation info of the oauth2-clients resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the oauth2-clients resource (see Change Information Detail)

_links

Object

The links list of the oauth2-clients resource

accessTokenValiditySeconds

Number

The access token validity in seconds

Integer value

clientId

String

The client ID of OAuth2 client

grantTypes

Array

The grant types of OAuth2 client

name

String

The name of OAuth2 client

redirectUri

String

The redirect URI of OAuth2 client

Valid URL

refreshTokenValiditySeconds

Number

The refresh token validity in seconds

Integer value

scope

String

The scope of OAuth2 client

Values: READ

Relation Description

self

Link to the oauth2-clients resource

list

Link to the collection of oauth2-clients resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the oauth2-clients collection

module

Link to the admin module

lastCreated

Link to the oauth2-clients collection sorted by creation date

lastUpdated

Link to the oauth2-clients collection sorted by last updated date

values

Link to values action on the current oauth2-clients resource

Organizational Units

An organizational unit is a logical entity that represents a research project or laboratory or any other organizational group of researchers. A preservation space is associated to it.

The URL of the REST resource is : http(s)://<root context>/admin/organizational-units

Details
Path Type Mandatory Description Constraints

resId

String

The organizational-units resource identifier [UUID]

creation

Object

The creation info of the organizational-units resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the organizational-units resource (see Change Information Detail)

_links

Object

The links list of the organizational-units resource

closingDate

String

The closing date of the organizational unit

Format: yyyy-MM-dd

defaultDisseminationPolicy

Null

The default dissemination policy of the organizational unit

defaultLicense

Null

Default license for this organizational unit

defaultPreservationPolicy

Null

The default preservation policy of the organizational unit

defaultSubmissionPolicy

Null

The default submission policy of the organizational unit

description

String

The description of the institution

isEmpty

Boolean

Indicates whether the organizational unit contains any data (depo, sip, aip)

keywords

Null

The keywords associated with this organizational unit, they are used as default for deposits created within this organizational unit

logo

Null

The logo of the organizational unit

name

String

The name of the organizational unit

open

Boolean

Indicates whether the organizational unit is currently open

openingDate

String

The opening date of the organizational unit

Format: yyyy-MM-dd

researchDomains

Null

The research domains associated with this organizational unit

url

String

The URL of the organizational unit

Valid URL

Relation Description

self

Link to the organizational-units resource

list

Link to the collection of organizational-units resource

module

Link to the parent’s resource

people

Link to people action on the current organizational-units resource

institutions

Link to institutions action on the current organizational-units resource

funding-agencies

Link to funding-agencies action on the current organizational-units resource

preservation-policies

Link to preservation-policies action on the current organizational-units resource

submission-policies

Link to submission-policies action on the current organizational-units resource

dissemination-policies

Link to dissemination-policies action on the current organizational-units resource

close

Link to close action on the current organizational-units resource

additional-fields-forms

Link to additional-fields-forms action on the current organizational-units resource

archive-acl

Link to archive-acl action on the current organizational-units resource

upload-logo

Link to upload-logo action on the current organizational-units resource

download-logo

Link to download-logo action on the current organizational-units resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the organizational-units collection

module

Link to the admin module

lastCreated

Link to the organizational-units collection sorted by creation date

lastUpdated

Link to the organizational-units collection sorted by last updated date

People

A person is associated to a user on the platform. It contains information such as the person’s ORCID, institution and organizational units it belongs to.

The URL of the REST resource is : http(s)://<root context>/admin/people

Details
Path Type Mandatory Description Constraints

resId

String

The people resource identifier [UUID]

creation

Object

The creation info of the people resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the people resource (see Change Information Detail)

_links

Object

The links list of the people resource

avatar

Null

Avatar of the person

firstName

String

The first name of the person

fullName

String

The full name of the person

hasAuthenticatedOrcid

Boolean

Has the person an authenticated ORCID

lastName

String

The last name of the person

orcid

String

The ORCID of the person

Format: xxxx-xxxx-xxxx-xxxx

Relation Description

self

Link to the people resource

list

Link to the collection of people resource

module

Link to the parent’s resource

upload-avatar

Link to upload-avatar action on the current people resource

download-avatar

Link to download-avatar action on the current people resource

institutions

Link to institutions action on the current people resource

organizational-units

Link to organizational-units action on the current people resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the people collection

module

Link to the admin module

lastCreated

Link to the people collection sorted by creation date

lastUpdated

Link to the people collection sorted by last updated date

Preservation Policies

A preservation policy defines whether approval is required for an AIP’s disposition as well as how long it should be kept.

The URL of the REST resource is : http(s)://<root context>/admin/preservation-policies

Details
Path Type Mandatory Description Constraints

resId

String

The preservation-policies resource identifier [UUID]

creation

Object

The creation info of the preservation-policies resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the preservation-policies resource (see Change Information Detail)

_links

Object

The links list of the preservation-policies resource

dispositionApproval

Boolean

Mandatory step to approve the AIP disposition

name

String

The name of the preservation policy

retention

Number

The retention duration in days of the preservation policy

3650 days ~ 10 years, 0 day ~ forever

smartRetention

String

The retention duration in human-readable format of the preservation policy

useNumber

Number

Use number in organizational units of the preservation policy

Relation Description

self

Link to the preservation-policies resource

list

Link to the collection of preservation-policies resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the preservation-policies collection

module

Link to the admin module

lastCreated

Link to the preservation-policies collection sorted by creation date

lastUpdated

Link to the preservation-policies collection sorted by last updated date

Rating Types

The rating types is the type of grade for a dataset: * Quality * Usefulness

The URL of the REST resource is : http(s)://<root context>/admin/rating-types

Details
Path Type Mandatory Description Constraints

resId

String

The rating-types resource identifier [UUID]

creation

Object

The creation info of the rating-types resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the rating-types resource (see Change Information Detail)

_links

Object

The links list of the rating-types resource

name

String

The name of the rating type

Relation Description

self

Link to the rating-types resource

list

Link to the collection of rating-types resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the rating-types collection

module

Link to the admin module

lastCreated

Link to the rating-types collection sorted by creation date

lastUpdated

Link to the rating-types collection sorted by last updated date

Research Domains

A research domain defines a set of research disciplines, and is part of a classification (for example: SNF Disciplines or re3data Subjects). It could be associated to an organizational unit.

The URL of the REST resource is : http(s)://<root context>/admin/research-domains

Details
Path Type Mandatory Description Constraints

resId

String

The research-domains resource identifier [UUID]

creation

Object

The creation info of the research-domains resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the research-domains resource (see Change Information Detail)

_links

Object

The links list of the research-domains resource

code

String

The code of the research domain

Length: 5 characters max.

labels

Array

Name labels for each supported languages

name

String

The name of the research domain

source

String

The source of the research domain

Relation Description

self

Link to the research-domains resource

list

Link to the collection of research-domains resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the research-domains collection

module

Link to the admin module

lastCreated

Link to the research-domains collection sorted by creation date

lastUpdated

Link to the research-domains collection sorted by last updated date

values

Link to values action on the current research-domains resource

Roles

A role defines a user’s access level on the platform, giving different permissions for performing actions on it.

The URL of the REST resource is : http(s)://<root context>/admin/roles

Details
Path Type Mandatory Description Constraints

resId

String

The roles resource identifier [UUID]

creation

Object

The creation info of the roles resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the roles resource (see Change Information Detail)

_links

Object

The links list of the roles resource

level

Number

The level of the role

name

String

The name of the role

Relation Description

self

Link to the roles resource

list

Link to the collection of roles resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the roles collection

module

Link to the admin module

lastCreated

Link to the roles collection sorted by creation date

lastUpdated

Link to the roles collection sorted by last updated date

Submission Agreements

A submission agreement defines information such as the content, format and scheduled arrival time of an SIP.

The URL of the REST resource is : http(s)://<root context>/admin/submission-agreements

Details
Path Type Mandatory Description Constraints

resId

String

The submission-agreements resource identifier [UUID]

creation

Object

The creation info of the submission-agreements resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the submission-agreements resource (see Change Information Detail)

_links

Object

The links list of the submission-agreements resource

description

String

The description of the submission agreement

title

String

The title of the submission agreement

version

String

The version of the submission agreement

Relation Description

self

Link to the submission-agreements resource

list

Link to the collection of submission-agreements resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the submission-agreements collection

module

Link to the admin module

lastCreated

Link to the submission-agreements collection sorted by creation date

lastUpdated

Link to the submission-agreements collection sorted by last updated date

Submission Policies

A submission policy is a policy that can be associated to an SIP. It defines whether an SIP can submitted with or without approval and the amount of time it should be kept.

The URL of the REST resource is : http(s)://<root context>/admin/submission-policies

Details
Path Type Mandatory Description Constraints

resId

String

The submission-policies resource identifier [UUID]

creation

Object

The creation info of the submission-policies resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the submission-policies resource (see Change Information Detail)

_links

Object

The links list of the submission-policies resource

name

String

The name of the submission policy

submissionApproval

Boolean

Mandatory step to approve a deposit

timeToKeep

Number

Time to keep completed deposit before purge

useNumber

Number

Use number in organizational units of the submission policy

Relation Description

self

Link to the submission-policies resource

list

Link to the collection of submission-policies resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the submission-policies collection

module

Link to the admin module

lastCreated

Link to the submission-policies collection sorted by creation date

lastUpdated

Link to the submission-policies collection sorted by last updated date

System properties

A system property is defined by the back-end administrators, for the whole system.

The URL of the REST resource is : http(s)://<root context>/admin/system-properties (Read-Only REST resource)

Details
Path Type Mandatory Description Constraints

_links

Object

The links list of the system-properties resource

defaultChecksum

String

The default checksum type used by the system

defaultLicense

String

The default license used by the system

fileSizeLimit

String

The maximum file size, in bytes, up to which data and virus verification are done

forbiddenCharacters

Array

The list of forbidden characters the system

goldenFormats

Array

The list of golden formats of the system

orcidClientId

String

The ORCID client ID used by the system

searchFacets

Array

Describes facet properties used on archives search page

Users

A user represents a user of the platform. A person and roles are associated to it.

The URL of the REST resource is : http(s)://<root context>/admin/users

Details
Path Type Mandatory Description Constraints

resId

String

The users resource identifier [UUID]

creation

Object

The creation info of the users resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the users resource (see Change Information Detail)

_links

Object

The links list of the users resource

applicationRole

Object

The application role details of the user

email

String

The email of the user

Valid email address

enabled

Boolean

If the user is enable

externalUid

String

The external UID of the user

firstName

String

The first name of the user

homeOrganization

String

The home organization of the user

lastLoginIpAddress

String

The IP address from last login

lastLoginTime

Null

Time of last login

lastName

String

The last name of the user

person

Null

The linked person of the user

Relation Description

self

Link to the users resource

list

Link to the collection of users resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the users collection

module

Link to the admin module

lastCreated

Link to the users collection sorted by creation date

lastUpdated

Link to the users collection sorted by last updated date

3.2. Pre-Ingest Module

3.2.1. Response Structure

Path Type Mandatory Description Constraints

name

String

The name of the module, i.e. preingest

_links

Object

The links list of the module, included its REST resources

Relation Description

self

Links to module itself

resources

REST Resource named contributors
REST Resource named deposits

3.2.2. Resources

Deposits

The URL of the REST resource is : http(s)://<root context>/preingest/deposits

Details
Path Type Mandatory Description Constraints

resId

String

The deposits resource identifier [UUID]

creation

Object

The creation info of the deposits resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the deposits resource (see Change Information Detail)

_links

Object

The links list of the deposits resource

access

String

The access level of the deposit

Values: PUBLIC, RESTRICTED, CLOSED

additionalFieldsFormId

String

The additional fields form ID used to generate the additional fields values

Mandatory if additionalFieldsValues are providen

additionalFieldsValues

String

Some eventual additional fields values generated through an additional fields form

Valid JSON

agreement

Boolean

The submission agreement of the deposit

allDataFileReady

Boolean

If all data file are ready

collectionBegin

String

The beginning of the deposit collection

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

collectionEnd

String

The end of the deposit collection

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

collectionSize

Number

Size of AIP collection

complianceLevel

Null

The compliance level of the deposit

Values: NOT_ASSESSED, NO_COMPLIANCE, WEAK_COMPLIANCE, AVERAGE_COMPLIANCE, FULL_COMPLIANCE

dataFileNumber

Number

Number of deposit data files

dataSensitivity

String

The data sensitivity of the deposit

Values: UNDEFINED, BLUE, GREEN, YELLOW, ORANGE, RED, CRIMSON

description

String

The description of the deposit

doi

String

The Digital Object Identifier (DOI) of the deposit

Valid DOI

embargo.access

String

Starting date of embargo period

Values: PUBLIC, RESTRICTED, CLOSED

embargo.months

Number

Month number of embargo duration

embargo.startDate

String

Starting date of embargo period

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

hasEmbargo

Boolean

If the deposit has an embargo

keywords

Array

List of deposit keywords

language

Null

The language object of the deposit

languageId

String

The language ID of the deposit

Valid ID

licenseId

String

The license ID of the deposit

metadataVersion

String

The metadata version of the deposit

Values: 1.0, 1.1, 2.0, 2.1

organizationalUnit

Null

The organizational unit object of the deposit

organizationalUnitId

String

The organizational unit ID of the deposit

preparationId

String

The preparation ID of the deposit

preservationPolicy

Null

The preservation policy object of the deposit

preservationPolicyId

String

The preservation policy ID of the deposit

Valid ID

publicationDate

String

The publication date of the deposit

Format: yyyy-MM-dd

sipId

String

The generated SIP DLCM ID of the deposit

status

String

The status of the deposit

Values: APPROVED, CHECKED, CLEANED, CLEANING, COMPLETED, IN_ERROR, IN_PROGRESS, IN_VALIDATION, PAUSED, REJECTED, SUBMITTED

statusMessage

String

The message related to the status

submissionAgreementId

String

The submission agreement of the deposit

Valid ID

submissionPolicy

Null

The submission policy object of the deposit

submissionPolicyId

String

The submission policy ID of the deposit

Valid ID

title

String

The title of the deposit

Relation Description

self

Link to the deposits resource

list

Link to the collection of deposits resource

module

Link to the parent’s resource

contributors

Link to contributors action on the current deposits resource

data

Link to data action on the current deposits resource

aip

Link to aip action on the current deposits resource

submission-agreements

Link to submission-agreements action on the current deposits resource

licenses

Link to licenses action on the current deposits resource

upload

Link to upload action on the current deposits resource

upload-archive

Link to upload-archive action on the current deposits resource

download

Link to download action on the current deposits resource

history

Link to history action on the current deposits resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the deposits collection

module

Link to the preingest module

lastCreated

Link to the deposits collection sorted by creation date

lastUpdated

Link to the deposits collection sorted by last updated date

schema

Link to schema action on the current deposits resource

values

Link to values action on the current deposits resource

Contributors

The URL of the REST resource is : http(s)://<root context>/preingest/contributors (Read-Only REST resource)

Details
Path Type Mandatory Description Constraints

resId

String

The contributors resource identifier [UUID]

creation

Object

The creation info of the contributors resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the contributors resource (see Change Information Detail)

_links

Object

The links list of the contributors resource

depositNumber

Number

The deposit number of the contributor

firstName

String

The first name of the contributor

fullName

String

The full name of the contributor

hasAuthenticatedOrcid

Boolean

Has the contributor an authenticated ORCID

lastName

String

The last name of the contributor

orcid

String

The ORCID of the contributor

Format: xxxx-xxxx-xxxx-xxxx

Relation Description

self

Link to the contributors resource

list

Link to the collection of contributors resource

module

Link to the parent’s resource

deposits

Link to deposits action on the current contributors resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the contributors collection

module

Link to the preingest module

lastCreated

Link to the contributors collection sorted by creation date

lastUpdated

Link to the contributors collection sorted by last updated date

with-deposits

Link to with-deposits action on the current contributors resource

3.3. Ingest Module

3.3.1. Response Structure

Path Type Mandatory Description Constraints

name

String

The name of the module, i.e. ingest

_links

Object

The links list of the module, included its REST resources

Relation Description

self

Links to module itself

resources

REST Resource named sip

3.3.2. Resources

Submission Information Package (SIP)

The URL of the REST resource is : http(s)://<root context>/ingest/sip

Details
Path Type Mandatory Description Constraints

resId

String

The sip resource identifier [UUID]

creation

Object

The creation info of the sip resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the sip resource (see Change Information Detail)

_links

Object

The links list of the sip resource

aipId

String

The generated AIP DLCM ID of the SIP

collectionSize

Number

Size of AIP collection

dataFileNumber

Number

Number of SIP data files

depositId

String

The source deposit ID of the SIP

dispositionApproval

Boolean

Mandatory step to approve the AIP disposition

info.access

String

The final access level of the package

Values: PUBLIC, RESTRICTED, CLOSED

info.accessCurrentlyPublic

Boolean

A boolean indicating wether the current access level is PUBLIC

info.complianceLevel

String

The compliance level of the package

Values: NOT_ASSESSED, NO_COMPLIANCE, WEAK_COMPLIANCE, AVERAGE_COMPLIANCE, FULL_COMPLIANCE

info.currentAccess

String

The current access level, deducted from the final access level and an eventual embargo

info.dataSensitivity

String

The data sensitivity of the deposit

Values: UNDEFINED, BLUE, GREEN, YELLOW, ORANGE, RED, CRIMSON

info.description

String

The description of the package

info.embargo.access

String

Starting date of embargo period

Values: PUBLIC, RESTRICTED, CLOSED

info.embargo.months

Number

Month number of embargo duration

info.embargo.startDate

String

Starting date of embargo period

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

info.licenseId

String

The license ID of the package

Valid ID

info.metadataVersion

String

The metadata version of the deposit

Values: 1.0, 1.1, 2.0, 2.1

info.name

String

The name of the package

info.organizationalUnitId

String

The organizational Unit ID of the information package

info.status

String

The status of the package

Values: CHECKED, CHECKING, CLEANED, CLEANING, COMPLETED, DISPOSABLE, DISPOSAL_APPROVED_BY_ORGUNIT, DISPOSAL_APPROVED, DISPOSED, DOWNLOADING, IN_ERROR, IN_PREPARATION, IN_PROGRESS, INDEXING, PRESERVATION_ERROR, READY, REINDEXING, RELOADED, REPLICATING_TOMBSTONE, REPLICATING_PACKAGE, RESUBMITTING, STORED, UPDATING_RETENTION

info.statusMessage

Null

The message related to the status

organizationalUnit

Null

The organizational unit object of the SIP

organizationalUnitId

String

The organizational unit ID of the SIP

ready

Boolean

If the SIP package is ready

retention

Number

The retention duration in days of the AIP

3650 days ~ 10 years, 0 day ~ forever

smartRetention

String

The retention duration in human-readable format of the AIP

submissionPolicy

Null

The submission policy object of the SIP

submissionPolicyId

String

The submission policy ID of the SIP

Valid ID

Relation Description

self

Link to the sip resource

list

Link to the collection of sip resource

module

Link to the parent’s resource

data

Link to data action on the current sip resource

aip

Link to aip action on the current sip resource

upload

Link to upload action on the current sip resource

resume

Link to resume action on the current sip resource

history

Link to history action on the current sip resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the sip collection

module

Link to the ingest module

lastCreated

Link to the sip collection sorted by creation date

lastUpdated

Link to the sip collection sorted by last updated date

schema

Link to schema action on the current sip resource

profile

Link to profile action on the current sip resource

values

Link to values action on the current sip resource

3.4. Archival Storage Module

3.4.1. Response Structure

Path Type Mandatory Description Constraints

name

String

The name of the module, i.e. archival-storage

_links

Object

The links list of the module, included its REST resources

Relation Description

self

Links to module itself

resources

REST Resource named aip
REST Resource named stored-aip

3.4.2. Resources

Archival Information Package (AIP)

The URL of the REST resource is : http(s)://<root context>/archival-storage/aip

Details
Path Type Mandatory Description Constraints

resId

String

The aip resource identifier [UUID]

creation

Object

The creation info of the aip resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the aip resource (see Change Information Detail)

_links

Object

The links list of the aip resource

archivalUnit

Boolean

if the AIP is an unit (AIU) or a collection (AIC)

archiveContainer

String

The container type of the AIP

Values: UNDEFINED, ZIP, BAG_IT

archiveFileNumber

Number

The total number of file in the AIP

archiveId

String

The storage URL of the AIP

archiveSize

Number

The size in bytes of the AIP

checksumCheck.checkDate

String

Date of last checksum check execution

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

checksumCheck.checkingSucceed

Boolean

Result of last checksum check execution

checksums

Array

The checksum list of the AIP

collectionSize

Number

Number of AIPs in collection

dataFileNumber

Number

Number of AIP data files

dispositionApproval

Boolean

Mandatory step to approve the AIP disposition

fileFormat.contentType

String

Content type of file

fileFormat.details

String

Format details of file

fileFormat.format

String

Format description of file

fileFormat.md5

String

MD5 checksum of file

fileFormat.puid

String

Format PUID of file

fileFormat.tool

Null

Tool info of file fromat identification

fileFormat.version

String

Format version of file

info.access

String

The final access level of the package

Values: PUBLIC, RESTRICTED, CLOSED

info.accessCurrentlyPublic

Boolean

A boolean indicating wether the current access level is PUBLIC

info.complianceLevel

String

The compliance level of the package

Values: NOT_ASSESSED, NO_COMPLIANCE, WEAK_COMPLIANCE, AVERAGE_COMPLIANCE, FULL_COMPLIANCE

info.currentAccess

String

The current access level, deducted from the final access level and an eventual embargo

info.dataSensitivity

String

The data sensitivity of the deposit

Values: UNDEFINED, BLUE, GREEN, YELLOW, ORANGE, RED, CRIMSON

info.description

String

The description of the package

info.embargo.access

String

Starting date of embargo period

Values: PUBLIC, RESTRICTED, CLOSED

info.embargo.months

Number

Month number of embargo duration

info.embargo.startDate

String

Starting date of embargo period

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

info.licenseId

String

The license ID of the package

Valid ID

info.metadataVersion

String

The metadata version of the deposit

Values: 1.0, 1.1, 2.0, 2.1

info.name

String

The name of the package

info.organizationalUnitId

String

The organizational Unit ID of the information package

info.status

String

The status of the package

Values: CHECKED, CHECKING, CLEANED, CLEANING, COMPLETED, DISPOSABLE, DISPOSAL_APPROVED_BY_ORGUNIT, DISPOSAL_APPROVED, DISPOSED, DOWNLOADING, IN_ERROR, IN_PREPARATION, IN_PROGRESS, INDEXING, PRESERVATION_ERROR, READY, REINDEXING, RELOADED, REPLICATING_TOMBSTONE, REPLICATING_PACKAGE, RESUBMITTING, STORED, UPDATING_RETENTION

info.statusMessage

Null

The message related to the status

ready

Boolean

If AIP package is ready

retention

Number

The retention duration in days of the AIP

3650 days ~ 10 years, 0 day ~ forever

retentionEnd

String

The end of the AIP retention

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

sipIds

Array

The source SIP IDs of the AIP

smartRetention

String

The retention duration in human-readable format of the AIP

smartSize

String

The size in human-readable format of the AIP

smartTombstoneSize

String

The size in human-readable format of the tombstone AIP

tombstoneSize

Number

The size in bytes of the tombstone AIP

virusCheck.checkDate

String

Date of virus check execution

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

virusCheck.details

String

Result detail of virus check

virusCheck.tool

Null

Tool info of virus check

Relation Description

self

Link to the aip resource

list

Link to the collection of aip resource

module

Link to the parent’s resource

data

Link to data action on the current aip resource

upload

Link to upload action on the current aip resource

resume

Link to resume action on the current aip resource

history

Link to history action on the current aip resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the aip collection

module

Link to the archival-storage module

lastCreated

Link to the aip collection sorted by creation date

lastUpdated

Link to the aip collection sorted by last updated date

schema

Link to schema action on the current aip resource

profile

Link to profile action on the current aip resource

values

Link to values action on the current aip resource

archivalCollections

Link to archivalCollections action on the current aip resource

archivalUnits

Link to archivalUnits action on the current aip resource

3.5. Data Management Module

3.5.1. Response Structure

Path Type Mandatory Description Constraints

name

String

The name of the module, i.e. data-mgmt

_links

Object

The links list of the module, included its REST resources

Relation Description

self

Links to module itself

resources

REST Resource named di
REST Resource named index-field-aliases
REST Resource named items
REST Resource named private-di
REST Resource named public-di
REST Resource named settings
REST Resource named thumbnails

3.5.2. Resources

Index Field Aliases

The URL of the REST resource is : http(s)://<root context>/data-mgmt/index-field-aliases

Details
Path Type Mandatory Description Constraints

resId

String

The index-field-aliases resource identifier [UUID]

creation

Object

The creation info of the index-field-aliases resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the index-field-aliases resource (see Change Information Detail)

_links

Object

The links list of the index-field-aliases resource

alias

String

The name that will be exposed to clients (as a field or a facet)

facet

Boolean

Should a facet be created for this field ? default to false

facetDefaultVisibleValues

Number

Number of facet values displayed by default in the user interface

facetLimit

Number

Maximum number of facets values to return if the IndexFieldAlias is a facet

facetMinCount

Number

Minimum number of occurrences of a facet value to be returned in facet results if the IndexFieldAlias is a facet

facetOrder

Number

Determines the position of a facet in the user interface

field

String

The field path in the index

indexName

String

The name of the ElasticSearch index the field is for

labels

Array

Alias labels for each supported languages

Relation Description

self

Link to the index-field-aliases resource

list

Link to the collection of index-field-aliases resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the index-field-aliases collection

module

Link to the data-mgmt module

lastCreated

Link to the index-field-aliases collection sorted by creation date

lastUpdated

Link to the index-field-aliases collection sorted by last updated date

Other Data management resources documentation will come later.

3.6. Access Module

3.6.1. Response Structure

Path Type Mandatory Description Constraints

name

String

The name of the module, i.e. access

_links

Object

The links list of the module, included its REST resources

Relation Description

self

Links to module itself

resources

REST Resource named aip
REST Resource named all-metadata
REST Resource named dip
REST Resource named metadata
REST Resource named oai-provider
REST Resource named oai-sets
REST Resource named orders
REST Resource named organizational-units
REST Resource named private-metadata

3.6.2. Resources

Dissemination Information Package (DIP)

The URL of the REST resource is : http(s)://<root context>/access/dip

Details
Path Type Mandatory Description Constraints

resId

String

The dip resource identifier [UUID]

creation

Object

The creation info of the dip resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the dip resource (see Change Information Detail)

_links

Object

The links list of the dip resource

aipIds

Array

The source AIP IDs of the DIP

info.access

String

The final access level of the package

Values: PUBLIC, RESTRICTED, CLOSED

info.accessCurrentlyPublic

Boolean

A boolean indicating wether the current access level is PUBLIC

info.complianceLevel

String

The compliance level of the package

Values: NOT_ASSESSED, NO_COMPLIANCE, WEAK_COMPLIANCE, AVERAGE_COMPLIANCE, FULL_COMPLIANCE

info.currentAccess

String

The current access level, deducted from the final access level and an eventual embargo

info.dataSensitivity

String

The data sensitivity of the deposit

Values: UNDEFINED, BLUE, GREEN, YELLOW, ORANGE, RED, CRIMSON

info.description

String

The description of the package

info.embargo.access

String

Starting date of embargo period

Values: PUBLIC, RESTRICTED, CLOSED

info.embargo.months

Number

Month number of embargo duration

info.embargo.startDate

String

Starting date of embargo period

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

info.licenseId

String

The license ID of the package

Valid ID

info.metadataVersion

String

The metadata version of the deposit

Values: 1.0, 1.1, 2.0, 2.1

info.name

String

The name of the package

info.organizationalUnitId

String

The organizational Unit ID of the information package

info.status

String

The status of the package

Values: CHECKED, CHECKING, CLEANED, CLEANING, COMPLETED, DISPOSABLE, DISPOSAL_APPROVED_BY_ORGUNIT, DISPOSAL_APPROVED, DISPOSED, DOWNLOADING, IN_ERROR, IN_PREPARATION, IN_PROGRESS, INDEXING, PRESERVATION_ERROR, READY, REINDEXING, RELOADED, REPLICATING_TOMBSTONE, REPLICATING_PACKAGE, RESUBMITTING, STORED, UPDATING_RETENTION

info.statusMessage

Null

The message related to the status

ready

Boolean

If DIP package is ready

Relation Description

self

Link to the dip resource

list

Link to the collection of dip resource

module

Link to the parent’s resource

data

Link to data action on the current dip resource

history

Link to history action on the current dip resource

aip

Link to aip action on the current dip resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the dip collection

module

Link to the access module

lastCreated

Link to the dip collection sorted by creation date

lastUpdated

Link to the dip collection sorted by last updated date

schema

Link to schema action on the current dip resource

profile

Link to profile action on the current dip resource

values

Link to values action on the current dip resource

Metadata

The URL of the REST resource is : http(s)://<root context>/access/metadata (Read-Only REST resource)

Details
Path Type Mandatory Description Constraints

resId

String

The metadata resource identifier [UUID]

_links

Object

The links list of the metadata resource

currentAccess

String

The current access level of indexed metadata

Values: PUBLIC, RESTRICTED, CLOSED

index

String

The index name of indexed metadata

metadata

Object

The object of indexed metadata

type

String

The type of indexed metadata

Relation Description

self

Link to the metadata resource

list

Link to the collection of metadata resource

module

Link to the parent’s resource

prepare-download

Link to prepare-download action on the current metadata resource

download-status

Link to download-status action on the current metadata resource

download

Link to download action on the current metadata resource

thumbnail

Link to thumbnail action on the current metadata resource

statistics

Link to statistics action on the current metadata resource

packages

Link to packages action on the current metadata resource

data

Link to data action on the current metadata resource

aip

Link to aip action on the current metadata resource

list-folders

Link to list-folders action on the current metadata resource

ratings

Link to ratings action on the current metadata resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the metadata collection

module

Link to the access module

lastCreated

Link to the metadata collection sorted by creation date

lastUpdated

Link to the metadata collection sorted by last updated date

values

Link to values action on the current metadata resource

search

Link to search action on the current metadata resource

search-doi

Link to search-doi action on the current metadata resource

OAI Sets

The URL of the REST resource is : http(s)://<root context>/access/oai-sets

Details
Path Type Mandatory Description Constraints

resId

String

The oai-sets resource identifier [UUID]

creation

Object

The creation info of the oai-sets resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the oai-sets resource (see Change Information Detail)

_links

Object

The links list of the oai-sets resource

description

String

The description of the OAI set

enabled

Boolean

If the OAI set is enable

name

String

The name of the OAI set

query

String

The query of the OAI set

Query compliante with indexing search

spec

String

The specification of the OAI set

In lower case

Relation Description

self

Link to the oai-sets resource

list

Link to the collection of oai-sets resource

module

Link to the parent’s resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the oai-sets collection

module

Link to the access module

lastCreated

Link to the oai-sets collection sorted by creation date

lastUpdated

Link to the oai-sets collection sorted by last updated date

organizational-units

Link to organizational-units action on the current oai-sets resource

Orders

The URL of the REST resource is : http(s)://<root context>/access/orders

Details
Path Type Mandatory Description Constraints

resId

String

The orders resource identifier [UUID]

creation

Object

The creation info of the orders resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the orders resource (see Change Information Detail)

_links

Object

The links list of the orders resource

aipNumber

Number

The AIP number of the order query

dipNumber

Number

The DIP number of the order query

metadataVersion

String

The metadata version of the deposit

Values: 1.0, 1.1, 2.0, 2.1

name

String

The name of the order query

publicOrder

Boolean

True if the order is public, false otherwise

query

String

The query of the order query

queryType

String

The type of the order query

Values: ADVANCED, DIRECT, SIMPLE

status

String

The status of the order query

Values: COMPLETED, DOWNLOADING, IN_DISSEMINATION_PREPARATION, IN_ERROR, IN_PREPARATION, IN_PROGRESS, READY, SUBMITTED

statusMessage

String

The message related to the status

Relation Description

self

Link to the orders resource

list

Link to the collection of orders resource

module

Link to the parent’s resource

aip

Link to aip action on the current orders resource

view

Link to view action on the current orders resource

save

Link to save action on the current orders resource

history

Link to history action on the current orders resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the orders collection

module

Link to the access module

lastCreated

Link to the orders collection sorted by creation date

lastUpdated

Link to the orders collection sorted by last updated date

values

Link to values action on the current orders resource

Organizational Units

A organizational unit is a logical entity which could represent a research project or laboratory or all other organizational group of researchers. A preservation space is associated to it.

The URL of the REST resource is : http(s)://<root context>/access/organizational-units (Read-Only REST resource)

Details
Path Type Mandatory Description Constraints

resId

String

The organizational-units resource identifier [UUID]

creation

Object

The creation info of the organizational-units resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the organizational-units resource (see Change Information Detail)

_links

Object

The links list of the organizational-units resource

closingDate

Null

The closing date of the organizational unit

Format: yyyy-MM-dd

description

String

The description of the institution

logo

Null

The logo of the organizational unit

name

String

The name of the organizational unit

The name of the organizational unit

openingDate

String

The opening date of the organizational unit

Format: yyyy-MM-dd

url

String

The URL of the organizational unit

Valid URL

Relation Description

self

Link to the organizational-units resource

list

Link to the collection of organizational-units resource

module

Link to the parent’s resource

archives

Link to archives action on the current organizational-units resource

download-logo

Link to download-logo action on the current organizational-units resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the organizational-units collection

module

Link to the access module

lastCreated

Link to the organizational-units collection sorted by creation date

lastUpdated

Link to the organizational-units collection sorted by last updated date

3.7. Preservation Plannning Module

3.7.1. Response Structure

Path Type Mandatory Description Constraints

name

String

The name of the module, i.e. preservation-planning

_links

Object

The links list of the module, included its REST resources

Relation Description

self

Links to module itself

resources

REST Resource named aip
REST Resource named modules
REST Resource named monitor
REST Resource named preservation-jobs

3.7.2. Resources

Module List

The module list allows to get the list of URLs for different modules.

The URL of the REST resource is : http(s)://<root context>/preservation-planning/modules (Read-Only REST resource)

Path Type Mandatory Description Constraints

access

String

The URL of access module

admin

String

The URL of admin module

archivalStorage

Array

The URL list of archival storage module

authorization

String

The URL of authoriration module

dataManagement

String

The URL of data management module

ingest

String

The URL of ingest module

preingest

String

The URL of pre-ingest module

Preservation Jobs

The preservation job allows to run manage mass processing of archives. There are different types of job:

Job Type Description

RELOAD

Reload all AIPs from the storage into the archival storage module

REINDEX

Reindex metadata of all AIPs

FIXITY

Run the fixity check for all AIPs

The URL of the REST resource is : http(s)://<root context>/preservation-planning/preservation-jobs

Details
Path Type Mandatory Description Constraints

resId

String

The preservation-jobs resource identifier [UUID]

creation

Object

The creation info of the preservation-jobs resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the preservation-jobs resource (see Change Information Detail)

_links

Object

The links list of the preservation-jobs resource

enable

Boolean

If the job is enable

executionNumber

Number

Number of job executions

jobRecurrence

String

Job recurrence

Values: DAILY, MONTHLY, ONCE, WEEKLY, YEARLY

jobType

String

The job type of the preservation job

Values: ARCHIVE_CHECK, CLEAN_SUBMISSION, DISPOSAL, FIXITY, MIGRATION, ARCHIVE_PRELOAD_SMALL, ARCHIVE_PRELOAD_BIG, PURGE_SUBMISSION_TEMP_FILES, REBUILD_REGISTRY, REINDEX, RELOAD, REPLICATION, REPLICATION_CHECK

lastExecutionStatus

Null

The status of the last job execution

Values: COMPLETED, CREATED, IN_ERROR, IN_PROGRESS, READY

name

String

The name of the preservation job

scheduling.hour

Number

The hour to schedule a daily/weekly/monthly/yearly job

Between 0 and 23

scheduling.month

Number

The month to schedule a yearly job

1 for January, 2 for February, 3 for March, 4 for April, 5 for May, 6 for June, 7 for July, 8 for August, 9 for September, 10 for October, 11 for November, 12 for december

scheduling.monthDay

Number

The day of the month to schedule a monthly/yearly job

Between 1 and 31

scheduling.weekDay

Null

The day of the week to schedule a weekly/monthly/yearly job

1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, 7 for Sunday

Relation Description

self

Link to the preservation-jobs resource

list

Link to the collection of preservation-jobs resource

module

Link to the parent’s resource

start

Link to start action on the current preservation-jobs resource

executions

Link to executions action on the current preservation-jobs resource

Collection Links

Read the Collection Documentation to understand how a collection is organized.

Relation Description

self

Link to the preservation-jobs collection

module

Link to the preservation-planning module

lastCreated

Link to the preservation-jobs collection sorted by creation date

lastUpdated

Link to the preservation-jobs collection sorted by last updated date

values

Link to values action on the current preservation-jobs resource

3.8. Resource Server Module

3.8.1. Type of Tools

Type Description Implementation

File Format

Tool to detect & identify the file format

DLCM File Format ⇒ Default tool by using Java functions

FITSFile Information Tool Set

Virus Check

Anti-virus tool

DLCM Virus Check ⇒ No virus check

ClamAVClamAV

3.8.2. Response Structure

Path Type Mandatory Description Constraints

name

String

The name of the tool

description

String

The description of the tool

version

String

The version of the tool

status

JSON

The state & information when the tool is running

4. Sub-resources

A sub-resource is a embedded or linked resource to a main resource (i.e. a REST resource).

4.1. Change Information Detail

Path Type Mandatory Description Constraints

when

String

The date of the executed event

Format: YYYY-MM-DDThh:mm:ss+nnn

who

String

The user who executed the event

4.2. Data File Detail

Path Type Description

resId

String

The data file resource identifier [UUID]

creation

Object

The creation info of the data file resource (see Change Information Detail)

lastUpdate

Object

The last updated info of the data file resource (see Change Information Detail)

status

Object

The status of the data file [CREATED, IN_ERROR, READY, RECEIVED, CHANGE_RELATIVE_LOCATION, CHANGE_DATA_CATEGORY, TO_PROCESS, PROCESSED, FILE_FORMAT_IDENTIFIED, FILE_FORMAT_UNKNOWN, VIRUS_CHECKED]

sourceData

String

The URI of the source data file

relativeLocation

String

The relative folder hierarchy of the data file

fileName

String

The field name of the data file

dataCategory

String

The category size of the data file (see Data File Categories)

dataType

String

The sub-category size of the data file (see Data File Categories)

complianceLevel

String

The compliance level of the data file [NO_COMPLIANCE, WEAK_COMPLIANCE, AVERAGE_COMPLIANCE, FULL_COMPLIANCE]

size

String

The size of the data file (in bytes)

smartSize

String

The human-readable size of the data file

fileFormat

Object

The file format detection information of the data file

virusCheck

Object

The virus check information of the data file

checksums

Array

The checksum list of the data file

4.3. Data File Categories

4.3.2. Data File Categories Description

Category Sub-Category Description

Primary

Primary Data category

Observational

Data captured in real-time, usually irreplaceable. For example, sensor data, survey data, sample data, neuro-images.

Experimental

Data from lab equipment, often reproducible, but can be expensive. For example, gene sequences, chromatograms, toroid magnetic field data.

Simulation

Data generated from test models where model and metadata are more important than output data. For example, climate models, economic models.

Derived

Data is reproducible but expensive. For example, text and data mining, compiled database, 3D models.

Reference

A (static or organic) conglomeration or collection of smaller (peer-reviewed) datasets, most probably published and curated. For example, gene sequence databanks, chemical structures, or spatial data portals.

Digitalized

Digital version of analogue objects. For example, manuscripts, books.

Secondary

Secondary Data category

Publication

Research publication or article

DataPaper

Research data paper

Documentation

Other documentation

Package

DLCM category

InformationPackage

DLCM Package (internal used only)

Metadata

DLCM metadata in XML format

CustomMetadata

Specific metadata of a research in JSON or XML format

Software

Software category

Code

Code or programs

Binaries

Binaries or executables

VirtualMachine

Images of virtual machines