Skip to content

Commit 486e680

Browse files
AkshayaKumarIntelexAkshaya Kumar
andauthored
[feature-ILX-45346] - Updated the Doc based on review (#12)
* Added Latest APIs to the api/docs * Updated the latest set of new api's along with filter options * Changes based on PR review comments * Alignment and extra data removal * Alignment Changes & Alphabetical Rearrangements * Review Comments Fix --------- Co-authored-by: Akshaya Kumar <Akshaya Kumar@DESKTOP-TIGJLBP>
1 parent 359f4c1 commit 486e680

File tree

4 files changed

+118
-48
lines changed

4 files changed

+118
-48
lines changed

source/includes/_acts-api.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# ACTS API
22

33
The ACTS API gives you the ability to retrieve or update data of selected database tables in ACTS product.
4-
5-
The ACTS API is currently in beta. This means that we might make changes to the data returned or how requests are made with future releases. Once the beta tag is removed, breaking changes to this API will be [versioned](#acts-api-versioning).

source/includes/acts/get_api.md

Lines changed: 103 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## Retrieve data from Database Table
22

3-
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.
3+
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 .
44

55
### 1. Attribute Type Table
66

7-
This section outlines the process of retrieving data from the Attribute Type table using the dedicated API endpoint. The endpoint facilitates the retrieval of all data from the Attribute Type table or enables the selection of specific information by including Attribute IDs and Attribute Types. Additionally, the Attribute Type endpoint supports pagination to effectively manage larger datasets.
7+
This section outlines the process of retrieving data from the Attribute Type table using the dedicated API endpoint. The endpoint facilitates the retrieval of all data from the Attribute Type table or enables the selection of specific information by including Attribute Ids and Attribute Types. Additionally, the Attribute Type endpoint supports pagination to effectively manage larger datasets.
88

99
> Example Request
1010
@@ -77,12 +77,12 @@ Attribute | Type | Description
7777
--------- | ---- | -----------
7878
PageNumber | int | Page number of the results to fetch.
7979
PageSize | int | The number of results per page
80-
attributeTypeIDs | int | Attribute ID is one of the filter parameter is a integer data type
80+
attributeTypeIds | int | Attribute ID is one of the filter parameter is a integer data type
8181
attributeTypes | string | Attribute Types is for the project detail type
8282

8383
### 2. Compound API Table
8484

85-
This section guides you through the process of fetching data from the Compound table using the dedicated API endpoint. The endpoint offers the flexibility to retrieve all data from the Compound table or selectively acquire information by including Compound IDs, Compound Type IDs, Compound Status IDs, Compound Names, External Identifiers, or CAS Numbers. Additionally, the Compound endpoint is equipped with pagination capabilities to facilitate efficient management of substantial datasets.
85+
This section guides you through the process of fetching data from the Compound table using the dedicated API endpoint. The endpoint offers the flexibility to retrieve all data from the Compound table or selectively acquire information by including Compound Ids, Compound Type Ids, Compound Status Ids, Compound Names, External Identifiers, or CAS Numbers. Additionally, the Compound endpoint is equipped with pagination capabilities to facilitate efficient management of substantial datasets.
8686

8787
> Example Request
8888
@@ -174,9 +174,9 @@ Attribute | Type | Description
174174
--------- | ---- | -----------
175175
PageNumber | int | Page number of the results to fetch.
176176
PageSize | int | The number of results per page
177-
compoundIDs | int | Compound ID is one of the unique identifier for this compound record
178-
compoundTypeIDs | int | Compound TYpe IDs is the associated compound type and is a second filter parameter option
179-
compoundstatusIDs | int | Compound Status IDs is associated with compound status
177+
compoundIds | int | Compound ID is one of the unique identifier for this compound record
178+
compoundTypeIds | int | Compound Type Ids is the associated compound type and is a second filter parameter option
179+
compoundstatusIds | int | Compound Status Ids is associated with compound status
180180
compoundNames | string | Compound Names The name of the compound which is a string type data and is one among the parameter for filter option
181181
externalIdentifier | int | External Identifiers is a unique identifier for this record to an external data system
182182
CAS | string | CAS Number is a Chemical Abstract Service number for the compound
@@ -238,11 +238,12 @@ Attribute | Type | Description
238238
--------- | ---- | -----------
239239
PageNumber | int | Page number of the results to fetch.
240240
PageSize | int | The number of results per page
241-
emissionCategoryIDs | int | Emission Category ID is one of the unique identifier for this emission category record and is one of the filter option provided for Emission Category
241+
emissionCategoryIds | int | Emission Category ID is one of the unique identifier for this emission category record and is one of the filter option provided for Emission Category
242+
emissionCategoryTypes | string | Emission Category Types is for the project to emission category detail types
242243
243244
### 4. Emission Type Table
244245
245-
This section guides you through the process of fetching data from the Emission Type table using the dedicated API endpoint. The endpoint enables you to retrieve data from the entire Emission Type table or selectively obtain information by including Emission Type IDs. Additionally, the Emission Type endpoint is equipped with pagination capabilities to facilitate the handling of extensive datasets.
246+
This section guides you through the process of fetching data from the Emission Type table using the dedicated API endpoint. The endpoint enables you to retrieve data from the entire Emission Type table or selectively obtain information by including Emission Type Ids. Additionally, the Emission Type endpoint is equipped with pagination capabilities to facilitate the handling of extensive datasets.
246247
247248
> Example Request
248249
@@ -300,11 +301,13 @@ Attribute | Type | Description
300301
--------- | ---- | -----------
301302
PageNumber | int | Page number of the results to fetch.
302303
PageSize | int | The number of results per page
303-
emissionTypeIDs | int | Emission Type ID is one of the type of emissions and is the one of the filter option provided for Emission Type
304+
emissionTypeIds | int | Emission Type ID is one of the type of emissions and is the one of the filter option provided for Emission Type
305+
emissionTypes | string | Emission Types is for the project to emission detail types
306+
304307
305308
### 5. Equipment Table
306309
307-
This section provides guidance on retrieving data from the Equipment table using the designated API endpoint. The endpoint allows you to retrieve all data from the Equipment table or specify specific data based on equipment IDs. Additionally, the Equipment endpoint offers pagination support to facilitate the handling of substantial datasets.
310+
This section provides guidance on retrieving data from the Equipment table using the designated API endpoint. The endpoint allows you to retrieve all data from the Equipment table or specify specific data based on equipment Ids. Additionally, the Equipment endpoint offers pagination support to facilitate the handling of substantial datasets.
308311
309312
> Example Request
310313
@@ -377,13 +380,13 @@ Attribute | Type | Description
377380
--------- | ---- | -----------
378381
PageNumber | int | Page number of the results to fetch.
379382
PageSize | int | The number of results per page
380-
equipmentIDs | int | Equipment ID is one of the unique identifier for this equipment record
381-
equipmentTypeIDs | int | Equipment Type ID is one of the unique identifier for this equipment type record
382-
equipmentStatusIDs | int | Equipment Status ID is one of the unique identifier for this equipment status record
383-
facilityIDs | int | Facility ID is one of the unique identifier for this equipment status record
384-
sourceNames | strings | Source Names is one of the unique identifier for this equipment record
385-
internalNames | strings | Internal Names is one of the unique identifier for this equipment record
386-
alternateNames | strings | Alternate Names is one of the unique identifier for this equipment record
383+
equipmentIds | int | Equipment ID is one of the unique identifier for this equipment record
384+
equipmentTypeIds | int | Equipment Type ID is one of the unique identifier for this equipment type record
385+
equipmentStatusIds | int | Equipment Status ID is one of the unique identifier for this equipment status record
386+
facilityIds | int | Facility ID is one of the unique identifier for this equipment status record
387+
sourceNames | string | Source Names is one of the unique identifier for this equipment record
388+
internalNames | string | Internal Names is one of the unique identifier for this equipment record
389+
alternateNames | string | Alternate Names is one of the unique identifier for this equipment record
387390
lastModifiedStartDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z"
388391
lastModifiedEndDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z"
389392
@@ -448,13 +451,13 @@ Attribute | Type | Description
448451
--------- | ---- | -----------
449452
PageNumber | int | Page number of the results to fetch.
450453
PageSize | int | The number of results per page
451-
equipmentStatusIDs | int | Equipment Status ID is one of the unique identifier for this equipment status record
454+
equipmentStatusIds | int | Equipment Status ID is one of the unique identifier for this equipment status record
452455
equipmentStatus | string | Equipment Status is one of the identifier for the status of the equipment
453456
454457
455458
### 7. Equipment Attribute Table
456459
457-
All data from the Equipment Attribute table will be returned from the endpoint below. You can optionally fetch specific data by including the facility attribute ids, facility names, emission type ids, facility type ids, unit ids, equipment ids, last modified start date and last modified end date. The facility attribute endpoint supports pagination.
460+
All data from the Equipment Attribute table will be returned from the endpoint below. You can optionally fetch specific data by including the facility attribute Ids, facility names, emission type Ids, facility type Ids, unit Ids, equipment Ids, last modified start date and last modified end date. The facility attribute endpoint supports pagination.
458461
459462
> Example Request
460463
@@ -606,13 +609,13 @@ Attribute | Type | Description
606609
--------- | ---- | -----------
607610
PageNumber | int | Page number of the results to fetch.
608611
PageSize | int | The number of results per page
609-
equipmentTypeIDs | int | Equipment Type ID is one of the unique identifier for this equipment type record
612+
equipmentTypeIds | int | Equipment Type ID is one of the unique identifier for this equipment type record
610613
equipmentTypes | string | Equipment Types is one of the filter option and the parameter is for the type of the equipment
611614
612615
613616
### 9. Facility Table
614617
615-
All data from the Facility table will be returned from the endpoint below. You can optionally fetch specific data by including the facility ids, facility names, emission type ids, facility type ids, facility status ids, county ids, last modified start date and last modified end date. The facility endpoint supports pagination.
618+
All data from the Facility table will be returned from the endpoint below. You can optionally fetch specific data by including the facility Ids, facility names, emission type Ids, facility type Ids, facility status Ids, county Ids, last modified start date and last modified end date. The facility endpoint supports pagination.
616619
617620
> Example Request
618621
@@ -621,7 +624,6 @@ var request = require("request");
621624

622625
var options = { method: 'GET',
623626
url: 'https://[tenant].actsapi.intelex.com/v1/facility' };
624-
625627
request(options, function (error, response, body) {
626628
if (error) throw new Error(error);
627629

@@ -706,7 +708,7 @@ lastModifiedEndDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - E
706708
707709
### 10. Facility Attribute Table
708710
709-
All data from the Facility Attribute table will be returned from the endpoint below. You can optionally fetch specific data by including the facility attribute ids, facility names, emission type ids, facility type ids, facility attribute and last modified end date. The facility attribute endpoint supports pagination.
711+
All data from the Facility Attribute table will be returned from the endpoint below. You can optionally fetch specific data by including the facility attribute Ids, facility names, emission type Ids, facility type Ids, facility attribute and last modified end date. The facility attribute endpoint supports pagination.
710712
711713
> Example Request
712714
@@ -779,7 +781,7 @@ comments | string | Comments any comments associated with this record
779781
780782
### 11. Operation Table
781783
782-
All data from the Operation table will be returned from the endpoint below. You can optionally fetch specific data by including the operation ids, operation type ids, emission type ids, emission category ids, unit ids, equipment ids, last modified start date and last modified end date. The Operation endpoint supports pagination.
784+
All data from the Operation table will be returned from the endpoint below. You can optionally fetch specific data by including the operation Ids, operation type Ids, emission type Ids, emission category Ids, unit Ids, equipment Ids, last modified start date and last modified end date. The Operation endpoint supports pagination.
783785
784786
> Example Request
785787
@@ -850,12 +852,12 @@ Attribute | Type | Description
850852
--------- | ---- | -----------
851853
PageNumber | int | Page number of the results to fetch.
852854
PageSize | int | The number of results per page
853-
operationIDs | int | Operation Ids are unique identifier for this operation type record
854-
operationTypeIDs | string | Operation Type IDs is one of the filter option and the parameter is for the type of the Operation Type
855-
emissionTypeIDs | int | The unique identifier of the associated emission type
856-
emissionCategoryIDs | int | The unique identifier of the associated emission category
857-
unitIDs | int | The unique identifier of the associated unit
858-
equipmentIDs | int | The unique identifier of the associated equipment
855+
operationIds | int | Operation Ids are unique identifier for this operation type record
856+
operationTypeIds | string | Operation Type Ids is one of the filter option and the parameter is for the type of the Operation Type
857+
emissionTypeIds | int | The unique identifier of the associated emission type
858+
emissionCategoryIds | int | The unique identifier of the associated emission category
859+
unitIds | int | The unique identifier of the associated unit
860+
equipmentIds | int | The unique identifier of the associated equipment
859861
lastModifiedStartDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z"
860862
lastModifiedEndDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z"
861863
@@ -930,7 +932,74 @@ operationTypes | int | The type of operational data
930932
931933
### 13. Unit Table
932934
933-
This section outlines how to retrieve data from the Unit table using the provided endpoint. You have the flexibility to fetch specific data by including unit IDs, unit type IDs, and units. The Unit type endpoint also supports pagination for managing large datasets effectively.
935+
All data from the Operation Type table will be returned from the endpoint below. You can optionally fetch specific data by including the operation type Ids, operation types . The Operation Type endpoint supports pagination.
936+
937+
> Example Request
938+
939+
```javascript
940+
var request = require("request");
941+
942+
var options = { method: 'GET',
943+
url: 'https://[tenant].actsapi.intelex.com/v1/operationtype' };
944+
request(options, function (error, response, body) {
945+
if (error) throw new Error(error);
946+
947+
console.log(body);
948+
});
949+
```
950+
951+
```csharp
952+
var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/operationtype");
953+
var request = new RestRequest(Method.GET);
954+
IRestResponse response = client.Execute(request);
955+
```
956+
957+
> Response Schema
958+
959+
```json
960+
{
961+
"currentPage": 1,
962+
"totalPages": 1,
963+
"currentPageSize": 500,
964+
"maxAPIPageSize": 500,
965+
"totalCount": 337,
966+
"hasPrevious": false,
967+
"hasNext": true,
968+
"data": [
969+
{
970+
"operationTypeId": "number",
971+
"operationType": "string",
972+
"parentOperationTypeId": "number",
973+
"compoundId": "number",
974+
"applicabilityFormula": "string",
975+
"sortOrder": "number",
976+
"lastModifiedDate": "2020-09-01T15:55:25",
977+
"externalIdentifier": "number",
978+
"comments": "number",
979+
"refId": "number"
980+
}
981+
]
982+
}
983+
984+
```
985+
986+
**API Endpoints**
987+
988+
`GET` /api/v1/operationtype
989+
990+
**Query parameters**
991+
992+
Attribute | Type | Description
993+
--------- | ---- | -----------
994+
PageNumber | int | Page number of the results to fetch.
995+
PageSize | int | The number of results per page
996+
operationTypeIds | int | The unique identifier for this operation type record
997+
operationTypes | string | The type of operational data
998+
999+
1000+
### 13. Unit Table
1001+
1002+
This section outlines how to retrieve data from the Unit table using the provided endpoint. You have the flexibility to fetch specific data by including unit Ids, unit type Ids, and units. The Unit type endpoint also supports pagination for managing large datasets effectively.
9341003
9351004
> Example Request
9361005
@@ -992,8 +1061,8 @@ Attribute | Type | Description
9921061
--------- | ---- | -----------
9931062
PageNumber | int | Page number of the results to fetch.
9941063
PageSize | int | The number of results per page
995-
unitIDs | int | Unit ID is one of the unique identifier for this Unit record
996-
unitTypeIDs | int | Unit Type IDs is the unique identifier of the associated unit type
1064+
unitIds | int | Unit ID is one of the unique identifier for this Unit record
1065+
unitTypeIds | int | Unit Type Ids is the unique identifier of the associated unit type
9971066
units | string | Units is one of the filter option and the parameter is for the Name of the Unit
9981067
9991068

source/includes/acts/post_api.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,8 @@ var options = { method: 'POST',
161161
LastModifiedDate: '2023-03-30T07:27:06.295Z',
162162
ExternalIdentifier: 'string',
163163
Comments:'string'},
164-
json: true };
164+
json: true };
165+
165166

166167
request(options, function (error, response, body) {
167168
if (error) throw new Error(error);
@@ -244,7 +245,7 @@ var options = { method: 'POST',
244245
IncidentNo: 0,
245246
ReportedDate: '2017-02-13T22:15:30.203Z',
246247
SuspectedCause: 'string' },
247-
json: true };
248+
json: true };
248249

249250
request(options, function (error, response, body) {
250251
if (error) throw new Error(error);
@@ -351,7 +352,8 @@ var options = { method: 'POST',
351352
LastModifiedDate: '2023-03-30T07:27:06.295Z',
352353
ExternalIdentifier: 'string',
353354
Comments:'string'},
354-
json: true };
355+
json: true };
356+
355357

356358
request(options, function (error, response, body) {
357359
if (error) throw new Error(error);
@@ -448,7 +450,8 @@ var options = { method: 'POST',
448450
comments: 'string',
449451
badDataFlag: 'number(1,0)',
450452
operationAmount: 'number' },
451-
json: true };
453+
json: true };
454+
452455

453456
request(options, function (error, response, body) {
454457
if (error) throw new Error(error);

0 commit comments

Comments
 (0)