Changelog: noa-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

What's New


    What's Deleted


      What's Deprecated


        What's Changed


        1. POST/noa-api/noa-versions
          • Request

            • Changed body: 'application/json'

              Schema

              Changed property: cciCode (string)

        4.1.0 - 4.2.0

        What's New


        1. GET/noa-api/add-puas Get all ADD_PUA entries from closed notifications for a given CCI code, including the notification sent date (effective deletion date). Used by APR-API.

        What's Deleted


          What's Deprecated


            What's Changed


            1. GET/noa-api/delete-puas Get all DELETE_PUA entries from closed notifications for a given CCI code, including the notification sent date (effective deletion date). Used by DOE-API, APR-API.

              4.0.0 - 4.1.0

              What's New


              1. GET/noa-api/delete-puas Get all DELETE_PUA entries from closed notifications for a given CCI code, including the notification sent date (effective deletion date). Used by DOE-API.
              2. POST/noa-api/delete-puas/mark-incorporated Mark DELETE_PUA entries as incorporated (PUA was actually deleted from CSP)
              3. GET/noa-api/pending-delete-puas Check if a pending DELETE_PUA notification exists for the given intervention and PUA code
              4. GET/noa-api/pending-delete-puas/unincorporated Get unincorporated DELETE_PUA entries for a given CCI code
              5. GET/noa-api/puas Get PUAs for an intervention (REMOVE_PUA cascading selection)

              What's Deleted


                What's Deprecated


                  What's Changed


                  1. POST/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information
                    • Request

                      • Changed body: 'application/json'

                        Schema

                        Added property: deletePuaList (array)

                    • Response

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

                          Schema

                          Added property: deletePuaList (array)

                  2. GET/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information/{detailedInformationId}
                    • Response

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

                          Schema

                          Added property: deletePuaList (array)

                  3. PUT/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information/{detailedInformationId}
                    • Request

                      • Changed body: 'application/json'

                        Schema

                        Added property: deletePuaList (array)

                    • Response

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

                          Schema

                          Added property: deletePuaList (array)

                  4. GET/noa-api/other-amendments/{amendmentId}
                    • Response

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

                          Schema

                          Added property: deletePuaList (array)

                  0.16.0 - 4.0.0

                  What's New


                  1. POST/noa-api/budget-codes/mark-consolidated-generated Mark entries as consolidated codes generated for a specific year
                  2. POST/noa-api/budget-codes/mark-incorporated Mark entries as incorporated into CSP amendment
                  3. POST/noa-api/budget-codes/mark-unincorporated Un-incorporate entries (PUA was deleted from draft amendment)
                  4. GET/noa-api/pending-budget-codes Get pending ADD_PUA entries for budget code generation

                  What's Deleted


                    What's Deprecated


                      What's Changed


                      1. GET/noa-api/other-amendments/pending-budget-codes
                        • Operation ID

                          • Changed getPendingBudgetCodes to getPendingBudgetCodes_1
                      2. GET/noa-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. POST/noa-api/noa-versions/{id}/general/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)

                      4. GET/noa-api/noa-versions/{id}/general/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)

                      5. PUT/noa-api/noa-versions/{id}/general/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/noa-api/noa-versions/{id}/general/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)

                      7. GET/noa-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)

                      0.15.0 - 0.16.0

                      What's New


                      1. GET/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information/budget-codes-impacts null

                      What's Deleted


                        What's Deprecated


                          What's Changed


                          1. DELETE/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information/{detailedInformationId}
                            • Response

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

                                  Schema

                                  Missing property: addPuaList (array)

                                  Missing property: budgetCodeChangeType (string)

                                  Missing property: cspFullVersion (string)

                                  Missing property: dateOfEntry (string)

                                  Missing property: dateOfEntryApplicable (boolean)

                                  Missing property: description (string)

                                  Missing property: id (integer)

                                  Missing property: impactOnAnnualTotalAllocations (boolean)

                                  Missing property: impactOnBudgetCodes (boolean)

                                  Missing property: justificationOutside (string)

                                  Missing property: justificationSpecific (string)

                                  Missing property: justificationSpecificApplicable (boolean)

                                  Missing property: modificationDate (string)

                                  Missing property: modificationUser (string)

                                  Missing property: noaFullVersion (string)

                                  Missing property: noaStatusId (integer)

                                  Missing property: objected (boolean)

                                  Missing property: optimisticLock (integer)

                                  Missing property: reason (string)

                                  Missing property: title (string)

                          2. GET/noa-api/noa-versions/{versionId}
                            • Response

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

                                  Schema

                                  Added property: listOfBudgetCodesImpact (array)

                              • Changed response : [404]//version not found
                                • Changed body: '*/*'

                                  Schema

                                  Added property: listOfBudgetCodesImpact (array)

                          0.14.0 - 0.15.0

                          What's New


                            What's Deleted


                              What's Deprecated


                                What's Changed


                                1. GET/noa-api/contribution-rates
                                  • Description

                                      old: 'Returns the intervention-level contribution rates for the selected intervention. Used in Step 4 of the cascading selection when interventionCategory = RD. Resolves the adopted CSP version from the CCI code.', new: 'Returns the intervention-level contribution rates for the selected intervention. Used in Step 4 of the cascading selection when interventionCategory = RD. Resolves the CSP version from the NOA version.'
                                  • Parameters

                                    • Add noaVersionId in query
                                    • DeletecciCodein query
                                2. GET/noa-api/intervention-types
                                  • Parameters

                                    • Add noaVersionId in query
                                    • DeletecciCodein query
                                3. GET/noa-api/interventions Get interventions filtered by NOA version and type of intervention
                                  • Description

                                      old: 'Returns interventions from the current adopted CSP version for the given CCI code, filtered by the selected TOI ID', new: 'Returns interventions from the CSP version linked to the given NOA version, filtered by the selected TOI ID'
                                  • Parameters

                                    • Add noaVersionId in query
                                    • DeletecciCodein query

                                0.13.0 - 0.14.0

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

                                0.12.0 - 0.13.0

                                What's New


                                1. GET/noa-api/contribution-rates Get contribution rates for an intervention (RD cascading selection)
                                2. GET/noa-api/intervention-categories Get list of intervention categories for cascading selection
                                3. GET/noa-api/intervention-types Get types of intervention filtered by category
                                4. GET/noa-api/interventions Get interventions filtered by CCI code and type of intervention
                                5. POST/noa-api/noa-versions/{versionId}/actions/CLO Close NOA Version by EC
                                6. GET/noa-api/other-amendments/pending-budget-codes Get amendment details with pending budget codes for a CCI code

                                What's Deleted


                                  What's Deprecated


                                    What's Changed


                                    1. POST/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information
                                      • Request

                                        • Changed body: 'application/json'

                                          Schema

                                          Added property: addPuaList (array)

                                          Added property: budgetCodeChangeType (string)

                                      • Response

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

                                            Schema

                                            Added property: addPuaList (array)

                                            Added property: budgetCodeChangeType (string)

                                    2. GET/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information/{detailedInformationId}
                                      • Response

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

                                            Schema

                                            Added property: addPuaList (array)

                                            Added property: budgetCodeChangeType (string)

                                    3. PUT/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information/{detailedInformationId}
                                      • Request

                                        • Changed body: 'application/json'

                                          Schema

                                          Added property: addPuaList (array)

                                          Added property: budgetCodeChangeType (string)

                                      • Response

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

                                            Schema

                                            Added property: addPuaList (array)

                                            Added property: budgetCodeChangeType (string)

                                    4. DELETE/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information/{detailedInformationId}
                                      • Response

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

                                            Schema

                                            Added property: addPuaList (array)

                                            Added property: budgetCodeChangeType (string)

                                    5. GET/noa-api/other-amendments/{amendmentId}
                                      • Response

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

                                            Schema

                                            Added property: addPuaList (array)

                                            Added property: budgetCodeChangeType (string)

                                    0.11.0 - 0.12.0

                                    What's New


                                      What's Deleted


                                        What's Deprecated


                                          What's Changed


                                          1. GET/noa-api/noa-versions/version-create-metadata
                                            • Response

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

                                                  Schema

                                          2. GET/noa-api/noa-versions/{id}/general/documents/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)

                                              • Changed response : [404]//documentable object not found
                                                • 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)

                                          0.10.0 - 0.11.0

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

                                          0.9.0 - 0.10.0

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

                                          0.8.3 - 0.9.0

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

                                          0.7.4 - 0.8.3

                                          What's New


                                            What's Deleted


                                              What's Deprecated


                                                What's Changed


                                                1. POST/noa-api/noa-versions
                                                  • Response

                                                    • Changed response : [200]//NOA created
                                                      • Changed body: '*/*'

                                                        Schema

                                                        Added property: dueDate (string)

                                                    • Changed response : [400]//Invalid input
                                                      • Changed body: '*/*'

                                                        Schema

                                                        Added property: dueDate (string)

                                                2. POST/noa-api/noa-versions/{versionId}/actions/CRE
                                                  • Response

                                                    • Changed response : [201]//Create New Version executed
                                                      • Changed body: '*/*'

                                                        Schema

                                                        Added property: dueDate (string)

                                                3. GET/noa-api/noa-versions/{versionId}/general/version-info
                                                  • Response

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

                                                        Schema

                                                        Added property: dueDate (string)

                                                4. PUT/noa-api/noa-versions/{versionId}/general/version-info
                                                  • Response

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

                                                        Schema

                                                        Added property: dueDate (string)

                                                5. GET/noa-api/noa-versions/{versionId}
                                                  • Response

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

                                                        Schema

                                                        Changed property: versionInfo (object)

                                                        Added property: versionInfo.dueDate (string)

                                                    • Changed response : [404]//version not found
                                                      • Changed body: '*/*'

                                                        Schema

                                                        Changed property: versionInfo (object)

                                                        Added property: versionInfo.dueDate (string)

                                                0.7.3 - 0.7.4

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

                                                0.7.2 - 0.7.3

                                                What's New


                                                  What's Deleted


                                                    What's Deprecated


                                                      What's Changed


                                                      1. POST/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information
                                                        • Request

                                                          • Changed body: 'application/json'

                                                            Schema

                                                            Added property: impactOnAnnualTotalAllocations (boolean)

                                                            Added property: impactOnBudgetCodes (boolean)

                                                        • Response

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

                                                              Schema

                                                              Added property: impactOnAnnualTotalAllocations (boolean)

                                                              Added property: impactOnBudgetCodes (boolean)

                                                      2. GET/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information/{detailedInformationId}
                                                        • Response

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

                                                              Schema

                                                              Added property: impactOnAnnualTotalAllocations (boolean)

                                                              Added property: impactOnBudgetCodes (boolean)

                                                      3. PUT/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information/{detailedInformationId}
                                                        • Request

                                                          • Changed body: 'application/json'

                                                            Schema

                                                            Added property: impactOnAnnualTotalAllocations (boolean)

                                                            Added property: impactOnBudgetCodes (boolean)

                                                        • Response

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

                                                              Schema

                                                              Added property: impactOnAnnualTotalAllocations (boolean)

                                                              Added property: impactOnBudgetCodes (boolean)

                                                      4. DELETE/noa-api/noa-versions/{noaVersionId}/other-amendments/detailed-information/{detailedInformationId}
                                                        • Response

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

                                                              Schema

                                                              Added property: impactOnAnnualTotalAllocations (boolean)

                                                              Added property: impactOnBudgetCodes (boolean)

                                                      5. GET/noa-api/other-amendments/{amendmentId}
                                                        • Response

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

                                                              Schema

                                                              Added property: impactOnAnnualTotalAllocations (boolean)

                                                              Added property: impactOnBudgetCodes (boolean)

                                                      0.7.1 - 0.7.2

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

                                                      0.7.0 - 0.7.1

                                                      What's New


                                                      1. GET/noa-api/noa-versions/{id}/tocsWithCrcCheck Checks crcs before returning tocs

                                                      What's Deleted


                                                        What's Deprecated


                                                          What's Changed


                                                          1. GET/noa-api/noa-versions/{id}/tocs
                                                            • Parameters

                                                              • Add sourceLanguageCode in query
                                                              • Add targetLanguageCode in query
                                                          2. GET/noa-api/noa-versions/{versionId}/general/version-info
                                                            • Response

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

                                                                  Schema

                                                                  Missing property: noAuthComments (integer)

                                                                  Missing property: noAuthReview (integer)

                                                          3. PUT/noa-api/noa-versions/{versionId}/general/version-info
                                                            • Request

                                                              • Changed body: 'application/json'

                                                                Schema

                                                                Missing property: noAuthComments (integer)

                                                                Missing property: noAuthReview (integer)

                                                            • Response

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

                                                                  Schema

                                                                  Missing property: noAuthComments (integer)

                                                                  Missing property: noAuthReview (integer)

                                                          4. GET/noa-api/noa-versions/{versionId}
                                                            • Response

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

                                                                  Schema

                                                                  Changed property: versionInfo (object)

                                                                  Missing property: versionInfo.noAuthComments (integer)

                                                                  Missing property: versionInfo.noAuthReview (integer)

                                                              • Changed response : [404]//version not found
                                                                • Changed body: '*/*'

                                                                  Schema

                                                                  Changed property: versionInfo (object)

                                                                  Missing property: versionInfo.noAuthComments (integer)

                                                                  Missing property: versionInfo.noAuthReview (integer)

                                                          0.6.0 - 0.7.0

                                                          What's New


                                                          1. GET/noa-api/other-amendments/{amendmentId} null

                                                          What's Deleted


                                                            What's Deprecated


                                                              What's Changed


                                                                0.5.0 - 0.6.0

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

                                                                0.4.0 - 0.5.0

                                                                What's New


                                                                  What's Deleted


                                                                    What's Deprecated


                                                                      What's Changed


                                                                      1. GET/noa-api/other-amendments
                                                                        • Parameters

                                                                          • Add majorVersions in query
                                                                          • DeletemajorVersionin query