From 4aa3b745e874015a4acf23c998ecd61127164be0 Mon Sep 17 00:00:00 2001 From: ArjunSinghILX Date: Fri, 24 Oct 2025 10:40:09 +0530 Subject: [PATCH] [ILX-57292] Remove section from reference, add index of APIs in their respective method sub pages --- source/includes/acts/delete_api.md | 5 ++- source/includes/acts/get_api.md | 33 +++++++++++++++++++- source/includes/acts/post_api.md | 6 +++- source/includes/acts/reference.md | 49 ------------------------------ 4 files changed, 41 insertions(+), 52 deletions(-) diff --git a/source/includes/acts/delete_api.md b/source/includes/acts/delete_api.md index 22c89770f08..1de0c0df653 100644 --- a/source/includes/acts/delete_api.md +++ b/source/includes/acts/delete_api.md @@ -4,13 +4,16 @@ This section outlines the available Delete APIs designed for modifying ACTS data * To remove the existing records, use the primary key of the record. -In the current release, one DELETE API End point is provided to remove or delete from the following table +As per the current release, DELETE APIs End points are provided to delete from the following tables: * Analysis * Analysis Compound * Emission Factor * Equipment Analysis * Operation +* Regulation +* Requirement +* Requirement Limit DELETE requests to these endpoints should be formatted in JSON. diff --git a/source/includes/acts/get_api.md b/source/includes/acts/get_api.md index 8818c1c9e24..a4cfdabfcc1 100644 --- a/source/includes/acts/get_api.md +++ b/source/includes/acts/get_api.md @@ -1,6 +1,37 @@ ## Retrieve Data -This section outlines the various GET APIs available for fetching data from different tables. Each API provides the capability to retrieve specific data based on provided parameters. Pagination support is available for managing large datasets effectively.The user can pass the set of parameters of same or different filter options at once . +This section outlines the various GET APIs available for fetching data from different tables. Each API provides the capability to retrieve specific data based on provided parameters. Pagination support is available for managing large datasets effectively.The user can pass the set of parameters of same or different filter options at once. + +As per the current release, GET APIs End points are provided to fetch from the following tables: + +* Attribute Type +* Compound +* Emission +* Emission Category +* Emission Factor +* Emission Type +* Equipment +* Equipment Attribute +* Equipment Status +* Equipment Type +* Facility +* Facility Attribute +* Operation +* Operation Type +* Query +* Regulation +* Regulation Type +* Requirement +* Requirement Limit +* Unit +* Workflow +* Workflow Answer +* Workflow Equipment +* Workflow Facility +* Workflow Person +* Workflow Question +* Workflow Question Category +* Workflow Type ### 1. Attribute Type Table diff --git a/source/includes/acts/post_api.md b/source/includes/acts/post_api.md index a651db78911..a01dda3b808 100644 --- a/source/includes/acts/post_api.md +++ b/source/includes/acts/post_api.md @@ -11,7 +11,7 @@ For efficient handling of larger data inserts, it is recommended to perform batc Note that excessively large batch POSTs may encounter throttling or failure, depending on system resources. -In the following release, the POST APIs End points are provided to add or update following: +As per the current release, POST APIs End points are provided to add or update the following tables: * Analysis * Analysis Compound @@ -24,6 +24,9 @@ In the following release, the POST APIs End points are provided to add or update * Facility * Facility Attribute * Operation +* Regulation +* Requirement +* Requirement Limit * Workflow * Workflow Answer * Workflow Equipment @@ -1368,6 +1371,7 @@ IRestResponse response = client.Execute(request); } ``` + ### 14. Requirement Limit Table This section outlines the process of adding new entries or modifying existing records within the Requirement Limit table using the dedicated API endpoint. diff --git a/source/includes/acts/reference.md b/source/includes/acts/reference.md index d08b0290544..0f0b7d3a0bd 100644 --- a/source/includes/acts/reference.md +++ b/source/includes/acts/reference.md @@ -58,52 +58,3 @@ When we make any new changes to the API, we release new versions. The current ve ### ACTS API Software & Certificate Version Details The ACTS API SSL Certification is incompatible with following version of the python 3.10 + . If we use the python version < 3.10 the SSL handshake works for ACTS API.Currently this is considered as one of the limitation. - -### API's and Associated Database Tables - -This ACTS API release includes 23 GET enpoints and 16 POST endpoints, along with the authentication endpoint described earlier. The tables that can be queried and updated are as follows. - -Database Tables supporting GET requests - -1. Attribute Type -2. Compound -3. Emission Category -4. Emission Factor Table -5. Emission Type -6. Equipment -7. Equipment Attribute -8. Equipment Status -9. Equipment Type -10. Facility -11. Facility Attribute -12. Operation -13. Operation Type -14. Query Results -15. Unit -16. Workflow -17. Workflow Answer -18. Workflow Equipment -19. Workflow Facility -20. Workflow Person -21. Workflow Question -22. Workflow Question Category -23. Workflow Type - -Database Tables supporting POST requests - -1. Analysis -2. Analysis Compound -3. Emission Factor -4. Emissions Recalculate By Equipment -5. Emissions Recalculate By Operation -6. Equipment -7. Equipment Analysis -8. Equipment Attribute -9. Facility -10. Facility Attribute -11. Operation -12. Workflow -13. Workflow Answer -14. Workflow Equipment -15. Workflow Facility -16. Workflow Person