hash
stringlengths 32
32
| doc_id
stringlengths 7
13
| section
stringlengths 3
121
| content
stringlengths 0
3.82M
|
|---|---|---|---|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.1.2.2 XML Syntax
|
The XML type ResponseType shall implement the requirements defined in the Response component. The ResponseType XML type shall be defined as in XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <complexType name="ResponseType"> <sequence> <element name="OptionalOutputs" type="dsb:OptionalOutputsType" minOccurs="0" /> <element ref="dsb:Result" /> </sequence> <attribute name="RequestID" type="string" use="optional"/> </complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.1.2.3 JSON Syntax
|
The component Response is used as a base type only, not as a JSON instance.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.2 RetrieveInfo
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.2.1 RetrieveInfo request
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.2.1.1 Semantics
|
The RetrieveInfo request shall extend the Request component (see clause 5.3.1.1) and shall inherit the set of sub-components. The RetrieveInfo request allows to retrieve information about the preservation profiles supported by the preservation service. As the number of preservation profiles supported by a preservation service may become high over long periods of time, the RetrieveInfo operation allows to filter for active and inactive preservation profiles using the optional Status element, or specify a single preservation profile using the Profile element. The RetrieveInfo request may contain the following sub-components: • The optional Profile element may be present and shall, if present, contain a URI according to IETF RFC 3986 [2], which specifies a specific preservation profile for which information is to be retrieved. • The optional Status element may be present and shall, if present, satisfy the requirements specified in the present document in clause 5.4.8. This element may be used to filter for active or inactive preservation profiles. If this optional element is omitted, only active preservation profiles are returned. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 23
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.2.1.2 XML Syntax
|
The XML type RetrieveInfoType shall implement the requirements defined in the RetrieveInfo component. The RetrieveInfoType XML element shall be defined as in XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <complexType name="RetrieveInfoType"> <complexContent> <extension base="pres:RequestType"> <sequence> <element name="Profile" type="anyURI" minOccurs="0" maxOccurs="1" /> <element name="Status" type="pres:StatusType" minOccurs="0" maxOccurs="1" /> </sequence> </extension> </complexContent> </complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.2.1.3 JSON Syntax
|
The RetrieveInfoType JSON object shall implement in JSON syntax the requirements defined in the RetrieveInfo component. The RetrieveInfoType JSON object shall be defined as in JSON Schema file (Preservation-API.json) provided in Annex D, and is copied below for information. "pres-RetrieveInfoType": { "type": "object", "properties": { "optIn": { "$ref": "#/definitions/dsb-OptionalInputsType" }, "reqId": { "type": "string" }, "pro": { "type": "string" }, "stat": { "type": "string" } } } Properties of the JSON object shall implement the sub-components of RetrieveInfo using JSON-specific names mapped as shown in Table 1. Table 1 Element Implementing JSON member name Comments Profile pro [] Status stat []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.2.2 RetrieveInfoResponse
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.2.2.1 Semantics
|
The RetrieveInfoResponse shall extend the Response component (see clause 5.3.1.2) and shall inherit the set of sub-components. RetrieveInfoResponse is returned as response to invoking the RetrieveInfo operation. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 24 The RetrieveInfoResponse may contain the following sub-components: • Zero or more Profile elements. If present, each instance shall satisfy the requirements specified in the present document in clause 5.4.7. The following error codes may appear in the Result/ResultMinor component within RetrieveInfoResponse: • http://uri.etsi.org/19512/error/noPermission • http://uri.etsi.org/19512/error/internalError • http://uri.etsi.org/19512/error/parameterError • http://uri.etsi.org/19512/error/notSupported
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.2.2.2 XML Syntax
|
The XML type RetrieveInfoResponseType shall implement the requirements defined in the RetrieveInfoResponse component. The RetrieveInfoResponseType XML element shall be defined as in XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <complexType name="RetrieveInfoResponseType"> <complexContent> <extension base="pres:ResponseType"> <sequence> <element maxOccurs="unbounded" minOccurs="0" ref="pres:Profile"/> </sequence> </extension> </complexContent> </complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.2.2.3 JSON Syntax
|
The RetrieveInfoResponseType JSON object shall be defined as in JSON Schema file (Preservation-API.json) provided in Annex D, and is copied below for information. "pres-RetrieveInfoResponseType": { "type": "object", "properties": { "optOut": { "$ref": "#/definitions/dsb-OptionalOutputsType" }, "reqId": { "type": "string" }, "pro": { "type": "array", "items": { "$ref": "#/definitions/pres-ProfileType" } } } } Properties of the JSON object shall implement the sub-components of RetrieveInfoResponse using JSON-specific names mapped as shown in Table 2. Table 2 Element Implementing JSON member name Comments Profile pro [] ETSI ETSI TS 119 512 V1.2.1 (2023-05) 25
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.3 PreservePO
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.3.1 PreservePO request
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.3.1.1 Semantics
|
The PreservePO request shall extend the Request component (see clause 5.3.1.1) and shall inherit the set of sub-components. It is used to submit zero or more preservation objects (PO) to the preservation service. The details how the preservation is performed is determined by the provided Profile element, which refers to an operational profile of the preservation service as described by a Profile element (see clause 5.4.7), which can be retrieved using the RetrieveInfo operation (see clause 5.3.2). The PreservePO request shall contain the following sub-components: • The Profile element. It shall contain one instance of a URI, which specifies the operational profile of the preservation service, which is used for preservation. The details of the Profile element are described in clause 5.4.7. • Zero or more instances of the PO element. Each instance shall satisfy the requirements specified in clause 5.4.5. NOTE: The invocation of PreservePO without any PO allows, in case of a preservation service with storage and support for versioning as outlined in Annex E, to obtain a POID without immediately storing data. The POID may be used in a subsequent call of UpdatePOC for storing preservation data objects, which may contain the POID as meta data.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.3.1.2 XML Syntax
|
The PreservePOType XML type shall be defined as in XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <xs:complexType name="PreservePOType"> <complexContent> <extension base="pres:RequestType"> <sequence> <element name="Profile" type="anyURI"/> <element ref="pres:PO" minOccurs="0" maxOccurs="unbounded" /> </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.3.1.3 JSON Syntax
|
The PreservePOType JSON object shall be defined as in JSON Schema file (Preservation-API.json) provided in Annex D, and is copied below for information. "pres-PreservePOType": { "type": "object", "properties": { "optIn": { "$ref": "#/definitions/dsb-OptionalInputsType" }, "reqId": { "type": "string" }, "pro": { "type": "string" }, "po": { "type": "array", "items": { "$ref": "#/definitions/pres-POType" } ETSI ETSI TS 119 512 V1.2.1 (2023-05) 26 } }, "required": ["pro"] } Properties in the JSON schema above shall implement sub-components of the PreservePO component mapped by names as shown in Table 3. Table 3 Element Implementing JSON member name Comments OptionalInputs optIn [] RequestID reqId [] Profile pro [] PO po []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.3.2 PreservePOResponse
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.3.2.1 Semantics
|
The PreservePOResponse shall extend the Response component (see clause 5.3.1.2) and shall inherit the set of sub-components. PreservePOResponse shall be returned as response to invoking the PreservePO operation. Below follows a list of the sub-components that may be present within this component: • The optional POID element. If present, it shall contain a string. The POID element is a unique identifier for the set of SubDOs provided within the PreservePO call. This identifier allows to address the provided set of SubDOs in subsequent calls, such as RetrieveTrace (see clause 5.3.7) or RetrievePO (see clause 5.3.4), UpdatePOC (see clause 5.3.6) and DeletePO (see clause 5.3.5), if applicable. It shall be returned after a successful call, if the preservation service provides (permanent or temporary) storage (see clause 4.3) or the preservation service supports the optional RetrieveTrace operation (see clause 5.3.7). • Zero or more instances of the PO element. Each instance shall satisfy the requirements specified in clause 5.4.5. In case of a storage model "without storage" (see clause 4.3), a successful call will return one PO element for each provided PO element. In this case the preservation evidence is produced in a synchronous manner and is enveloped within each PO element. The following error codes may appear in the Result/ResultMinor component within PreservePOResponse: • http://uri.etsi.org/19512/error/noPermission • http://uri.etsi.org/19512/error/internalError • http://uri.etsi.org/19512/error/parameterError • http://uri.etsi.org/19512/error/transferError • http://uri.etsi.org/19512/error/noSpaceError • http://uri.etsi.org/19512/error/notSupported • http://uri.etsi.org/19512/error/unknownPOFormat • http://uri.etsi.org/19512/error/POFormatError • http://uri.etsi.org/19512/error/externalServiceUnavailable • http://uri.etsi.org/19512/warning/lowSpace ETSI ETSI TS 119 512 V1.2.1 (2023-05) 27
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.3.2.2 XML Syntax
|
The XML type PreservePOResponseType shall be defined as in XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <xs:complexType name="PreservePOResponseType"> <complexContent> <extension base="pres:ResponseType"> <sequence> <element ref="pres:POID" minOccurs="0" maxOccurs="1" /> <element ref="pres:PO" minOccurs="0" maxOccurs="unbounded" /> </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.3.2.3 JSON Syntax
|
The PreservePOResponseType JSON object shall be defined as in JSON Schema file (Preservation_API.json) provided in Annex D, and which is copied below for information. "pres-PreservePOResponseType": { "type": "object", "properties": { "optOut": { "$ref": "#/definitions/dsb-OptionalOutputsType" }, "reqId": { "type": "string" }, "poId": { "type": "string" }, "po": { "$ref": "#/definitions/pres-POType" } } } Properties in the JSON schema above shall implement sub-components of the PreservePOResponse component mapped by names as shown in Table 4. Table 4 Element Implementing JSON member name Comments OptionalOutputs optOut [] RequestID reqId [] POID poId [] PO po []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.4 RetrievePO (Conditional)
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.4.1 RetrievePO Request
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.4.1.1 Semantics
|
The RetrievePO request shall extend the Request component (see clause 5.3.1.1) and shall inherit the set of sub-components. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 28 The RetrievePO operation may only be provided in preservation schemes with storage (see clause 4.3.1) or with temporary storage (see clause 4.3.2). This operation allows to retrieve preservation objects, which have been previously provided for preservation with PreservePO (see clause 5.3.3), and/or related evidences produced by the preservation service. For this purpose, the client sends the preservation object identifier (POID), which addresses a stored set of preservation objects, together with further optional information, which specifies what the client exactly wants to retrieve. This optional information may contain a sequence of VersionID elements, if necessary and supported by the used POFormat (see clause 5.4.5 and Annex E), a SubjectOfRetrieval parameter, which specifies whether the previously submitted and then processed preservation object and/or the corresponding evidence is requested and optional format information (POFormat and EvidenceFormat), which specifies the formats in which the preservation objects and/or evidences are requested to be returned. The RetrievePO component shall contain the following sub-component: • The POID element. It shall contain one instance of a string, which is used for addressing preservation objects, which have been deposited previously using the PreservePO operation (see clause 5.3.3). The RetrievePO request may contain the following sub-components: • Zero or more instances of the VersionID element. If present, each instance shall contain an instance of a string. This element is only applicable, if the POFormat under consideration supports versioning as explained in Annex E. If the VersionID element is missing, the preservation data objects and/or evidences corresponding to the latest version are returned. If the VersionID element is equal to the string all the preservation data objects and/or evidences corresponding to all version are returned. • The optional SubjectOfRetrieval element. If present, it shall contain a sub-component, which satisfies the requirements specified in clause 5.4.9. This element allows to specify whether the preservation objects and/or the preservation evidence are to be retrieved. If this element is missing POwithEmbeddedEvidence shall be used as default value. • The optional POFormat element. If present, it shall contain a URI. This URI shall be among the set of supported formats, as specified by the set of Output/Format/FormatID child elements of the applicable Profile/Operation element, which Name element is equal to the string "RetrievePO" (see clause 5.4.7). This element allows to explicitly specify the format in which the (sequence of) preservation object(s) is to be returned. If this element is missing, the default Output/Format indicated within the applicable Operation element, which Name element is equal to the string "RetrievePO", within the applied Profile (see clause 5.4.7) is used. • The optional EvidenceFormat element. If present, it shall contain a URI. This element allows to explicitly specify the format in which the preservation evidence is to be returned, if multiple options are supported in the preservation profile under consideration. If this element is missing, the default EvidenceFormat specified within the applied Profile (see clause 5.4.7) is used.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.4.1.2 XML Syntax
|
The XML type RetrievePOType shall implement the requirements defined in the RetrievePO component. The RetrievePOType XML type shall be defined as in XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <xs:complexType name="RetrievePOType"> <complexContent> <extension base="pres:RequestType"> <sequence> <element ref="pres:POID"/> <element ref="pres:VersionID" minOccurs="0" maxOccurs="unbounded" /> <element name="SubjectOfRetrieval" type="pres:SubjectOfRetrievalType" minOccurs="0" maxOccurs="1" /> <element name="POFormat" type="anyURI" minOccurs="0" maxOccurs="1" /> <element name="EvidenceFormat" type="anyURI" minOccurs="0" maxOccurs="1"/> ETSI ETSI TS 119 512 V1.2.1 (2023-05) 29 </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.4.1.3 JSON Syntax
|
The RetrievePOType JSON object shall implement in JSON syntax the requirements defined in the RetrievePO component. The RetrievePOType JSON object shall be defined as in the JSON Schema file (Preservation-API.json) provided in Annex D, and which is copied below for information. "pres-RetrievePOType": { "type": "object", "properties": { "poformat": { "type": "string" }, "optIn": { "$ref": "#/definitions/dsb-OptionalInputsType" }, "reqId": { "type": "string" }, "poId": { "type": "string" }, "versionId": { "type": "array", "items": { "type": "string" } }, "sor": { "type": "string" }, "poFormat": { "type": "string" }, "evFormat": { "type": "string" } }, "required": ["poId"] } Properties in the JSON schema above shall implement sub-components of the RetrievePO component mapped by names as shown in Table 5. Table 5 Element Implementing JSON member name Comments OptionalInputs optIn [] RequestID reqId [] POID poId [] VersionID versionId [] SubjectOfRetrieval sor [] POFormat poFormat [] EvidenceFormat evFormat []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.4.2 RetrievePOResponse
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.4.2.1 Semantics
|
The RetrievePOResponse shall extend the Response component (see clause 5.3.1.2) and shall inherit the set of sub-components. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 30 RetrievePOResponse shall be returned as response to invoking the RetrievePO operation. The returned PO elements shall contain the (sequence of) preservation object(s) and/or the evidence as specified in the request. The RetrievePOResonse may contain the following sub-component: • One or more instances of the PO element. If present, each instance shall satisfy the requirements specified in clause 5.4.5. The following error codes may appear in the Result/ResultMinor component within RetrievePOResponse: • http://uri.etsi.org/19512/error/noPermission • http://uri.etsi.org/19512/error/internalError • http://uri.etsi.org/19512/error/parameterError • http://uri.etsi.org/19512/error/notSupported • http://uri.etsi.org/19512/error/unknownPOFormat • http://uri.etsi.org/19512/error/unknownEvidenceFormat • http://uri.etsi.org/19512/error/unknownPOID • http://uri.etsi.org/19512/error/unknownVersionID • http://uri.etsi.org/19512/warning/requestOnlyPartlySuccessful If the request is only partly successful, the preservation service should provide further details in the ResultMessage component (see clause 4.1.7 of OASIS DSS-X Core 2.0 [5]).
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.4.2.2 XML Syntax
|
The XML type RetrievePOResponseType shall implement the requirements defined in the RetrievePOResponse component. The RetrievePOResponseType XML type shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <xs:complexType name="RetrievePOResponseType"> <complexContent> <extension base="pres:ResponseType"> <sequence> <element ref="pres:PO" minOccurs="0" maxOccurs="unbounded"/> </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.4.2.3 JSON Syntax
|
The RetrievePOResponseType JSON object shall implement in JSON syntax the requirements defined in the RetrievePOResponse component. The RetrievePOResponseType JSON object shall be defined as in the JSON Schema file (Preservation-API.json) provided in Annex D, and which is copied below for information. "pres-RetrievePOResponseType": { "type": "object", "properties": { "optOut": { "$ref": "#/definitions/dsb-OptionalOutputsType" }, "reqId": { "type": "string" }, ETSI ETSI TS 119 512 V1.2.1 (2023-05) 31 "po": { "type": "array", "items": { "$ref": "#/definitions/pres-POType" } } } } Properties in the JSON schema above shall implement sub-components of the RetrievePOResponse component mapped by names as shown in Table 6. Table 6 Element Implementing JSON member name Comments OptionalOutputs optOut [] RequestID reqId [] PO po []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.5 DeletePO (Conditional)
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.5.1 DeletePO Request
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.5.1.1 Semantics
|
The DeletePO request shall extend the Request component (see clause 5.3.1.1) and shall inherit the set of sub-components. The DeletePO request shall only be supported in the case of a preservation scheme with storage (see clause 4.3.1). In order to delete a (sequence of) preservation object(s) and corresponding metadata, the client sends a preservation object identifier (POID), which addresses these data objects, and optionally additional parameters, which specify the details of the operation. The optional parameters may comprise a deletion mode (Mode), a claimed requestor name (ClaimedRequestorName) and a reason (Reason) for deletion. The DeletePO component shall contain the following sub-component: • The POID element. It shall contain one instance of a string and shall be used for addressing preservation objects, which have been deposited previously using the PreservePO operation (see clause 5.3.3). The DeletePO component may contain the following sub-components: • The optional Mode element. If present, it shall contain a sub-component as specified in clause 5.4.2. This element allows to specify, whether only the provided SubDOs (OnlySubDOs) or also the produced preservation evidences (SubDOsAndEvidence) shall be deleted from the storage of the preservation service. If this optional element is omitted, the default SubDOsAndEvidence shall be used. • The optional ClaimedRequestorName element. If present, it shall contain a string. This element allows to convey additional information about the claimed requestor of the deletion operation. • The optional Reason element. If present, it shall contain a string. This element allows to provide additional information about the reason for deletion.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.5.1.2 XML Syntax
|
The XML type DeletePOType shall implement the requirements defined in the DeletePO component. The DeletePOType XML type shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 32 <xs:complexType name="DeletePOType"> <complexContent> <extension base="pres:RequestType"> <sequence> <element ref="pres:POID"/> <element name="Mode" type="pres:DeletionModeType" minOccurs="0" maxOccurs="1" /> <element name="ClaimedRequestorName" type="string" minOccurs="0" maxOccurs="1" /> <element name="Reason" type="string" minOccurs="0" maxOccurs="1"/> </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.5.1.3 JSON Syntax
|
The DeletePOType JSON object shall implement in JSON syntax the requirements defined in the DeletePO component. The DeletePOType JSON object shall be defined as in the JSON Schema file (Preservation-API.json) provided in Annex D, and which is copied below for information. "pres-DeletePOType": { "type": "object", "properties": { "optIn": { "$ref": "#/definitions/dsb-OptionalInputsType" }, "reqId": { "type": "string" }, "poId": { "type": "string" }, "mod": { "type": "string" }, "crn": { "type": "string" }, "reason": { "type": "string" } }, "required": ["poId"] } Properties in the JSON schema above shall implement sub-components of the DeletePO component mapped by names as shown in Table 7. Table 7 Element Implementing JSON member name Comments OptionalInputs optIn [] RequestID reqId [] POID poId [] Mode mod [] ClaimedRequestorName crn [] Reason reason []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.5.2 DeletePOResponse
|
The DeletePOResponse shall extend the Response component (see clause 5.3.1.2) and shall inherit the set of sub-components. DeletePOResponse shall be returned as response to invoking the DeletePO operation. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 33 The following error codes may appear in the Result/ResultMinor component within DeletePOResponse: • http://uri.etsi.org/19512/error/noPermission • http://uri.etsi.org/19512/error/internalError • http://uri.etsi.org/19512/error/parameterError • http://uri.etsi.org/19512/error/notSupported • http://uri.etsi.org/19512/error/unknownPOID • http://uri.etsi.org/19512/error/unknownMode
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.6 UpdatePOC (Optional)
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.6.1 UpdatePOC Request
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.6.1.1 Semantics
|
The UpdatePOC request shall extend the Request component (see clause 5.3.1.1) and shall inherit the set of sub-components. The UpdatePOC request allows to update a POC in case of preservation with storage and provide a new version of it, if the preservation service and the applied POC-Format supports this feature (see Annex E). A given POC-Format may either support a simple update strategy, or a sophisticated update strategy, or both. In the simple update strategy, the sequence of provided DeltaPOC elements are treated as plain preservation objects, which are simply added to an existing POC in order to create a new version of the POC, which contains the previously contained preservation objects and additionally the newly provided preservation objects. In the more sophisticated update strategy, as outlined in Annex E, a single DeltaPOC element shall be provided, which allows to specify the difference between the latest version of the POC and the new version of the POC, which may consequently contain more or less preservation objects, as specified by the provided DeltaPOC element. The UpdatePOC request shall contain the following sub-components: • The POID element. It shall contain one instance of a string. This element shall adress the POC, which is to be updated. • The DeltaPOC element. It shall be present one or more times and satisfy the requirements specified in clause 5.4.5. There are two cases, which need to be distinguished based on the question, whether the format of the DeltaPOC supports sophisticated versioning as outlined in Annex E or not and whether there are multiple DeltaPOC elements or not: 1) If there is a single DeltaPOC element, which POC-Format supports sophisticated versioning as outlined in Annex E, this element specifies the content of the new version of the POC based on the latest existing version. 2) If there are multiple DeltaPOC elements or the POC-Format only supports simple versioning, the provided set of DeltaPOC elements is simply added to the POC in order to create a new version of it.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.6.1.2 XML Syntax
|
The XML type UpdatePOCType shall implement the requirements defined in the UpdatePOC component. The UpdatePOCType XML type shall be defined as in XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 34 <xs:complexType name="UpdatePOCType"> <complexContent> <extension base="pres:RequestType"> <sequence> <element ref="pres:POID"/> <element ref="pres:DeltaPOC" minOccurs="1" maxOccurs="unbounded"/> </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.6.1.3 JSON Syntax
|
The UpdatePOCType JSON object shall implement in JSON syntax the requirements defined in the UpdatePOC component. The UpdatePOCType JSON object shall be defined as in the JSON Schema file (Preservation-API.json)provided in Annex C, and which is copied below for information. "pres-UpdatePOCType": { "type": "object", "properties": { "optIn": { "$ref": "#/definitions/dsb-OptionalInputsType" }, "reqId": { "type": "string" }, "poId": { "type": "string" }, "deltaPoc": { "type": "array", "items": { "$ref": "#/definitions/pres-POType" } } }, "required": ["poId", "deltaPoc"] } Properties in the JSON schema above shall implement sub-components of the UpdatePOC component mapped by names as shown in Table 8. Table 8 Element Implementing JSON member name Comments OptionalInputs optIn [] RequestID reqId [] POID poId [] DeltaPOC deltaPoc []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.6.2 UpdatePOCResponse
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.6.2.1 Semantics
|
The UpdatePOCResponse shall extend the Response component (see clause 5.3.1.2) and shall inherit the set of sub-components. UpdatePOCResponse shall be returned as response to invoking the UpdatePOC operation. After the internal processing of the UpdatePOC request the preservation service returns UpdatePOCResponse, which in particular contains the identifier (VersionID) of the newly created version within the already stored POC. The UpdatePOCResponse may contain the following sub-components: • The optional VersionID element. If present, it shall contain a string. A sequential versioning scheme should be used, which assigns version identifiers such as v1, v2, v3, etc. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 35 The following error codes may appear in the Result/ResultMinor component within UpdatePOCResponse: • http://uri.etsi.org/19512/error/noPermission • http://uri.etsi.org/19512/error/internalError • http://uri.etsi.org/19512/error/parameterError • http://uri.etsi.org/19512/error/transferError • http://uri.etsi.org/19512/error/notSupported • http://uri.etsi.org/19512/error/noSpaceError • http://uri.etsi.org/19512/error/unknownPOID • http://uri.etsi.org/19512/error/unknownDeltaPOCType • http://uri.etsi.org/19512/error/DeltaPOCInternalProblem • http://uri.etsi.org/19512/warning/lowSpace
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.6.2.2 XML Syntax
|
The XML type UpdatePOCResponseType shall implement the requirements defined in the UpdatePOCResponse component. The UpdatePOCResponseType XML type shall be defined as in the XML Schema file (Preservation-API.xsd provided in Annex C, and which is copied below for information. <xs:complexType name="UpdatePOCResponseType"> <complexContent> <extension base="pres:ResponseType"> <sequence> <element maxOccurs="1" minOccurs="0" ref="pres:VersionID"/> </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.6.2.3 JSON Syntax
|
The UpdatePOCResponseType JSON object shall implement in JSON syntax the requirements defined in the UpdatePOCResponse component. The UpdatePOCResponseType JSON object shall be defined as in the JSON Schema file (Preservation_API.json) provided in Annex D, and which is copied below for information. "pres-UpdatePOCResponseType": { "type": "object", "properties": { "optOut": { "$ref": "#/definitions/dsb-OptionalOutputsType" }, "reqId": { "type": "string" }, "versionId": { "type": "string" } } } Properties in the JSON schema above shall implement sub-components of the UpdatePOCResponse component mapped by names as shown in Table 9. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 36 Table 9 Element Implementing JSON member name Comments OptionalOutputs optOut [] RequestID reqId [] VersionID versionId []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.7 RetrieveTrace (Optional)
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.7.1 RetrieveTrace request
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.7.1.1 Semantics
|
The RetrieveTrace request shall extend the Request component (see clause 5.3.1.1) and shall inherit the set of sub-components. The RetrieveTrace request allows to request an audit trail element, which contains information with respect to relevant events, which happened within a preservation service for a specific (set of) submission data object(s). The RetrieveTrace component shall contain the following sub-component: • The POID element. It shall contain one instance of a string, which shall identify the (sequence of) submission data object (s) for which an audit trail is requested.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.7.1.2 XML Syntax
|
The XML type RetrieveTraceType shall implement the requirements defined in the RetrieveTrace component. The RetrieveTraceType XML type shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <xs:complexType name="RetrieveTraceType"> <complexContent> <extension base="pres:RequestType"> <sequence> <element ref="pres:POID"/> </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.7.1.3 JSON Syntax
|
The RetrieveTraceType JSON object shall implement in JSON syntax the requirements defined in the RetrieveTrace component. The RetrieveTraceType JSON object shall be defined as in the JSON Schema file (Preservation-API.json) provided in Annex D, which and is copied below for information. "pres-RetrieveTraceType": { "type": "object", "properties": { "optIn": { "$ref": "#/definitions/dsb-OptionalInputsType" }, "reqId": { "type": "string" }, "poId": { "type": "string" ETSI ETSI TS 119 512 V1.2.1 (2023-05) 37 } }, "required": ["poId"] } Properties in the JSON schema above shall implement sub-components of the RetrieveTrace component mapped by names as shown in Table 10. Table 10 Element Implementing JSON member name Comments OptionalInputs optIn [] RequestID reqId [] POID poId []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.7.2 RetrieveTraceResponse
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.7.2.1 Semantics
|
The RetrieveTraceResponse shall extend the Response component (see clause 5.3.1.2) and shall inherit the set of sub-components. RetrieveTraceResponse shall be returned as response to invoking the RetrieveTrace operation and shall contain the trace of operations corresponding to the provided POID. After the internal processing of the RetrieveTrace request the preservation service shall return RetrieveTraceResponse, which in particular shall contain the Trace element as specified in clause 5.4.10. Below follows a list of the sub-components that may be present within this component: • The Trace element shall contain one instance of a sub-component. This element shall satisfy the requirements specified clause 5.4.10. The following error codes may appear in the Result/ResultMinor component within RetrieveTraceResponse: • http://uri.etsi.org/19512/error/noPermission • http://uri.etsi.org/19512/error/internalError • http://uri.etsi.org/19512/error/parameterError • http://uri.etsi.org/19512/error/notSupported • http://uri.etsi.org/19512/error/unknownPOID
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.7.2.2 XML Syntax
|
The XML type RetrieveTraceResponseType shall implement the requirements defined in the RetrieveTraceResponse component. The RetrieveTraceResponseType XML type shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <xs:complexType name="RetrieveTraceResponseType"> <complexContent> <extension base="pres:ResponseType"> <sequence> <element ref="pres:Trace"/> </sequence> </extension> </complexContent> </xs:complexType> ETSI ETSI TS 119 512 V1.2.1 (2023-05) 38
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.7.2.3 JSON Syntax
|
The RetrieveTraceResponseType JSON object shall implement in the JSON syntax the requirements defined in the RetrieveTraceResponse component. The RetrieveTraceResponseType JSON object shall be defined as in JSON Schema file (Preservation_API.json) provided in Annex D, and which is copied below for information. "pres-RetrieveTraceResponseType": { "type": "object", "properties": { "optOut": { "$ref": "#/definitions/dsb-OptionalOutputsType" }, "reqId": { "type": "string" }, "trace": { "$ref": "#/definitions/pres-TraceType" } }, "required": ["trace"] } Properties in the JSON schema above shall implement sub-components of the RetrieveTraceResponse component mapped by names as shown in Table 11. Table 11 Element Implementing JSON member name Comments OptionalOutputs optOut [] RequestID reqId [] Trace trace []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.8 ValidateEvidence (Optional)
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.8.1 ValidateEvidence Request
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.8.1.1 Semantics
|
The ValidateEvidence request shall extend the Request component (see clause 5.3.1.1) and shall inherit the set of sub-components. The ValidateEvidence request allows to validate a provided preservation evidence (Evidence) and optionally a corresponding (set of) preservation objects (PO), which are protected by it. The ValidateEvidence request shall contain the following sub-components: • The Evidence element. It shall satisfy the requirements specified in clause 5.4.4. The ValidateEvidence request may contain the following sub-components: • Zero or more instances of the optional PO element. If present, each instance shall satisfy the requirements specified in clause 5.4.5. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 39
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.8.1.2 XML Syntax
|
The XML type ValidateEvidenceType shall implement the requirements defined in the ValidateEvidence component. The ValidateEvidenceType XML type shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <xs:complexType name="ValidateEvidenceType"> <complexContent> <extension base="pres:RequestType"> <sequence> <element ref="pres:Evidence" minOccurs="0" maxOccurs="1" /> <element ref="pres:PO" minOccurs="0" maxOccurs="unbounded" /> </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.8.1.3 JSON Syntax
|
The ValidateEvidenceType JSON object shall implement in JSON syntax the requirements defined in the ValidateEvidence component. The ValidateEvidenceType JSON object shall be defined as in the JSON Schema file (Preservation-API.json) provided in Annex D, and which is copied below for information. "pres-ValidateEvidenceType": { "type": "object", "properties": { "optIn": { "$ref": "#/definitions/dsb-OptionalInputsType" }, "reqId": { "type": "string" }, "ev": { "$ref": "#/definitions/pres-EvidenceType" }, "po": { "type": "array", "items": { "$ref": "#/definitions/pres-POType" } } } } Properties in the JSON schema above shall implement sub-components of the ValidateEvidence component mapped by names as shown in Table 12. Table 12 Element Implementing JSON member name Comments OptionalInputs optIn [] RequestID reqId [] Evidence ev [] PO po []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.8.2 ValidateEvidenceResponse
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.8.2.1 Semantics
|
The ValidateEvidenceResponse shall extend the Response component (see clause 5.3.1.2) and shall inherit the set of sub-components. ValidateEvidenceResponse shall be returned as response to invoking the ValidateEvidence operation. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 40 The ValidateEvidenceResponse may contain the following sub-components: • The optional ValidationReport element. If present, it shall satisfy the requirements specified in clause 5.4.5. • The optional ProofOfExistence element. If present, it shall contain a date/time value which corresponds to a moment in time at which the preservation object is known to have existed. The following error codes may appear in the Result/ResultMinor component within ValidateEvidence: • http://uri.etsi.org/19512/error/noPermission • http://uri.etsi.org/19512/error/internalError • http://uri.etsi.org/19512/error/parameterError • http://uri.etsi.org/19512/error/notSupported
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.8.2.2 XML Syntax
|
The XML type ValidatePOCResponseType shall implement the requirements defined in the ValidatePOCResponse component. The ValidatePOCResponseType XML type shall be defined as in the XML Schema file (Preservation_API.xsd) provided in Annex C, and which is copied below for information. <xs:complexType name="ValidatePOCResponseType"> <complexContent> <extension base="pres:ResponseType"> <sequence> <element ref="pres:ValidationReport" minOccurs="0" maxOccurs="1" /> <element name="ProofOfExistence" type="dateTime" minOccurs="0" maxOccurs="1"/> </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.8.2.3 JSON Syntax
|
The ValidatePOCResponseType JSON object shall implement in JSON syntax the requirements defined in the ValidatePOCResponse component. The ValidatePOCResponseType JSON object shall be defined as in the JSON Schema file (Preservation-API.json) provided in Annex D, and which is copied below for information. "pres-ValidatePOCResponseType": { "type": "object", "properties": { "pocreport": { "$ref": "#/definitions/pres-POType" }, "optOut": { "$ref": "#/definitions/dsb-OptionalOutputsType" }, "reqId": { "type": "string" }, "valRep": { "$ref": "#/definitions/pres-POType" }, "poe": { "type": "integer", "format": "utc-millisec" } } } ETSI ETSI TS 119 512 V1.2.1 (2023-05) 41 Properties in the JSON schema above shall implement sub-components of the ValidatePOCResponse component mapped by names as shown in Table 13. Table 13 Element Implementing JSON member name Comments OptionalOutputs optOut [] RequestID reqId [] ValidationReport valRep [] ProofOfExistence poe []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.9 Search (Optional)
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.9.1 Search request
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.9.1.1 Semantics
|
The Search request shall extend the Request component (see clause 5.3.1.1) and shall inherit the set of sub-components. The Search request allows to search among the (sets of) preservation object(s), which are accessible by the client. For this purpose, the client provides a query string (Filter), which allows to search for specific preservation objects and POIDs. The Search request may contain the following sub-components: • The optional Filter element. If present, it shall contain one instance of a string. This element shall be structured according to the applicable query language as described in the Operation component for the Search request indicated in the Profile element according to clause 5.4.7. 5.3.8.1.2 XML Syntax The XML type SearchType shall implement the requirements defined in the Search component. The SearchType XML type shall be defined as in XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <xs:complexType name="SearchType"> <complexContent> <extension base="pres:RequestType"> <sequence> <element name="Filter" type="string"/> </sequence> </extension> </complexContent> </xs:complexType> ETSI ETSI TS 119 512 V1.2.1 (2023-05) 42
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.9.1.3 JSON Syntax
|
The SearchType JSON object shall implement in JSON syntax the requirements defined in the Search component. The SearchType JSON object shall be defined as in JSON Schema file (Preservation-API.json) provided in Annex D, and which is copied below for information. "pres-SearchType": { "type": "object", "properties": { "optIn": { "$ref": "#/definitions/dsb-OptionalInputsType" }, "reqId": { "type": "string" }, "fi": { "type": "string" } } } Properties of the JSON object shall implement the sub-components of the Search request using JSON-specific names mapped as shown in Table 14. Table 14 Element Implementing JSON member name Comments Filter fi []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.9.2 SearchResponse
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.9.2.1 Semantics
|
The SearchResponse shall extend the Response component (see clause 5.3.1.2) and shall inherit the set of sub-components. SearchResponse shall be returned as response to invoking the Search operation. The SearchResponse may contain the following sub-component: • Zero or more instances of the optional POID element. Each instance shall contain a string. The list of returned POID elements matches the provided Filter element. The following error codes may appear in the Result/ResultMinor component within RetrieveTraceResponse: • http://uri.etsi.org/19512/error/noPermission • http://uri.etsi.org/19512/error/internalError • http://uri.etsi.org/19512/error/parameterError • http://uri.etsi.org/19512/error/notSupported ETSI ETSI TS 119 512 V1.2.1 (2023-05) 43
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.9.2.2 XML Syntax
|
The XML type SearchResponseType shall implement the requirements defined in the SearchResponse component. The SearchResponseType XML type shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <xs:complexType name="SearchResponseType"> <complexContent> <extension base="pres:ResponseType"> <sequence> <element ref="pres:POID" minOccurs="0" maxOccurs="unbounded" /> </sequence> </extension> </complexContent> </xs:complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.3.9.2.3 JSON Syntax
|
The SearchResponseType JSON object shall implement in JSON syntax the requirements defined in the SearchResponse component. The SearchResponseType JSON object shall be defined as in the JSON Schema file (Preservation-API.json) provided in Annex D, and which is copied below for information. "pres-SearchResponseType": { "type": "object", "properties": { "result": { "$ref": "#/definitions/dsb-ResultType" }, "optOut": { "$ref": "#/definitions/dsb-OptionalOutputsType" }, "reqId": { "type": "string" }, "poId": { "type": "array", "items": { "type": "string" } } } } Properties of the JSON object shall implement the sub-components of SearchResponse using JSON-specific names mapped as shown in Table 15. Table 15 Element Implementing JSON member name Comments POID poId [] ETSI ETSI TS 119 512 V1.2.1 (2023-05) 44
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4 Components for operations
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.1 Overview
|
The components in the present clause are provided in alphabetic ordering as shown in Table 16. Table 16 Component Clause DeletionMode 5.4.2 Event 5.4.3 Evidence 5.4.4 PO 5.4.5 PreservationStorageModel 5.4.6 Profile 5.4.7 Status 5.4.8 SubjectOfRetrieval 5.4.9 Trace 5.4.10
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.2 Component DeletionMode
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.2.1 Semantics
|
The DeletionMode component specifies the details of the Mode parameter in the DeletePO request (see clause 5.3.5). The DeletionMode component shall contain the following sub-component: • The value element. It shall contain one instance of a string. Its value shall be limited to an item of the following set: - OnlySubDOs - indicates that only the provided SubDOs will be deleted. - SubDOsAndEvidence - indicates that the provided SubDOs and the preservation evidences produced by the preservation service will be deleted.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.2.2 XML Syntax
|
The XML type DeletionModeType shall implement the requirements defined in the DeletionMode component. The DeletionModeType XML type shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <simpleType name="DeletionModeType"> <restriction base="string"> <enumeration value="OnlySubDOs"/> <enumeration value="SubDOsAndEvidence"/> </restriction> </simpleType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.2.3 JSON Syntax
|
The DeletionModeType JSON object shall implement in JSON syntax the requirements defined in the DeletionMode component. The DeletionModeType JSON object shall be defined as in the JSON Schema file (Preservation-API.xsd) provided in Annex D, and which is copied below for information. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 45 "pres-DeletionModeType": { "type": "string", "enum": ["OnlySubDOs", "SubDOsAndEvidence"] } Properties in the JSON schema above shall implement the sub-component of the DeletionMode component mapped by names as shown in Table 17. Table 17 Element Implementing JSON member name Comments value Value []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.3 Component Event
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.3.1 Semantics
|
The Event component contains information about an event, which occurred within the preservation service. It is part of the Trace component (see clause 5.4.10), which can be retrieved with the RetrieveTrace operation (see clause 5.3.7). The Event component shall contain the following sub-components: • The Time element. It shall be present and contain one instance of a date/time value, which indicates the point in time at which the event occurred. • The Subject element. It shall be present and contain one instance of a string, which indicates the subject which triggered the event. In case the event is triggered by the client, the Subject element should contain a string, which identifies the client. If the event is triggered by the preservation service, the Subject element should indicate this accordingly. In this case it may provide additional details with respect to the specific module, which triggered the event. • The Operation element. It shall be present and contain one instance of a string, which indicates the characteristic of the event, such as the invoked operation related to the event. The Event component may contain the following sub-components: • The optional Object element. If present, it shall contain a string, which indicates the object which is addressed within the event. • The optional Detail element. If present, it shall contain a string, which describes more details related to the event.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.3.2 XML Syntax
|
The EventType XML type shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <complexType name="EventType"> <sequence> <element name="Time" type="dateTime"/> <element name="Subject" type="string"/> <element name="Operation" type="string"/> <element name="Object" type="string" minOccurs="0" maxOccurs="1" /> <element name="Detail" type="string" minOccurs="0" maxOccurs="1" /> </sequence> </complexType> ETSI ETSI TS 119 512 V1.2.1 (2023-05) 46
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.3.3 JSON Syntax
|
The EventType JSON object shall implement in JSON syntax the requirements defined in the Event component. The EventType JSON element shall be defined as in the JSON Schema file (Preservation-API.xsd) provided in Annex D, and which is copied below for information. "pres-EventType": { "type": "object", "properties": { "time": { "type": "integer", "format": "utc-millisec" }, "sub": { "type": "string" }, "op": { "type": "string" }, "obj": { "type": "string" }, "det": { "type": "string" } }, "required": ["time", "sub", "op"] } Properties in the JSON schema above shall implement sub-components of the Event component mapped by names as shown in Table 18. Table 18 Element Implementing JSON member name Comments Time time [] Subject sub [] Operation op [] Object obj [] Detail det []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.4 Component Evidence
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.4.1 Semantics
|
The Evidence component is used as an input element within the ValidateEvidence operation (see clause 5.3.8) to provide the preservation evidence, which is to be validated. The Evidence component shall extend the PO component (see clause 5.4.5), from which it inherits the mandatory subcomponent representing the value of the preservation object and the subcomponent FormatId, which is mandatory in this case. The Evidence component shall contain the following sub-components: • One instance of either base64 encoded binary data or xml data, which contains the value of the preservation evidence. The technical details are depending on the syntax under consideration. • The FormatId element. It shall contain one instance of a URI, which identifies the format of the preservation evidence. Refer to clause A.2 for preservation evidence formats used in the preservation schemes specified in the present document (see Annex F). ETSI ETSI TS 119 512 V1.2.1 (2023-05) 47 The Evidence component may contain the optional sub-components MimeType, PronomId, ID and RelatedObjects of the PO component (see clause 5.4.5) and the following sub-components: • The optional POID element. If present, it shall contain one instance of a string, which identifies the preservation object to which the Evidence component belongs. • The optional VersionID element. If present, it shall contain one instance of a string, which identifies a particular version of the preservation object provided provided in the ValidateEvidence operation.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.4.2 XML Syntax
|
The XML type EvidenceType shall implement the requirements defined in the Evidence component. In this case the value of the Evidence component is a choice between a base64 encoded binaryData element and an XML- based xmlData element from an arbitrary namespace. The EvidenceType XML type shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <complexType name="EvidenceType"> <complexContent> <extension base="pres:POType"> <attribute name="POID" type="string" use="optional"/> <attribute name="VersionID" type="string" use="optional"/> </extension> </complexContent> </complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.4.3 JSON Syntax
|
The EvidenceType JSON object shall implement in JSON syntax the requirements defined in the Evidence component. In this case the value of the Evidence component is a base64 encoded binaryData element. The EvidenceType JSON element shall be defined as in the JSON Schema file (Preservation-API.json) provided in Annex D, and which is copied below for information. "pres-EvidenceType": { "type": "object", "properties": { "value": { "binaryData": { "$ref": "#/definitions/pres-POType:BinaryData" }, "formatId": { "type": "string" }, "mimeType": { "type": "string" }, "pronomId": { "type": "string" }, "id": { "type": "string" }, "relObj": { "type": "array", "items": { "type": "string" }, }, "poId": { "type": "string" }, "verId": { "type": "string" } } } ETSI ETSI TS 119 512 V1.2.1 (2023-05) 48 Properties in the JSON schema above shall implement sub-components of the Evidence component mapped by names as shown in Table 19. Table 19 Element Implementing JSON member name Comments choice of binaryData or xmlData binaryData [] FormatId formatId [] MimeType mimeType PronomId pronomId ID id RelatedObjects relObj POID poId [] VersionID verId []
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.5 Component PO
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.5.1 Semantics
|
The PO component is a generic container object, which is used for conveying preservation objects. This generic component is used in several operations, such as PreservePO (see clause 5.3.3), RetrievePO (see clause 5.3.4), UpdatePOC (see clause 5.3.6) and ValidateEvidence (see clause 5.3.8). The component PO shall contain the following the sub-component: • One instance of a subcomponent, which contains the value of the preservation object. The technical details are depending on the syntax under consideration (see clause 5.4.5.2 and clause 5.4.5.3). The component PO may contain the following optional the sub-components: • The optional FormatId element. If present, it shall contain a URI, which specifies the general type and format of the PO, if present. This element shall be present, if the preservation object is an evidence (see clause A.2) or specific submission data object (see clause A.1) or an additional output format (see clause A.3) and hence requires specific treatment beyond base64 encoding or decoding respectively. • The optional MimeType element. If present, it shall contain one instance of a string and indicate the Media Type of a preservation object. This element shall be present, if the FormatId element is omitted. It should contain values registered in the Media Type Registry maintained by IANA [i.18]. NOTE: The MimeType element allows to distinguish between XML syntax and JSON syntax conveyed in the PO component. • The optional PronomId element. If present, it shall contain one instance of a string and refer to the PRONOM Persistant Unique Identifier (PUID) [i.23]. This identifier should be used, if additional classification information for the preservation object is required in a specific context. • The optional ID element. If present, it shall contain one instance of a unique identifier. It may be used for uniquely identifying a preservation object within a larger data structure. • The optional RelatedObjects element. If present, it shall contain one instance of a unique identifier reference and may be used for pointing to related preservation objects within a larger data structure.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.5.2 XML Syntax
|
The XML type POType shall implement the requirements defined in the PO component. In this case the value of the preservation object is a choice between a base64 encoded binaryData element and an XML-based xmlData element from an arbitrary namespace. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 49 NOTE: The technical destinction between binaryData and xmlData within the choice element of the POType below is necessary to enable efficient handling and optimized transmission of XML-based preservation objects, according to clause A.3.2 for example, via SOAP-based [i.25] interfaces using the "SOAP Message Transmission Optimization Mechanism" according to [i.26]. The POType XML element shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <complexType name="POType"> <choice> <element name="binaryData"> <complexType xmime:expectedContentTypes="*/*"> <simpleContent> <extension base="base64Binary"> </extension> </simpleContent> </complexContent> </element> <element name="xmlData"> <complexType> <sequence> <any namespace="##any" processContents="lax"></any> </sequence> </complexType> </element> </choice> <attribute name="FormatId" type="anyURI" use="optional"/> <attribute name="MimeType" type="string" use="optional"/> <attribute name="PronomId" type="string" use="optional"/> <attribute name="ID" type="ID" use="optional"/> <attribute name="RelatedObjects" type="IDREFS" use="optional"/> </complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.5.3 JSON Syntax
|
The POType JSON object shall implement in JSON syntax the requirements defined in the PO component. In this case the value of the preservation object is a base64 encoded binaryData element. The POType JSON object shall be defined as in the JSON Schema file (Preservation-API.json) provided in Annex D, and is copied below for information. "pres-POType": { "type": "object", "properties": { "binaryData": { "$ref": "#\/definitions\/pres-POType:BinaryData"" }, "formatId": { "type": "string" }, "mimeType": { "type": "string" }, "pronomId": { "type": "string" }, "id": { "type": "string" }, "relObj": { "type": "array" "items": { "type": "string" } } } } Properties in the JSON schema above shall implement sub-components of PO component mapped by names as shown in Table 20. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 50 Table 20 Element Implementing JSON member name Comments choice of binaryData or xmlData binaryData [] FormatId formatId [] MimeType mimeType PronomId pronomId ID id RelatedObjects relObj
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.6 Component PreservationStorageModel
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.6.1 Semantics
|
The PreservationStorageModel component specifies the storage model (see clause 4.3) of the operational profile (see clause 5.4.7) of the preservation service under consideration. The PreservationStorageModel component shall be an instance of a string, which shall be one of the following values: • WithStorage - for a preservation service with storage (see clause 4.3.1). • WithTemporaryStorage - for a preservation service with temporary storage (see clause 4.3.2). • WithoutStorage - for a preservation service without storage (see clause 4.3.3).
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.6.2 XML Syntax
|
The XML type PreservationStorgeModelType shall implement the requirements defined in the PreservationStorgeModel component. The PreservationStorageModelType XML element shall be defined as in XML Schema file (Preservation-API.xsd)provided in Annex C, and which is copied below for information. <simpleType name="PreservationStorageModelType"> <restriction base="string"> <enumeration value="WithStorage"/> <enumeration value="WithTemporaryStorage"/> <enumeration value="WithoutStorage"/> </restriction> </simpleType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.6.3 JSON Syntax
|
The component PreservationStorageModel is derived from the string type with the admissible values specified above.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.7 Component Profile
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.7.1 Semantics
|
The Profile component specifies the operational details of a preservation profile, as outlined in clause 4.4. The Profile component shall contain the following sub-components: • The ProfileIdentifier element. It shall be present and contain a URI according to IETF RFC 3986 [2], which uniquely identifies the preservation profile. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 51 NOTE 1: The identifier may reflect organizational structures of the pertinent naming authority. Such organizational aspects are beyond the scope of the present document. • The Operation element. It shall be present one or more times and provides information about the operations supported by the preservation profile. Each element shall satisfy the requirements specified in OASIS Digital Signature Service Information [6]. For each operation supported by the preservation profile there shall be one Operation element. The Operation element shall specify: - The set of supported input parameters and submission data object formats, which require a special treatment by the preservation service beyond any base64 decoding for binary data objects, within the set of Input and Format elements, if applicable. NOTE 2: Base64 encoding is necessary for the transmission of binary data objects within XML-based structures using SOAP according to [i.25]. NOTE 3: Refer to clause 5.4.5.2 for the detailed specification of the POType, which distinguishes between base64 encoded binary data objects and XML-based data objects in order to support the efficient handling of both binary and XML-based data objects and preservation object containers SOAP according to [i.25]. EXAMPLE: The XML-based Archive Information Package (XAIP) according to clause A.3.2 is an example of an XML-based preservation object container, which may in turn contain nested binary data objects. - The set of supported optional input elements within the Option elements, if applicable. - The set of supported output parameters and retrievable data object formats, within the set of Output and Formats elements, if applicable. NOTE 4: The submission data object formats specified within the present document can be found in clause A.1. NOTE 5: The output formats registered by the present document are preservation object container formats. They can be found in clause A.3. NOTE 6: All submission data object formats may also appear as output data formats. NOTE 7: Typical examples for output data object formats comprise formats for preservation object containers, which contain multiple preservation objects, which have been submitted in a single call to the preservation service or belong together for some other reason. • The Policy element. This element shall be present one or two times in order to specify the set of policies, which are applicable for the preservation profile. Each element shall satisfy the requirements specified in OASIS Digital Signature Service Information [6]. There shall be one Policy element, which specifies the preservation evidence policy of the preservation profile. The Type of this Policy element shall be equal to the following URI: - http://uri.etsi.org/19512/policy/preservation-evidence If the preservation goal is PDS and the valiation data is not provided by the client, there shall be a second Policy element, which specifies the signature validation policy. The Type of this Policy element shall be equal to the following URI: - http://uri.etsi.org/19512/policy/signature-validation NOTE 8: While the current version of the present document assumes that a human-readable policy document is present, future versions of the present document may refer to machine-readable policy specifications, if available. When this is achieved, this will allow machine-processable profiles. • The ProfileValidityPeriod element. This element shall specify in its child element ValidFrom, the point in time from which on the preservation profile has become active or will become active and may in its optional child element ValidUntil specify the point in time at which the preservation profile will become inactive, if required. • The PreservationStorageModel element. It shall satisfy the requirements specified in clause 5.4.6 and is used to specify the storage model of the preservation profile according to clause 4.3. ETSI ETSI TS 119 512 V1.2.1 (2023-05) 52 • The PreservationGoal element. It shall be present one or more times and provides information about the preservation goals supported by the preservation profile. Each element shall be a URI according to IETF RFC 3986 [2], which specifies a preservation goal supported by the preservation service. NOTE 9: Refer to clause 4.2 for the preservation goals defined in the present document. • The EvidenceFormat element. This element shall be present one or more times in order to specify the set of evidence formats supported by the present preservation profile. Each element shall satisfy the requirements of the Format component specified in OASIS Digital Signature Service Information [6]. NOTE 10: The evidence formats defined by the present document can be found in clause A.2. The Profile component may contain the following sub-components: • The Specification element. This element may appear zero or more times and shall, if present, be a URI according to IETF RFC 3986 [2]. This URI shall refer to a publicly available specification in which the preservation profile is described. • The Description element. This element may appear zero or more times and shall, if present, be of type InternationalStringType according to OASIS DSS-X Core 2.0 [5] or a corresponding JSON translation and may be used to provide descriptions of the preservation profile in multiple languages. If the Specification element above is present, the Description element should focus on those aspects of the preservation profile, which are not yet specified in the referenced specification document in sufficient detail. • The SchemeIdentifier element. This element may be present in order to identify the preservation scheme related to the preservation profile. If present, it shall contain a URI according to IETF RFC 3986 [2]. NOTE 11: Refer to Annex F for preservation schemes defined by the present document. • The ExpectedEvidenceDuration element. This element is optional and may be used to specify the duration during which the preservation service expects that a preservation evidence can be used to achieve the preservation goal. NOTE 12: See ETSI TS 119 511 [i.14], clause 4.4 for more information on the expected evidence duration. • The PreservationEvidenceRetentionPeriod element. This element shall be present in case of preservation with temporary storage in order to specify the period in which the asynchronously produced preservation evidences can be retrieved by the client. • Zero or more instances of the Extension element, which can be used to extend the semantics of the Profile component. Each instance shall be as specified in OASIS Digital Signature Service Metadata [6]. The effective set of sub-components of the Profile element and the mapping to the JSON syntax and the requirements defined in clause 6.4 of ETSI TS 119 511 [i.14] is provided in Table 21. Table 21 Element Implementing JSON member name Correspondence to requirements defined in ETSI TS 119 511 [i.14], (clause 6.4) ProfileIdentifier pid OVR-6.4-04 a) Operation op OVR-6.4-04 b) Policy pol OVR-6.4-04 c) ProfileValidityPeriod pvp OVR-6.4-04 d) PreservationStorageModel psm OVR-6.4-04 e) PreservationGoal pg OVR-6.4-04 f) EvidenceFormat ef OVR-6.4-04 g) Specification spec OVR-6.4-04 h) Description desc OVR-6.4-04 i) SchemeIdentifier sid OVR-6.4-04 j) ExpectedEvidenceDuration eed OVR-6.4-05 PreservationEvidence RetentionPeriod perp OVR-6.4-06 Extension ext ETSI ETSI TS 119 512 V1.2.1 (2023-05) 53
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.7.2 XML Syntax
|
The XML type ProfileType shall implement the requirements defined in the Profile component. The ProfileType XML type defined in the present document is an extension of the info:ProfileType defined in OASIS Digital Signature Service Information [6] and shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <complexType name="ProfileType"> <complexContent> <extension base="info:ProfileType"> <sequence> <element name="SchemeIdentifier" type="anyURI" minOccurs="0" maxOccurs="1"/> <element name="ProfileValidityPeriod" type="pres:ProfileValidityPeriodType"/> <element name="PreservationStorageModel" type="pres:PreservationStorageModelType" /> <element name="PreservationGoal" type="anyURI" minOccurs="1" maxOccurs="unbounded" /> <element name="EvidenceFormat" type="info:FormatType" maxOccurs="unbounded" /> <element name="ExpectedEvidenceDuration" type="duration" minOccurs="0" /> <element name="PreservationEvidenceRetentionPeriod" type="duration" minOccurs="0" /> </sequence> </extension> </complexContent> </complexType>
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.7.3 JSON Syntax
|
The ProfileType JSON object shall implement in JSON syntax the requirements defined in the Profile component. The ProfileType JSON object shall be defined as in the JSON Schema file (Preservation-API.json) provided in Annex D, and which is copied below for information. "pres-ProfileType": { "type": "object", "properties": { "pid": { "type": "string" }, "spec": { "type": "array", "items": { "type": "string" } }, "description": { "type": "array", "items": { "$ref": "#/definitions/dsb-InternationalStringType" } }, "op": { "type": "array", "items": { "$ref": "#/definitions/md-OperationType" } }, "pol": { "type": "array", "items": { "$ref": "#/definitions/md-PolicyType" } }, "ext": { "type": "array", "items": { "$ref": "#/definitions/md-ExtensionType" } ETSI ETSI TS 119 512 V1.2.1 (2023-05) 54 }, "sid": { "type": "string" }, "pvp": { "$ref": "#/definitions/pres-ProfileValidityPeriodType" }, "psm": { "type": "string" }, "pg": { "type": "array", "items": { "type": "string" } }, "ef": { "type": "array", "items": { "$ref": "#/definitions/md-FormatType" } }, "eed": { "type": "string" }, "perp": { "type": "string" } }, "required": ["pvp", "psm", "pg", "ef"] } Properties in the JSON schema above shall implement sub-components of the Profile component mapped by names as shown in Table 21.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.8 Component Status
| |
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.8.1 Semantics
|
The Status component is used in the RetrieveInfo request (see clause 5.3.2). The Status component shall contain the following sub-components: • The value element. It shall contain one instance of a string which shall be one of the following values: - active - to indicate that only active preservation profiles shall be returned in RetrieveInfoResponse. This value shall be the default value, if the optional Status element is omitted in the RetrieveInfo call according to clause 5.3.2. - inactive - to indicate that only inactive preservation profiles shall be returned in RetrieveInfoResponse. - all - to indicate that both, active and inactive preservation profiles shall be returned.
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.8.2 XML Syntax
|
The XML type StatusType shall implement the requirements defined in the Status component. The StatusType XML type shall be defined as in the XML Schema file (Preservation-API.xsd) provided in Annex C, and which is copied below for information. <simpleType name="StatusType"> <restriction base="string"> <enumeration value="active"/> <enumeration value="inactive"/> </restriction> </simpleType> ETSI ETSI TS 119 512 V1.2.1 (2023-05) 55
|
cdd823ba984b81337eedcd223e1a6810
|
119 512
|
5.4.8.3 JSON Syntax
|
The component Status is derived from the string type with the values specified above.
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.