Skip to content

[ILX-51713] Keep /actsapi/ route reference only in ACTS API document #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 13, 2025
Merged

[ILX-51713] Keep /actsapi/ route reference only in ACTS API document #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions source/includes/_api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/actsapi/v2/
https://intelex_url/api/v2/
```

To begin using the Intelex API you will need:
Expand Down Expand Up @@ -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 **/actsapi/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 **/api/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).
Expand Down
30 changes: 15 additions & 15 deletions source/includes/_interface-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/actsapi/v2/apps' };
url: 'https://intelex_url/api/v2/apps' };

request(options, function (error, response, body) {
if (error) throw new Error(error);
Expand All @@ -22,7 +22,7 @@ request(options, function (error, response, body) {
```

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

Returns the apps that you can use

#### GET /actsapi/v2/apps
#### GET /api/v2/apps

Attribute | Description
--------- | -----------
Expand All @@ -65,7 +65,7 @@ NavigationUrl | Navigation URL of application
var request = require("request");

var options = { method: 'GET',
url: 'https://intelex_url/actsapi/v2/reports' };
url: 'https://intelex_url/api/v2/reports' };

request(options, function (error, response, body) {
if (error) throw new Error(error);
Expand All @@ -75,7 +75,7 @@ request(options, function (error, response, body) {
```

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

Returns the reports that you can view

#### GET /actsapi/v2/reports
#### GET /api/v2/reports

Attribute | Description
--------- | -----------
Expand All @@ -113,7 +113,7 @@ NavigationUrl | URL to view report
var request = require("request");

var options = { method: 'GET',
url: 'https://intelex_url/actsapi/v2/dashboards' };
url: 'https://intelex_url/api/v2/dashboards' };

request(options, function (error, response, body) {
if (error) throw new Error(error);
Expand All @@ -123,7 +123,7 @@ request(options, function (error, response, body) {
```

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

Returns the dashboards that you can view

#### GET /actsapi/v2/dashboards
#### GET /api/v2/dashboards

Attribute | Description
--------- | -----------
Expand All @@ -160,7 +160,7 @@ NavigationUrl | URL to view dashboard
var request = require("request");

var options = { method: 'GET',
url: 'https://intelex_url/actsapi/v2/locations' };
url: 'https://intelex_url/api/v2/locations' };

request(options, function (error, response, body) {
if (error) throw new Error(error);
Expand All @@ -170,7 +170,7 @@ request(options, function (error, response, body) {
```

```csharp
var client = new RestClient("https://intelex_url/actsapi/v2/locations");
var client = new RestClient("https://intelex_url/api/v2/locations");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```
Expand Down Expand Up @@ -200,7 +200,7 @@ IRestResponse response = client.Execute(request);

Returns the location hierarchy

#### GET /actsapi/v2/locations
#### GET /api/v2/locations

Attribute | Description
--------- | -----------
Expand All @@ -218,7 +218,7 @@ Children | An array of child locations
var request = require("request");

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

request(options, function (error, response, body) {
if (error) throw new Error(error);
Expand All @@ -228,7 +228,7 @@ request(options, function (error, response, body) {
```

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

Returns a user's details

#### GET /actsapi/v2/users/me
#### GET /api/v2/users/me

Attribute | Description
--------- | -----------
Expand Down
Loading
Loading