It Portal actions & endpoints

Introduction

The It Portal Integration with Rewst delivers a robust set of actions and endpoints for interacting with It Portal. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the It Portal Integration:

• Accounts

• Additional Credentials

• Addresses

• Agreements

• Cabinets

• Categories Types

• Companies

• Configurations

• Contacts

• Devices

• Documents

• Facilities

• Generic Request

• Interactions

• Ip Networks

• Kbs

• Sheets

• Sites

• System

• Templates

Actions

Accounts

List Accounts

GET example.itportal.com/api/2.0/accounts/

Fetches lists of portal accounts with optional filters. See notes on individual parameters below

Create Account

POST example.itportal.com/api/2.0/accounts/

New account will be added to the portal

Get Account

GET example.itportal.com/api/2.0/accounts/{accountId}/

This method fetches a single account resource. It is the canonical URI for any account resource provided by the API

Delete Account

DELETE example.itportal.com/api/2.0/accounts/{accountId}/

Description coming soon...

Update Account

PATCH example.itportal.com/api/2.0/accounts/{accountId}/

Updates specific fields on an entity (RFC 7396)

Get Credentials For Account

GET example.itportal.com/api/2.0/accounts/{accountId}/credentials/

This method fetches a single account credentials resource

Additional Credentials

List Additional Credentials

GET example.itportal.com/api/2.0/additionalCredentials/

Fetches lists of additional credentials with optional filters. See notes on individual parameters below

Create Additional Credential

POST example.itportal.com/api/2.0/additionalCredentials/

New additional credential will be added to the portal object

Get Additional Credential

GET example.itportal.com/api/2.0/additionalCredentials/{additionalCredentialId}/

This method fetches a single additional credential resource. It is the canonical URI for any additional credential resource provided by the API

Delete Additional Credential

DELETE example.itportal.com/api/2.0/additionalCredentials/{additionalCredentialId}/

Description coming soon...

Update Additional Credential

PATCH example.itportal.com/api/2.0/additionalCredentials/{additionalCredentialId}/

Updates specific fields on an entity (RFC 7396)

Addresses

Create Address

POST example.itportal.com/api/2.0/companies/{companyId}/addresses/

New address will be added to the Portal company

List Addresses

GET example.itportal.com/api/2.0/addresses/

Fetches lists of addresses with optional filters. See notes on individual parameters below

Get Address

GET example.itportal.com/api/2.0/addresses/{addressId}/

This method fetches a single address resource. It is the canonical URI for any address resource provided by the API

Delete Address

DELETE example.itportal.com/api/2.0/addresses/{addressId}/

Description coming soon...

Update Address

PATCH example.itportal.com/api/2.0/addresses/{addressId}/

Updates specific fields on an entity (RFC 7396)

Agreements

List Agreements

GET example.itportal.com/api/2.0/agreements/

Fetches lists of portal agreements with optional filters. See notes on individual parameters below

Create Agreement

POST example.itportal.com/api/2.0/agreements/

New agreement will be added to the portal

Get Agreement

GET example.itportal.com/api/2.0/agreements/{agreementId}/

This method fetches a single agreement resource. It is the canonical URI for any agreement resource provided by the API

Delete Agreement

DELETE example.itportal.com/api/2.0/agreements/{agreementId}/

Description coming soon...

Update Agreement

PATCH example.itportal.com/api/2.0/agreements/{agreementId}/

Updates specific fields on an entity (RFC 7396)

Cabinets

List Cabinets

GET example.itportal.com/api/2.0/cabinets/

Fetches lists of portal cabinets with optional filters. See notes on individual parameters below

Create Cabinet

POST example.itportal.com/api/2.0/cabinets/

New cabinet will be added to the portal

Get Cabinet

GET example.itportal.com/api/2.0/cabinets/{cabinetId}/

This method fetches a single cabinet resource. It is the canonical URI for any cabinet resource provided by the API

Delete Cabinet

DELETE example.itportal.com/api/2.0/cabinets/{cabinetId}/

Description coming soon...

Update Cabinet

PATCH example.itportal.com/api/2.0/cabinets/{cabinetId}/

Updates specific fields on an entity (RFC 7396)

Categories Types

List KB Categories

GET example.itportal.com/api/2.0/categories/kb/

Fetches lists of portal KB categories with optional filters. See notes on individual parameters below

List Company Types

GET example.itportal.com/api/2.0/types/company/

Fetches lists of portal company types with optional filters. See notes on individual parameters below

List Account Types

GET example.itportal.com/api/2.0/types/account/

Fetches lists of portal account types with optional filters. See notes on individual parameters below

List Agreement Types

GET example.itportal.com/api/2.0/types/agreement/

Fetches lists of portal agreement types with optional filters. See notes on individual parameters below

List Contact Types

GET example.itportal.com/api/2.0/types/contact/

Fetches lists of portal contact types with optional filters. See notes on individual parameters below

List Facility Types

GET example.itportal.com/api/2.0/types/facility/

Fetches lists of portal facility types with optional filters. See notes on individual parameters below

List Device Types

GET example.itportal.com/api/2.0/types/device/

Fetches lists of portal device types with optional filters. See notes on individual parameters below

List Document Types

GET example.itportal.com/api/2.0/types/document/

Fetches lists of portal document types with optional filters. See notes on individual parameters below

Companies

List Companies

GET example.itportal.com/api/2.0/companies/

Fetches lists of portal companies with optional filters. See notes on individual parameters below

Create Company

POST example.itportal.com/api/2.0/companies/

New Company will be added to the portal

Get Company

GET example.itportal.com/api/2.0/companies/{companyId}/

This method fetches a single company resource. It is the canonical URI for any company resource provided by the API

Delete Company

DELETE example.itportal.com/api/2.0/companies/{companyId}/

Description coming soon...

Update Company

PATCH example.itportal.com/api/2.0/companies/{companyId}/

Updates specific fields on an entity (RFC 7396)

List Company Accounts

GET example.itportal.com/api/2.0/companies/{companyId}/accounts/

Fetches lists of portal accounts with optional filters. See notes on individual parameters below

List Company Addresses

GET example.itportal.com/api/2.0/companies/{companyId}/addresses/

Fetches lists of portal addresses with optional filters. See notes on individual parameters below

Configurations

List Configurations

GET example.itportal.com/api/2.0/configurations/

Fetches lists of portal configurations with optional filters. See notes on individual parameters below

Create Configuration

POST example.itportal.com/api/2.0/configurations/

New configuration will be added to the portal. For the Configuration Type ID, please create at least one Configuration via ITPortal then use the Get Configuration action.

Get Configuration

GET example.itportal.com/api/2.0/configurations/{configurationId}/

This method fetches a single configuration resource. It is the canonical URI for any configuration resource provided by the API

Delete Configuration

DELETE example.itportal.com/api/2.0/configurations/{configurationId}/

Description coming soon...

Update Configuration

PATCH example.itportal.com/api/2.0/configurations/{configurationId}/

Updates specific fields on an entity (RFC 7396)

Contacts

List Contacts

GET example.itportal.com/api/2.0/contacts/

Fetches lists of portal contacts with optional filters. See notes on individual parameters below

Create Contact

POST example.itportal.com/api/2.0/contacts/

New contact will be added to the portal

Get Contact

GET example.itportal.com/api/2.0/contacts/{contactId}/

This method fetches a single contact resource. It is the canonical URI for any contact resource provided by the API

Delete Contact

DELETE example.itportal.com/api/2.0/contacts/{contactId}/

Description coming soon...

Update Contact

PATCH example.itportal.com/api/2.0/contacts/{contactId}/

Updates specific fields on an entity (RFC 7396)

Devices

List Devices

GET example.itportal.com/api/2.0/devices/

Fetches lists of portal devices with optional filters. See notes on individual parameters below

Create Device

POST example.itportal.com/api/2.0/devices/

New device will be added to the portal

Get Device

GET example.itportal.com/api/2.0/devices/{deviceId}/

This method fetches a single device resource. It is the canonical URI for any device resource provided by the API

Delete Device

DELETE example.itportal.com/api/2.0/devices/{deviceId}/

Description coming soon...

Update Device

PATCH example.itportal.com/api/2.0/devices/{deviceId}/

Updates specific fields on an entity (RFC 7396)

Get Management URLs For Device

GET example.itportal.com/api/2.0/devices/{deviceId}/managementUrls/

This method fetches a single device Management Urls resource

Create Device Management URL

POST example.itportal.com/api/2.0/devices/{deviceId}/managementUrls/

New Device Management Url will be added to the portal

Get IPs For Device

GET example.itportal.com/api/2.0/devices/{deviceId}/ips/

This method fetches a single device IPs resource

Create Device IP

POST example.itportal.com/api/2.0/devices/{deviceId}/ips/

New device IP will be added to the portal

Get Configuration Files For Device

GET example.itportal.com/api/2.0/devices/{deviceId}/configurationFiles/

This method fetches a single device configurations files resource

Get Credentials For Device

GET example.itportal.com/api/2.0/devices/{deviceId}/credentials/

This method fetches a single device credentials resource

Update Device IP

PATCH example.itportal.com/api/2.0/devices/{deviceId}/ips/{ipId}/

Updates specific fields on an entity (RFC 7396)

Delete Management URL

DELETE example.itportal.com/api/2.0/devices/{deviceId}/managementUrls/{murlId}/

Description coming soon...

Update Device Management URL

PATCH example.itportal.com/api/2.0/devices/{deviceId}/managementUrls/{murlId}/

Updates specific fields on an entity (RFC 7396)

Get Notes For Device

GET example.itportal.com/api/2.0/devices/{deviceId}/notes/

This method fetches a single device Notes resource

Create Device Note

POST example.itportal.com/api/2.0/devices/{deviceId}/notes/

New device Note will be added to the portal

Update Device Note

PATCH example.itportal.com/api/2.0/devices/{deviceId}/notes/{noteId}/

Updates specific fields on an entity (RFC 7396)

Get Switch Port Ranges For Device

GET example.itportal.com/api/2.0/devices/{deviceId}/switchPortRanges/

This method fetches a single device mapped switch port ranges resource

Create Device Switch Port Range

POST example.itportal.com/api/2.0/devices/{deviceId}/switchPortRanges/

New device switch port range will be added to the portal

Delete Switch Port Range

DELETE example.itportal.com/api/2.0/devices/{deviceId}/switchPortRanges/{switchPortRangeId}/

Description coming soon...

Update Switch Port Range

PATCH example.itportal.com/api/2.0/devices/{deviceId}/switchPortRanges/{switchPortRangeId}/

Updates specific fields on an entity (RFC 7396)

Update Switch Port

PATCH example.itportal.com/api/2.0/devices/{deviceId}/switchPortRanges/{switchPortRangeId}/switchPorts/{switchPortId}/

Updates specific fields on an entity (RFC 7396)

Documents

List Documents

GET example.itportal.com/api/2.0/documents/

Fetches lists of portal documents with optional filters. See notes on individual parameters below

Create Document

POST example.itportal.com/api/2.0/documents/

New document will be added to the portal

Get Document

GET example.itportal.com/api/2.0/documents/{documentId}/

This method fetches a single document resource. It is the canonical URI for any document resource provided by the API

Delete Document

DELETE example.itportal.com/api/2.0/documents/{documentId}/

Description coming soon...

Update Document

PATCH example.itportal.com/api/2.0/documents/{documentId}/

Updates specific fields on an entity (RFC 7396)

Facilities

List Facilities

GET example.itportal.com/api/2.0/facilities/

Fetches lists of portal facilities with optional filters. See notes on individual parameters below

Create Facility

POST example.itportal.com/api/2.0/facilities/

New facility will be added to the portal

Get Facility

GET example.itportal.com/api/2.0/facilities/{facilityId}/

This method fetches a single facility resource. It is the canonical URI for any facility resource provided by the API

Delete Facility

DELETE example.itportal.com/api/2.0/facilities/{facilityId}/

Description coming soon...

Update Facility

PATCH example.itportal.com/api/2.0/facilities/{facilityId}/

Updates specific fields on an entity (RFC 7396)

Generic Request

IT Portal API Request

GET example.itportal.com/<url_path>

Generic action for making authenticated requests against the IT Portal API

Interactions

Delete Interaction

DELETE example.itportal.com/api/2.0/interactions/{interactionId}/

Description coming soon...

List Interactions

GET example.itportal.com/api/2.0/interactions/{objectType}/{objectId}/

Description coming soon...

Create Interactions

POST example.itportal.com/api/2.0/interactions/{objectType}/{objectId}/

Description coming soon...

Ip Networks

List IP Networks

GET example.itportal.com/api/2.0/ipnetworks/

Fetches lists of portal IP Networks with optional filters. See notes on individual parameters below

Create IP Network

POST example.itportal.com/api/2.0/ipnetworks/

New ip network will be added to the portal

Get IP Network

GET example.itportal.com/api/2.0/ipnetworks/{ipnetworkId}/

This method fetches a single IP network resource. It is the canonical URI for any IP network resource provided by the API

Delete IP Network

DELETE example.itportal.com/api/2.0/ipnetworks/{ipnetworkId}/

Description coming soon...

Update IP Network

PATCH example.itportal.com/api/2.0/ipnetworks/{ipnetworkId}/

Updates specific fields on an entity (RFC 7396)

Kbs

List KBs

GET example.itportal.com/api/2.0/kbs/

Fetches lists of portal knowledge base articles with optional filters. See notes on individual parameters below

Create KBs

POST example.itportal.com/api/2.0/kbs/

New knowledge base article will be added to the portal

Get KB

GET example.itportal.com/api/2.0/kbs/{kbId}/

This method fetches a single knowledge base article resource. It is the canonical URI for any KB resource provided by the API

Delete KB

DELETE example.itportal.com/api/2.0/kbs/{kbId}/

Description coming soon...

Update KB

PATCH example.itportal.com/api/2.0/kbs/{kbId}/

Updates specific fields on an entity (RFC 7396)

Sheets

Get Sheet

GET example.itportal.com/api/2.0/sheets/{sheetId}/

Fetch object sheet

Delete Sheet

DELETE example.itportal.com/api/2.0/sheets/{sheetId}/

Description coming soon...

Update Sheet

PATCH example.itportal.com/api/2.0/sheets/{sheetId}/

Updates specific fields on an entity (RFC 7396)

Create Sheet

POST example.itportal.com/api/2.0/sheets/{itemType}/{itemId}

New Sheet will be added to the object

Sites

List Sites

GET example.itportal.com/api/2.0/sites/

Fetches lists of portal sites with optional filters. See notes on individual parameters below

Create Site

POST example.itportal.com/api/2.0/sites/

New site will be added to the portal

Get Site

GET example.itportal.com/api/2.0/sites/{siteId}/

This method fetches a single site resource. It is the canonical URI for any site resource provided by the API

Delete Site

DELETE example.itportal.com/api/2.0/sites/{siteId}/

Description coming soon...

Update Site

PATCH example.itportal.com/api/2.0/sites/{siteId}/

Updates specific fields on an entity (RFC 7396)

System

List Companies Main Contacts

GET example.itportal.com/api/2.0/system/companies/mainContacts/

Fetches lists of portal main contacts with optional filters. See notes on individual parameters below

List Users

GET example.itportal.com/api/2.0/system/users/

Fetches lists of portal users

List Countries

GET example.itportal.com/api/2.0/system/countries/

Fetches lists of countries

List Security Groups

GET example.itportal.com/api/2.0/system/groups/securityGroups/

Fetches lists of portal security groups

Templates

List Templates

GET example.itportal.com/api/2.0/templates/{objectType}/{objectId}/

Fetches lists of portal templates with values

Upd Field For ID Field

PATCH example.itportal.com/api/2.0/templates/{objectType}/{objectId}/{templateId}/fields/{fieldId}/

Updates specific field on an entity's template