diff --git a/source/includes/_api-reference.md b/source/includes/_api-reference.md index 9caf66b9860..46aec22a8a3 100644 --- a/source/includes/_api-reference.md +++ b/source/includes/_api-reference.md @@ -7,7 +7,7 @@ The Intelex API is organized around REST. Our API has predictable, resource-orie > API Endpoint - replace **intelex_url** with the full URL path to your Intelex system ``` -https://intelex_url/api/v2/ +https://intelex_url/actsapi/v2/ ``` To begin using the Intelex API you will need: @@ -136,7 +136,7 @@ Response Code | Meaning ## Versioning -When we make backwards-incompatible changes to the API, we release new versions. The current version is **v2** and can be determined with our API base path **/api/v2/**. Read our [Intelex platform release notes](https://community.intelex.com/library/knowledgebase/release-notes) to see our API changelog. +When we make backwards-incompatible changes to the API, we release new versions. The current version is **v2** and can be determined with our API base path **/actsapi/v2/**. Read our [Intelex platform release notes](https://community.intelex.com/library/knowledgebase/release-notes) to see our API changelog. ## API Rate Limiting / Quotas To ensure Intelex Platform is reliable and has the expected performance for all users, we limit the number of API calls an API user (or application) can make within a given time period. If the limit is exceeded, the API user may be throttled and subsequent requests within the same period will fail (status code 429). diff --git a/source/includes/_interface-api.md b/source/includes/_interface-api.md index 3637f3e1ac8..e12b75ad216 100644 --- a/source/includes/_interface-api.md +++ b/source/includes/_interface-api.md @@ -12,7 +12,7 @@ The following resources give you access to system information var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/apps' }; + url: 'https://intelex_url/actsapi/v2/apps' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -22,7 +22,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/apps"); +var client = new RestClient("https://intelex_url/actsapi/v2/apps"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -45,7 +45,7 @@ IRestResponse response = client.Execute(request); Returns the apps that you can use -#### GET /api/v2/apps +#### GET /actsapi/v2/apps Attribute | Description --------- | ----------- @@ -65,7 +65,7 @@ NavigationUrl | Navigation URL of application var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/reports' }; + url: 'https://intelex_url/actsapi/v2/reports' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -75,7 +75,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/reports"); +var client = new RestClient("https://intelex_url/actsapi/v2/reports"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -96,7 +96,7 @@ IRestResponse response = client.Execute(request); Returns the reports that you can view -#### GET /api/v2/reports +#### GET /actsapi/v2/reports Attribute | Description --------- | ----------- @@ -113,7 +113,7 @@ NavigationUrl | URL to view report var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/dashboards' }; + url: 'https://intelex_url/actsapi/v2/dashboards' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -123,7 +123,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/dashboards"); +var client = new RestClient("https://intelex_url/actsapi/v2/dashboards"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -144,7 +144,7 @@ IRestResponse response = client.Execute(request); Returns the dashboards that you can view -#### GET /api/v2/dashboards +#### GET /actsapi/v2/dashboards Attribute | Description --------- | ----------- @@ -160,7 +160,7 @@ NavigationUrl | URL to view dashboard var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/locations' }; + url: 'https://intelex_url/actsapi/v2/locations' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -170,7 +170,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/locations"); +var client = new RestClient("https://intelex_url/actsapi/v2/locations"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -200,7 +200,7 @@ IRestResponse response = client.Execute(request); Returns the location hierarchy -#### GET /api/v2/locations +#### GET /actsapi/v2/locations Attribute | Description --------- | ----------- @@ -218,7 +218,7 @@ Children | An array of child locations var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/users/me' }; + url: 'https://intelex_url/actsapi/v2/users/me' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -228,7 +228,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/users/me"); +var client = new RestClient("https://intelex_url/actsapi/v2/users/me"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -245,7 +245,7 @@ IRestResponse response = client.Execute(request); Returns a user's details -#### GET /api/v2/users/me +#### GET /actsapi/v2/users/me Attribute | Description --------- | ----------- diff --git a/source/includes/_object-data-api.md b/source/includes/_object-data-api.md index e0d11e3cca4..a054ff60625 100644 --- a/source/includes/_object-data-api.md +++ b/source/includes/_object-data-api.md @@ -3,7 +3,7 @@ > Object Data API Endpoint - replace **intelex_object** with the system name of your object ``` -https://intelex_url/api/v2/object/intelex_object +https://intelex_url/actsapi/v2/object/intelex_object ``` The Object Data API gives you the ability to create, retrieve, update, and delete data in your Intelex application objects. Each Object Data API resource is an Intelex application object. Access each resource by using the system name of the object in the API endpoint URL. The data sent and returned with your API requests are the fields that exist on the object you are accessing. The system name of fields is used in every request and response. @@ -18,8 +18,8 @@ Your instance of Intelex may include system and custom objects. System objects i { "value": { "@odata.type": "#Intelex.IncidentsObject", - "@odata.id": "https://intelex_url/api/v2/object/IncidentsObject(UID)", - "@odata.editLink": "https://intelex_url/api/v2/object/IncidentsObject(UID)" + "@odata.id": "https://intelex_url/actsapi/v2/object/IncidentsObject(UID)", + "@odata.editLink": "https://intelex_url/actsapi/v2/object/IncidentsObject(UID)" } } ``` @@ -37,7 +37,7 @@ Property | Description ```json { - "@odata.nextLink": "https://intelex_url/api/v2/object/IncidentsObject?$skip=500" + "@odata.nextLink": "https://intelex_url/actsapi/v2/object/IncidentsObject?$skip=500" } ``` @@ -73,7 +73,7 @@ EDIS Staging Table | Staging table used to process EDIS | EmployeeStagingEntity var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -83,7 +83,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -111,7 +111,7 @@ IRestResponse response = client.Execute(request); Returns all records from an Intelex object that the user is authorized to view -#### GET /api/v2/object/{intelex_object} +#### GET /actsapi/v2/object/{intelex_object} ##### URL Parameters @@ -127,7 +127,7 @@ intelex_object | The Intelex system name of the object being requested eg. Incid var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -137,7 +137,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -179,7 +179,7 @@ id | The Intelex UID of the record being requested var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/SubIncidents' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/SubIncidents' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -190,7 +190,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/SubIncidents"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/SubIncidents"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -236,7 +236,7 @@ navigation_property|The Intelex system name of the relation type or lookup type var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/SubIncidents(UID)' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/SubIncidents(UID)' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -246,7 +246,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/SubIncidents(UID)"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/SubIncidents(UID)"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -290,7 +290,7 @@ navigation_property|The Intelex system name of the relation type or lookup type var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject', qs: { '$select': 'IncidentNo' } }; request(options, function (error, response, body) { @@ -302,7 +302,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject?$select=IncidentNo"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject?$select=IncidentNo"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -345,7 +345,7 @@ field_name | Field name(s) to include in response var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject', qs: { '$count': 'true' } }; request(options, function (error, response, body) { @@ -357,7 +357,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject?$count=true"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject?$count=true"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -402,7 +402,7 @@ intelex_object | The Intelex system name of the object being requested eg. Incid var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject', qs: { '$skip': '10', '$top': '5' } }; request(options, function (error, response, body) { @@ -413,7 +413,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject?$skip=10&$top=5"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject?$skip=10&$top=5"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -463,7 +463,7 @@ skip_n| Number of items to be skipped var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject', qs: { '$orderby': 'DateCreated desc' } }; request(options, function (error, response, body) { @@ -475,7 +475,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject?$orderby=DateCreateddesc"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject?$orderby=DateCreateddesc"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -533,7 +533,7 @@ field_name | Fields that you want to sort by var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject', qs: { '$filter': 'IncidentNo eq 1000' } }; request(options, function (error, response, body) { @@ -544,7 +544,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject?$filter=IncidentNo eq 10"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject?$filter=IncidentNo eq 10"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -657,7 +657,7 @@ You can only access the records you have permission to view. var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject', qs: { '$expand': 'Location' } }; request(options, function (error, response, body) { @@ -668,7 +668,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject?$expand=Location"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject?$expand=Location"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -747,7 +747,7 @@ relation_field | Relation field used to request related object data var request = require("request"); var options = { method: 'POST', - url: 'https://intelex_url/api/v2/object/IncidentsObject', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject', headers: { 'content-type': 'application/json' }, body: { ActionsTaken: 'string', @@ -766,7 +766,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n \"ActionsTaken\": \"string\",\r\n \"Date\": \"2017-02-13T22:15:30.203Z\",\r\n \"Description\": \"string\",\r\n \"IncidentNo\": 0,\r\n \"ReportedDate\": \"2017-02-13T22:15:30.203Z\",\r\n \"SuspectedCause\": \"string\"\r\n}", ParameterType.RequestBody); @@ -793,7 +793,7 @@ IRestResponse response = client.Execute(request); ```json { - "Location@odata.bind": "https://intelex_url/api/v2/object/LocationObject(Id)" + "Location@odata.bind": "https://intelex_url/actsapi/v2/object/LocationObject(Id)" } ``` @@ -801,7 +801,7 @@ IRestResponse response = client.Execute(request); ```json { - "Severity@odata.bind": "https://intelex_url/api/v2/object/SeverityLookupObject(Id)" + "Severity@odata.bind": "https://intelex_url/actsapi/v2/object/SeverityLookupObject(Id)" } ``` @@ -810,7 +810,7 @@ IRestResponse response = client.Execute(request); ```json { "Workflow": { - "PersonResponsible@odata.bind": "https://intelex_url/api/v2/object/EmployeeObject(UID)", + "PersonResponsible@odata.bind": "https://intelex_url/actsapi/v2/object/EmployeeObject(UID)", "RecurringSeries": { "Frequency": "RRULE:FREQ=HOURLY", "StartDate": "2017-06-06T02:30:00-05:00", @@ -825,8 +825,8 @@ IRestResponse response = client.Execute(request); ```json { "RelatedIncidents@odata.bind": [ - "https://intelex_url/api/v2/object/RelatedIncidentObject(Id)", - "https://intelex_url/api/v2/object/RelatedIncidentObject(Id)" + "https://intelex_url/actsapi/v2/object/RelatedIncidentObject(Id)", + "https://intelex_url/actsapi/v2/object/RelatedIncidentObject(Id)" ] } ``` @@ -865,7 +865,7 @@ ActionToExecute | UID of the workflow stage action|No|Id=797bbb3b-b485-4e73-a21c var request = require("request"); var options = { method: 'POST', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/SubIncidents', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/SubIncidents', headers: { 'content-type': 'application/json' }, body: { ActionsTaken: 'string', @@ -884,7 +884,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/SubIncidents"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/SubIncidents"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n \"ActionsTaken\": \"string\",\r\n \"Date\": \"2017-02-13T22:15:30.203Z\",\r\n \"Description\": \"string\",\r\n \"IncidentNo\": 0,\r\n \"ReportedDate\": \"2017-02-13T22:15:30.203Z\",\r\n \"SuspectedCause\": \"string\"\r\n}", ParameterType.RequestBody); @@ -942,7 +942,7 @@ ActionToExecute | UID of the workflow stage action|No|Id=797bbb3b-b485-4e73-a21c var request = require("request"); var options = { method: 'PATCH', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)', headers: { 'content-type': 'application/json' }, body: { Description: 'string' }, json: true }; @@ -955,7 +955,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)"); var request = new RestRequest(Method.PATCH); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n \"Description\": \"string\"\r\n}", ParameterType.RequestBody); @@ -966,7 +966,7 @@ IRestResponse response = client.Execute(request); ```json { - "Location@odata.bind": "https://intelex_url/api/v2/object/LocationObject(UID)" + "Location@odata.bind": "https://intelex_url/actsapi/v2/object/LocationObject(UID)" } ``` @@ -974,7 +974,7 @@ IRestResponse response = client.Execute(request); ```json { - "Severity@odata.bind": "https://intelex_url/api/v2/object/SeverityLookupObject(UID)" + "Severity@odata.bind": "https://intelex_url/actsapi/v2/object/SeverityLookupObject(UID)" } ``` @@ -983,8 +983,8 @@ IRestResponse response = client.Execute(request); ```json { "RelatedIncidents@odata.bind": [ - "https://intelex_url/api/v2/object/RelatedIncidentObject(UID)", - "https://intelex_url/api/v2/object/RelatedIncidentObject(UID)" + "https://intelex_url/actsapi/v2/object/RelatedIncidentObject(UID)", + "https://intelex_url/actsapi/v2/object/RelatedIncidentObject(UID)" ] } ``` @@ -1023,7 +1023,7 @@ ActionToExecute | UID of the workflow stage action|No|Id=797bbb3b-b485-4e73-a21c var request = require("request"); var options = { method: 'DELETE', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1033,7 +1033,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)"); var request = new RestRequest(Method.DELETE); IRestResponse response = client.Execute(request); ``` @@ -1057,7 +1057,7 @@ id|The Intelex UID of the record being updated var request = require("request"); var options = { method: 'DELETE', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/SubIncidents(UID)' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/SubIncidents(UID)' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1067,7 +1067,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/SubIncidents(UID)"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/SubIncidents(UID)"); var request = new RestRequest(Method.DELETE); IRestResponse response = client.Execute(request); ``` @@ -1092,7 +1092,7 @@ navigation_property|The Intelex system name of the relation type field var request = require("request"); var options = { method: 'DELETE', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/Severity/$ref' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Severity/$ref' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1102,7 +1102,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/Severity/$ref"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Severity/$ref"); var request = new RestRequest(Method.DELETE); IRestResponse response = client.Execute(request); ``` @@ -1127,7 +1127,7 @@ navigation_property|The Intelex system name of the relation type field - must be var request = require("request"); var options = { method: 'DELETE', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/RelatedIncidents(UID)/$ref' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/RelatedIncidents(UID)/$ref' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1137,7 +1137,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/RelatedIncidents(UID)/$ref"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/RelatedIncidents(UID)/$ref"); var request = new RestRequest(Method.DELETE); IRestResponse response = client.Execute(request); ``` @@ -1164,7 +1164,7 @@ navigation_property|The Intelex system name of the relation type field - must be var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1174,7 +1174,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1220,7 +1220,7 @@ id|The Intelex UID of the record being accessed var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/Status' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/Status' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1230,7 +1230,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/Status"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/Status"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1281,7 +1281,7 @@ id|The Intelex UID of the record being accessed var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/CurrentStage' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/CurrentStage' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1291,7 +1291,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/CurrentStage"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/CurrentStage"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1342,7 +1342,7 @@ id|The Intelex UID of the record being accessed var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/CurrentStage/Actions' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/CurrentStage/Actions' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1352,7 +1352,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/CurrentStage/Actions"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/CurrentStage/Actions"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1406,7 +1406,7 @@ id|The Intelex UID of the record being accessed var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/PersonResponsible' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/PersonResponsible' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1416,7 +1416,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/PersonResponsible"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/PersonResponsible"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1456,7 +1456,7 @@ id|The Intelex UID of the record being accessed var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/RecurringSeries' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/RecurringSeries' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1466,7 +1466,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/RecurringSeries"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/RecurringSeries"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1510,7 +1510,7 @@ id|The Intelex UID of the record being accessed var request = require("request"); var options = { method: 'POST', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/CurrentStage/Actions(UID)/Action.ExecuteStageAction' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/CurrentStage/Actions(UID)/Action.ExecuteStageAction' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1521,7 +1521,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow/CurrentStage/Actions(UID)/Action.ExecuteStageAction"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow/CurrentStage/Actions(UID)/Action.ExecuteStageAction"); var request = new RestRequest(Method.POST); IRestResponse response = client.Execute(request); ``` @@ -1545,7 +1545,7 @@ id|The Intelex UID of the record or action being accessed var request = require("request"); var options = { method: 'PATCH', - url: 'https://intelex_url/api/v2/object/IncidentsObject%28UID%29/Workflow/RecurringSeries', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject%28UID%29/Workflow/RecurringSeries', headers: { 'content-type': 'application/json' }, body: { Frequency: 'RRULE:FREQ=HOURLY', @@ -1560,7 +1560,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject%28UID%29/Workflow/RecurringSeries"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject%28UID%29/Workflow/RecurringSeries"); var request = new RestRequest(Method.PATCH); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\n \"Frequency\": \"RRULE:FREQ=HOURLY\",\n \"StartDate\": \"2017-06-06T03:30:00-04:00\"\n}", ParameterType.RequestBody); @@ -1594,9 +1594,9 @@ EndDate | Date you want the frequency to end var request = require("request"); var options = { method: 'PATCH', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow', headers: { 'content-type': 'application/json' }, - body: { 'PersonResponsible@odata.bind': 'https://intelex_url/api/v2/object/EmployeeObject(UID)' }, + body: { 'PersonResponsible@odata.bind': 'https://intelex_url/actsapi/v2/object/EmployeeObject(UID)' }, json: true }; request(options, function (error, response, body) { @@ -1607,10 +1607,10 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/Workflow"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/Workflow"); var request = new RestRequest(Method.PATCH); request.AddHeader("content-type", "application/json"); -request.AddParameter("application/json", "{\n\t\"PersonResponsible@odata.bind\": \"https://intelex_url/api/v2/object/EmployeeObject(UID)\"\n}", ParameterType.RequestBody); +request.AddParameter("application/json", "{\n\t\"PersonResponsible@odata.bind\": \"https://intelex_url/actsapi/v2/object/EmployeeObject(UID)\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` @@ -1643,7 +1643,7 @@ There are two types of file attachments on records. Files can be attached to the var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject%28UID%29/ILX.Attachments' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject%28UID%29/ILX.Attachments' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1653,7 +1653,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject%28UID%29/ILX.Attachments"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject%28UID%29/ILX.Attachments"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1698,7 +1698,7 @@ id|The Intelex UID of the record being accessed var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/ILX.Attachments(UID)', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/ILX.Attachments(UID)', headers: { prefer: 'attachment=thumbnail', accept: 'application/octet-stream' } }; @@ -1711,7 +1711,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject%28UID%29/ILX.Attachments(UID)"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject%28UID%29/ILX.Attachments(UID)"); var request = new RestRequest(Method.GET); request.AddHeader("prefer", "attachment=thumbnail"); request.AddHeader("accept", "application/octet-stream"); @@ -1760,7 +1760,7 @@ Prefer|Used to request a thumbnail version of an image file|attachment=thumbnail var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/DocDocumentEntity(UID)/CurrentRevision/File', + url: 'https://intelex_url/actsapi/v2/object/DocDocumentEntity(UID)/CurrentRevision/File', headers: { accept: 'application/octet-stream' } }; @@ -1772,7 +1772,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/DocDocumentEntity%28UID%29/CurrentRevision/File"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/DocDocumentEntity%28UID%29/CurrentRevision/File"); var request = new RestRequest(Method.GET); request.AddHeader("accept", "application/octet-stream"); IRestResponse response = client.Execute(request); @@ -1818,7 +1818,7 @@ var fs = require("fs"); var request = require("request"); var options = { method: 'POST', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/ILX.Attachments', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/ILX.Attachments', headers: { 'content-type': 'multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' }, formData: { '': @@ -1835,7 +1835,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/ILX.Attachments"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/ILX.Attachments"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"); request.AddParameter("multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW", "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"\"; filename=\"C:\\Document.docx\"\r\nContent-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document\r\n\r\n\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--", ParameterType.RequestBody); @@ -1884,7 +1884,7 @@ multipart/formData | file | The file you want to attach to the record. Cannot ex var request = require("request"); var options = { method: 'DELETE', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/ILX.Attachments(UID)' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/ILX.Attachments(UID)' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1895,7 +1895,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/ILX.Attachments(UID)"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/ILX.Attachments(UID)"); var request = new RestRequest(Method.DELETE); IRestResponse response = client.Execute(request); ``` @@ -1920,7 +1920,7 @@ The first step for File type is to upload document. The file must be attached to var fs = require("fs"); var request = require("request"); var options = { method: 'POST', - url: 'https://intelex_url/api/v2/FileUpload', + url: 'https://intelex_url/actsapi/v2/FileUpload', headers: { 'content-type': 'multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' }, formData: { '': @@ -1959,7 +1959,7 @@ content-type | The multipart/form-data content type is intended to allow informa var fs = require("fs"); var request = require("request"); var options = { method: 'POST', - url: 'https://intelex_url/api/v2/object/SysFileInfoEntity', + url: 'https://intelex_url/actsapi/v2/object/SysFileInfoEntity', headers: { 'content-type': 'multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' }, formData: { '': @@ -2008,7 +2008,7 @@ Once you have @odata.id of FileInfo, you can use that to attach to an obj ``` { .... - "FileInput@odata.bind": "http://torwdtahmed02.intelex.com/devlogin/inspections/api/v2/object/SysFileInfoEntity(47df4cec-50ad-4da5-a820-7827985a77bb)" + "FileInput@odata.bind": "http://torwdtahmed02.intelex.com/devlogin/inspections/actsapi/v2/object/SysFileInfoEntity(47df4cec-50ad-4da5-a820-7827985a77bb)" } ``` ##### POST /object/{intelex_object} @@ -2047,7 +2047,7 @@ To access Merge Template details use the system reserved property: ILX.MailMerge var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/ILX.MailMergeDocs' }; + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/ILX.MailMergeDocs' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -2057,7 +2057,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/ILX.MailMergeDocs"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/ILX.MailMergeDocs"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -2105,7 +2105,7 @@ id|The Intelex UID of the object record being accessed var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/object/IncidentsObject(UID)/ILX.MailMergeDocs(UID)', + url: 'https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/ILX.MailMergeDocs(UID)', headers: { accept: 'application/octet-stream' } }; @@ -2117,7 +2117,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/object/IncidentsObject(UID)/ILX.MailMergeDocs(UID)"); +var client = new RestClient("https://intelex_url/actsapi/v2/object/IncidentsObject(UID)/ILX.MailMergeDocs(UID)"); var request = new RestRequest(Method.GET); request.AddHeader("accept", "application/octet-stream"); IRestResponse response = client.Execute(request); @@ -2214,7 +2214,7 @@ Content-Transfer-Encoding: binary Content-ID: 1 HTTP/1.1 201 Created -Location: https://intelex_url/api/v2/object/IncidentsObject(UID) +Location: https://intelex_url/actsapi/v2/object/IncidentsObject(UID) Content-Type: application/json; odata.metadata=minimal OData-Version: 4.0 diff --git a/source/includes/_package-api.md b/source/includes/_package-api.md index b0cbcd084c9..34c39ca3e56 100644 --- a/source/includes/_package-api.md +++ b/source/includes/_package-api.md @@ -13,7 +13,7 @@ var fs = require("fs"); var request = require("request"); var options = { method: 'POST', - url: 'https://intelex_url/api/v2/packages/install', + url: 'https://intelex_url/actsapi/v2/packages/install', headers: { 'content-type': 'multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' }, formData: { '': @@ -30,7 +30,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/packages/install"); +var client = new RestClient("https://intelex_url/actsapi/v2/packages/install"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"); request.AddParameter("multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW", "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"\"; filename=\"C:\\Package.ipack\"\r\nContent-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document\r\n\r\n\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--", ParameterType.RequestBody); @@ -54,7 +54,7 @@ IRestResponse response = client.Execute(request); Installs an Intelex package. This request will only accept one of two body parameters. If you want to install and package that already has been imported, then provide the PackageId in your request. If you want to import and install a package, then provide the package file as multipart/formdata. Do not provide both parameters. -#### POST /api/v2/packages/install +#### POST /actsapi/v2/packages/install ##### Body Parameters @@ -73,7 +73,7 @@ var fs = require("fs"); var request = require("request"); var options = { method: 'POST', - url: 'https://intelex_url/api/v2/packages/import', + url: 'https://intelex_url/actsapi/v2/packages/import', headers: { 'content-type': 'multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' }, formData: { '': @@ -90,7 +90,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/packages/import"); +var client = new RestClient("https://intelex_url/actsapi/v2/packages/import"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"); request.AddParameter("multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW", "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"\"; filename=\"C:\\Package.ipack\"\r\nContent-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document\r\n\r\n\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--", ParameterType.RequestBody); @@ -114,7 +114,7 @@ IRestResponse response = client.Execute(request); Imports an Intelex package -#### POST /api/v2/packages/import +#### POST /actsapi/v2/packages/import ##### Body Parameters diff --git a/source/includes/_system-api b/source/includes/_system-api index 7120bbe2cb7..3345d54ca34 100644 --- a/source/includes/_system-api +++ b/source/includes/_system-api @@ -11,7 +11,7 @@ The Task API is currently in beta. This means that we might make changes to the { "value": { "@odata.type": "#Intelex.IncidentsObject", - "@odata.id": "https://intelex_url/api/v2/object/IncidentsObject(UID)", + "@odata.id": "https://intelex_url/actsapi/v2/object/IncidentsObject(UID)", } } ``` @@ -28,7 +28,7 @@ Property | Description ```json { - "@odata.nextLink": "https://intelex_url/api/v2/task/mytasks?$skip=500" + "@odata.nextLink": "https://intelex_url/actsapi/v2/task/mytasks?$skip=500" } ``` @@ -60,7 +60,7 @@ The following resources are similar to the application abs you find in the My Ta var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task' }; + url: 'https://intelex_url/actsapi/v2/task' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -70,7 +70,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task"); +var client = new RestClient("https://intelex_url/actsapi/v2/task"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -91,7 +91,7 @@ IRestResponse response = client.Execute(request); Returns the task resource endpoints that you can access -#### GET /api/v2/task +#### GET /actsapi/v2/task Attribute | Description --------- | ----------- diff --git a/source/includes/_task-api.md b/source/includes/_task-api.md index 8e30f2ad0bd..c774e84f66b 100644 --- a/source/includes/_task-api.md +++ b/source/includes/_task-api.md @@ -11,7 +11,7 @@ The Task API is currently in beta. This means that we might make changes to the { "value": { "@odata.type": "#Intelex.IncidentsObject", - "@odata.id": "https://intelex_url/api/v2/object/IncidentsObject(UID)", + "@odata.id": "https://intelex_url/actsapi/v2/object/IncidentsObject(UID)", } } ``` @@ -28,7 +28,7 @@ Property | Description ```json { - "@odata.nextLink": "https://intelex_url/api/v2/task/mytasks?$skip=500" + "@odata.nextLink": "https://intelex_url/actsapi/v2/task/mytasks?$skip=500" } ``` @@ -60,7 +60,7 @@ The following resources are similar to the application tabs you find in the My T var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task' }; + url: 'https://intelex_url/actsapi/v2/task' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -70,7 +70,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task"); +var client = new RestClient("https://intelex_url/actsapi/v2/task"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -91,7 +91,7 @@ IRestResponse response = client.Execute(request); Returns the task resource endpoints that you can access -#### GET /api/v2/task +#### GET /actsapi/v2/task Attribute | Description --------- | ----------- @@ -107,7 +107,7 @@ url | Endpoint for resource var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/mytasks' }; + url: 'https://intelex_url/actsapi/v2/task/mytasks' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -117,7 +117,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task/mytasks"); +var client = new RestClient("https://intelex_url/actsapi/v2/task/mytasks"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -154,7 +154,7 @@ IRestResponse response = client.Execute(request); Returns your tasks -#### GET /api/v2/task/mytasks +#### GET /actsapi/v2/task/mytasks Attribute | Description --------- | ----------- @@ -184,7 +184,7 @@ WebLink | Web URL to access task view var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/stafftasks' }; + url: 'https://intelex_url/actsapi/v2/task/stafftasks' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -194,7 +194,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task/stafftasks"); +var client = new RestClient("https://intelex_url/actsapi/v2/task/stafftasks"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -231,7 +231,7 @@ IRestResponse response = client.Execute(request); Returns all tasks assigned to employees that the user is supervisor of -#### GET /api/v2/task/stafftasks +#### GET /actsapi/v2/task/stafftasks Attribute | Description --------- | ----------- @@ -261,7 +261,7 @@ WebLink | Web URL to access task view var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/locationtasks' }; + url: 'https://intelex_url/actsapi/v2/task/locationtasks' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -271,7 +271,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task/locationtasks"); +var client = new RestClient("https://intelex_url/actsapi/v2/task/locationtasks"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -308,7 +308,7 @@ IRestResponse response = client.Execute(request); Returns all tasks for a location. Default location is the user's logon location set in their user profile. Tasks returned will belong to the default location and its child locations. -#### GET /api/v2/task/locationtasks +#### GET /actsapi/v2/task/locationtasks Attribute | Description --------- | ----------- @@ -344,7 +344,7 @@ ActiveLocation | Provide the ID of the location you want to use as the active lo var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/alltasks' }; + url: 'https://intelex_url/actsapi/v2/task/alltasks' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -354,7 +354,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task/alltasks"); +var client = new RestClient("https://intelex_url/actsapi/v2/task/alltasks"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -391,7 +391,7 @@ IRestResponse response = client.Execute(request); Returns all tasks in Intelex -#### GET /api/v2/task/alltasks +#### GET /actsapi/v2/task/alltasks Attribute | Description --------- | ----------- @@ -421,7 +421,7 @@ WebLink | Web URL to access task view var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/types' }; + url: 'https://intelex_url/actsapi/v2/task/types' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -431,7 +431,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task/types"); +var client = new RestClient("https://intelex_url/actsapi/v2/task/types"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -463,7 +463,7 @@ IRestResponse response = client.Execute(request); Returns types of tasks you can create. This data is used to determine which objects have 'quick task creation' enabled -#### GET /api/v2/task/types +#### GET /actsapi/v2/task/types Attribute | Description --------- | ----------- @@ -487,7 +487,7 @@ You can use the following query options on any of the Task API resources var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/mytasks', + url: 'https://intelex_url/actsapi/v2/task/mytasks', qs: { '$select': 'RecordDescription' } }; request(options, function (error, response, body) { @@ -499,7 +499,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task/mytasks?$select=RecordDescription"); +var client = new RestClient("https://intelex_url/actsapi/v2/task/mytasks?$select=RecordDescription"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -541,7 +541,7 @@ field_name | Field name(s) to include in response var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/mytasks', + url: 'https://intelex_url/actsapi/v2/task/mytasks', qs: { '$count': 'true' } }; request(options, function (error, response, body) { @@ -553,7 +553,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task/mytasks?$count=true"); +var client = new RestClient("https://intelex_url/actsapi/v2/task/mytasks?$count=true"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -600,7 +600,7 @@ The $count system query option with a value of true specifies that the total cou var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/mytasks', + url: 'https://intelex_url/actsapi/v2/task/mytasks', qs: { '$skip': '10', '$top': '5' } }; request(options, function (error, response, body) { @@ -611,7 +611,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task/mytasks?$skip=10&$top=5"); +var client = new RestClient("https://intelex_url/actsapi/v2/task/mytasks?$skip=10&$top=5"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -663,7 +663,7 @@ skip_n| Number of items to be skipped var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/mytasks', + url: 'https://intelex_url/actsapi/v2/task/mytasks', qs: { '$orderby': 'NextDate desc' } }; request(options, function (error, response, body) { @@ -675,7 +675,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task/mytasks?$orderby=NextDate desc"); +var client = new RestClient("https://intelex_url/actsapi/v2/task/mytasks?$orderby=NextDate desc"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -734,7 +734,7 @@ field_name | Fields that you want to sort by var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/mytasks', + url: 'https://intelex_url/actsapi/v2/task/mytasks', qs: { '$filter': 'RespEmployeeName eq \'Steve Rogers\'' } }; request(options, function (error, response, body) { @@ -746,7 +746,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("http://cloud3.intelex.com/wabouchalha/api/v2/task/mytasks?%24filter=RespEmployeeName%20eq%20'Steve%20Rogers'"); +var client = new RestClient("http://cloud3.intelex.com/wabouchalha/actsapi/v2/task/mytasks?%24filter=RespEmployeeName%20eq%20'Steve%20Rogers'"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -832,7 +832,7 @@ filter_expression | Filter expression used to query data var request = require("request"); var options = { method: 'GET', - url: 'https://intelex_url/api/v2/task/locationtasks', + url: 'https://intelex_url/actsapi/v2/task/locationtasks', qs: { '$expand': 'Location' } }; request(options, function (error, response, body) { @@ -843,7 +843,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://intelex_url/api/v2/task/locationtasks?$expand=Location"); +var client = new RestClient("https://intelex_url/actsapi/v2/task/locationtasks?$expand=Location"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` diff --git a/source/includes/acts/delete_api.md b/source/includes/acts/delete_api.md index 988f405cdef..8464c372651 100644 --- a/source/includes/acts/delete_api.md +++ b/source/includes/acts/delete_api.md @@ -20,7 +20,7 @@ This section guides you through the process of removing/deleting the existing re **Analysis DELETE endpoint** -`DELETE` /api/v1/analysis +`DELETE` /actsapi/v1/analysis > Example Request & JSON Input Body @@ -28,7 +28,7 @@ This section guides you through the process of removing/deleting the existing re var request = require("request"); var options = { method: 'DELETE', - url: 'https://[tenant].actsapi.intelex.com/v1/analysis', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/analysis', headers: { 'content-type': 'application/json' }, body: { @@ -45,7 +45,7 @@ request(options, function (error, response, body) { ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/analysis"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/analysis"); var request = new RestRequest(Method.DELETE); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n [operationId1, operationId2, operationId3....] \r\n}", ParameterType.RequestBody); @@ -78,7 +78,7 @@ This section guides you through the process of removing/deleting the existing re **Analysis Compound DELETE endpoint** -`DELETE` /api/v1/analysiscompound +`DELETE` /actsapi/v1/analysiscompound > Example Request & JSON Input Body @@ -86,7 +86,7 @@ This section guides you through the process of removing/deleting the existing re var request = require("request"); var options = { method: 'DELETE', - url: 'https://[tenant].actsapi.intelex.com/v1/analysiscompound', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/analysiscompound', headers: { 'content-type': 'application/json' }, body: { @@ -103,7 +103,7 @@ request(options, function (error, response, body) { ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/analysiscompound"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/analysiscompound"); var request = new RestRequest(Method.DELETE); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n [analysisCompoundId1, analysisCompoundId2, analysisCompoundId3....] \r\n}", ParameterType.RequestBody); @@ -137,7 +137,7 @@ This section guides you through the process of removing/deleting the existing re **Emission Factor DELETE endpoint** -`DELETE` /api/v1/emissionfactor +`DELETE` /actsapi/v1/emissionfactor > Example Request & JSON Input Body @@ -145,7 +145,7 @@ This section guides you through the process of removing/deleting the existing re var request = require("request"); var options = { method: 'DELETE', - url: 'https://[tenant].actsapi.intelex.com/v1/emissionfactor', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/emissionfactor', headers: { 'content-type': 'application/json' }, body: { @@ -162,7 +162,7 @@ request(options, function (error, response, body) { ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/emissionfactor"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/emissionfactor"); var request = new RestRequest(Method.DELETE); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n \"emissionFactorId\": \"number\"\r\n}", ParameterType.RequestBody); @@ -196,7 +196,7 @@ This section guides you through the process of removing/deleting the existing re **Equipment Analysis DELETE endpoint** -`DELETE` /api/v1/equipmentanalysis +`DELETE` /actsapi/v1/equipmentanalysis > Example Request & JSON Input Body @@ -204,7 +204,7 @@ This section guides you through the process of removing/deleting the existing re var request = require("request"); var options = { method: 'DELETE', - url: 'https://[tenant].actsapi.intelex.com/v1/equipmentanalysis', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/equipmentanalysis', headers: { 'content-type': 'application/json' }, body: { @@ -221,7 +221,7 @@ request(options, function (error, response, body) { ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipmentanalysis"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/equipmentanalysis"); var request = new RestRequest(Method.DELETE); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n [equipmentanalysisId1, equipmentanalysisId2, equipmentanalysisId3....] \r\n}", ParameterType.RequestBody); @@ -254,7 +254,7 @@ This section guides you through the process of removing/deleting the existing re **Operation DELETE endpoint** -`DELETE` /api/v1/operation +`DELETE` /actsapi/v1/operation > Example Request & JSON Input Body @@ -262,7 +262,7 @@ This section guides you through the process of removing/deleting the existing re var request = require("request"); var options = { method: 'DELETE', - url: 'https://[tenant].actsapi.intelex.com/v1/operation', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/operation', headers: { 'content-type': 'application/json' }, body: { [operationId1, operationId2, operationId3....] @@ -278,7 +278,7 @@ request(options, function (error, response, body) { ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/operation"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/operation"); var request = new RestRequest(Method.DELETE); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n [operationId1, operationId2, operationId3....]\r\n}", ParameterType.RequestBody); diff --git a/source/includes/acts/get_api.md b/source/includes/acts/get_api.md index 666abbbe004..7de4ea76ba6 100644 --- a/source/includes/acts/get_api.md +++ b/source/includes/acts/get_api.md @@ -12,7 +12,7 @@ This section outlines the process of retrieving data from the Attribute Type tab var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/attributetype' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/attributetype' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -22,7 +22,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/attributetype"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/attributetype"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -69,7 +69,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/attributetype +`GET` /actsapi/v1/attributetype **Query parameters** @@ -90,7 +90,7 @@ This section guides you through the process of fetching data from the Compound t var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/compound' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/compound' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -100,7 +100,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/compound"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/compound"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -166,7 +166,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/compound +`GET` /actsapi/v1/compound **Query parameters** @@ -191,14 +191,14 @@ This section elaborates on how to obtain data from the Emission Category table u var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/emissioncategory' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/emissioncategory' }; request(options, function (error, response, body) { if (error) throw new Error(error); ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/emissioncategory"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/emissioncategory"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -230,7 +230,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/emissioncategory +`GET` /actsapi/v1/emissioncategory **Query parameters** @@ -251,14 +251,14 @@ This section elaborates on how to obtain data from the Emission Factor table usi var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/emissionfactor' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/emissionfactor' }; request(options, function (error, response, body) { if (error) throw new Error(error); ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/emissionfactor"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/emissionfactor"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -300,7 +300,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/emissionfactor +`GET` /actsapi/v1/emissionfactor **Query parameters** @@ -328,7 +328,7 @@ This section guides you through the process of fetching data from the Emission T var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/emissiontype' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/emissiontype' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -338,7 +338,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/emissiontype"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/emissiontype"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -370,7 +370,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/emissiontype +`GET` /actsapi/v1/emissiontype **Query parameters** @@ -392,7 +392,7 @@ This section provides guidance on retrieving data from the Equipment table using var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/equipment' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/equipment' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -402,7 +402,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipment"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/equipment"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -449,7 +449,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/equipment +`GET` /actsapi/v1/equipment **Query parameters** @@ -478,7 +478,7 @@ All data from the Equipment Attribute table will be returned from the endpoint b var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/equipmentattribute' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/equipmentattribute' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -488,7 +488,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipmentattribute"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/equipmentattribute"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -522,7 +522,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/equipmentattribute +`GET` /actsapi/v1/equipmentattribute **Query parameters** @@ -548,7 +548,7 @@ All data from the Equipment Status table will be returned from the endpoint belo var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/equipmentstatus' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/equipmentstatus' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -558,7 +558,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipmentstatus"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/equipmentstatus"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -590,7 +590,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/equipmentstatus +`GET` /actsapi/v1/equipmentstatus **Query parameters** @@ -613,7 +613,7 @@ All data from the Equipment Type table will be returned from the endpoint below. var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/equipmenttype' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/equipmenttype' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -623,7 +623,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipmenttype"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/equipmenttype"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -676,7 +676,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/equipmenttype +`GET` /actsapi/v1/equipmenttype **Query parameters** @@ -698,7 +698,7 @@ All data from the Facility table will be returned from the endpoint below. You c var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/facility' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/facility' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -707,7 +707,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/facility"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/facility"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -761,7 +761,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/facility +`GET` /actsapi/v1/facility **Query parameters** @@ -791,7 +791,7 @@ All data from the Facility Attribute table will be returned from the endpoint be var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/facilityattribute' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/facilityattribute' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -801,7 +801,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/facilityattribute"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/facilityattribute"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -835,7 +835,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/facilityattribute +`GET` /actsapi/v1/facilityattribute **Query parameters** @@ -864,7 +864,7 @@ All data from the Operation table will be returned from the endpoint below. You var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/operation' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/operation' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -874,7 +874,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/operation"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/operation"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -919,7 +919,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/operation +`GET` /actsapi/v1/operation **Query parameters** @@ -947,7 +947,7 @@ All data from the Operation Type table will be returned from the endpoint below. var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/operationtype' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/operationtype' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -957,7 +957,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/operationtype"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/operationtype"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -993,7 +993,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/operationtype +`GET` /actsapi/v1/operationtype **Query parameters** @@ -1014,7 +1014,7 @@ The QueryResults API end point will allow the user to run the views saved in Que var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/queryresults', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/queryresults', headers: { 'content-type': 'application/json' }, body: { @@ -1030,7 +1030,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/queryresults"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/queryresults"); var request = new RestRequest(Method.GET); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n \"queryViewId\": \"number\"\r\n}", ParameterType.RequestBody); @@ -1079,7 +1079,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/queryresults +`GET` /actsapi/v1/queryresults **Query parameters** @@ -1100,7 +1100,7 @@ This section outlines how to retrieve data from the Unit table using the provide var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/unit' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/unit' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1110,7 +1110,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/unit"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/unit"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1146,7 +1146,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/unit +`GET` /actsapi/v1/unit **Query parameters** @@ -1168,7 +1168,7 @@ This section outlines how to retrieve data from the Workflow table using the pro var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/workflow' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflow' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1178,7 +1178,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflow"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflow"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1211,7 +1211,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/workflow +`GET` /actsapi/v1/workflow **Query parameters** @@ -1236,7 +1236,7 @@ This section outlines how to retrieve data from the Workflow Answer table using var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowanswer' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowanswer' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1246,7 +1246,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflowanswer"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflowanswer"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1285,7 +1285,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/workflowanswer +`GET` /actsapi/v1/workflowanswer **Query parameters** @@ -1314,7 +1314,7 @@ This section outlines how to retrieve data from the Workflow Equipment table usi var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowEquipment' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowEquipment' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1324,7 +1324,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflowEquipment"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflowEquipment"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1357,7 +1357,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/workflowEquipment +`GET` /actsapi/v1/workflowEquipment **Query parameters** @@ -1379,7 +1379,7 @@ This section outlines how to retrieve data from the Workflow Facility table usin var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowfacility' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowfacility' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1389,7 +1389,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflowfacility"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflowfacility"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1422,7 +1422,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/workflowfacility +`GET` /actsapi/v1/workflowfacility **Query parameters** @@ -1446,7 +1446,7 @@ This section outlines how to retrieve data from the Workflow Person table using var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowperson' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowperson' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1456,7 +1456,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflowperson"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflowperson"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1489,7 +1489,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/workflowperson +`GET` /actsapi/v1/workflowperson **Query parameters** @@ -1511,7 +1511,7 @@ This section outlines how to retrieve data from the Workflow Question table usin var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowquestion' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowquestion' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1521,7 +1521,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflowquestion"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflowquestion"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1580,7 +1580,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/workflowquestion +`GET` /actsapi/v1/workflowquestion **Query parameters** @@ -1604,7 +1604,7 @@ This section outlines how to retrieve data from the Workflow Question Category t var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowquestioncategory' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowquestioncategory' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1614,7 +1614,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflowquestioncategory"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflowquestioncategory"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1659,7 +1659,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/workflowquestioncategory +`GET` /actsapi/v1/workflowquestioncategory **Query parameters** @@ -1682,7 +1682,7 @@ This section outlines how to retrieve data from the Workflow Type table using th var request = require("request"); var options = { method: 'GET', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowtype' }; + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowtype' }; request(options, function (error, response, body) { if (error) throw new Error(error); @@ -1692,7 +1692,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflowtype"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflowtype"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` @@ -1734,7 +1734,7 @@ IRestResponse response = client.Execute(request); **API Endpoints** -`GET` /api/v1/workflowtype +`GET` /actsapi/v1/workflowtype **Query parameters** diff --git a/source/includes/acts/post_api.md b/source/includes/acts/post_api.md index 3f08a79e360..8c92cb8b69a 100644 --- a/source/includes/acts/post_api.md +++ b/source/includes/acts/post_api.md @@ -38,7 +38,7 @@ This section guides you through the process of modifying existing Analysis recor **Analysis POST endpoint** -`POST` api/v1/analysis +`POST` /actsapi/v1/analysis > Example Request & JSON Input Body @@ -46,7 +46,7 @@ This section guides you through the process of modifying existing Analysis recor var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/analysis', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/analysis', headers: { 'content-type': 'application/json' }, body: [ @@ -81,7 +81,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/analysis"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/analysis"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "[ {\r\n \"analysisId\": \"number\",\r\n \"analysisName\": \"string\",\r\n @@ -154,7 +154,7 @@ This section guides you through the process of modifying existing Analysis Compo **Analysis Compound POST endpoint** -`POST` api/v1/analysiscompound +`POST` /actsapi/v1/analysiscompound > Example Request & JSON Input Body @@ -162,7 +162,7 @@ This section guides you through the process of modifying existing Analysis Compo var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/analysiscompound', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/analysiscompound', headers: { 'content-type': 'application/json' }, body: [ @@ -197,7 +197,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/analysiscompound"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/analysiscompound"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "[ {\r\n \"analysisCompoundId\": \"number\",\r\n \"analysisId\": \"number\",\r\n @@ -270,7 +270,7 @@ This section guides you through the process of modifying existing Emission Facto **Emission Factor POST endpoint** -`POST` api/v1/emissionfactor +`POST` /actsapi/v1/emissionfactor > Example Request & JSON Input Body @@ -278,7 +278,7 @@ This section guides you through the process of modifying existing Emission Facto var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/emissionfactor', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/emissionfactor', headers: { 'content-type': 'application/json' }, body: [ @@ -309,7 +309,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/emissionfactor"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/emissionfactor"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "[ {\r\n \"emissionFactorId\": \"number\",\r\n \"equipmentId\": \"number\",\r\n \"emissionTypeId\": \"number\",\r\n \"emissionCategoryId\": \"number\",\r\n \"compoundId\": \"number\",\r\n \"emissionFactorName\": \"string\",\r\n \"activeDate\": \"2023-06-25T04:00:00Z\",\r\n \"emissionFactor\": \"number\",\r\n \"unitId\": \"number\",\r\n \"viewColumnName\": \"string\",\r\n \"inactiveDate\": \"2023-06-25T04:00:00Z\",\r\n \"dataLockTypeId\": \"number\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\": \"string\"\r\n }\r\n]", ParameterType.RequestBody); @@ -373,7 +373,7 @@ This section guides you through the process of an on-demand update to the emissi **Equipment/EmissionCalculation POST endpoint** -`POST` api/v1/equipment/emissioncalculation +`POST` /actsapi/v1/equipment/emissioncalculation > Example Request & JSON Input Body @@ -381,7 +381,7 @@ This section guides you through the process of an on-demand update to the emissi var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/equipment/emissioncalculation', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/equipment/emissioncalculation', headers: { 'content-type': 'application/json' }, body: { [equipmentId1, equipmentId2, equipmentId3....] @@ -396,7 +396,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipment/emissioncalculation"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/equipment/emissioncalculation"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n [equipmentId1, equipmentId2, equipmentId3....]\r\n}", ParameterType.RequestBody); @@ -445,7 +445,7 @@ This section guides you through the process of an on-demand update to the emissi **Operation/EmissionCalculation POST endpoint** -`POST` api/v1/operation/emissioncalculation +`POST` /actsapi/v1/operation/emissioncalculation > Example Request & JSON Input Body @@ -453,7 +453,7 @@ This section guides you through the process of an on-demand update to the emissi var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/operation/emissioncalculation', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/operation/emissioncalculation', headers: { 'content-type': 'application/json' }, body: { [operationId1, operationId2, operationId3....] @@ -468,7 +468,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/operation/emissioncalculation"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/operation/emissioncalculation"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\r\n [operationId1, operationId2, operationId3....]\r\n}", ParameterType.RequestBody); @@ -518,7 +518,7 @@ This section guides you through the process of modifying existing equipment reco **Equipment POST endpoint** -`POST` api/v1/equipment +`POST` /actsapi/v1/equipment > Example Request & JSON Input Body @@ -526,7 +526,7 @@ This section guides you through the process of modifying existing equipment reco var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/equipment', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/equipment', headers: { 'content-type': 'application/json' }, body: [ { @@ -561,7 +561,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipment"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/equipment"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", " [ {\r\n \"equipmentId\": \"number\",\r\n \"areaId\": \"number\",\r\n \"facilityId\": \"number\",\r\n \"equipmentTypeId\": \"number\",\r\n \"sourceName\": \"string \",\r\n \"equipmentStatusId\": \"number\",\r\n \"modelId\": \"number\",\r\n \"ownershipId\": \"number\",\r\n \"ownerId\": \"number\",\r\n \"serialNumber\": \"number\",\r\n \"manufactureDate\": \"2023-06-25T04:00:00Z\",\r\n \"internalName\": \"string\",\r\n \"alternateName\": \"string\",\r\n \"design\": \"string\",\r\n \"originalSurveyDate\": \"2023-06-25T04:00:00Z\",\r\n \"activeDate\": \"2023-06-25T04:00:00Z\",\r\n \"inactiveDate\": \"2023-06-25T04:00:00Z\",\r\n\t \"dataLockTypeId\": \"number\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\": \"string\"\r\n }\r\n]", ParameterType.RequestBody); @@ -629,7 +629,7 @@ This section outlines the process of adding new entries or modifying existing re **Equipment Analysis POST Endpoint** -`POST` api/v1/equipmentanalysis +`POST` /actsapi/v1/equipmentanalysis > Example Request & JSON Input Body @@ -637,7 +637,7 @@ This section outlines the process of adding new entries or modifying existing re var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/equipmentanalysis', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/equipmentanalysis', headers: { 'content-type': 'application/json' }, body: @@ -665,7 +665,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipmentanalysis"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/equipmentanalysis"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", " [\r\n { \r\n\ "equipmentAnalysisId\": \"number\",\r\n \"equipmentId\": \"number\",\r\n @@ -725,7 +725,7 @@ This section outlines the process of adding new entries or modifying existing re **Equipment Attribute POST Endpoint** -`POST` api/v1/equipmentattribute +`POST` /actsapi/v1/equipmentattribute > Example Request & JSON Input Body @@ -733,7 +733,7 @@ This section outlines the process of adding new entries or modifying existing re var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/equipmentattribute', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/equipmentattribute', headers: { 'content-type': 'application/json' }, body: @@ -759,7 +759,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/equipmentattribute"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/equipmentattribute"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", " [\r\n { \r\n"equipmentAttributeId\": \"number\",\r\n \"equipmentId\": \"number\",\r\n \"attributeTypeId\": \"number\",\r\n \"equipmentAttribute\":\"string\",\r\n \"dataLockTypeId\": \"number\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\":\"string\"\r\n }\r\n]", ParameterType.RequestBody); @@ -816,7 +816,7 @@ This section outlines the process of adding new entries or modifying existing re **Facility POST Endpoint** -`POST` api/v1/facility +`POST` /actsapi/v1/facility > Example Request & JSON Input Body @@ -824,7 +824,7 @@ This section outlines the process of adding new entries or modifying existing re var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/facility', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/facility', headers: { 'content-type': 'application/json' }, body: [{ @@ -866,7 +866,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/facility"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/facility"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "[{\r\n \"facilityId\": \"number\",\r\n \"facilityName\": \"string\",\r\n \"areaId\": \"number\",\r\n \"facilityTypeId\": \"number\",\r\n \"facilityStatusId\": \"number\",\r\n \"sortOrder\": \"number\",\r\n \"facilityOwnershipId\": \"number\",\r\n \"facilityOwnerId\": \"number\",\r\n \"landOwnershipId\": \"number\",\r\n \"landOwnerId\": \"number\",\r\n \"operatorId\": \"number\",\r\n \"countryId\": \"number\",\r\n \"countyId\": \"number\",\r\n \"offshoreBlockId\": \"number\",\r\n \"meteorologicalId\": \"number\",\r\n \"businessEntityId\": \"number\",\r\n \"businessUnitId\": \"number\",\r\n \"alternateName\": \"string\",\r\n \"purchaseDate\": \"2023-06-25T04:00:00Z\",\r\n \"previousOwnerId\": \"number\",\r\n \"soldDate\": \"2023-06-25T04:00:00Z\",\r\n \"soldToId\": \"number\",\r\n \"activeDate\": \"2023-06-25T04:00:00Z\",\r\n \"inactiveDate\": \"2023-06-25T04:00:00Z\",\r\n \"dataLockTypeId\": \"number\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\": \"string\"\r\n }]", ParameterType.RequestBody); @@ -942,7 +942,7 @@ This section outlines the process of adding new entries or modifying existing re **Facility Attribute POST Endpoint** -`POST` api/v1/facilityattribute +`POST` /actsapi/v1/facilityattribute > Example Request & JSON Input Body @@ -950,7 +950,7 @@ This section outlines the process of adding new entries or modifying existing re var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/facilityattribute', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/facilityattribute', headers: { 'content-type': 'application/json' }, body: [ @@ -974,7 +974,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/facilityattribute"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/facilityattribute"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "[\r\n { \r\n"facilityAttributeId\": \"number\",\r\n \"facilityId\": \"number\",\r\n \"attributeTypeId\": \"number\",\r\n \"facilityAttribute\":\"string\",\r\n \"dataLockTypeId\": \"number\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\":\"string\"\r\n }\r\n]", ParameterType.RequestBody); @@ -1029,7 +1029,7 @@ This section outlines the process of adding new entries or modifying existing re **Operation POST Endpoint** -`POST` api/v1/operation +`POST` /actsapi/v1/operation > Example Request & JSON Input Body @@ -1037,7 +1037,7 @@ This section outlines the process of adding new entries or modifying existing re var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/operation', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/operation', headers: { 'content-type': 'application/json' }, body: [ @@ -1074,7 +1074,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/operation"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/operation"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "[\r\n {\r\n \"operationId\": \"number\",\r\n \"equipmentId\": \"number\",\r\n \"emissionTypeId\": \"number\",\r\n \"emissionCategoryId\": \"number\",\r\n \"operationTypeId\": \"number\",\r\n \"activeDate\": \"2023-06-25T04:00:00Z\",\r\n \"unitId\": \"number\",\r\n \"controlledInd\": \"string\",\r\n \"estimatedInd\": \"string\",\r\n \"invalidInd\": \"string\",\r\n \"calculateEmissionsInd\": \"string\",\r\n \"collectionDate\": \"2023-06-25T04:00:00Z\",\r\n \"fieldEventId\": \"number\",\r\n \"inactiveDate\": \"2023-06-25T04:00:00Z\",\r\n \"dataLockTypeId\": \"number\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\": \"string\",\r\n \"badDataFlag\": \"number(1,0)\",\r\n \"operationAmount\": \"number\"\r\n } \r\n]", ParameterType.RequestBody); @@ -1142,7 +1142,7 @@ This section outlines the process of adding new entries or modifying existing re **Workflow POST Endpoint** -`POST` api/v1/workflow +`POST` /actsapi/v1/workflow > Example Request & JSON Input Body @@ -1150,7 +1150,7 @@ This section outlines the process of adding new entries or modifying existing re var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/workflow', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflow', headers: { 'content-type': 'application/json' }, body: [ @@ -1174,7 +1174,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflow"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflow"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", " [\r\n {\r\n \"workflowId\": \"number\",\r\n \"workflowTypeId\": \"number\",\r\n \"workflowDate\": \"2024-01-03T08:16:24.155Z\",\r\n \"dataLockTypeId\": \"number\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\": \"string\"\r\n }\r\n]", ParameterType.RequestBody); @@ -1228,7 +1228,7 @@ This section outlines the process of adding new entries or modifying existing re **Workflow Answer POST Endpoint** -`POST` api/v1/workflowanswer +`POST` /actsapi/v1/workflowanswer > Example Request & JSON Input Body @@ -1236,7 +1236,7 @@ This section outlines the process of adding new entries or modifying existing re var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowanswer', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowanswer', headers: { 'content-type': 'application/json' }, body: [{ @@ -1264,7 +1264,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflowanswer"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflowanswer"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "[{\r\n \"workflowAnswerId\": \"number\",\r\n \"workflowId\": \"number\",\r\n \"workflowQuestionId\": \"number\",\r\n \"categoryAnswerIndex\": \"number\",\r\n \"categoryRevisionIndex\": \"number\",\r\n \"questionAnswerIndex\": \"number\",\r\n \"questionRevisionIndex\": \"number\",\r\n \"workflowAnswer\": \"string\",\r\n \"dataLockTypeId\": \"number\",\r\n \"personId\": \"number\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\": \"string\"\r\n }]", ParameterType.RequestBody); @@ -1322,7 +1322,7 @@ This section outlines the process of adding new entries or modifying existing re **Workflow Equipment POST Endpoint** -`POST` api/v1/workflowequipment +`POST` /actsapi/v1/workflowequipment > Example Request & JSON Input Body @@ -1330,7 +1330,7 @@ This section outlines the process of adding new entries or modifying existing re var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowequipment', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowequipment', headers: { 'content-type': 'application/json' }, body: [ @@ -1354,7 +1354,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflowequipment"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflowequipment"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "[\r\n {\r\n \"workflowEquipmentId\": \"number\",\r\n \"workflowId\": \"number\",\r\n \"equipmentId\": \"number\",\r\n \"workflowQuestionId\": \"number\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\": \"string\"\r\n }\r\n]", ParameterType.RequestBody); @@ -1408,7 +1408,7 @@ This section outlines the process of adding new entries or modifying existing re **Workflow Facility POST Endpoint** -`POST` api/v1/workflowfacility +`POST` /actsapi/v1/workflowfacility > Example Request & JSON Input Body @@ -1416,7 +1416,7 @@ This section outlines the process of adding new entries or modifying existing re var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowfacility', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowfacility', headers: { 'content-type': 'application/json' }, body: [ @@ -1440,7 +1440,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/workflowfacility"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/workflowfacility"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "[\r\n {\r\n \"workflowFacilityId\": \"number\",\r\n \"workflowId\": \"number\",\r\n \"facilityId\": \"number\",\r\n \"workflowQuestionId\": \"number\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\": \"string\"\r\n }\r\n]", ParameterType.RequestBody); @@ -1495,7 +1495,7 @@ This section outlines the process of adding new entries or modifying existing re **Workflow Person POST Endpoint** -`POST` api/v1/workflowperson +`POST` /actsapi/v1/workflowperson > Example Request & JSON Input Body @@ -1503,7 +1503,7 @@ This section outlines the process of adding new entries or modifying existing re var request = require("request"); var options = { method: 'POST', - url: 'https://[tenant].actsapi.intelex.com/v1/workflowperson', + url: 'https://[tenant].actsapi.intelex.com/actsapi/v1/workflowperson', headers: { 'content-type': 'application/json' }, body: [ @@ -1527,7 +1527,7 @@ request(options, function (error, response, body) { ``` ```csharp -var client = new RestClient("https://[tenant].actsapi.intelex.com/v1/Workflowperson"); +var client = new RestClient("https://[tenant].actsapi.intelex.com/actsapi/v1/Workflowperson"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "[\r\n {\r\n \"workflowPersonId\": \"number\",\r\n \"workflowId\": \"number\",\r\n \"personId\": \"number\",\r\n \"workflowQuestionId\": \"number\",\r\n \"lastModifiedDate\": \"2024-01-03T08:16:24.155Z\",\r\n \"externalIdentifier\": \"string\",\r\n \"comments\": \"string\"\r\n }\r\n]", ParameterType.RequestBody); diff --git a/source/includes/acts/reference.md b/source/includes/acts/reference.md index cae326415c1..d08b0290544 100644 --- a/source/includes/acts/reference.md +++ b/source/includes/acts/reference.md @@ -9,7 +9,7 @@ Our API has predictable, resource-oriented URLs, and uses HTTP response codes to >API Endpoint - In the URL the tenant is the individual unique tenants based on the tenants they are specifying ``` -https://[tenant].actsapi.intelex.com/v1/api/ +https://[tenant].actsapi.intelex.com/actsapi/v1/ ``` To begin using the Intelex API you will need: @@ -51,9 +51,9 @@ The user authentication endpoint uses a POST to generate the access token [beare ### ACTS API Versioning -When we make any new 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/. +When we make any new 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 /actsapi/v1/. ->Example API endpoint : https://[tenant].actsapi.intelex.com/v1/[endpoint-name] +>Example API endpoint : https://[tenant].actsapi.intelex.com/actsapi/v1/[endpoint-name] ### ACTS API Software & Certificate Version Details