Skip to content

[ILX-57292] Remove section from reference, add index of APIs in their respective method sub pages #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ArjunSinghILX merged 1 commit into from
Oct 24, 2025
Merged

[ILX-57292] Remove section from reference, add index of APIs in their respective method sub pages #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion source/includes/acts/delete_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
33 changes: 32 additions & 1 deletion source/includes/acts/get_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 5 additions & 1 deletion source/includes/acts/post_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</aside>

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
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down
49 changes: 0 additions & 49 deletions source/includes/acts/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading