{
    "components": {
        "schemas": {
            "AppliedValidationRulesDto": {
                "properties": {
                    "cci": {
                        "maxLength": 15,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "fullVersion": {
                        "maxLength": 10,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "id": {
                        "maxLength": 15,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "listOfLabelValue": {
                        "items": {
                            "$ref": "#/components/schemas/AppliedValidationRulesLabelValueDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfValidationResult": {
                        "items": {
                            "$ref": "#/components/schemas/ValidationResultDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "objectTypeId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "title": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "AppliedValidationRulesLabelValueDto": {
                "properties": {
                    "key": {
                        "nullable": true,
                        "type": "string"
                    },
                    "referenceId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "value": {
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "AresDocumentDto": {
                "properties": {
                    "aresRegistrationNumber": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "listOfAresItemIds": {
                        "items": {
                            "type": "string"
                        },
                        "nullable": true,
                        "type": "array"
                    }
                },
                "type": "object"
            },
            "CciSearchResultDto": {
                "properties": {
                    "accountingYearId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "cci": {
                        "maxLength": 15,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "commissionDecisionDate": {
                        "maxLength": 10,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "commissionDecisionNumber": {
                        "maxLength": 20,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "countryId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "documentGroupId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "ecId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "enablingConditionId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "fullVersion": {
                        "maxLength": 10,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "fundId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "id": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "link": {
                        "maxLength": 1000,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "objectType": {
                        "maxLength": 4,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "objectTypeId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "specificType": {
                        "maxLength": 10,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "statusId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "title": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "CompareChapterDto": {
                "properties": {
                    "fromChapter": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "id": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "representation": {
                        "nullable": true,
                        "type": "string"
                    },
                    "section": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "toChapter": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    }
                },
                "type": "object"
            },
            "CompareDto": {
                "properties": {
                    "id": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "representation": {
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "DocumentAttachmentDto": {
                "properties": {
                    "attachmentTypeCode": {
                        "maxLength": 20,
                        "minLength": 0,
                        "type": "string"
                    },
                    "commissionReference": {
                        "maxLength": 16,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "containsTextKeyword": {
                        "description": "In case the document was loaded by having the extra text parameter, this flag indicates if the attachement contains the text",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "id": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "isEncrypted": {
                        "description": "is encrypted (read-only)",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "isHidden": {
                        "description": "flag to indicate that an attachments need to be hidden. (after the document was sent)",
                        "type": "boolean"
                    },
                    "isSystemGenerated": {
                        "description": "system property to indicate if attachment was generated by the system (read-only)",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "language": {
                        "description": "The language id. This can be provided by the referenceData languages.",
                        "format": "int64",
                        "type": "integer"
                    },
                    "masterDocumentAttachmentId": {
                        "description": "A document attachment might be linked to a \"parent\" documentAttachment",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "sfcLargeObject": {
                        "$ref": "#/components/schemas/LargeObjectDto"
                    },
                    "title": {
                        "maxLength": 256,
                        "minLength": 0,
                        "type": "string"
                    }
                },
                "required": [
                    "attachmentTypeCode",
                    "isHidden",
                    "language",
                    "title"
                ],
                "type": "object"
            },
            "DocumentAuthorityRestrictionDto": {
                "properties": {
                    "authorityTypeId": {
                        "format": "int64",
                        "type": "integer"
                    }
                },
                "required": [
                    "authorityTypeId"
                ],
                "type": "object"
            },
            "DocumentAuthorityTypeRestrictionMetaDataDto": {
                "description": "list of possible document authority type restrictions. Will only be populted for the referring document types having the 'restrict read' option. The list is indentifiable through the documentTypeId",
                "properties": {
                    "documentTypeId": {
                        "description": "the Id of the document type",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "listOfPossibleAuthorityRestrictions": {
                        "description": "the list of possible document AuthorityRestrictions for this document type",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    }
                },
                "readOnly": true,
                "type": "object"
            },
            "DocumentDto": {
                "properties": {
                    "ackBy": {
                        "description": "user acknowledged by (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "ackByEmail": {
                        "description": "contact email address of the ackBy user (read-only)",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "ackDate": {
                        "description": "acknowledge date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "type": "string"
                    },
                    "commissionReference": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "countryId": {
                        "description": "For Member State Documents, the Country is automatically set at creation with the Country of the Node creating the Document and cannot be modified.For Commission Documents, the Commission user can select a specific Country or none meaning \"All Countries\".",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "deletable": {
                        "description": "Indicator if the document can be deleted (read-only)",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "documentDate": {
                        "format": "date",
                        "type": "string"
                    },
                    "documentGroupId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "documentTypeId": {
                        "format": "int64",
                        "type": "integer"
                    },
                    "editable": {
                        "description": "Indicator if the document can be edited (read-only)",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "isReferring": {
                        "description": "Indicator if the document is referred",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "listOfDocumentAttachments": {
                        "items": {
                            "$ref": "#/components/schemas/DocumentAttachmentDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfDocumentAuthorityRestrictions": {
                        "items": {
                            "$ref": "#/components/schemas/DocumentAuthorityRestrictionDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfDocumentLinks": {
                        "items": {
                            "$ref": "#/components/schemas/DocumentLinkDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfDocumentMetaData": {
                        "items": {
                            "$ref": "#/components/schemas/DocumentMetaDataDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfFundIds": {
                        "items": {
                            "format": "int64",
                            "type": "integer"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfNotValidLinks": {
                        "description": "List of CCIs linked to this document that have been deleted",
                        "items": {
                            "$ref": "#/components/schemas/DocumentLinkDto"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "listOfRepliesFromDocument": {
                        "description": "In case the document can have a reply then this listOfRepliesFromDocument will contain the replying documents",
                        "items": {
                            "$ref": "#/components/schemas/DocumentDto"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "localReference": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUserEmail": {
                        "description": "email address from last modification user (read-only)",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "ownerNodeId": {
                        "description": "Node where the document was created (read-only)",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "parentDocumentId": {
                        "description": "In case this document is a reply to a received Document. parentDocumentId is the id of the received document.",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "repliesToDocument": {
                        "$ref": "#/components/schemas/DocumentDto"
                    },
                    "sendEnabled": {
                        "description": "Indicator if the document can be sent (read-only)",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "sent": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "sentBy": {
                        "description": "SentBy user (read-only)",
                        "maxLength": 359,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "sentByEmail": {
                        "description": "contact email address of the sentBy user (read-only)",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "sentByUserId": {
                        "description": "SentBy ecas user id (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "sentDate": {
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "sentDocumentAcknowledgeable": {
                        "description": "flag that indicates if the documents (which is sent) is to be acknowledged.",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "sentDocumentEditable": {
                        "description": "flag that indicates if the documents (which is sent) is updateable. When this is true the user can hide/show the attachments",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "sentDocumentRefreshable": {
                        "description": "flag that indicates if the documents (which is sent) is refreshable. When this is true the user can refresh the attachments from Ares",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "tabLabel": {
                        "description": "The label to use in the tab page (only applicable for STD documents)",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "title": {
                        "maxLength": 256,
                        "minLength": 0,
                        "type": "string"
                    }
                },
                "required": [
                    "documentDate",
                    "documentTypeId",
                    "title"
                ],
                "type": "object"
            },
            "DocumentDtoMetadata": {
                "properties": {
                    "canCreate": {
                        "description": "Indicates if the user can create a document",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "isUserAnAuditAgent": {
                        "description": "Indicates if the user is an Audit Agent",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "listOfDocumentAuthorityTypeRestrictionMetaData": {
                        "description": "list of possible document authority type restrictions. Will only be populted for the referring document types having the 'restrict read' option. The list is indentifiable through the documentTypeId",
                        "items": {
                            "$ref": "#/components/schemas/DocumentAuthorityTypeRestrictionMetaDataDto"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "listOfDocumentLinkMetaData": {
                        "description": "list of possible document links. Will only be populated for the referring document types. The list is indentifiable through the documentTypeId",
                        "items": {
                            "$ref": "#/components/schemas/DocumentLinkMetaDataDto"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "listOfDocumentTypeMeta": {
                        "description": "list of possible document types meta for the listOfDocumentTypes",
                        "items": {
                            "$ref": "#/components/schemas/ReferenceDataDtoInterface"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "listOfDocumentTypeMetaForCurrentDocType": {
                        "description": "list of possible document types meta for the current document type",
                        "items": {
                            "$ref": "#/components/schemas/ReferenceDataDtoInterface"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "listOfDocumentTypes": {
                        "description": "list of possible document types for creation",
                        "items": {
                            "$ref": "#/components/schemas/ReferenceDataDtoInterface"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "listOfDocumentTypesForThisGroup": {
                        "description": "list of possible document types for this specific document group",
                        "items": {
                            "$ref": "#/components/schemas/ReferenceDataDtoInterface"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "listOfDocumentTypesSendable": {
                        "items": {
                            "$ref": "#/components/schemas/DocumentTypeSendableDtoMetadata"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfReferringDocumentTypes": {
                        "description": "list of referred doc types (the part of ids of possible document types for creation that are referred document types)",
                        "items": {
                            "description": "list of referred doc types (the part of ids of possible document types for creation that are referred document types)",
                            "format": "int64",
                            "readOnly": true,
                            "type": "integer"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "showCciLink": {
                        "description": "Indicates if the column \"CciLink(s)\" should be shown or not",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "showExtraFields": {
                        "description": "Indicates if the column \"Extra Fields\" should be shown or not",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    }
                },
                "type": "object"
            },
            "DocumentLinkDto": {
                "description": "List of CCIs linked to this document that have been deleted",
                "properties": {
                    "accountingPeriod": {
                        "maxLength": 6,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "cci": {
                        "maxLength": 51,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "decisionNumber": {
                        "maxLength": 20,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "fullVersion": {
                        "maxLength": 81,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "fund": {
                        "maxLength": 8,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "id": {
                        "format": "int64",
                        "type": "integer"
                    },
                    "mainObjectId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "objectTitle": {
                        "description": "title for the cci in case of a referring document (read-only)",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "objectType": {
                        "maxLength": 4,
                        "minLength": 0,
                        "type": "string"
                    },
                    "version": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "workVersion": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    }
                },
                "readOnly": true,
                "required": [
                    "id",
                    "objectType"
                ],
                "type": "object"
            },
            "DocumentLinkMetaDataDto": {
                "description": "list of possible document links. Will only be populated for the referring document types. The list is indentifiable through the documentTypeId",
                "properties": {
                    "documentTypeId": {
                        "description": "the Id of the document type",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "listOfPossibleLinks": {
                        "description": "the list of possible document links for this document type",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "objectTypeId": {
                        "description": "the Id of the object type",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    }
                },
                "readOnly": true,
                "type": "object"
            },
            "DocumentMetaDataDto": {
                "properties": {
                    "documentTypeMetaDataCode": {
                        "maxLength": 12,
                        "minLength": 0,
                        "type": "string"
                    },
                    "value": {
                        "description": "The string representation or the metadata. In case metadata has multiple values they are separated by a semicolon. The default maximum length of the metadata is specified in this DTO but can be further restricted in the metadata directory definition (maxChars)",
                        "maxLength": 2000,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "required": [
                    "documentTypeMetaDataCode"
                ],
                "type": "object"
            },
            "DocumentSearchDto": {
                "properties": {
                    "codelang": {
                        "maxLength": 2,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "commissionReference": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "country": {
                        "maxLength": 4000,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "countryId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "direction": {
                        "maxLength": 10,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "documentDate": {
                        "format": "date",
                        "type": "string"
                    },
                    "documentGroupId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "documentType": {
                        "maxLength": 4000,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "documentTypeId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "jsonMetadata": {
                        "description": "Json representation of the list of metadata linked to this document (if any)",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "links": {
                        "maxLength": 32767,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "localReference": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "objectId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "objectSubtype": {
                        "maxLength": 6,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "objectTypeId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "ownerNodeId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "sentBy": {
                        "description": "SentBy user",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "sentDate": {
                        "format": "date-time",
                        "nullable": true,
                        "type": "string"
                    },
                    "tabLabel": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "title": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "totalAttachmentSize": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "version": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "workVersion": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    }
                },
                "required": [
                    "documentDate"
                ],
                "type": "object"
            },
            "DocumentSearchParams": {
                "properties": {
                    "attachmentTitle": {
                        "description": "the title of a document attachment. Only documents having an attachment containing the title specified will be returned",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "empty": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "languageIds": {
                        "description": "the language ids of a document attachment. Only documents having an attachment in one of the specified languages will be returned",
                        "items": {
                            "description": "the language ids of a document attachment. Only documents having an attachment in one of the specified languages will be returned",
                            "format": "int64",
                            "type": "integer"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "page": {
                        "default": 0,
                        "description": "The page of the search results to be returned",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "query": {
                        "description": "the RSQL query to search",
                        "nullable": true,
                        "type": "string"
                    },
                    "size": {
                        "default": 1000,
                        "description": "The size of each page of the search results",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "sort": {
                        "default": "-modificationDate",
                        "description": "The sort string. This string consists of comma separated field names that will be used for ascending sorting.In case descending sorting is desired the field name should be prefixed with a \"-\"",
                        "example": "title,-modificationDate",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "text": {
                        "description": "a partial text to search in document attachments",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "DocumentTypeSendableDtoMetadata": {
                "properties": {
                    "documentTypeId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "sendable": {
                        "nullable": true,
                        "type": "boolean"
                    }
                },
                "type": "object"
            },
            "DocumentWithVersionInfoDto": {
                "properties": {
                    "ackBy": {
                        "description": "user acknowledged by (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "ackByEmail": {
                        "description": "contact email address of the ackBy user (read-only)",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "ackDate": {
                        "description": "acknowledge date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "type": "string"
                    },
                    "commissionReference": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "countryId": {
                        "description": "For Member State Documents, the Country is automatically set at creation with the Country of the Node creating the Document and cannot be modified.For Commission Documents, the Commission user can select a specific Country or none meaning \"All Countries\".",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "deletable": {
                        "description": "Indicator if the document can be deleted (read-only)",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "documentDate": {
                        "format": "date",
                        "type": "string"
                    },
                    "documentGroupId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "documentTypeId": {
                        "format": "int64",
                        "type": "integer"
                    },
                    "editable": {
                        "description": "Indicator if the document can be edited (read-only)",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "isReferring": {
                        "description": "Indicator if the document is referred",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "listOfDocumentAttachments": {
                        "items": {
                            "$ref": "#/components/schemas/DocumentAttachmentDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfDocumentAuthorityRestrictions": {
                        "items": {
                            "$ref": "#/components/schemas/DocumentAuthorityRestrictionDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfDocumentLinks": {
                        "items": {
                            "$ref": "#/components/schemas/DocumentLinkDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfDocumentMetaData": {
                        "items": {
                            "$ref": "#/components/schemas/DocumentMetaDataDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfFundIds": {
                        "items": {
                            "format": "int64",
                            "type": "integer"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfNotValidLinks": {
                        "description": "List of CCIs linked to this document that have been deleted",
                        "items": {
                            "$ref": "#/components/schemas/DocumentLinkDto"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "listOfRepliesFromDocument": {
                        "description": "In case the document can have a reply then this listOfRepliesFromDocument will contain the replying documents",
                        "items": {
                            "$ref": "#/components/schemas/DocumentDto"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "localReference": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUserEmail": {
                        "description": "email address from last modification user (read-only)",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "objectVersion": {
                        "description": "The version of the object where this document was created (read-only)",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "objectVersionId": {
                        "description": "The id of the object where this document was created (read-only)",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "ownerNodeId": {
                        "description": "Node where the document was created (read-only)",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "parentDocumentId": {
                        "description": "In case this document is a reply to a received Document. parentDocumentId is the id of the received document.",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "repliesToDocument": {
                        "$ref": "#/components/schemas/DocumentDto"
                    },
                    "sendEnabled": {
                        "description": "Indicator if the document can be sent (read-only)",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "sent": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "sentBy": {
                        "description": "SentBy user (read-only)",
                        "maxLength": 359,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "sentByEmail": {
                        "description": "contact email address of the sentBy user (read-only)",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "sentByUserId": {
                        "description": "SentBy ecas user id (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "sentDate": {
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "sentDocumentAcknowledgeable": {
                        "description": "flag that indicates if the documents (which is sent) is to be acknowledged.",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "sentDocumentEditable": {
                        "description": "flag that indicates if the documents (which is sent) is updateable. When this is true the user can hide/show the attachments",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "sentDocumentRefreshable": {
                        "description": "flag that indicates if the documents (which is sent) is refreshable. When this is true the user can refresh the attachments from Ares",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "tabLabel": {
                        "description": "The label to use in the tab page (only applicable for STD documents)",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "title": {
                        "maxLength": 256,
                        "minLength": 0,
                        "type": "string"
                    }
                },
                "required": [
                    "documentDate",
                    "documentTypeId",
                    "title"
                ],
                "type": "object"
            },
            "EditablePagesDto": {
                "type": "object"
            },
            "EditableSectionsDto": {
                "type": "object"
            },
            "ExportExtraDto": {
                "properties": {
                    "annexAnnualPlan": {
                        "description": "A flag indicating if the Annex for the Annual plan export option is available on the user actions menu. This would be Decisional Annex T7 for ETC and T10 for IJG",
                        "nullable": true,
                        "type": "boolean"
                    },
                    "annexPriorityPlan": {
                        "description": "A flag indicating if the Annex for the Priority plan export option is available on the user actions menu. This would be Decisional Annex T10 for ETC and T11 for IJG",
                        "nullable": true,
                        "type": "boolean"
                    }
                },
                "type": "object"
            },
            "ImportReport": {
                "properties": {
                    "errors": {
                        "items": {
                            "$ref": "#/components/schemas/ParseError"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "successRecords": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "totalRecords": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    }
                },
                "type": "object"
            },
            "LargeObjectDto": {
                "description": "actual file(aka large object) information. Should not be provided when the content doesn't need to be updated",
                "properties": {
                    "contentCrc": {
                        "description": "the \"SHA-256\" hash will be automatically calculated (Read-Only)",
                        "maxLength": 512,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "filename": {
                        "description": "Temporary filename on the server. This filename will be returned with a previous call to the server to save the document (/temp-attachment) ",
                        "maxLength": 512,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "lobName": {
                        "description": "The lobname is the actual name of the file. This lobname will only be looked at in case a \"filename\" was provided",
                        "example": "file_name_example.pdf",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "lobSize": {
                        "description": "size is automatically calculated from the provided file (read-only)",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "mimeType": {
                        "description": "when not provided, the mimetype will be guessed from the file extension",
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "MdsAnswerDto": {
                "properties": {
                    "dateAnswer": {
                        "format": "date",
                        "nullable": true,
                        "type": "string"
                    },
                    "deletable": {
                        "description": "Indentify if an answer is deletable or not",
                        "nullable": true,
                        "type": "boolean"
                    },
                    "editable": {
                        "description": "Indentify if an answer is editable or not",
                        "nullable": true,
                        "type": "boolean"
                    },
                    "hint": {
                        "description": "Hint",
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "inToc": {
                        "description": "When the answer type is 'V' (void), it signifies whether the title has already present in the table of contents (TOC).",
                        "nullable": true,
                        "type": "boolean"
                    },
                    "label": {
                        "description": "Label",
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "maxLength": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "numberAnswer": {
                        "nullable": true,
                        "type": "number"
                    },
                    "orderBy": {
                        "description": "Order of the questions",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "parentQuestionId": {
                        "description": "ID of the parent quesiton this asnwer refers to",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "questionId": {
                        "description": "ID of the question this aswer refers to.",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "repeatable": {
                        "description": "Indentify if an answer is repeatable or not",
                        "nullable": true,
                        "type": "boolean"
                    },
                    "richTextAnswer": {
                        "maxLength": 3116480,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "showChildrenInTwoColumns": {
                        "description": "Info for the report only, indetifies if a table has to be showed in one column or in two ",
                        "nullable": true,
                        "type": "boolean"
                    },
                    "surveyType": {
                        "description": "Survey type (I=Direct, II=Indirect)",
                        "example": "I",
                        "maxLength": 2,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "textAnswer": {
                        "maxLength": 5000,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "type": {
                        "description": "Answer type ( T=Text, R=RichText, N=Number, D=Date, V=Void )",
                        "example": "T",
                        "maxLength": 1,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "MdsAnswerMetadataDto": {
                "properties": {
                    "questionIds": {
                        "items": {
                            "format": "int64",
                            "type": "integer"
                        },
                        "nullable": true,
                        "type": "array"
                    }
                },
                "type": "object"
            },
            "MdsCreateDto": {
                "properties": {
                    "cci": {
                        "maxLength": 16,
                        "minLength": 0,
                        "type": "string"
                    },
                    "version": {
                        "format": "int32",
                        "type": "integer"
                    }
                },
                "required": [
                    "cci",
                    "version"
                ],
                "type": "object"
            },
            "MdsCreateMetadataDto": {
                "properties": {
                    "listOfProgrammes": {
                        "items": {
                            "$ref": "#/components/schemas/ProgrammeDto"
                        },
                        "nullable": true,
                        "type": "array"
                    }
                },
                "type": "object"
            },
            "MdsObservationDto": {
                "properties": {
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "isEcUser": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "nameAndSurname": {
                        "maxLength": 300,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "text": {
                        "maxLength": 4000,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "MdsPersonInChargeDto": {
                "properties": {
                    "beginDate": {
                        "format": "date",
                        "nullable": true,
                        "type": "string"
                    },
                    "email": {
                        "maxLength": 255,
                        "minLength": 0,
                        "type": "string"
                    },
                    "endDate": {
                        "format": "date",
                        "nullable": true,
                        "type": "string"
                    },
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "key": {
                        "description": "Key to be used in the table compare",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "languageId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "name": {
                        "maxLength": 255,
                        "minLength": 0,
                        "type": "string"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "phone": {
                        "maxLength": 50,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "required": [
                    "email",
                    "name"
                ],
                "type": "object"
            },
            "MdsSearchDto": {
                "properties": {
                    "cci": {
                        "description": "Programme Cci",
                        "example": "2021BE05SFPR001",
                        "maxLength": 51,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "currentNode": {
                        "description": "Translated current node description",
                        "example": "European Commission",
                        "maxLength": 25000,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "currentNodeId": {
                        "description": "Current node id",
                        "example": 580,
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "englishTitle": {
                        "description": "Eglish Title",
                        "maxLength": 383,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "fullVersion": {
                        "description": "Version and workversion of the national audit report",
                        "example": "1.0",
                        "maxLength": 81,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "ownerNodeId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "previousNode": {
                        "description": "Translated previous node description",
                        "example": "Belgium",
                        "maxLength": 25000,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "previousNodeId": {
                        "description": "Previous node id",
                        "example": 580,
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "status": {
                        "description": "Translated status description",
                        "example": "Sent",
                        "maxLength": 25000,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "statusId": {
                        "description": "Status id",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "statusModificationDate": {
                        "description": "Status modification date",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "version": {
                        "description": "Version number",
                        "format": "int32",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "workVersion": {
                        "description": "Work version number",
                        "format": "int32",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    }
                },
                "type": "object"
            },
            "MdsSearchMetaDataDto": {
                "properties": {
                    "canCreate": {
                        "nullable": true,
                        "type": "boolean"
                    }
                },
                "type": "object"
            },
            "MdsVersionDto": {
                "properties": {
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "listOfAnswers": {
                        "items": {
                            "$ref": "#/components/schemas/MdsAnswerDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfDocument": {
                        "items": {
                            "$ref": "#/components/schemas/DocumentDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfObservations": {
                        "items": {
                            "$ref": "#/components/schemas/MdsObservationDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "listOfPersonInCharge": {
                        "items": {
                            "$ref": "#/components/schemas/MdsPersonInChargeDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "versionInfo": {
                        "$ref": "#/components/schemas/VersionInfoDto"
                    }
                },
                "type": "object"
            },
            "MetadataDto": {
                "properties": {
                    "canImportFromExcel": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "compareChaptersDto": {
                        "items": {
                            "$ref": "#/components/schemas/CompareChapterDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "compareDto": {
                        "items": {
                            "$ref": "#/components/schemas/CompareDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "disabledFundIds": {
                        "items": {
                            "format": "int64",
                            "type": "integer"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "editablePagesDto": {
                        "$ref": "#/components/schemas/EditablePagesDto"
                    },
                    "editableSectionsDto": {
                        "$ref": "#/components/schemas/EditableSectionsDto"
                    },
                    "exportExtraDto": {
                        "$ref": "#/components/schemas/ExportExtraDto"
                    },
                    "nextActionsDtoList": {
                        "items": {
                            "$ref": "#/components/schemas/NextActionsDto"
                        },
                        "nullable": true,
                        "type": "array"
                    }
                },
                "type": "object"
            },
            "MvoSummaryDto": {
                "properties": {
                    "cci": {
                        "nullable": true,
                        "type": "string"
                    },
                    "currentNodeCode": {
                        "nullable": true,
                        "type": "string"
                    },
                    "currentNodeId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "ownerNodeCode": {
                        "nullable": true,
                        "type": "string"
                    },
                    "ownerNodeId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "previousNodeCode": {
                        "nullable": true,
                        "type": "string"
                    },
                    "previousNodeId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "statusCode": {
                        "nullable": true,
                        "type": "string"
                    },
                    "statusDate": {
                        "description": "Status date",
                        "format": "date-time",
                        "nullable": true,
                        "type": "string"
                    },
                    "statusId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "version": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "workVersion": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    }
                },
                "type": "object"
            },
            "NextActionsDto": {
                "properties": {
                    "actionCode": {
                        "maxLength": 3,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "confirmationRequired": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "hideActionButton": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "id": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "inMoreActionsButton": {
                        "nullable": true,
                        "type": "boolean"
                    }
                },
                "type": "object"
            },
            "ParseError": {
                "properties": {
                    "args": {
                        "items": {
                            "type": "object"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "column": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "message": {
                        "nullable": true,
                        "type": "string"
                    },
                    "row": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    }
                },
                "type": "object"
            },
            "ProgrammeDto": {
                "properties": {
                    "cci": {
                        "maxLength": 15,
                        "minLength": 15,
                        "nullable": true,
                        "type": "string"
                    },
                    "englishTitle": {
                        "maxLength": 383,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "versions": {
                        "items": {
                            "format": "int32",
                            "type": "integer"
                        },
                        "nullable": true,
                        "type": "array"
                    }
                },
                "type": "object"
            },
            "ReferenceDataDtoInterface": {
                "description": "list of possible document types meta for the current document type",
                "properties": {
                    "code": {
                        "nullable": true,
                        "type": "string"
                    }
                },
                "readOnly": true,
                "type": "object"
            },
            "RequestRevisionByEcDto": {
                "properties": {
                    "listOfAresDocuments": {
                        "items": {
                            "$ref": "#/components/schemas/AresDocumentDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "reason": {
                        "maxLength": 2000,
                        "minLength": 0,
                        "type": "string"
                    }
                },
                "required": [
                    "reason"
                ],
                "type": "object"
            },
            "ReturnMsModificationDto": {
                "properties": {
                    "reason": {
                        "maxLength": 2000,
                        "minLength": 0,
                        "type": "string"
                    }
                },
                "required": [
                    "reason"
                ],
                "type": "object"
            },
            "SendActionMetadataDto": {
                "properties": {
                    "attachmentDownloadUrl": {
                        "description": "The attachment download base url. The {docAttId} from the listOfDocumentAttachments needs to be appended to get the full url for download.",
                        "example": "12345/general/documents/12346/attachments",
                        "maxLength": 2048,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "listOfDocumentAttachments": {
                        "description": "list of snapshot attachments. This will only be returned on the highest MS node.",
                        "items": {
                            "$ref": "#/components/schemas/DocumentAttachmentDto"
                        },
                        "nullable": true,
                        "readOnly": true,
                        "type": "array"
                    },
                    "lowerMsNode": {
                        "description": "Indicates if the current node is a lower MS node or not",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    },
                    "requiresEuloginSignature": {
                        "description": "Indication whether the eulogin signature is required for this action or not",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    }
                },
                "type": "object"
            },
            "SendDocumentDtoMetadata": {
                "properties": {
                    "actionId": {
                        "description": "Indicates the Send Document Action id linked to this Object type",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "requiresEuloginSignature": {
                        "description": "Indication whether the eulogin signature is required for this action or not",
                        "nullable": true,
                        "readOnly": true,
                        "type": "boolean"
                    }
                },
                "type": "object"
            },
            "SfcObjectStatusHistoryDto": {
                "properties": {
                    "actionId": {
                        "format": "int64",
                        "type": "integer"
                    },
                    "comments": {
                        "maxLength": 2000,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "currentNodeId": {
                        "format": "int64",
                        "type": "integer"
                    },
                    "email": {
                        "maxLength": 256,
                        "minLength": 0,
                        "type": "string"
                    },
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "nameAndSurname": {
                        "maxLength": 512,
                        "minLength": 0,
                        "type": "string"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "previousNodeId": {
                        "format": "int64",
                        "type": "integer"
                    },
                    "statusId": {
                        "format": "int64",
                        "type": "integer"
                    }
                },
                "required": [
                    "actionId",
                    "currentNodeId",
                    "email",
                    "nameAndSurname",
                    "previousNodeId",
                    "statusId"
                ],
                "type": "object"
            },
            "TempFileDto": {
                "properties": {
                    "filename": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "TocDto": {
                "properties": {
                    "childrenCrcValue": {
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "code": {
                        "maxLength": 20,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "crcValue": {
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "disabled": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "hasContent": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "helpI18nCode": {
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "highlighted": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "hintI18nCode": {
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "id": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "key": {
                        "maxLength": 1024,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "nameArguments": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "nameI18nCode": {
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "orderBy": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "orderByChar": {
                        "maxLength": 256,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "parentTocId": {
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "staticItem": {
                        "nullable": true,
                        "type": "boolean"
                    },
                    "subtitle1I18nCode": {
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "subtitle2I18nCode": {
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "titleArguments": {
                        "maxLength": 3000,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "titleI18nCode": {
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "tocItemArguments": {
                        "maxLength": 1000,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "tocItemOrderBy": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "tooltipI18nCode": {
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "url": {
                        "maxLength": 20,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "ValidationResultDto": {
                "properties": {
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "orderBy": {
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "resultI18nCode": {
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "ruleI18nCode": {
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "severityCode": {
                        "maxLength": 5,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "severityI18nCode": {
                        "description": "Denormalization of the serverityCode to be able to immediately translate the severity code.",
                        "maxLength": 128,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    },
                    "validationResultParameters": {
                        "items": {
                            "$ref": "#/components/schemas/ValidationResultParameterDto"
                        },
                        "nullable": true,
                        "type": "array"
                    },
                    "validationRuleCode": {
                        "maxLength": 20,
                        "minLength": 0,
                        "nullable": true,
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "ValidationResultParameterDto": {
                "properties": {
                    "type": {
                        "description": "Type of the parameter",
                        "enum": [
                            "BIGDECIMAL",
                            "DATE",
                            "DATE_TIME",
                            "I18N",
                            "I18N_LIST",
                            "LONG",
                            "STRING"
                        ],
                        "nullable": true,
                        "type": "string"
                    },
                    "value": {
                        "description": "Value of the parameter. Note that for BIGDECIMAL the value is returned as a string to avoid the limitation in precission that can happen in the JSON or in the client application language. For example depending on the type: STRING('abc'), I18N('fund.ESF'), I18N_LIST('fund.ESF,fund.CF'), LONG( 1234 ), BIGDECIMAL('123.12'), DATE('2024-03-14'), DATE_TIME('2024-03-14T14:06:57.275651600')",
                        "nullable": true,
                        "type": "object"
                    }
                },
                "type": "object"
            },
            "VersionInfoDto": {
                "properties": {
                    "cci": {
                        "description": "CCI of the Porgramme linked to this Material Deprivation Survey",
                        "type": "string"
                    },
                    "currentNodeId": {
                        "description": "Current node id",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "englishTitle": {
                        "description": "The english title",
                        "maxLength": 256,
                        "minLength": 0,
                        "type": "string"
                    },
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "languageId": {
                        "description": "The source language identifier",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    },
                    "originalNodeId": {
                        "description": "Original node id",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "ownerNodeId": {
                        "description": "Owner node id",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "statusDate": {
                        "description": "Status date",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "statusId": {
                        "description": "Status id",
                        "format": "int64",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "version": {
                        "description": "The version",
                        "format": "int32",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    },
                    "workVersion": {
                        "description": "The work version",
                        "format": "int32",
                        "nullable": true,
                        "readOnly": true,
                        "type": "integer"
                    }
                },
                "required": [
                    "cci",
                    "englishTitle"
                ],
                "type": "object"
            },
            "VersionInfoUpdateDto": {
                "properties": {
                    "id": {
                        "description": "Object Identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "languageId": {
                        "description": "The source language identifier",
                        "format": "int64",
                        "nullable": true,
                        "type": "integer"
                    },
                    "modificationDate": {
                        "description": "last modification date (read-only)",
                        "format": "date-time",
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "modificationUser": {
                        "description": "last modification user (read-only)",
                        "maxLength": 30,
                        "minLength": 0,
                        "nullable": true,
                        "readOnly": true,
                        "type": "string"
                    },
                    "optimisticLock": {
                        "description": "This property can be used to detect conflicting updates, and prevent the loss of updates that would be overwritten by a last-commit-wins strategy.",
                        "format": "int32",
                        "nullable": true,
                        "type": "integer"
                    }
                },
                "type": "object"
            }
        },
        "securitySchemes": {
            "sfcBearerAuthentication": {
                "bearerFormat": "JWT",
                "in": "header",
                "scheme": "bearer",
                "type": "http"
            }
        }
    },
    "info": {
        "contact": {
            "email": "EC-SFC2021-INFO@ec.europa.eu",
            "name": "Support",
            "url": "https://ec.europa.eu/sfc/en/2021/webservices"
        },
        "description": "This is the swagger documentation for the mds-api for the SFC2021 frontoffice system.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).   ",
        "title": "SFC2021 mds-api",
        "version": "3.8.0"
    },
    "openapi": "3.0.1",
    "paths": {
        "/mds-api/cci-search": {
            "get": {
                "description": "Returns a list of objects that are relevant to the specified cci.",
                "operationId": "searchCci",
                "parameters": [
                    {
                        "in": "query",
                        "name": "cci",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/CciSearchResultDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Search for a specific cci",
                "tags": [
                    "Cci Search"
                ]
            }
        },
        "/mds-api/commission-reference-document/{commissionReferenceNumber}": {
            "get": {
                "description": "Get Commission Reference Document.",
                "operationId": "getHRSPA",
                "parameters": [
                    {
                        "in": "path",
                        "name": "commissionReferenceNumber",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/DocumentDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    },
                    "404": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/DocumentDto"
                                }
                            }
                        },
                        "description": "commission reference document not found"
                    }
                },
                "summary": "Get Commission Reference Document",
                "tags": [
                    "HRS"
                ]
            }
        },
        "/mds-api/document-attachments/{docAttId}": {
            "get": {
                "description": "Returns the document attachment from the database as a outputStream in the response.  (Internal service for the registration module)",
                "operationId": "downloadDocumentAttachment",
                "parameters": [
                    {
                        "in": "path",
                        "name": "docAttId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation"
                    }
                },
                "summary": "Download document attachment file",
                "tags": [
                    "Documents registration"
                ]
            }
        },
        "/mds-api/document-search": {
            "post": {
                "description": "Returns a list of documents that match the specified criteria.",
                "operationId": "searchAllDocuments",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/DocumentSearchParams"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/DocumentSearchDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Search for documents",
                "tags": [
                    "Global Document Search"
                ]
            }
        },
        "/mds-api/document-search/download-all": {
            "post": {
                "description": "Downloads a zip file with all attachments matching the search criteria.",
                "operationId": "downloadAllDocuments",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/DocumentSearchParams"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "successful operation"
                    }
                },
                "summary": "Download all documents",
                "tags": [
                    "Global Document Search"
                ]
            }
        },
        "/mds-api/documents/{documentId}": {
            "get": {
                "description": "Returns the document (Internal service for the registration module)",
                "operationId": "getDocument",
                "parameters": [
                    {
                        "in": "path",
                        "name": "documentId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/DocumentDto"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Returns the document",
                "tags": [
                    "Documents registration"
                ]
            }
        },
        "/mds-api/mds-versions": {
            "get": {
                "description": "Returns the list of  Material Deprivation Surveys Version that are relevant to the external user/system calling this\r\n   * method. The user/system is identified through the common Sfc2021 Authenticator.",
                "operationId": "searchAllMdsVersions",
                "parameters": [
                    {
                        "in": "query",
                        "name": "page",
                        "required": false,
                        "schema": {
                            "default": 0,
                            "format": "int32",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "query",
                        "name": "size",
                        "required": false,
                        "schema": {
                            "format": "int32",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "sort",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/MdsSearchDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Find Material Deprivation Surveys",
                "tags": [
                    "Search"
                ]
            },
            "post": {
                "description": "This method should be used when a user requests the creation of a Material Deprivation Survey object in the SFC system",
                "operationId": "createMdsVersion",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/MdsCreateDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsSearchDto"
                                }
                            }
                        },
                        "description": "Material Deprivation Survey created"
                    },
                    "400": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsSearchDto"
                                }
                            }
                        },
                        "description": "Invalid input"
                    }
                },
                "summary": "Add a new Material Deprivation Survey",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/export": {
            "get": {
                "description": "Export into MS Excel a list of documents.",
                "operationId": "exportMdsVersions",
                "parameters": [
                    {
                        "in": "query",
                        "name": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "query",
                        "name": "sort",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation"
                    }
                },
                "summary": "Export Material Deprivation Survey Versions in excel format",
                "tags": [
                    "Search"
                ]
            }
        },
        "/mds-api/mds-versions/search-metadata": {
            "get": {
                "description": "Returns the meta data contains a flag stating if the user can create a new Material Deprivation Survey version.",
                "operationId": "searchMdsVersionsMetadata",
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsSearchMetaDataDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Returns the search screen meta data.",
                "tags": [
                    "Search"
                ]
            }
        },
        "/mds-api/mds-versions/validation-rules/{mdsVerId}": {
            "get": {
                "description": "Returns the applied validation rules for the Material Deprivation Survey Version with the given MDS id.",
                "operationId": "mdsValidationRules",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/AppliedValidationRulesDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    },
                    "404": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/AppliedValidationRulesDto"
                                }
                            }
                        },
                        "description": "Material Deprivation Survey version not found"
                    }
                },
                "summary": "Returns the applied validation rules for the Material Deprivation Survey.",
                "tags": [
                    "Validation Rules"
                ]
            }
        },
        "/mds-api/mds-versions/version-create-metadata": {
            "get": {
                "description": "Get all metadata needed for the Material Deprivation Survey create action",
                "operationId": "getVersionInformationCreateMetadata",
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsCreateMetadataDto"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Get Material Deprivation Survey create metadata",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{id}/general/documents": {
            "get": {
                "description": "Returns the list of DocumentDto for a given documentable object id.",
                "operationId": "getDocumentsNar",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/DocumentDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "successful operation"
                    },
                    "404": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/DocumentDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "documentable object not found"
                    }
                },
                "summary": "Find the list of Documents linked to a specific documentable object",
                "tags": [
                    "00.5 - General / Documents"
                ]
            },
            "post": {
                "description": "Inserts a document if the user has the permission.",
                "operationId": "insertDocumentMds",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/DocumentDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/DocumentDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Inserts a new document",
                "tags": [
                    "00.5 - General / Documents"
                ]
            }
        },
        "/mds-api/mds-versions/{id}/general/documents/metadata": {
            "get": {
                "description": "Provides the specific metadata for the documents section.",
                "operationId": "getDocumentsMetadataMds",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/DocumentDtoMetadata"
                                }
                            }
                        },
                        "description": "successful operation"
                    },
                    "404": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/DocumentDtoMetadata"
                                }
                            }
                        },
                        "description": "documentable object not found"
                    }
                },
                "summary": "metadata for the documents",
                "tags": [
                    "00.5 - General / Documents"
                ]
            }
        },
        "/mds-api/mds-versions/{id}/general/documents/{documentId}": {
            "delete": {
                "description": "Deletes the document when the document is not sent and the user needs to have the permission to delete the document.",
                "operationId": "deleteDocumentMds",
                "parameters": [
                    {
                        "in": "path",
                        "name": "documentId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation"
                    }
                },
                "summary": "Deletes the document",
                "tags": [
                    "00.5 - General / Documents"
                ]
            },
            "get": {
                "description": "Gets the document if the user has the permission.",
                "operationId": "getDocumentsNarIdDocIdPrg",
                "parameters": [
                    {
                        "in": "path",
                        "name": "documentId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/DocumentDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Retrieves the document",
                "tags": [
                    "00.5 - General / Documents"
                ]
            },
            "put": {
                "description": "Updates the document if the user has the permission.",
                "operationId": "updateDocumentMds",
                "parameters": [
                    {
                        "in": "path",
                        "name": "documentId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/DocumentDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/DocumentDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Updates the document",
                "tags": [
                    "00.5 - General / Documents"
                ]
            }
        },
        "/mds-api/mds-versions/{id}/general/documents/{documentId}/attachments/{docAttId}": {
            "get": {
                "description": "Returns the document attachment from the database as a outputStream in the response. The user needs to have access to be able to download the attachment.",
                "operationId": "downloadDocumentAttachementMds",
                "parameters": [
                    {
                        "in": "path",
                        "name": "docAttId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "documentId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "format": "binary",
                                    "type": "string"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Download document attachment file",
                "tags": [
                    "00.5 - General / Documents"
                ]
            }
        },
        "/mds-api/mds-versions/{id}/general/documents/{documentId}/refresh": {
            "put": {
                "description": "Updates the document with the latest information from Ares. The main purpose is to upload additional translation that might have been added in Ares afterwards. (By the creator or de DMO)",
                "operationId": "refreshDocumentMds",
                "parameters": [
                    {
                        "in": "path",
                        "name": "documentId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/DocumentDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Refresh the document",
                "tags": [
                    "00.5 - General / Documents"
                ]
            }
        },
        "/mds-api/mds-versions/{id}/general/documents/{documentId}/send": {
            "post": {
                "description": "Send the document when the document is not sent, when it's not an integral document and the user has the permission to send the document.",
                "operationId": "sendDocumentMds",
                "parameters": [
                    {
                        "description": "Optional callback for web application use only; It's the URL that was used by EU Login to redirect the browser to after the signature operation took place",
                        "in": "query",
                        "name": "callback",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "description": "Optional signature ID for web application use only; It's the id returned be eu-login after the signature operation took place",
                        "in": "query",
                        "name": "signatureId",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "path",
                        "name": "documentId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation"
                    }
                },
                "summary": "Sends the document",
                "tags": [
                    "00.5 - General / Documents"
                ]
            }
        },
        "/mds-api/mds-versions/{id}/general/documents/{documentId}/send/metadata": {
            "get": {
                "description": "It return the metadata info for the Send aciton of Document.",
                "operationId": "getSendDocumentMetadata",
                "parameters": [
                    {
                        "in": "path",
                        "name": "documentId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/SendDocumentDtoMetadata"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Metadata for the Send action in documents",
                "tags": [
                    "00.5 - General / Documents"
                ]
            }
        },
        "/mds-api/mds-versions/{id}/general/mandatory-documents": {
            "get": {
                "description": "Returns the last version of mandatory documents uploaded against this or previous documentable object versions",
                "operationId": "getMandatoryDocumentsMds",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/DocumentWithVersionInfoDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "successful operation"
                    },
                    "404": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/DocumentWithVersionInfoDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "documentable object not found"
                    }
                },
                "summary": "Find the mandatory documents",
                "tags": [
                    "00.5 - General / Documents"
                ]
            }
        },
        "/mds-api/mds-versions/{id}/tocs": {
            "get": {
                "description": "Returns the Table of Contents entries of Material Deprivation Survey for a given Material Deprivation Survey Version id.",
                "operationId": "tocs",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/TocDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "successful operation"
                    },
                    "404": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/TocDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "Material Deprivation Survey not found"
                    }
                },
                "summary": "Get the table of contents",
                "tags": [
                    "Table of contents"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}": {
            "get": {
                "description": "Returns the Material Deprivation Survey Version for a given Material Deprivation Survey Version id.",
                "operationId": "findMaterialDeprivationSurveyVersion",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsVersionDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    },
                    "404": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsVersionDto"
                                }
                            }
                        },
                        "description": "Deprivation Survey Version not found"
                    }
                },
                "summary": "Find Material Deprivation Survey Version by id",
                "tags": [
                    "Search"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/actions/CRE": {
            "post": {
                "description": "This method should be used when a user wants to create a new version of Material Deprivation Survey. A new version needs to be created when the last version was returned by the Commission.",
                "operationId": "createNewVersion",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsSearchDto"
                                }
                            }
                        },
                        "description": "Create New Version executed"
                    }
                },
                "summary": "Create New Version of a Material Deprivation Survey",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/actions/DEL": {
            "post": {
                "description": "This method should be used when a user wants to delete a Material Deprivation Survey version from the system",
                "operationId": "delete",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "Delete executed"
                    }
                },
                "summary": "Delete Material Deprivation Survey Version",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/actions/EDT": {
            "post": {
                "description": "This method should be used when the user would like to return to the OPEN status without actually editing any data",
                "operationId": "edit",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                },
                "summary": "Edit Material Deprivation Survey Version",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/actions/PSE": {
            "post": {
                "description": "This method should be used when a user on the highest MS Node wants to indicate that the Material Deprivation Survey version can be prepared for sending to the Commission",
                "operationId": "prepareForSendToEc",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "Prepare for Send executed"
                    }
                },
                "summary": "Prepare for Send to EC Material Deprivation Survey Version",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/actions/REO": {
            "post": {
                "description": "This method should be used when a Commission user wants to undo the last action. The notification utility will be called to notify the reopening by the Commission to the Member State and to the Back-Office.",
                "operationId": "reopen",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "Reopen executed"
                    }
                },
                "summary": "Reopen Material Deprivation Survey Version",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/actions/RME": {
            "post": {
                "description": "This use case occurs when a user wants to return the Survey version sent by the Member State/Region because it is incomplete or incorrect. The notification utility will be called to notify the request to the Member State/Region and to the Back-Office",
                "operationId": "requestRevisionByEc",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/RequestRevisionByEcDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "success"
                    },
                    "404": {
                        "description": "version not found"
                    }
                },
                "summary": "Request for Revised Material Deprivation Survey Version by EC",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/actions/RMM": {
            "post": {
                "description": "This method should be used when a user wants to return the Material Deprivation Survey Version sent by the Region because it is incomplete or incorrect and needs to be modified. The notification utility will be called to notify the return to the Region.",
                "operationId": "returnByMsForModification",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ReturnMsModificationDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "201": {
                        "description": "Return by MS executed"
                    }
                },
                "summary": "Return Material Deprivation Survey Version by MS for Modification",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/actions/SND": {
            "post": {
                "description": "This method should be used when a user is ready to send its recorded data on a Material Deprivation Survey version to the Commission or to an upper Node. The notification utility will be called to notify the Commission or the upper Node of the sending of the version.",
                "operationId": "sendToEc",
                "parameters": [
                    {
                        "description": "Optional callback for web application use only; It's the URL that was used by EU Login to redirect the browser to after the signature operation took place",
                        "in": "query",
                        "name": "callback",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "description": "Optional signature ID for web application use only; It's the id returned be eu-login after the signature operation took place",
                        "in": "query",
                        "name": "signatureId",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "Send executed"
                    }
                },
                "summary": "Send to EC Material Deprivation Survey",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/actions/SND/metadata": {
            "get": {
                "operationId": "getSendMetadata",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/SendActionMetadataDto"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Send Material Deprivation Survey metadata",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/actions/VAL": {
            "post": {
                "description": "This method should be used when a user requests an overall validation of the information related to a version of the Material Deprivation Survey Version",
                "operationId": "validate",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "Validation executed"
                    }
                },
                "summary": "Validate Material Deprivation Survey Version",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/general/history": {
            "get": {
                "description": "Returns a history of all actions performed against the Material Deprivation Survey version and the resulting status.",
                "operationId": "getStatusHistory",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/SfcObjectStatusHistoryDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Retrieves the Status History",
                "tags": [
                    "00.3 - General / History"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/general/observations": {
            "get": {
                "description": "Returns a list of all the Observations in a conversation.",
                "operationId": "getListOfObservations",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/MdsObservationDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Get List of Observations",
                "tags": [
                    "00.4- General / Observations"
                ]
            },
            "post": {
                "description": "Creates a new Observation",
                "operationId": "postObservations",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/MdsObservationDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsObservationDto"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Create new Observation",
                "tags": [
                    "00.4- General / Observations"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/general/officials": {
            "get": {
                "description": "Retrieves a list of all the officials in charge",
                "operationId": "getOfficials",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/MdsPersonInChargeDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Get list of Officials in charge",
                "tags": [
                    "00.2 - General / Officials in charge"
                ]
            },
            "post": {
                "description": "Creates a new Official in charge",
                "operationId": "postOfficials",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/MdsPersonInChargeDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsPersonInChargeDto"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Create a new Official",
                "tags": [
                    "00.2 - General / Officials in charge"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/general/officials/{offId}": {
            "delete": {
                "description": "Deletes an existing Official in charge",
                "operationId": "deleteOfficials",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "offId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "type": "boolean"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Delete an Official",
                "tags": [
                    "00.2 - General / Officials in charge"
                ]
            },
            "get": {
                "description": "Retrieves the information for the official in charge specified",
                "operationId": "getOfficial",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "offId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsPersonInChargeDto"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Read Official in charge",
                "tags": [
                    "00.2 - General / Officials in charge"
                ]
            },
            "put": {
                "description": "Updates the information for the Official specified",
                "operationId": "putOfficials",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "offId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/MdsPersonInChargeDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsPersonInChargeDto"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Update Official in charge",
                "tags": [
                    "00.2 - General / Officials in charge"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/general/validation-results": {
            "get": {
                "description": "The list shows the results of the last validation action execution",
                "operationId": "getValidationResults",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/ValidationResultDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Retrieves the list of validation results",
                "tags": [
                    "00.1 - General / Version information"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/general/version-info": {
            "get": {
                "description": "Read Material Deprivation Survey version information",
                "operationId": "getVersionInformation",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/VersionInfoDto"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Read version information",
                "tags": [
                    "00.1 - General / Version information"
                ]
            },
            "put": {
                "description": "Update Material Deprivation Survey version information",
                "operationId": "putVersionInformationIjgGeneral",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/VersionInfoUpdateDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/VersionInfoDto"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Update version information",
                "tags": [
                    "00.1 - General / Version information"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/import": {
            "post": {
                "description": "Imports rows (answers) from an Excel file.",
                "operationId": "importFromExcel",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/TempFileDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/ImportReport"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Excel import.",
                "tags": [
                    "Excel Import"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/import-validate": {
            "post": {
                "description": "Validates the Excel file to be imported.",
                "operationId": "validateImportExcelFile",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/TempFileDto"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/ImportReport"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Excel validation.",
                "tags": [
                    "Excel Import"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/metadata": {
            "get": {
                "description": "Get all possible actions related with the status of a Material Deprivation Survey identified by a given id",
                "operationId": "actionsMetadata",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/NextActionsDto"
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "400": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MetadataDto"
                                }
                            }
                        },
                        "description": "Invalid input"
                    }
                },
                "summary": "Get all possible actions",
                "tags": [
                    "Workflow actions"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/sections/{sectionCode}": {
            "get": {
                "description": "Retrieves answers basing on the Material Deprivation Survey Id and the relative section",
                "operationId": "getAnswers",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "sectionCode",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/MdsAnswerDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "summary": "Read Answers",
                "tags": [
                    "Answers"
                ]
            },
            "put": {
                "description": "Updates answers linked to a Material Deprivation Survey Id and the Toc Item Id",
                "operationId": "updateAnswers",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "sectionCode",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "items": {
                                    "$ref": "#/components/schemas/MdsAnswerDto"
                                },
                                "type": "array"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/MdsAnswerDto"
                                    },
                                    "type": "array"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Update Answers",
                "tags": [
                    "Answers"
                ]
            }
        },
        "/mds-api/mds-versions/{mdsVerId}/sections/{sectionCode}/metadata": {
            "get": {
                "description": "Metadata for the creation/update of the answers",
                "operationId": "getMetadataAnswers",
                "parameters": [
                    {
                        "in": "path",
                        "name": "mdsVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "sectionCode",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MdsAnswerMetadataDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Metadata for Answers",
                "tags": [
                    "Answers"
                ]
            }
        },
        "/mds-api/mds-versions/{narVerId}/summary": {
            "get": {
                "description": "Returns the data to complete the header of the object: cci, status, status date, modification date, modification user, current node, previous node and owner node",
                "operationId": "summary",
                "parameters": [
                    {
                        "in": "path",
                        "name": "narVerId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/MvoSummaryDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Returns the information to fill the summary header of the object.",
                "tags": [
                    "Material Deprivation Survey Summary"
                ]
            }
        },
        "/mds-api/probe/liveness": {
            "get": {
                "description": "Returns the health state of the  Material Deprivation Survey service",
                "operationId": "testApiLiveness",
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "additionalProperties": {
                                        "type": "string"
                                    },
                                    "type": "object"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Liveness page",
                "tags": [
                    "Liveness"
                ]
            }
        },
        "/mds-api/temp-attachment": {
            "post": {
                "description": "Allow to save a file on the server.The returned filename can then be used when manipulating the objects where a file needs to be attached.",
                "operationId": "saveToTempFile",
                "requestBody": {
                    "content": {
                        "multipart/form-data": {
                            "schema": {
                                "properties": {
                                    "file": {
                                        "format": "binary",
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "file"
                                ],
                                "type": "object"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/TempFileDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Saves a given multipart file into a temporary file on the server",
                "tags": [
                    "Files upload"
                ]
            }
        },
        "/mds-api/{id}/global-search/documents/{documentId}": {
            "get": {
                "description": "Gets the document if the user has the permission with the extra option to flag any attachemnts containing the specified text.",
                "operationId": "getDocumentWithTextMarkup",
                "parameters": [
                    {
                        "in": "path",
                        "name": "documentId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "text",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/DocumentDto"
                                }
                            }
                        },
                        "description": "successful operation"
                    }
                },
                "summary": "Retrieves document details for a global search document result",
                "tags": [
                    "Global Document Search"
                ]
            }
        },
        "/mds-api/{id}/global-search/documents/{documentId}/attachments/{docAttId}": {
            "get": {
                "description": "Returns the text of a document attachment from the database and highlights the text specified (if the attachment contains it",
                "operationId": "downloadHighlightedDocumentAttachment",
                "parameters": [
                    {
                        "in": "path",
                        "name": "docAttId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "documentId",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "format": "int64",
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "text",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation"
                    }
                },
                "summary": "Highlight text in an attachment",
                "tags": [
                    "Global Document Search"
                ]
            }
        }
    },
    "security": [
        {
            "sfcBearerAuthentication": [
                "read",
                "write"
            ]
        }
    ],
    "servers": [
        {
            "url": "http://sfc2021.net1.cec.eu.int:8080/sfc2021"
        }
    ]
}