Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Enviance Portal API

The Portal API from Enviance — 13 operation(s) for portal.

Enviance Portal API is one of 39 APIs that Enviance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Portal. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 27 operations across 13 paths, and defines 26 schemas. It is described by OpenAPI 2.0, at version Platform.v2026.2.0.0.20260708.

Requests are made against the base URL https://api.enviance.com.

27 operations 13 paths 26 schemas 4 DELETE13 GET4 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
Platform.v2026.2.0.0.20260708
Base URL
https://api.enviance.com
Authentication
basic, API Key
Contact
Resource Areas
1

Authentication & Security 2

Enviance Portal API declares 2 security schemes for authenticating requests. It defines a basic scheme (Basic). An API key is passed in the header as Authorization (EnvianceAuth).

  • Basic — Forces authentication with credentials via an api gateway
  • EnvianceAuth — Enviance \ . Obtain SessionId by POST /ver2/AuthenticationService.svc/sessions first

Paths & Operations 27

Across 13 paths, the API surfaces 27 operations — 4 DELETE, 13 GET, 4 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Portal 27
GET
/ver2/PortalService.svc/portal/dashboard
envianceSdk.portal.getDashboard [ "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPageGroupAllNestedByCurrentUser 7 params → default
GET
/ver2/PortalService.svc/portal/dashboard/pagegroups
envianceSdk.portal.getPageGroups [ "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPageGroups 7 params → default
POST
/ver2/PortalService.svc/portal/dashboard/pagegroups
envianceSdk.portal.createPageGroup [ { "name": "Page Group1", "properties": { "key1": "value 1", "key 2": "value 2" } }, "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.CreatePageGroup 8 params → default
GET
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}
envianceSdk.portal.getPageGroups [ "onsuccess", "onerror" ] envianceSdk.portal.getPageGroup [ "Page Group Name or ID", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPageGroup 8 params → default
PATCH
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}
envianceSdk.portal.updatePageGroup [ "Page Group1", { "name": "Page Group1 modified", "properties": { "key1": "value 1", "key 2": "value 2" } }, "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.UpdatePageGroup 9 params → default
DELETE
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}
envianceSdk.portal.deletePageGroup [ "Page Group1", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.DeletePageGroup 8 params → default
GET
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages
envianceSdk.portal.getPages [ "Page Group1", "onsuccess", "onerror" ] envianceSdk.portal.getPageSettings [ "Page Group1", "Page Name", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPages 8 params → default
POST
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages
envianceSdk.portal.createPageGroup [ { "name": "Page Group1", "properties": { "key1": "value 1", "key 2": "value 2" } }, "onsuccess", "onerror" ] envianceSdk.portal.createPage [ "Page Group", { "name…
Enviance.RestServices.Ver2.Portal.Impl.PortalService.CreatePage 9 params → default
GET
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}
envianceSdk.portal.getPageGroups [ "onsuccess", "onerror" ] envianceSdk.portal.getPageGroup [ "Page Group Name or ID", "onsuccess", "onerror" ] envianceSdk.portal.getPages [ "Page Group1", "onsuccess…
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPage 9 params → default
PATCH
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}
envianceSdk.portal.updatePageGroup [ "Page Group1", { "name": "Page Group1 modified", "properties": { "key1": "value 1", "key 2": "value 2" } }, "onsuccess", "onerror" ] envianceSdk.portal.updatePage…
Enviance.RestServices.Ver2.Portal.Impl.PortalService.UpdatePage 10 params → default
DELETE
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}
envianceSdk.portal.deletePageGroup [ "Page Group1", "onsuccess", "onerror" ] envianceSdk.portal.deletePage [ "Parent Page Group", "Page A", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.DeletePage 9 params → default
GET
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}/panels
envianceSdk.portal.getPanels [ "Page Group1", "Page Name", "onsuccess", "onerror" ] envianceSdk.portal.getPanelSettings [ "Page Group1", "Page Name", "Panel Name", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPanels 9 params → default
POST
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}/panels
envianceSdk.portal.createPanel [ "Page Group1", "Page Name", { "name": "Panel Name", "properties": { "color": "green", "Position": "top" }, "accessLevels": { "users": [ { "id": "918b8c13-41e6-4b62-9e…
Enviance.RestServices.Ver2.Portal.Impl.PortalService.CreatePanel 10 params → default
GET
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}/panels/{panelIdOrName}
envianceSdk.portal.getPanels [ "Page Group1", "Page Name", "onsuccess", "onerror" ] envianceSdk.portal.getPanel [ "Page Group1", "Page Name", "Panel Name", "onsuccess", "onerror" ] envianceSdk.portal…
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPanel 10 params → default
PATCH
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}/panels/{panelIdOrName}
envianceSdk.portal.updatePanel [ "Page Group1", "Page Name", "Panel Name", { "name": "Panel Name", "properties": { "color": "green", "Position": "top" }, "accessLevels": { "users": [ { "id": "918b8c1…
Enviance.RestServices.Ver2.Portal.Impl.PortalService.UpdatePanel 11 params → default
DELETE
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}/panels/{panelIdOrName}
envianceSdk.portal.deletePanel [ "Page Group1", "Page Name", "Panel Name", "onsuccess", "onerror" ] envianceSdk.portal.deletePanelTemplate [ "Panel Template Name", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.DeletePanel 10 params → default
PUT
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}/panels/{panelIdOrName}/settings
envianceSdk.portal.savePanelSettings [ "Page Group1", "Page Name", "Panel Name", "some user settngs for page", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.SavePanelSettings 11 params → default
GET
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}/panels/{panelIdOrName}/settings
envianceSdk.portal.getPanelSettings [ "Page Group1", "Page Name", "Panel Name", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPanelSettings 10 params → default
PUT
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}/settings
envianceSdk.portal.savePageSettings [ "Page Group1", "Page Name", "some user settngs for page", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.SavePageSettings 10 params → default
GET
/ver2/PortalService.svc/portal/dashboard/pagegroups/{pageGroupIdOrName}/pages/{pageIdOrName}/settings
envianceSdk.portal.getPageSettings [ "Page Group1", "Page Name", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPageSettings 9 params → default
GET
/ver2/PortalService.svc/portal/dashboard/paneltemplates
envianceSdk.portal.getPanelTemplates [ "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPanelTemplates 7 params → default
POST
/ver2/PortalService.svc/portal/dashboard/paneltemplates
envianceSdk.portal.createPanelTemplate [ { "name": "Panel Template Name", "properties": { "Position": "absolute" } }, "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.CreatePanelTemplate 8 params → default
GET
/ver2/PortalService.svc/portal/dashboard/paneltemplates/{panelTemplateIdOrName}
envianceSdk.portal.getPanelTemplates [ "onsuccess", "onerror" ] envianceSdk.portal.getPanelTemplate [ "Panel Template Name", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetPanelTemplate 8 params → default
PATCH
/ver2/PortalService.svc/portal/dashboard/paneltemplates/{panelTemplateIdOrName}
envianceSdk.portal.updatePanelTemplate [ "Panel Template Name", { "name": "Panel Template Name", "properties": { "Position": "top" } }, "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.UpdatePanelTemplate 9 params → default
DELETE
/ver2/PortalService.svc/portal/dashboard/paneltemplates/{panelTemplateIdOrName}
envianceSdk.portal.deletePanelTemplate [ "Panel Template Name", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Portal.Impl.PortalService.DeletePanelTemplate 9 params → default
GET
/ver2/PortalService.svc/portal/powerBiReports
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetReports 7 params → default
GET
/ver2/PortalService.svc/portal/powerBiReports/{reportIdOrName}
Enviance.RestServices.Ver2.Portal.Impl.PortalService.GetReport 8 params → default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Enviance.RestServices.Ver2.Portal.Dto.PageFlatWithPanelsInfo (8 properties), Enviance.RestServices.Ver2.Portal.Dto.PowerBIReportInfo (8 properties), Enviance.RestServices.Ver2.Portal.Dto.PanelFlatInfo (7 properties), Enviance.RestServices.Ver2.Portal.Dto.PanelWithAllInfo (5 properties). Each schema is shown below with its type and property counts.

CreatePanelTemplate
object
1 property
Enviance.RestServices.Ver2.Portal.Dto.IdNameInfo
object
2 properties
Enviance.RestServices.Ver2.Portal.Dto.PowerBIReportInfo
object
8 properties
Enviance.RestServices.Ver2.Portal.Dto.PanelFlatInfo
object
7 properties
UpdatePanel
object
1 property
Enviance.RestServices.Ver2.Portal.Dto.UserGroupPermissionInfo
object
3 properties
Enviance.RestServices.Ver2.Portal.Dto.PanelWithPropsInfo
object
4 properties
UpdatePage
object
1 property
Enviance.RestServices.Ver2.Portal.Dto.PanelTemplateInfo
object
3 properties
Enviance.RestServices.Ver2.Portal.Dto.PageGroupInfo
object
3 properties
Enviance.RestServices.Ver2.Portal.Dto.PageWithAllInfo
object
5 properties
Enviance.RestServices.Ver2.Portal.Dto.PageGroupWithPagesInfo
object
4 properties
Enviance.RestServices.Ver2.Portal.Dto.PanelWithAllInfo
object
5 properties
Enviance.RestServices.Ver2.Portal.Dto.PagePermissionsInfo
object
3 properties
Enviance.RestServices.Ver2.Portal.Dto.PageFlatWithPanelsInfo
object
8 properties
UpdatePanelTemplate
object
1 property
UpdatePageGroup
object
1 property
Enviance.RestServices.Ver2.Portal.Dto.PageGroupAllNestedInfo
object
4 properties
CreatePanel
object
1 property
CreatePage
object
1 property
CreatePageGroup
object
1 property
SavePageSettings
object
1 property
Enviance.RestServices.Ver2.Portal.Dto.PageWithPropsInfo
object
4 properties
DeletePanelTemplate
object
Enviance.RestServices.Ver2.Portal.Dto.PanelPermissionsInfo
object
2 properties
SavePanelSettings
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

enviance-portal-api-openapi.yml Raw ↑

Other APIs Enviance publishes across the network.

Enviance Activity API
Enviance Authentication API
Enviance BatchRequest API
Enviance Bulk API
Enviance Chemical API
Enviance ChemicalGroup API
Enviance ChemicalList API
Enviance Command API
Enviance Compliance API
Enviance CompliancePermissions API
Enviance CustomField API
Enviance Data API