diff --git a/source/includes/acts/delete_api.md b/source/includes/acts/delete_api.md index 8464c372651..22c89770f08 100644 --- a/source/includes/acts/delete_api.md +++ b/source/includes/acts/delete_api.md @@ -306,3 +306,164 @@ IRestResponse response = client.Execute(request); ``` +### 6. Regulation Table + +This section guides you through the process of removing/deleting the existing records from the Regulation table using the designated API endpoint. + +**Regulation DELETE endpoint** + +`DELETE` /actsapi/v1/regulation + +> Example Request & JSON Input Body + +```javascript +var request = require("request"); + +var options = { method: 'DELETE', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/regulation', + headers: { 'content-type': 'application/json' }, + body: + { [regulationId1, regulationId2, regulationId3....] + }, + json: true }; + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/regulation"); +var request = new RestRequest(Method.DELETE); +request.AddHeader("content-type", "application/json"); +request.AddParameter("application/json", "{\r\n [regulationId1, regulationId2, regulationId3....]\r\n}", ParameterType.RequestBody); +IRestResponse response = client.Execute(request); +``` + +> Input JSON Body + +```json + { + [regulationId1, regulationId2, regulationId3....] + } +``` +> Example Response + +```json +{ + "deletedRowCount": 1, + "notFoundCount": 0, + "failureCount": 0, + "errorMessage" : [] +} +``` + +### 7. Requirement Table + +This section guides you through the process of removing/deleting the existing records from the Requirement table using the designated API endpoint. + +**Requirement DELETE endpoint** + +`DELETE` /actsapi/v1/requirement + +> Example Request & JSON Input Body + +```javascript +var request = require("request"); + +var options = { method: 'DELETE', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/requirement', + headers: { 'content-type': 'application/json' }, + body: + { [requirementId1, requirementId2, requirementId3....] + }, + json: true }; + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/requirement"); +var request = new RestRequest(Method.DELETE); +request.AddHeader("content-type", "application/json"); +request.AddParameter("application/json", "{\r\n [requirementId1, requirementId2, requirementId3....]\r\n}", ParameterType.RequestBody); +IRestResponse response = client.Execute(request); +``` + +> Input JSON Body + +```json + { + [requirementId1, requirementId2, requirementId3....] + } +``` +> Example Response + +```json +{ + "deletedRowCount": 1, + "notFoundCount": 0, + "failureCount": 0, + "errorMessage" : [] +} +``` + +### 8. Requirement Limit Table + +This section guides you through the process of removing/deleting the existing records from the Requirement Limit table using the designated API endpoint. + +**Requirement Limit DELETE endpoint** + +`DELETE` /actsapi/v1/requirementlimit + +> Example Request & JSON Input Body + +```javascript +var request = require("request"); + +var options = { method: 'DELETE', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/requirementlimit', + headers: { 'content-type': 'application/json' }, + body: + { [requirementLimitId1, requirementLimitId2, requirementLimitId3....] + }, + json: true }; + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/requirementlimit"); +var request = new RestRequest(Method.DELETE); +request.AddHeader("content-type", "application/json"); +request.AddParameter("application/json", "{\r\n [requirementLimitId1, requirementLimitId2, requirementLimitId3....]\r\n}", ParameterType.RequestBody); +IRestResponse response = client.Execute(request); +``` + +> Input JSON Body + +```json + { + [requirementLimitId1, requirementLimitId2, requirementLimitId3....] + } +``` +> Example Response + +```json +{ + "deletedRowCount": 1, + "notFoundCount": 0, + "failureCount": 0, + "errorMessage" : [] +} +``` \ No newline at end of file diff --git a/source/includes/acts/get_api.md b/source/includes/acts/get_api.md index c4dc4466b32..8818c1c9e24 100644 --- a/source/includes/acts/get_api.md +++ b/source/includes/acts/get_api.md @@ -181,7 +181,99 @@ compoundNames | string | Compound Names The name of the compound which is a stri externalIdentifier | int | External Identifiers is a unique identifier for this record to an external data system cas | string | CAS Number is a Chemical Abstract Service number for the compound -### 3. Emission Category Table +### 3. Emission Table + +This section elaborates on how to obtain data from the Emission table using the designated API endpoint. The endpoint allows you to retrieve all data from the Emission table or selectively acquire information by providing the Emission ID. Moreover, the Emission endpoint features pagination to facilitate efficient management of substantial datasets. + +> Example Request + +```javascript +var request = require("request"); + +var options = { method: 'GET' + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/emission' }; + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/emission"); +var request = new RestRequest(Method.GET); +IRestResponse response = client.Execute(request); +``` + +> Response Schema + +```json +{ + "currentPage": 1, + "totalPages": 3, + "currentPageSize": 500, + "maxAPIPageSize": 500, + "totalCount": 1346, + "hasPrevious": false, + "hasNext": true, + "data": [ + { + "activeDate": "2025-10-21T08:37:41.669Z", + "inactiveDate": "2025-10-21T08:37:41.669Z", + "lastModifiedDate": "2025-10-21T08:37:41.669Z", + "externalIdentifier": "string", + "comments": "string", + "emissionId": "number", + "equipmentId": "number", + "emissionTypeId": "number", + "emissionCategoryId": "number", + "compoundId": "number", + "unitId": "number", + "emissionAmount": "number", + "controlledInd": "string", + "estimatedInd": "string", + "limitEmissionAmount": "number", + "limitUnitId": "number", + "calculationId": "number", + "calculation": "string", + "limitCalculationId": "number", + "limitCalculation": "string", + "dataLockTypeId": "number", + "badDataFlag": "boolean" + } + ] +} +``` + +**API Endpoints** + +`GET` /actsapi/v1/emission + +**Query parameters** + +Attribute| Type | Description +-------- | ---- |------------ +PageNumber| int | Page number of the results to fetch. +PageSize| int | The number of results per page +emissionIds| int | Emission ID is one of the unique identifier for this emission record +emissionTypeIds| int | The unique identifier of the associated emission type +emissionCategoryIds| int | The unique identifier of the associated emission category +equipmentIds| int | The unique identifier of the associated equipment +unitIds| int | The unique identifier of the associated unit +compoundIds| int | The unique identifier of the associated compound +calculationIds| int | The unique identifier of the associated calculation +estimatedInd| string | Estimated Ind can be of value 'Y' or 'N' +badDataFlag| boolean | Bad Data flag can be of value true or false +externalIdentifier| string | External Identifier is a unique identifier for this record to an external data system +lastModifiedStartDate| datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +lastModifiedEndDate| datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +activeStartDate| datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +activeEndDate| datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +inactiveStartDate| datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +inactiveEndDate| datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" + +### 4. Emission Category Table This section elaborates on how to obtain data from the Emission Category table using the designated API endpoint. The endpoint allows you to retrieve all data from the Emission Category table or selectively acquire information by providing the Emission Category ID. Moreover, the Emission Category endpoint features pagination to facilitate efficient management of substantial datasets. @@ -241,7 +333,7 @@ PageSize | int | The number of results per page 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 emissionCategoryTypes | string | Emission Category Types is for the project to emission category detail types -### 4. Emission Factor Table +### 5. Emission Factor Table This section elaborates on how to obtain data from the Emission Factor table using the designated API endpoint. The endpoint allows you to retrieve all data from the Emission Factor table or You can optionally fetch specific data by including the emission factor Ids, emission factor names, emission type Ids, emission category Ids, unit Ids, compound Ids, equipment Ids, last modified start date and last modified end date. The Emission Factor endpoint supports pagination. @@ -318,7 +410,7 @@ equipmentIds | int | The unique identifier of the associated equipment lastModifiedStartDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" lastModifiedEndDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" -### 5. Emission Type Table +### 6. Emission Type Table 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. @@ -382,7 +474,7 @@ emissionTypeIds | int | Emission Type ID is one of the type of emissions and is emissionTypes | string | Emission Types is for the project to emission detail types -### 6. Equipment Table +### 7. Equipment Table 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. @@ -469,7 +561,7 @@ lastModifiedEndDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - E externalIdentifier | string | External Identifier a unique identifier for this record to an external data system -### 7. Equipment Attribute Table +### 8. Equipment Attribute Table 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. @@ -539,7 +631,7 @@ lastModifiedStartDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - lastModifiedEndDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" -### 8. Equipment Status Table +### 9. Equipment Status Table 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. @@ -604,7 +696,7 @@ equipmentStatus | string | Equipment Status is one of the identifier for the sta -### 9. Equipment Type Table +### 10. Equipment Type Table 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. @@ -689,7 +781,7 @@ equipmentTypeIds | int | Equipment Type ID is one of the unique identifier for t equipmentTypes | string | Equipment Types is one of the filter option and the parameter is for the type of the equipment -### 10. Facility Table +### 11. Facility Table 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. @@ -782,7 +874,7 @@ lastModifiedStartDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - lastModifiedEndDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" -### 11. Facility Attribute Table +### 12. Facility Attribute Table 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. @@ -855,7 +947,7 @@ externalidentifier | string | External Identifier a unique identifier for this r comments | string | Comments any comments associated with this record -### 12. Operation Table +### 13. Operation Table 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. @@ -938,7 +1030,7 @@ lastModifiedStartDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - lastModifiedEndDate | string | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" -### 13. Operation Type Table +### 14. Operation Type Table 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. @@ -1005,7 +1097,7 @@ PageSize | int | The number of results per page operationTypeIDs | int | The unique identifier for this operation type record operationTypes | int | The type of operational data -### 14. Query Results +### 15. Query Results The QueryResults API end point will allow the user to run the views saved in Query view tables and returns the dynamic results based on the specific query view id value. The QueryResults endpoint supports pagination. @@ -1090,8 +1182,375 @@ PageNumber | int | Page number of the results to fetch. PageSize | int | The number of results per page queryViewId | int | The unique identifier for this query view record +### 16. Regulation Table +This section elaborates on how to obtain data from the Regulation table using the designated API endpoint. The endpoint allows you to retrieve all data from the Regulation table or selectively acquire information by providing the Regulation ID. Moreover, the Regulation endpoint features pagination to facilitate efficient management of substantial datasets. + +> Example Request + +```javascript +var request = require("request"); + +var options = { method: 'GET' + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/regulation' }; + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/regulation"); +var request = new RestRequest(Method.GET); +IRestResponse response = client.Execute(request); +``` + +> Response Schema + +```json +{ + "currentPage": 1, + "totalPages": 3, + "currentPageSize": 500, + "maxAPIPageSize": 500, + "totalCount": 1346, + "hasPrevious": false, + "hasNext": true, + "data": [ + { + "activeDate": "2025-10-21T09:49:43.867Z", + "inactiveDate": "2025-10-21T09:49:43.867Z", + "lastModifiedDate": "2025-10-21T09:49:43.867Z", + "externalIdentifier": "string", + "comments": "string", + "regulationId": "number", + "agencyId": "number", + "regulationTypeId": "number", + "mediaId": "number", + "regulationName": "string", + "regulationStatusId": "number", + "applicationDate": "2025-10-21T09:49:43.867Z", + "completeDate": "2025-10-21T09:49:43.867Z", + "publicNoticeDate": "2025-10-21T09:49:43.867Z", + "issueDate": "2025-10-21T09:49:43.867Z", + "renewalDate": "2025-10-21T09:49:43.867Z", + "expirationDate": "2025-10-21T09:49:43.867Z", + "description": "string", + "applicabilityCriteria": "string", + "sortOrder": "number" + } + ] +} +``` + +**API Endpoints** + +`GET` /actsapi/v1/regulation + +**Query parameters** + +Attribute | Type | Description | +--------- |------|-------------| +PageNumber | int | Page number of the results to fetch. +PageSize | int | The number of results per page +regulationIds | int | Regulation ID is one of the unique identifier for this regulation record +regulationNames| string | Regulation Names are one of the filter option and the parameter is for the name of the regulations +regulationTypeIds | int | The unique identifier of the associated regulation type +regulationStatusIds | int | The unique identifier of the associated regulation status +agencyIds | int | The unique identifier of the associated agency +mediaIds | int | The unique identifier of the associated media +applicationStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +applicationEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +completeStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +completeEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +publicNoticeStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +publicNoticeEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +issueStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +issueEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +renewalStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +renewalEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +expirationStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +expirationEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +externalIdentifier| string | External Identifier is a unique identifier for this record to an external data system +lastModifiedStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +lastModifiedEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +activeStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +activeEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +inactiveStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +inactiveEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" + + +### 17. Regulation Type Table +This section elaborates on how to obtain data from the Regulation Type table using the designated API endpoint. The endpoint allows you to retrieve all data from the Regulation Type table or selectively acquire information by providing the Regulation Type ID. Moreover, the Regulation Type endpoint features pagination to facilitate efficient management of substantial datasets. + +> Example Request + +```javascript +var request = require("request"); + +var options = { method: 'GET' + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/regulationType' }; + +request(options, function (error, response, body) { + if (error) throw new Error(error); -### 15. Unit Table + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/regulationType"); +var request = new RestRequest(Method.GET); +IRestResponse response = client.Execute(request); +``` + +> Response Schema + +```json +{ + "currentPage": 1, + "totalPages": 3, + "currentPageSize": 500, + "maxAPIPageSize": 500, + "totalCount": 1346, + "hasPrevious": false, + "hasNext": true, + "data": [ + { + "regulationTypeId": "number", + "regulationType": "string", + "regulationAttributesInd": "string", + "regulationTermInd": "string", + "requirementsInd": "string", + "requirementLimitsInd": "string", + "areaAssociationsInd": "string", + "facilityAssociationsInd": "string", + "facilityRequirementsInd": "string", + "equipmentAssociationsInd": "string", + "projectAssociationsInd": "string", + "regulationTaskAssigneesInd": "string", + "requirementTaskAssigneesInd": "string", + "areaTaskAssigneesInd": "string", + "facilityTaskAssigneesInd": "string", + "requirementEquipTaskAsnInd": "string", + "ownershipInterestInd": "string", + "correspondenceInd": "string", + "fileAttachmentsInd": "string", + "sortOrder": "number", + "lastModifiedDate": "2025-10-21T10:39:13.942Z", + "externalIdentifier": "string", + "comments": "string" + } + ] +} +``` + +**API Endpoints** + +`GET` /actsapi/v1/regulationType + +**Query parameters** + +Attribute | Type | Description | +--------- |------|-------------| +PageNumber | int | Page number of the results to fetch. +PageSize | int | The number of results per page +regulationTypeIds | int | Regulation Type ID is one of the unique identifier for this regulation type record +regulationTypes | string | Regulation Types is one of the filter option and the parameter is for the type of the regulation +externalIdentifier| string | External Identifier is a unique identifier for this record to an external data system +lastModifiedStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +lastModifiedEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" + +### 18. Requirement Table +This section elaborates on how to obtain data from the Requirement table using the designated API endpoint. The endpoint allows you to retrieve all data from the Requirement table or selectively acquire information by providing the Requirement ID. Moreover, the Requirement endpoint features pagination to facilitate efficient management of substantial datasets. + +> Example Request + +```javascript +var request = require("request"); + +var options = { method: 'GET' + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/requirement' }; + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/requirement"); +var request = new RestRequest(Method.GET); +IRestResponse response = client.Execute(request); +``` + +> Response Schema + +```json +{ + "currentPage": 1, + "totalPages": 3, + "currentPageSize": 500, + "maxAPIPageSize": 500, + "totalCount": 1346, + "hasPrevious": false, + "hasNext": true, + "data": [ + { + "requirementId": "number", + "regulationId": "number", + "requirementTypeId": "number", + "requirementName": "string", + "requirementFrequencyId": "number", + "requirementCategoryId": "number", + "regulationActivityId": "number", + "description": "string", + "associatedRequirements": "string", + "applicabilityCriteria": "string", + "sortOrder": "number", + "generateTaskInd": "string", + "taskText": "string", + "firstDueDate": "2025-10-21T10:58:41.085Z", + "generateFacilityTasksInd": "string", + "combineTasksInd": "string", + "attributeTypeId": "number", + "triggerOffset": "number", + "triggerOffsetType": "string", + "creationOffset": "number", + "dependentRequirementId": "number", + "conditionalFormula": "string", + "activeDate": "2025-10-21T10:58:41.085Z", + "inactiveDate": "2025-10-21T10:58:41.085Z", + "lastModifiedDate": "2025-10-21T10:58:41.085Z", + "externalIdentifier": "string", + "comments": "string" + } + ] +} +``` + +**API Endpoints** + +`GET` /actsapi/v1/requirement + +**Query parameters** + +Attribute | Type | Description | +--------- |------|-------------| +PageNumber | int | Page number of the results to fetch. +PageSize | int | The number of results per page +requirementIds | int | Requirement ID is one of the unique identifier for this requirement record +regulationIds | int | The unique identifier of the associated regulation +requirementTypeIds | int | The unique identifier of the associated requirement type +requirementNames | string | Requirement Names is one of the filter option and the parameter is for the name of the requirement +requirementCategoryIds | int | The unique identifier of the associated requirement category +regulationActivityIds | int | The unique identifier of the associated regulation activity +externalIdentifier| string | External Identifier is a unique identifier for this record to an external data system +lastModifiedStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +lastModifiedEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +activeStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +activeEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +inactiveStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +inactiveEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" + +### 19. Requirement Limit Table +This section elaborates on how to obtain data from the Requirement Limit table using the designated API endpoint. The endpoint allows you to retrieve all data from the Requirement Limit table or selectively acquire information by providing the Requirement Limit ID. Moreover, the Requirement Limit endpoint features pagination to facilitate efficient management of substantial datasets. + +> Example Request + +```javascript +var request = require("request"); + +var options = { method: 'GET' + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/requirementLimit' }; + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/requirementLimit"); +var request = new RestRequest(Method.GET); +IRestResponse response = client.Execute(request); +``` + +> Response Schema + +```json +{ + "currentPage": 1, + "totalPages": 3, + "currentPageSize": 500, + "maxAPIPageSize": 500, + "totalCount": 1346, + "hasPrevious": false, + "hasNext": true, + "data": [ + { + "activeDate": "2025-10-21T11:09:26.877Z", + "inactiveDate": "2025-10-21T11:09:26.877Z", + "lastModifiedDate": "2025-10-21T11:09:26.877Z", + "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" + } + ] +} +``` + +**API Endpoints** + +`GET` /actsapi/v1/requirementLimit + +**Query parameters** + +Attribute | Type | Description | +--------- |------|-------------| +PageNumber | int | Page number of the results to fetch. +PageSize | int | The number of results per page +requirementLimitIds | int | Requirement Limit ID is one of the unique identifier for this requirement limit record +requirementIds | int | The unique identifier of the associated requirement +requirementLimitTypeIds | int | The unique identifier of the associated requirement limit type +compoundIds | int | The unique identifier of the associated compound +compoundGroupTypeIds | int | The unique identifier of the associated compound group type +unitIds | int | The unique identifier of the associated unit +emissionTypeIds | int | The unique identifier of the associated emission type +emissionCategoryIds | int | The unique identifier of the associated emission category +operationTypeIds | int | The unique identifier of the associated operation type +analysisTypeIds | int | The unique identifier of the associated operation type +externalIdentifier| string | External Identifier is a unique identifier for this record to an external data system +lastModifiedStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +lastModifiedEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +activeStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +activeEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +inactiveStartDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" +inactiveEndDate | datetime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" + +### 20. Unit Table 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. @@ -1159,7 +1618,7 @@ unitIds | int | Unit ID is one of the unique identifier for this Unit record unitTypeIds | int | Unit Type Ids is the unique identifier of the associated unit type units | string | Units is one of the filter option and the parameter is for the Name of the Unit -### 16. Workflow Table +### 21. Workflow Table This section outlines how to retrieve data from the Workflow table using the provided endpoint. You have the flexibility to fetch specific data by including workflow Ids, workflow type Ids, workflow date for both start date and end date along with the last modified date. The workflow endpoint also supports pagination for managing large datasets effectively. @@ -1229,7 +1688,7 @@ lastModifiedEndDate | dateTime | Date time format "yyyy/mm/dd T hours:min:secZ - externalIdentifier | string | External Identifier a unique identifier for this record to an external data system -### 17. Workflow Answer Table +### 22. Workflow Answer Table This section outlines how to retrieve data from the Workflow Answer table using the provided endpoint. You have the flexibility to fetch specific data by including workflow Answer Ids, workflow Ids, workflow question Ids, category Answer Index, category Revision Index, question Answer Index, question Revision Index, workflow Answer, lastModifiedStartDate and lastModifiedEndDate. The Workflow Answer endpoint also supports pagination for managing large datasets effectively. @@ -1307,7 +1766,7 @@ workflowAnswer | string | Wokflow Answer is the answer to the question.. lastModifiedStartDate | dateTime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" lastModifiedEndDate | dateTime | Date time format "yyyy/mm/dd T hours:min:secZ - Ex : 2017-02-13T22:15:30Z" -### 18. Workflow Equipment Table +### 23. Workflow Equipment Table This section outlines how to retrieve data from the Workflow Equipment table using the provided endpoint. Equipment workflows are typically labeled Inspection. You have the flexibility to fetch specific data by including workflow Equipment Ids, workflow Ids, and Equipment Ids. The Workflow Equipment endpoint also supports pagination for managing large datasets effectively. @@ -1372,7 +1831,7 @@ workflowEquipmentIds | int | Workflow Equipment ID is the unique identifier for workflowIds | int | Workflow Ids is the unique identifier of the associated workflow. equipmentIds | string | Equipment IDs are the unique identifier of the associated equipment. -### 19. Workflow Facility Table +### 24. Workflow Facility Table This section outlines how to retrieve data from the Workflow Facility table using the provided endpoint. Facility workflows are typically labeled Inspection. You have the flexibility to fetch specific data by including workflow Facility Ids, workflow Ids and facility Ids. The Workflow Facility endpoint also supports pagination for managing large datasets effectively. @@ -1439,7 +1898,7 @@ facilityIds | int | Facility IDs are the unique identifier for the associated fa -### 20. Workflow Person Table +### 25. Workflow Person Table This section outlines how to retrieve data from the Workflow Person table using the provided endpoint. You have the flexibility to fetch specific data by including workflow person Ids, workflow Ids and person Ids. The Unit type endpoint also supports pagination for managing large datasets effectively. @@ -1504,7 +1963,7 @@ workflowPersonIds | int | Workflow Person ID is the unique identifier for the as workflowIds | int | Workflow IDs are the unique identifier for workflows (the named form or workflow type+date completed). personIds | int | Person IDs are the assigned values for associated person(s) and can be used as a filter. -### 21. Workflow Question Table +### 26. Workflow Question Table This section outlines how to retrieve data from the Workflow Question table using the provided endpoint. You have the flexibility to fetch specific data by including workflow Question Ids, workflow question categoy Ids, data type Ids, required Inds and questions. The Workflow Question endpoint also supports pagination for managing large datasets effectively. @@ -1597,7 +2056,7 @@ dataTypeIds | int | Data Type IDs are the unique identifiers for the associated requiredInds | string | Required Inds is the value if an answer is required before saving the form. questions | string | Questions are the question content values included on the form. -### 22. Workflow Question Category Table +### 27. Workflow Question Category Table This section outlines how to retrieve data from the Workflow Question Category table using the provided endpoint. You have the flexibility to fetch specific data by including workflow question category Ids, workflow type Ids and workflow question category. The Workflow Question Category endpoint also supports pagination for managing large datasets effectively. @@ -1675,7 +2134,7 @@ workflowTypeIds | int | Workflow Type IDs are the unique identifiers for the ass workflow question category | string | Workflow Question Category is the category of the form type. -### 23. Workflow Type Table +### 28. Workflow Type Table This section outlines how to retrieve data from the Workflow Type table using the provided endpoint. You have the flexibility to fetch specific data by including workflow Ids, workflow type Ids, and workflows. The Unit type endpoint also supports pagination for managing large datasets effectively. diff --git a/source/includes/acts/post_api.md b/source/includes/acts/post_api.md index 8c92cb8b69a..a651db78911 100644 --- a/source/includes/acts/post_api.md +++ b/source/includes/acts/post_api.md @@ -1136,7 +1136,356 @@ IRestResponse response = client.Execute(request); ``` -### 12. Workflow Table +### 12. Regulation Table + +This section outlines the process of adding new entries or modifying existing records within the Regulation table using the dedicated API endpoint. + +**Regulation POST Endpoint** + +`POST` /actsapi/v1/regulation + +> Example Request & JSON Input Body + +```javascript +var request = require("request"); + +var options = { method: 'POST', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/regulation', + headers: { 'content-type': 'application/json' }, + body: + [ + { + "activeDate": "2025-10-21T15:14:09.542Z", + "inactiveDate": "2025-10-21T15:14:09.543Z", + "externalIdentifier": "string", + "comments": "string", + "regulationId": "number", + "agencyId": "number", + "regulationTypeId": "number", + "mediaId": "number", + "regulationName": "string", + "regulationStatusId": "number", + "applicationDate": "2025-10-21T15:14:09.543Z", + "completeDate": "2025-10-21T15:14:09.543Z", + "publicNoticeDate": "2025-10-21T15:14:09.543Z", + "issueDate": "2025-10-21T15:14:09.543Z", + "renewalDate": "2025-10-21T15:14:09.543Z", + "expirationDate": "2025-10-21T15:14:09.543Z", + "description": "string", + "applicabilityCriteria": "string", + "sortOrder": "number" + } + ], + json: true }; + + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/regulation"); +var request = new RestRequest(Method.POST); +request.AddHeader("content-type", "application/json"); +request.AddParameter("application/json", "[{\"activeDate\":\"2025-10-21T15:14:09.542Z\",\"inactiveDate\":\"2025-10-21T15:14:09.543Z\",\"externalIdentifier\":\"string\",\"comments\":\"string\",\"regulationId\":\"number\",\"agencyId\":\"number\",\"regulationTypeId\":\"number\",\"mediaId\":\"number\",\"regulationName\":\"string\",\"regulationStatusId\":\"number\",\"applicationDate\":\"2025-10-21T15:14:09.543Z\",\"completeDate\":\"2025-10-21T15:14:09.543Z\",\"publicNoticeDate\":\"2025-10-21T15:14:09.543Z\",\"issueDate\":\"2025-10-21T15:14:09.543Z\",\"renewalDate\":\"2025-10-21T15:14:09.543Z\",\"expirationDate\":\"2025-10-21T15:14:09.543Z\",\"description\":\"string\",\"applicabilityCriteria\":\"string\",\"sortOrder\":\"number\"}]", ParameterType.RequestBody); +IRestResponse response = client.Execute(request); +``` + +> Input JSON Body + +```json +[ + { + "activeDate": "2025-10-21T15:14:09.542Z", + "inactiveDate": "2025-10-21T15:14:09.543Z", + "externalIdentifier": "string", + "comments": "string", + "regulationId": "number", + "agencyId": "number", + "regulationTypeId": "number", + "mediaId": "number", + "regulationName": "string", + "regulationStatusId": "number", + "applicationDate": "2025-10-21T15:14:09.543Z", + "completeDate": "2025-10-21T15:14:09.543Z", + "publicNoticeDate": "2025-10-21T15:14:09.543Z", + "issueDate": "2025-10-21T15:14:09.543Z", + "renewalDate": "2025-10-21T15:14:09.543Z", + "expirationDate": "2025-10-21T15:14:09.543Z", + "description": "string", + "applicabilityCriteria": "string", + "sortOrder": "number" + } +] +``` +> Example Response + +```json +{ + "insertedRowCount" : 2, + "updatedRowCount" : 3, + "failureCount" : 0, + "errorMessage" : [] +} +``` + +> Example Output For When Data Get's Failed To Insert or Update + +```json +{ + "insertedRowCount": 0, + "updatedRowCount": 0, + "failureCount": 1, + "errorMessage": [ + "Not found RegulationIds: 123041" + ] +} +``` + +### 13. Requirement Table + +This section outlines the process of adding new entries or modifying existing records within the Requirement table using the dedicated API endpoint. + +**Requirement POST Endpoint** + +`POST` /actsapi/v1/requirement + +> Example Request & JSON Input Body + +```javascript +var request = require("request"); + +var options = { method: 'POST', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/requirement', + headers: { 'content-type': 'application/json' }, + body: + [ + { + "requirementId": "number", + "regulationId": "number", + "requirementTypeId": "number", + "requirementName": "string", + "requirementFrequencyId": "number", + "requirementCategoryId": "number", + "regulationActivityId": "number", + "description": "string", + "associatedRequirements": "string", + "applicabilityCriteria": "string", + "sortOrder": "number", + "generateTaskInd": "string", + "taskText": "string", + "firstDueDate": "2024-01-03T08:16:24.155Z", + "generateFacilityTasksInd": "string", + "combineTasksInd": "string", + "attributeTypeId": "number", + "triggerOffset": "number", + "triggerOffsetType": "string", + "creationOffset": "number", + "dependentRequirementId": "number", + "conditionalFormula": "string", + "activeDate": "2024-01-03T08:16:24.155Z", + "inactiveDate": "2024-01-03T08:16:24.155Z", + "externalIdentifier": "string", + "comments": "string" + } + ], + json: true }; + + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/requirement"); +var request = new RestRequest(Method.POST); +request.AddHeader("content-type", "application/json"); +request.AddParameter("application/json", "[{\"requirementId\":\"number\",\"regulationId\":\"number\",\"requirementTypeId\":\"number\",\"requirementName\":\"string\",\"requirementFrequencyId\":\"number\",\"requirementCategoryId\":\"number\",\"regulationActivityId\":\"number\",\"description\":\"string\",\"associatedRequirements\":\"string\",\"applicabilityCriteria\":\"string\",\"sortOrder\":\"number\",\"generateTaskInd\":\"string\",\"taskText\":\"string\",\"firstDueDate\":\"2024-01-03T08:16:24.155Z\",\"generateFacilityTasksInd\":\"string\",\"combineTasksInd\":\"string\",\"attributeTypeId\":\"number\",\"triggerOffset\":\"number\",\"triggerOffsetType\":\"string\",\"creationOffset\":\"number\",\"dependentRequirementId\":\"number\",\"conditionalFormula\":\"string\",\"activeDate\":\"2024-01-03T08:16:24.155Z\",\"inactiveDate\":\"2024-01-03T08:16:24.155Z\",\"externalIdentifier\":\"string\",\"comments\":\"string\"}]", ParameterType.RequestBody); +IRestResponse response = client.Execute(request); +``` + +> Input JSON Body + +```json +[ + { + "requirementId": "number", + "regulationId": "number", + "requirementTypeId": "number", + "requirementName": "string", + "requirementFrequencyId": "number", + "requirementCategoryId": "number", + "regulationActivityId": "number", + "description": "string", + "associatedRequirements": "string", + "applicabilityCriteria": "string", + "sortOrder": "number", + "generateTaskInd": "string", + "taskText": "string", + "firstDueDate": "2024-01-03T08:16:24.155Z", + "generateFacilityTasksInd": "string", + "combineTasksInd": "string", + "attributeTypeId": "number", + "triggerOffset": "number", + "triggerOffsetType": "string", + "creationOffset": "number", + "dependentRequirementId": "number", + "conditionalFormula": "string", + "activeDate": "2024-01-03T08:16:24.155Z", + "inactiveDate": "2024-01-03T08:16:24.155Z", + "externalIdentifier": "string", + "comments": "string" + } +] +``` +> Example Response + +```json +{ + "insertedRowCount" : 2, + "updatedRowCount" : 3, + "failureCount" : 0, + "errorMessage" : [] +} +``` + +> Example Output For When Data Get's Failed To Insert or Update + +```json +{ + "insertedRowCount": 0, + "updatedRowCount": 0, + "failureCount": 1, + "errorMessage": [ + "RequirementId: 103356 does not exist" + ] +} + +``` +### 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. + +**Requirement Limit POST Endpoint** + +`POST` /actsapi/v1/requirementLimit + +> Example Request & JSON Input Body + +```javascript +var request = require("request"); + +var options = { method: 'POST', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/requirementLimit', + headers: { 'content-type': 'application/json' }, + body: + [ + { + "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" + } + ], + json: true }; + +request(options, function (error, response, body) { + if (error) throw new Error(error); + console.log(body); +}); +``` + +```csharp +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/requirementLimit"); +var request = new RestRequest(Method.POST); +request.AddHeader("content-type", "application/json"); +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); +IRestResponse response = client.Execute(request); +``` + +> Input JSON Body + +```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" + } +] +``` +> Example Response + +```json +{ + "insertedRowCount" : 1, + "updatedRowCount" : 0, + "failureCount" : 0, + "errorMessage" : [] +} +``` + +> Example Output For When Data Get's Failed To Insert or Update + +```json +{ + "insertedRowCount": 0, + "updatedRowCount": 0, + "failureCount": 1, + "errorMessage": [ + "Not found RequirementLimitIds: 12345" + ] +} +``` + +### 15. Workflow Table This section outlines the process of adding new entries or modifying existing records within the Workflow table using the dedicated API endpoint. @@ -1222,7 +1571,7 @@ IRestResponse response = client.Execute(request); ``` -### 13. Workflow Answer Table +### 16. Workflow Answer Table This section outlines the process of adding new entries or modifying existing records within the Workflow Answer table using the dedicated API endpoint. @@ -1316,7 +1665,7 @@ IRestResponse response = client.Execute(request); ``` -### 14. Workflow Equipment Table +### 17. Workflow Equipment Table This section outlines the process of adding new entries or modifying existing records within the Workflow Equipment table using the dedicated API endpoint. @@ -1402,7 +1751,7 @@ IRestResponse response = client.Execute(request); ``` -### 15. Workflow Facility Table +### 18. Workflow Facility Table This section outlines the process of adding new entries or modifying existing records within the Workflow Facility table using the dedicated API endpoint. @@ -1489,7 +1838,7 @@ IRestResponse response = client.Execute(request); ``` -### 16. Workflow Person Table +### 19. Workflow Person Table This section outlines the process of adding new entries or modifying existing records within the Workflow Person table using the dedicated API endpoint.