Changelog: document-api (Group: ALL)

4.3.0 - 4.4.0

This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

4.2.0 - 4.3.0

This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

4.1.0 - 4.2.0

What's New

    What's Deleted

      What's Deprecated

        What's Changed

        1. GET/document-api/document-groups/{id}/documents/{documentId}/actions/RPL/metadata

          • Response

            • Changed response : [200]//OK
              • Changed body: '*/*'

                Schema

                Changed property: ackBy (string)

                Changed property: ackByEmail (string)

                Changed property: commissionReference (string)

                Changed property: localReference (string)

                Changed property: modificationUserEmail (string)

                Changed property: sentBy (string)

                Changed property: sentByEmail (string)

                Changed property: sentByUserId (string)

                Changed property: title (string)

        4.0.0 - 4.1.0

        What's New

          What's Deleted

            What's Deprecated

              What's Changed

              1. GET/document-api/document-groups/{id}/documents/{documentId}/actions/RPL/metadata

                • Response

                  • Changed response : [200]//OK
                    • Changed body: '*/*'

                      Schema

                      Added property: ackBy (string)

                      Added property: ackByEmail (string)

                      Added property: ackDate (string)

                      Added property: commissionReference (string)

                      Added property: countryId (integer)

                      Added property: documentDate (string)

                      Added property: documentGroupId (integer)

                      Added property: documentId (integer)

                      Added property: documentTypeId (integer)

                      Added property: listOfDocumentAttachments (array)

                      Added property: listOfDocumentLinks (array)

                      Added property: listOfDocumentMetaData (array)

                      Added property: listOfNotValidLinks (array)

                      Added property: listOfRepliesFromDocument (array)

                      Added property: localReference (string)

                      Added property: modificationUserEmail (string)

                      Added property: ownerNodeId (integer)

                      Added property: parentDocumentId (integer)

                      Added property: repliesToDocument (object)

                      Added property: sentBy (string)

                      Added property: sentByEmail (string)

                      Added property: sentByUserId (string)

                      Added property: sentDate (string)

                      Added property: title (string)

              3.62.0 - 4.0.0

              What's New

                What's Deleted

                  What's Deprecated

                  1. GET/document-api/document-groups/{id}/documents/{documentId}/tocs Retrieves the toc for the document

                  What's Changed

                  1. GET/document-api/document-groups/{id}/documents/{documentId}/tocs

                    • Description

                        old: 'Gets the table of content for the document.', new: 'Deprecated: front-end doesn't need this anymore'
                  2. GET/document-api/commission-reference-document/{commissionReferenceNumber}

                    • Response

                      • Changed response : [200]//successful operation
                        • Changed body: '*/*'

                          Schema

                          Changed property: deletable (boolean)

                          Changed property: editable (boolean)

                          Changed property: isReferring (boolean)

                          Changed property: sendEnabled (boolean)

                          Changed property: sentDocumentAcknowledgeable (boolean)

                          Changed property: sentDocumentEditable (boolean)

                          Changed property: sentDocumentRefreshable (boolean)

                          Changed property: tabLabel (string)

                      • Changed response : [404]//commission reference document not found
                        • Changed body: '*/*'

                          Schema

                          Changed property: deletable (boolean)

                          Changed property: editable (boolean)

                          Changed property: isReferring (boolean)

                          Changed property: sendEnabled (boolean)

                          Changed property: sentDocumentAcknowledgeable (boolean)

                          Changed property: sentDocumentEditable (boolean)

                          Changed property: sentDocumentRefreshable (boolean)

                          Changed property: tabLabel (string)

                  3. GET/document-api/commission-references/{commissionReferenceNumber}

                    • Response

                      • Changed response : [200]//successful operation
                        • Changed body: '*/*'

                          Schema

                          Changed property: deletable (boolean)

                          Changed property: editable (boolean)

                          Changed property: isReferring (boolean)

                          Changed property: sendEnabled (boolean)

                          Changed property: sentDocumentAcknowledgeable (boolean)

                          Changed property: sentDocumentEditable (boolean)

                          Changed property: sentDocumentRefreshable (boolean)

                          Changed property: tabLabel (string)

                      • Changed response : [404]//documentable object version or document commission reference not found
                        • Changed body: '*/*'

                          Schema

                          Changed property: deletable (boolean)

                          Changed property: editable (boolean)

                          Changed property: isReferring (boolean)

                          Changed property: sendEnabled (boolean)

                          Changed property: sentDocumentAcknowledgeable (boolean)

                          Changed property: sentDocumentEditable (boolean)

                          Changed property: sentDocumentRefreshable (boolean)

                          Changed property: tabLabel (string)

                  4. POST/document-api/document-groups/{id}/documents

                    • Response

                      • Changed response : [200]//successful operation
                        • Changed body: '*/*'

                          Schema

                          Changed property: deletable (boolean)

                          Changed property: editable (boolean)

                          Changed property: isReferring (boolean)

                          Changed property: sendEnabled (boolean)

                          Changed property: sentDocumentAcknowledgeable (boolean)

                          Changed property: sentDocumentEditable (boolean)

                          Changed property: sentDocumentRefreshable (boolean)

                          Changed property: tabLabel (string)

                  5. GET/document-api/document-groups/{id}/documents/{documentId}

                    • Response

                      • Changed response : [200]//successful operation
                        • Changed body: '*/*'

                          Schema

                          Changed property: deletable (boolean)

                          Changed property: editable (boolean)

                          Changed property: isReferring (boolean)

                          Changed property: sendEnabled (boolean)

                          Changed property: sentDocumentAcknowledgeable (boolean)

                          Changed property: sentDocumentEditable (boolean)

                          Changed property: sentDocumentRefreshable (boolean)

                          Changed property: tabLabel (string)

                  6. PUT/document-api/document-groups/{id}/documents/{documentId}

                    • Response

                      • Changed response : [200]//successful operation
                        • Changed body: '*/*'

                          Schema

                          Changed property: deletable (boolean)

                          Changed property: editable (boolean)

                          Changed property: isReferring (boolean)

                          Changed property: sendEnabled (boolean)

                          Changed property: sentDocumentAcknowledgeable (boolean)

                          Changed property: sentDocumentEditable (boolean)

                          Changed property: sentDocumentRefreshable (boolean)

                          Changed property: tabLabel (string)

                  7. POST/document-api/document-groups/{id}/documents/{documentId}/actions/RPL

                    • Response

                      • Changed response : [200]//OK
                        • Changed body: '*/*'

                          Schema

                          Changed property: deletable (boolean)

                          Changed property: editable (boolean)

                          Changed property: isReferring (boolean)

                          Changed property: sendEnabled (boolean)

                          Changed property: sentDocumentAcknowledgeable (boolean)

                          Changed property: sentDocumentEditable (boolean)

                          Changed property: sentDocumentRefreshable (boolean)

                          Changed property: tabLabel (string)

                  8. PUT/document-api/document-groups/{id}/documents/{documentId}/refresh

                    • Response

                      • Changed response : [200]//successful operation
                        • Changed body: '*/*'

                          Schema

                          Changed property: deletable (boolean)

                          Changed property: editable (boolean)

                          Changed property: isReferring (boolean)

                          Changed property: sendEnabled (boolean)

                          Changed property: sentDocumentAcknowledgeable (boolean)

                          Changed property: sentDocumentEditable (boolean)

                          Changed property: sentDocumentRefreshable (boolean)

                          Changed property: tabLabel (string)

                  9. GET/document-api/{id}/global-search/documents/{documentId}

                    • Response

                      • Changed response : [200]//successful operation
                        • Changed body: '*/*'

                          Schema

                          Changed property: deletable (boolean)

                          Changed property: editable (boolean)

                          Changed property: isReferring (boolean)

                          Changed property: sendEnabled (boolean)

                          Changed property: sentDocumentAcknowledgeable (boolean)

                          Changed property: sentDocumentEditable (boolean)

                          Changed property: sentDocumentRefreshable (boolean)

                          Changed property: tabLabel (string)

                  10. GET/document-api/document-groups/{id}/documents/{documentId}/actions/RPL/metadata

                    • Response

                      • Changed response : [200]//OK
                        • Changed body: '*/*'

                          Schema

                          Added property: deletable (boolean)

                          Added property: editable (boolean)

                          Added property: isReferring (boolean)

                          Added property: sendEnabled (boolean)

                          Added property: sent (boolean)

                          Added property: sentDocumentAcknowledgeable (boolean)

                          Added property: sentDocumentEditable (boolean)

                          Added property: sentDocumentRefreshable (boolean)

                  3.61.0 - 3.62.0

                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                  3.60.0 - 3.61.0

                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                  3.59.0 - 3.60.0

                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                  3.58.0 - 3.59.0

                  What's New

                    What's Deleted

                      What's Deprecated

                        What's Changed

                        1. GET/document-api/document-groups/{id}/documents/{documentId}/actions/RPL/metadata

                          • Response

                            • Changed response : [200]//OK
                              • Changed body: '*/*'

                                Schema

                                Changed property: tabLabel (string)

                        3.57.0 - 3.58.0

                        What's New

                          What's Deleted

                            What's Deprecated

                            1. GET/document-api/document-groups/{id}/documents/{documentId}/metadata-permission metadata for permission of the document

                            What's Changed

                            1. GET/document-api/document-groups/{id}/documents/create-metadata

                              • Response

                                • Changed response : [200]//successful operation
                                  • Changed body: '*/*'

                                    Schema

                                    Added property: canImportFromExcel (boolean)

                                    Added property: compareChaptersDto (array)

                                    Added property: compareDto (array)

                                    Added property: disabledFundIds (array)

                                    Added property: editablePagesDto (object)

                                    Added property: editableSectionsDto (object)

                                    Added property: exportExtraDto (object)

                                    Added property: nextActionsDtoList (array)

                            2. GET/document-api/document-groups/{id}/documents/search-metadata

                              • Response

                                • Changed response : [200]//successful operation
                                  • Changed body: '*/*'

                                    Schema

                                    Added property: canImportFromExcel (boolean)

                                    Added property: compareChaptersDto (array)

                                    Added property: compareDto (array)

                                    Added property: disabledFundIds (array)

                                    Added property: editablePagesDto (object)

                                    Added property: editableSectionsDto (object)

                                    Added property: exportExtraDto (object)

                                    Added property: nextActionsDtoList (array)

                            3. GET/document-api/document-groups/{id}/documents/{documentId}/actions/RPL/metadata

                              • Response

                                • Changed response : [200]//OK
                                  • Changed body: '*/*'

                                    Schema

                                    Added property: canImportFromExcel (boolean)

                                    Added property: compareChaptersDto (array)

                                    Added property: compareDto (array)

                                    Added property: disabledFundIds (array)

                                    Added property: editablePagesDto (object)

                                    Added property: editableSectionsDto (object)

                                    Added property: exportExtraDto (object)

                                    Added property: tabLabel (string)

                            4. GET/document-api/document-groups/{id}/documents/{documentId}/metadata

                              • Description

                                  old: 'Provides the specific metadata for the document.', new: 'Provides the specific metadata for the document, including permission metadata.'

                              • Response

                                • Changed response : [200]//successful operation
                                  • Changed body: '*/*'

                                    Schema

                                    Added property: canImportFromExcel (boolean)

                                    Added property: compareChaptersDto (array)

                                    Added property: compareDto (array)

                                    Added property: disabledFundIds (array)

                                    Added property: editablePagesDto (object)

                                    Added property: editableSectionsDto (object)

                                    Added property: exportExtraDto (object)

                                    Added property: nextActionsDtoList (array)

                            5. GET/document-api/document-groups/{id}/documents/{documentId}/metadata-permission

                              • Description

                                  old: 'Provides the specific metadata for the document's permission.', new: 'Deprecated: use the /metadata endpoint instead. Provides the specific metadata for the document's permission.'

                            3.56.0 - 3.57.0

                            This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                            3.55.0 - 3.56.0

                            This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                            3.54.0 - 3.55.0

                            What's New

                            1. GET/document-api/global-search/document-search/{compositeId} Return a specific document from its compositeId
                            2. GET/document-api/global-search/document-search/{compositeId}/attachments/{docAttId} Download document attachment file
                            3. GET/document-api/global-search/document-search/{compositeId}/metadata Return the metadata for a specific document from its compositeId

                            What's Deleted

                              What's Deprecated

                                What's Changed

                                  3.53.0 - 3.54.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.52.0 - 3.53.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.51.0 - 3.52.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.50.0 - 3.51.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.49.0 - 3.50.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.48.0 - 3.49.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.47.0 - 3.48.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.46.0 - 3.47.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.45.0 - 3.46.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.44.0 - 3.45.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.43.0 - 3.44.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.42.0 - 3.43.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.41.0 - 3.42.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.40.0 - 3.41.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.39.0 - 3.40.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.38.0 - 3.39.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.37.0 - 3.38.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.36.0 - 3.37.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.35.0 - 3.36.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.34.0 - 3.35.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.33.0 - 3.34.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.32.0 - 3.33.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.31.0 - 3.32.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.30.0 - 3.31.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.29.0 - 3.30.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.28.0 - 3.29.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.27.0 - 3.28.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.26.0 - 3.27.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.25.0 - 3.26.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.24.0 - 3.25.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.23.0 - 3.24.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.22.0 - 3.23.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.21.0 - 3.22.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.20.0 - 3.21.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.19.0 - 3.20.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.18.0 - 3.19.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.17.0 - 3.18.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.16.0 - 3.17.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.15.0 - 3.16.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.14.0 - 3.15.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.13.0 - 3.14.0

                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                  3.12.0 - 3.13.0

                                  What's New

                                    What's Deleted

                                      What's Deprecated

                                        What's Changed

                                        1. GET/document-api/commission-reference-document/{commissionReferenceNumber}

                                          • Description

                                              old: 'Provides the commission reference document in a documentDto model. (only to be used by EC users)', new: 'Provides the commission reference document in a documentDto model. (only to be used by EC users)The documentTypeId can optionally be given to determine if the rendition version is needed or the original version.'

                                          • Parameters

                                            • Add documentTypeId in query

                                        3.11.0 - 3.12.0

                                        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                        3.10.0 - 3.11.0

                                        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                        3.9.0 - 3.10.0

                                        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                        3.8.0 - 3.9.0

                                        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                        3.7.0 - 3.8.0

                                        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                        3.6.0 - 3.7.0

                                        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                        3.5.0 - 3.6.0

                                        What's New

                                          What's Deleted

                                            What's Deprecated

                                              What's Changed

                                              1. POST/document-api/document-search/download-all

                                                • Operation ID

                                                  • Changed downloadAllDocuments_1 to downloadAllDocuments
                                              2. POST/document-api/global-search/document-search/download-all

                                                • Operation ID

                                                  • Changed downloadAllDocuments to downloadAllDocumentsFromGlobalSearch
                                              3. POST/document-api/global-search/document-search/export

                                                • Operation ID

                                                  • Changed exportDocuments to exportDocumentsFromGlobalSearch

                                              3.2.1 - 3.5.0

                                              What's New

                                              1. POST/document-api/document-search/download-all Download all documents
                                              2. POST/document-api/global-search/document-search Search for documents
                                              3. POST/document-api/global-search/document-search/download-all Download all documents
                                              4. POST/document-api/global-search/document-search/export Export search results

                                              What's Deleted

                                                What's Deprecated

                                                  What's Changed

                                                  1. POST/document-api/document-search

                                                    • Request

                                                      • Changed body: 'application/json'

                                                        Schema

                                                        Added property: empty (boolean)

                                                        Added property: page (integer)

                                                        Added property: size (integer)

                                                  3.2.0 - 3.2.1

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.