Skip to content

Commit 097f7f5

Browse files
AntonStokozAkshaya Kumar
andauthored
Changes made based on the comments (#8)
* Changes made based on the comments * Updated as per the comments * Commit made based on the PR comments --------- Co-authored-by: Akshaya Kumar <Akshaya Kumar@DESKTOP-TIGJLBP>
1 parent 35b632e commit 097f7f5

File tree

5 files changed

+89
-64
lines changed

5 files changed

+89
-64
lines changed

source/includes/_acts-api-reference.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To begin using the Intelex API you will need:
1414
>API Endpoint - replace **intelex_ACTS API url** with the full URL path to your Intelex system
1515
1616
```
17-
https://*.actsapi.intelex.com
17+
https://{tenant}.actsapi.intelex.com
1818
```
1919

2020
## Authentication
@@ -23,10 +23,10 @@ https://*.actsapi.intelex.com
2323
2424
```CSharp
2525

26-
//PostMan Body for Authentication Endpoint
26+
//JSON Body for Authentication Endpoint
2727
{"client_id":"Client ID Data",
2828
"client_secret":"Client Secret Data",
29-
"audience":"https://*.intelex.com/API-release",
29+
"audience":"https://{tenant}.intelex.com/API-release",
3030
"grant_type":"client_credentials"}
3131
```
3232
>Example Response:
@@ -47,7 +47,7 @@ During Auth0 authentication, the client passes 'client id' and 'client secret' t
4747

4848
All API requests must be made over HTTPS, and API requests without authentication will fail. Security on data is managed by the ACTS platform, and API requests will provide the same admin access available to logged in ACTS admin users.
4949

50-
The user authentication endpoint uses a POST (with input parameters described above) to generate the access token [bearer token].
50+
The user authentication endpoint uses a POST to generate the access token [bearer token].
5151

5252
>Authentication API Endpoint - https: // dev-intelex.us.auth0.com/oauth/token
5353
@@ -78,4 +78,4 @@ Response Code | Meaning
7878

7979
When we make backwards-incompatible changes to the API, we release new versions. The current version of the ACTS API is v1 and can be determined with our API base path /api/v1/.
8080

81-
>Example API Endpoint : https://*.actsapi.intelex.com/API/**/v1/TableName
81+
>Example API Endpoint : https://{tenant}.actsapi.intelex.com/API/**/v1/TableName

source/includes/_all-get-apis.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,144 +6,144 @@ The following GET APIs are used to fetch the data from the respective tables.
66

77
All data from the Attribute Type table will be returned from the endpoint below. You can optionally fetch specific data by including Attribute ID’s and Attribute Types. The Attribute Type endpoint supports pagination.
88

9-
> Example GET Endpoint Without Pagination:
9+
> Example Of AttributeType GET Endpoint Without Pagination:
1010
1111
```
12-
https: // *actsapi.intelex.com/API-develop/v1/AttributeType
12+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/AttributeType
1313
```
1414

15-
> Example GET Endpoint With Pagination:
15+
> Example Of AttributeType GET Endpoint With Pagination and Filter Option:
1616
1717
```
18-
https: // *actsapi.intelex.com/API-develop/v1/AttributeType?PageNumber=1&PageSize=500&attributeTypeIDs="int data"&attributeTypes="string data"
18+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/AttributeType?PageNumber=1&PageSize=500&attributeTypeIDs="int data"&attributeTypes="string data"
1919
```
2020

2121
## 2.Compound API GET Endpoint
2222

2323
All data from the Compound table will be returned from the endpoint below. You can optionally fetch specific data by including compound ID’s, compound Type IDs, compound status IDs, compound Names, external identifiers, or CAS number. The Compound endpoint supports pagination.
2424

25-
> Example GET Endpoint Without Pagination:
25+
> Example Of Compound GET Endpoint Without Pagination:
2626
2727
```
28-
https: // *actsapi.intelex.com/API-develop/v1/Compound
28+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/Compound
2929
```
3030

31-
> Example GET Endpoint With Pagination:
31+
> Example Of Compound GET Endpoint With Pagination and Filter Option:
3232
3333
```
34-
https: // *actsapi.intelex.com/API-develop/v1/Compound? PageNumber=1&PageSize=500&compoundIDs="int data"&compoundTypeIDs="int data"&compoundstatusIDs="int data"&compoundNames="string data"&externalIdentifier="int"&CAS="string data"
34+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/Compound? PageNumber=1&PageSize=500&compoundIDs="int data"&compoundTypeIDs="int data"&compoundstatusIDs="int data"&compoundNames="string data"&externalIdentifier="int"&CAS="string data"
3535
```
3636

3737
## 3.Emission Category API GET Endpoint
3838

3939
All data from the Emission Category table will be returned from the endpoint below. You can optionally fetch specific data by including the emission category ID. The Emission Category endpoint supports pagination.
4040

4141

42-
> Example GET Endpoint Without Pagination:
42+
> Example Of EmissionCategory GET Endpoint Without Pagination:
4343
4444
```
45-
https: // *actsapi.intelex.com/API-develop/v1/EmissionCategory
45+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/EmissionCategory
4646
```
47-
> Example GET Endpoint With Pagination and Filter Option:
47+
> Example Of EmissionCategory GET Endpoint With Pagination and Filter Option:
4848
4949
```
50-
https: // *actsapi.intelex.com/API-develop/v1/EmissionCategory/{int data – Emission Category ID}
50+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/EmissionCategory/{int data – Emission Category ID}
5151
```
5252

5353
## 4.Emission Type API GET Endpoint
5454

5555
All data from the Emission type table will be returned from the endpoint below. You can optionally fetch specific data by including the emission type ID. The Emission Type endpoint supports pagination.
5656

57-
> Example GET Endpoint Without Pagination:
57+
> Example Of EmissionType GET Endpoint Without Pagination:
5858
5959
```
60-
https: // *actsapi.intelex.com/API-develop/v1/EmissionType
60+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/EmissionType
6161
```
6262

63-
> Example GET Endpoint With Pagination and Filter Option:
63+
> Example Of EmissionType GET Endpoint With Pagination and Filter Option:
6464
6565
```
66-
https: //*actsapi.intelex.com/API-develop/v1/EmissionType?PageNumber=1&PageSize=500&emissionTypeID={int data value}
66+
https: //{tenant}.actsapi.intelex.com/API-develop/v1/EmissionType?PageNumber=1&PageSize=500&emissionTypeID={int data value}
6767
```
6868

6969
## 5.Equipment API GET Endpoint
7070

7171
All data from the Equipment table will be returned from the endpoint below. You can optionally fetch specific data by including the equipment ID. The Equipment endpoint supports pagination.
7272

73-
> Example GET Endpoint Without Pagination:
73+
> Example Of Equipment GET Endpoint Without Pagination:
7474
7575
```
76-
https: // *actsapi.intelex.com/API-develop/v1/Equipment
76+
https: //{tenant}.actsapi.intelex.com/API-develop/v1/Equipment
7777
```
7878

79-
> Example GET Endpoint With Pagination and Filter Option:
79+
> Example Of Equipment GET Endpoint With Pagination and Filter Option:
8080
8181
```
82-
https: //*actsapi.intelex.com/API-develop/v1/Equipment?PageNumber=1&PageSize=500&equipmentID={int data value}
82+
https: //{tenant}.actsapi.intelex.com/API-develop/v1/Equipment?PageNumber=1&PageSize=500&equipmentID={int data value}
8383
```
8484

8585
## 6.Equipment Status API GET Endpoint
8686

8787
All data from the Equipment Status table will be returned from the endpoint below. You can optionally fetch specific data by including the equipment status ID and equipment status value. The Equipment Status endpoint supports pagination.
8888

89-
> Example GET Endpoint Without Pagination:
89+
> Example Of EquipmentStatus GET Endpoint Without Pagination:
9090
9191
```
92-
https: // *actsapi.intelex.com/API-develop/v1/EquipmentStatus
92+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/EquipmentStatus
9393
```
9494

95-
> Example GET Endpoint With Pagination and Filter Option:
95+
> Example Of EquipmentStatus GET Endpoint With Pagination and Filter Option:
9696
9797
```
98-
https: // *actsapi.intelex.com/API-develop/v1/EquipmentStatus?PageNumber=1&PageSize=500&EquipmentStatusIDs="int data"&EquipmentStatus="string data"
98+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/EquipmentStatus?PageNumber=1&PageSize=500&EquipmentStatusIDs="int data"&EquipmentStatus="string data"
9999
```
100100

101101
## 7.Equipment Type API GET Endpoint
102102

103103
All data from the Equipment Type table will be returned from the endpoint below. You can optionally fetch specific data by including the equipment type ID and equipment types value. The Equipment type endpoint supports pagination.
104104

105-
> Example GET Endpoint Without Pagination:
105+
> Example Of EquipmentType GET Endpoint Without Pagination:
106106
107107
```
108-
https: // *actsapi.intelex.com/API-develop/v1/EquipmentType
108+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/EquipmentType
109109
```
110110

111-
> Example GET Endpoint With Pagination and Filter Option:
111+
> Example Of EquipmentType GET Endpoint With Pagination and Filter Option:
112112
113113
```
114-
https: // *actsapi.intelex.com/API-develop/v1/EquipmentType?PageNumber=1&PageSize=500&EquipmentTypeIDs="int data"&EquipmentType="string data"
114+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/EquipmentType?PageNumber=1&PageSize=500&EquipmentTypeIDs="int data"&EquipmentType="string data"
115115
```
116116

117117
## 8.Operation API GET Endpoint
118118

119119
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.
120120

121-
> Example GET Endpoint Without Pagination:
121+
> Example Of Operation GET Endpoint Without Pagination:
122122
123123
```
124-
https: // *actsapi.intelex.com/API-develop/v1/Operation
124+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/Operation
125125
```
126126

127-
> Example GET Endpoint With Pagination and Filter Option:
127+
> Example Of Operation GET Endpoint With Pagination and Filter Option:
128128
129129
```
130-
https: // *actsapi.intelex.com/API-develop/v1/ Operation?PageNumber =1&PageSize=500&OperationIDs="int data"&OperationTypeIDs=”string data "&EmissionTypeIDs="int data”&EmissionCategoryIDs="int data”&UnitIDs="int data"&EquipmentIDs="int data"&LastModifiedStartDate=”string format – date time data"&LastModifiedEndDate="string format – date time data"
130+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/ Operation?PageNumber =1&PageSize=500&OperationIDs="int data"&OperationTypeIDs=”string data "&EmissionTypeIDs="int data”&EmissionCategoryIDs="int data”&UnitIDs="int data"&EquipmentIDs="int data"&LastModifiedStartDate=”string format – date time data"&LastModifiedEndDate="string format – date time data"
131131
```
132132

133133
## 9.Unit API GET Endpoint
134134

135135
All data from the Unit table will be returned from the endpoint below. You can optionally fetch specific data by including the unit ids, unit type ids and units. The Unit type endpoint supports pagination.
136136

137-
> Example GET Endpoint Without Pagination:
137+
> Example Of Unit GET Endpoint Without Pagination:
138138
139139
```
140-
https: // *actsapi.intelex.com/API-develop/v1/Unit
140+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/Unit
141141
```
142142

143-
> Example GET Endpoint With Pagination and Filter Option:
143+
> Example Of Unit GET Endpoint With Pagination and Filter Option:
144144
145145
```
146-
https: // *actsapi.intelex.com/API-develop/v1/Unit?PageNumber=1&PageSize=500&UnitIDs="int data"&UnitTypeIDs="int data" &Units="string data"
146+
https: // {tenant}.actsapi.intelex.com/API-develop/v1/Unit?PageNumber=1&PageSize=500&UnitIDs="int data"&UnitTypeIDs="int data" &Units="string data"
147147
```
148148

149149
## Sample Result Set Of One Of the API Endpoint

source/includes/_all-post-apis.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,27 @@ Equipment records can be updated, or new records added at the following endpoint
1515
> Equipment POST endpoint:
1616
1717
```
18-
https: // *actsapi.intelex.com/API-staging/DEVELOPMENT/v1/Equipment
18+
https: // {tenant}.actsapi.intelex.com/API-staging/DEVELOPMENT/v1/Equipment
1919
```
2020

2121
## 2.Operation POST API endpoint
2222

2323
Operation records can be updated, or new records added at the following endpoint:
2424

25-
> General URL Of POST Endpoint:
25+
> Operation POST Endpoint:
2626
2727
```
28-
https: // *actsapi.intelex.com/API-staging/DEVELOPMENT/v1/Operation
28+
https: // {tenant}.actsapi.intelex.com/API-staging/DEVELOPMENT/v1/Operation
2929
```
3030

3131
## 3.Facility POST API endpoint
3232

3333
Facility records can be updated, or new records added at the following endpoint:
3434

35-
> General URL Of POST Endpoint :
35+
> Facility POST Endpoint :
3636
3737
```
38-
https: // *actsapi.intelex.com/API-staging/DEVELOPMENT/v1/Facility
38+
https: // {tenant}.actsapi.intelex.com/API-staging/DEVELOPMENT/v1/Facility
3939
```
4040

4141
## 4.Facility Attribute POST API endpoint
@@ -45,7 +45,7 @@ Facility Attribute records can be updated, or new records added at the following
4545
> Facility Attribute POST Endpoint:
4646
4747
```
48-
https: // *actsapi.intelex.com/API-staging/DEVELOPMENT/v1/FacilityAttribute
48+
https: // {tenant}.actsapi.intelex.com/API-staging/DEVELOPMENT/v1/FacilityAttribute
4949
```
5050

5151
## JSON body for both Insert & Update
@@ -91,4 +91,27 @@ If the primary id is an existing ID - "#####" then the data we are passing is ha
9191
]
9292
```
9393

94+
> Example Output For Both Update and Insert
95+
```
96+
{
97+
"insertedRowCount" : 2 ,
98+
"updatedRowCount" : 3 ,
99+
"failureCount" : 0 ,
100+
"errorMessage" : []
101+
102+
}
103+
104+
```
94105

106+
> Example Output For When Data Get's Failed To Insert or Update
107+
```
108+
{
109+
"insertedRowCount" : 0 ,
110+
"updatedRowCount" : 1 ,
111+
"failureCount" : 1 ,
112+
"errorMessage" : [
113+
"Operation ID : 0, Error: An error occurred while saving the entity changes. See the inner exception for details "
114+
]
115+
}
116+
117+
```

source/includes/_total-apis-and-tables.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,20 @@
33
This ACTS API release includes 11 GET enpoints and 4 POST endpoints, along with the authentication endpoint described above. The tables you can query and update are as follows.
44

55
1.Tables Supporting GET requests
6-
* Operation Table
7-
* Equipment Table
8-
* Emission Type Table
9-
* Emission Category Table
10-
* Equipment Status Table
11-
* Unit Table
12-
* Attribute Type Table
13-
* Equipment Type Table
14-
* Compound Table
6+
7+
1. Operation Table
8+
2. Equipment Table
9+
3. Emission Type Table
10+
4. Emission Category Table
11+
5. Equipment Status Table
12+
6. Unit Table
13+
7. Attribute Type Table
14+
8. Equipment Type Table
15+
9. Compound Table
1516

1617
2.Tables Supporting POST requests
17-
* Equipment Table
18-
* Operation Table
19-
* Facility Table
20-
* Facility Attribute Table
18+
19+
1. Equipment Table
20+
2. Operation Table
21+
3. Facility Table
22+
4. Facility Attribute Table

source/includes/_types-of-apisand-genralurl.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
1. GET API’s In the current ACTS – API release overall there have been planned for 11 GET API’s
44

5-
> Example GET API Endpoint : https : // *actsapi.intelex.com/API-develop/v1/{Table Object}/{Fetch_Based_On_ID’s}
5+
> Example GET API Endpoint : https : // {tenant}.actsapi.intelex.com/API-develop/v1/{Table Object}/{Fetch_Based_On_ID’s}
66
7-
2. POST API’s in the upcoming release we are including 4 POST API’s .
7+
2. POST API’s in the current release we are including 4 POST API’s .
88
These API’s helps to edit and make updates in the respective tables.
99
In the POST API the user needs to pass on the input in JSON Format . The Input JSON body would be something like this
1010

@@ -26,7 +26,7 @@
2626
]
2727
```
2828

29-
> Example POST API Endpoint : https : // *actsapi.intelex.com/API-develop/v1/{Table Object}
29+
> Example POST API Endpoint : https : // {tenant}.actsapi.intelex.com/API-develop/v1/{Table Object}
3030
3131
{Table Object} : Unit , Operation , Emission , Emission Category tables etc
3232

@@ -38,7 +38,7 @@ v1 : Version , First version of the ACTS - API
3838
3. GET API's With Pagination Option
3939
In this case user can specify the page number and page size where 500 is maximum size of the page. Example output with the page number and page size
4040

41-
> Example GET API Endpoint : https ://*actsapi.intelex.com/API-develop/v1/{Table Object}/{Fetch_Based_On_ID’s}/ ?PageNumber=1&PageSize=50
41+
> Example GET API Endpoint : https ://{tenant}.actsapi.intelex.com/API-develop/v1/{Table Object}/{Fetch_Based_On_ID’s}/ ?PageNumber=1&PageSize=50
4242
4343
{Table Object} : Unit , Operation , Emission , Emission Category tables etc
4444

0 commit comments

Comments
 (0)