Skip to content

Commit 238a007

Browse files
Keep /actsapi/ route reference only in ACTS API document (#41)
1 parent 0f7f5ae commit 238a007

File tree

6 files changed

+146
-146
lines changed

6 files changed

+146
-146
lines changed

source/includes/_api-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The Intelex API is organized around REST. Our API has predictable, resource-orie
77
> API Endpoint - replace **intelex_url** with the full URL path to your Intelex system
88
99
```
10-
https://intelex_url/actsapi/v2/
10+
https://intelex_url/api/v2/
1111
```
1212

1313
To begin using the Intelex API you will need:
@@ -136,7 +136,7 @@ Response Code | Meaning
136136

137137
## Versioning
138138

139-
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.
139+
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.
140140

141141
## API Rate Limiting / Quotas
142142
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).

source/includes/_interface-api.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The following resources give you access to system information
1212
var request = require("request");
1313

1414
var options = { method: 'GET',
15-
url: 'https://intelex_url/actsapi/v2/apps' };
15+
url: 'https://intelex_url/api/v2/apps' };
1616

1717
request(options, function (error, response, body) {
1818
if (error) throw new Error(error);
@@ -22,7 +22,7 @@ request(options, function (error, response, body) {
2222
```
2323

2424
```csharp
25-
var client = new RestClient("https://intelex_url/actsapi/v2/apps");
25+
var client = new RestClient("https://intelex_url/api/v2/apps");
2626
var request = new RestRequest(Method.GET);
2727
IRestResponse response = client.Execute(request);
2828
```
@@ -45,7 +45,7 @@ IRestResponse response = client.Execute(request);
4545

4646
Returns the apps that you can use
4747

48-
#### GET /actsapi/v2/apps
48+
#### GET /api/v2/apps
4949

5050
Attribute | Description
5151
--------- | -----------
@@ -65,7 +65,7 @@ NavigationUrl | Navigation URL of application
6565
var request = require("request");
6666

6767
var options = { method: 'GET',
68-
url: 'https://intelex_url/actsapi/v2/reports' };
68+
url: 'https://intelex_url/api/v2/reports' };
6969

7070
request(options, function (error, response, body) {
7171
if (error) throw new Error(error);
@@ -75,7 +75,7 @@ request(options, function (error, response, body) {
7575
```
7676

7777
```csharp
78-
var client = new RestClient("https://intelex_url/actsapi/v2/reports");
78+
var client = new RestClient("https://intelex_url/api/v2/reports");
7979
var request = new RestRequest(Method.GET);
8080
IRestResponse response = client.Execute(request);
8181
```
@@ -96,7 +96,7 @@ IRestResponse response = client.Execute(request);
9696

9797
Returns the reports that you can view
9898

99-
#### GET /actsapi/v2/reports
99+
#### GET /api/v2/reports
100100

101101
Attribute | Description
102102
--------- | -----------
@@ -113,7 +113,7 @@ NavigationUrl | URL to view report
113113
var request = require("request");
114114

115115
var options = { method: 'GET',
116-
url: 'https://intelex_url/actsapi/v2/dashboards' };
116+
url: 'https://intelex_url/api/v2/dashboards' };
117117

118118
request(options, function (error, response, body) {
119119
if (error) throw new Error(error);
@@ -123,7 +123,7 @@ request(options, function (error, response, body) {
123123
```
124124

125125
```csharp
126-
var client = new RestClient("https://intelex_url/actsapi/v2/dashboards");
126+
var client = new RestClient("https://intelex_url/api/v2/dashboards");
127127
var request = new RestRequest(Method.GET);
128128
IRestResponse response = client.Execute(request);
129129
```
@@ -144,7 +144,7 @@ IRestResponse response = client.Execute(request);
144144

145145
Returns the dashboards that you can view
146146

147-
#### GET /actsapi/v2/dashboards
147+
#### GET /api/v2/dashboards
148148

149149
Attribute | Description
150150
--------- | -----------
@@ -160,7 +160,7 @@ NavigationUrl | URL to view dashboard
160160
var request = require("request");
161161

162162
var options = { method: 'GET',
163-
url: 'https://intelex_url/actsapi/v2/locations' };
163+
url: 'https://intelex_url/api/v2/locations' };
164164

165165
request(options, function (error, response, body) {
166166
if (error) throw new Error(error);
@@ -170,7 +170,7 @@ request(options, function (error, response, body) {
170170
```
171171

172172
```csharp
173-
var client = new RestClient("https://intelex_url/actsapi/v2/locations");
173+
var client = new RestClient("https://intelex_url/api/v2/locations");
174174
var request = new RestRequest(Method.GET);
175175
IRestResponse response = client.Execute(request);
176176
```
@@ -200,7 +200,7 @@ IRestResponse response = client.Execute(request);
200200

201201
Returns the location hierarchy
202202

203-
#### GET /actsapi/v2/locations
203+
#### GET /api/v2/locations
204204

205205
Attribute | Description
206206
--------- | -----------
@@ -218,7 +218,7 @@ Children | An array of child locations
218218
var request = require("request");
219219

220220
var options = { method: 'GET',
221-
url: 'https://intelex_url/actsapi/v2/users/me' };
221+
url: 'https://intelex_url/api/v2/users/me' };
222222

223223
request(options, function (error, response, body) {
224224
if (error) throw new Error(error);
@@ -228,7 +228,7 @@ request(options, function (error, response, body) {
228228
```
229229

230230
```csharp
231-
var client = new RestClient("https://intelex_url/actsapi/v2/users/me");
231+
var client = new RestClient("https://intelex_url/api/v2/users/me");
232232
var request = new RestRequest(Method.GET);
233233
IRestResponse response = client.Execute(request);
234234
```
@@ -245,7 +245,7 @@ IRestResponse response = client.Execute(request);
245245

246246
Returns a user's details
247247

248-
#### GET /actsapi/v2/users/me
248+
#### GET /api/v2/users/me
249249

250250
Attribute | Description
251251
--------- | -----------

0 commit comments

Comments
 (0)