Skip to content

Commit bfc8cdd

Browse files
committed
[ILX-57292] Add doc for Requirement Limit POST
1 parent b4c7b08 commit bfc8cdd

File tree

1 file changed

+121
-5
lines changed

1 file changed

+121
-5
lines changed

source/includes/acts/post_api.md

Lines changed: 121 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1368,8 +1368,124 @@ IRestResponse response = client.Execute(request);
13681368
}
13691369

13701370
```
1371+
### 14. Requirement Limit Table
13711372

1372-
### 14. Workflow Table
1373+
This section outlines the process of adding new entries or modifying existing records within the Requirement Limit table using the dedicated API endpoint.
1374+
1375+
**Requirement Limit POST Endpoint**
1376+
1377+
`POST` /actsapi/v1/requirementlimit
1378+
1379+
> Example Request & JSON Input Body
1380+
1381+
```javascript
1382+
var request = require("request");
1383+
1384+
var options = { method: 'POST',
1385+
url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/requirementlimit',
1386+
headers: { 'content-type': 'application/json' },
1387+
body:
1388+
[
1389+
{
1390+
"activeDate": "2025-10-21T15:34:20.173Z",
1391+
"inactiveDate": "2025-10-21T15:34:20.173Z",
1392+
"externalIdentifier": "string",
1393+
"comments": "string",
1394+
"requirementLimitId": "number",
1395+
"requirementId": "number",
1396+
"requirementLimitTypeId": "number",
1397+
"compoundId": "number",
1398+
"compoundGroupTypeId": "number",
1399+
"unitId": "number",
1400+
"operator": "string",
1401+
"limitThreshold": "number",
1402+
"compareLimitInd": "string",
1403+
"compareDecimalPlaces": "number",
1404+
"compareOffset": "number",
1405+
"compareDays": "number",
1406+
"limitViolationText": "string",
1407+
"emissionTypeId": "number",
1408+
"emissionCategoryId": "number",
1409+
"operationTypeId": "number",
1410+
"analysisTypeId": "number",
1411+
"analysisValueName": "string",
1412+
"customLimitThreshold": "string",
1413+
"sortOrder": "number"
1414+
}
1415+
],
1416+
json: true };
1417+
1418+
request(options, function (error, response, body) {
1419+
if (error) throw new Error(error);
1420+
console.log(body);
1421+
});
1422+
```
1423+
1424+
```csharp
1425+
var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/requirementlimit");
1426+
var request = new RestRequest(Method.POST);
1427+
request.AddHeader("content-type", "application/json");
1428+
request.AddParameter("application/json", "[{\"activeDate\":\"2025-10-21T15:34:20.173Z\",\"inactiveDate\":\"2025-10-21T15:34:20.173Z\",\"externalIdentifier\":\"string\",\"comments\":\"string\",\"requirementLimitId\":\"number\",\"requirementId\":\"number\",\"requirementLimitTypeId\":\"number\",\"compoundId\":\"number\",\"compoundGroupTypeId\":\"number\",\"unitId\":\"number\",\"operator\":\"string\",\"limitThreshold\":\"number\",\"compareLimitInd\":\"string\",\"compareDecimalPlaces\":\"number\",\"compareOffset\":\"number\",\"compareDays\":\"number\",\"limitViolationText\":\"string\",\"emissionTypeId\":\"number\",\"emissionCategoryId\":\"number\",\"operationTypeId\":\"number\",\"analysisTypeId\":\"number\",\"analysisValueName\":\"string\",\"customLimitThreshold\":\"string\",\"sortOrder\":\"number\"}]", ParameterType.RequestBody);
1429+
IRestResponse response = client.Execute(request);
1430+
```
1431+
1432+
> Input JSON Body
1433+
1434+
```json
1435+
[
1436+
{
1437+
"activeDate": "2025-10-21T15:34:20.173Z",
1438+
"inactiveDate": "2025-10-21T15:34:20.173Z",
1439+
"externalIdentifier": "string",
1440+
"comments": "string",
1441+
"requirementLimitId": "number",
1442+
"requirementId": "number",
1443+
"requirementLimitTypeId": "number",
1444+
"compoundId": "number",
1445+
"compoundGroupTypeId": "number",
1446+
"unitId": "number",
1447+
"operator": "string",
1448+
"limitThreshold": "number",
1449+
"compareLimitInd": "string",
1450+
"compareDecimalPlaces": "number",
1451+
"compareOffset": "number",
1452+
"compareDays": "number",
1453+
"limitViolationText": "string",
1454+
"emissionTypeId": "number",
1455+
"emissionCategoryId": "number",
1456+
"operationTypeId": "number",
1457+
"analysisTypeId": "number",
1458+
"analysisValueName": "string",
1459+
"customLimitThreshold": "string",
1460+
"sortOrder": "number"
1461+
}
1462+
]
1463+
```
1464+
> Example Response
1465+
1466+
```json
1467+
{
1468+
"insertedRowCount" : 1,
1469+
"updatedRowCount" : 0,
1470+
"failureCount" : 0,
1471+
"errorMessage" : []
1472+
}
1473+
```
1474+
1475+
> Example Output For When Data Get's Failed To Insert or Update
1476+
1477+
```json
1478+
{
1479+
"insertedRowCount": 0,
1480+
"updatedRowCount": 0,
1481+
"failureCount": 1,
1482+
"errorMessage": [
1483+
"Not found RequirementLimitIds: 12345"
1484+
]
1485+
}
1486+
```
1487+
1488+
### 15. Workflow Table
13731489

13741490
This section outlines the process of adding new entries or modifying existing records within the Workflow table using the dedicated API endpoint.
13751491

@@ -1455,7 +1571,7 @@ IRestResponse response = client.Execute(request);
14551571

14561572
```
14571573

1458-
### 15. Workflow Answer Table
1574+
### 16. Workflow Answer Table
14591575

14601576
This section outlines the process of adding new entries or modifying existing records within the Workflow Answer table using the dedicated API endpoint.
14611577

@@ -1549,7 +1665,7 @@ IRestResponse response = client.Execute(request);
15491665

15501666
```
15511667

1552-
### 16. Workflow Equipment Table
1668+
### 17. Workflow Equipment Table
15531669

15541670
This section outlines the process of adding new entries or modifying existing records within the Workflow Equipment table using the dedicated API endpoint.
15551671

@@ -1635,7 +1751,7 @@ IRestResponse response = client.Execute(request);
16351751

16361752
```
16371753

1638-
### 17. Workflow Facility Table
1754+
### 18. Workflow Facility Table
16391755

16401756
This section outlines the process of adding new entries or modifying existing records within the Workflow Facility table using the dedicated API endpoint.
16411757

@@ -1722,7 +1838,7 @@ IRestResponse response = client.Execute(request);
17221838

17231839
```
17241840

1725-
### 18. Workflow Person Table
1841+
### 19. Workflow Person Table
17261842

17271843
This section outlines the process of adding new entries or modifying existing records within the Workflow Person table using the dedicated API endpoint.
17281844

0 commit comments

Comments
 (0)