Edit

Business Central Admin Center API - Session management

INTRODUCED IN: Business Central 2020 release wave 1

Manage the active sessions on an environment.

Get active sessions

Gets active sessions for an environment.

GET /admin/{apiVersion}/applications/{applicationFamily}/environments/{environmentName}/sessions

Route parameters

apiVersion - the version of the Admin Center API. Currently, the latest version is v2.29

applicationFamily - the family of the ring's application (for example, "BusinessCentral")

environmentName - the name of the targeted environment

Response

{
  value: [
    {
      environmentName: string,
      applicationFamily: string,
      sessionId: int,
      userId: string,
      clientType: string,
      logOnDate: string,
      entryPointOperation: string,
      entryPointObjectName: string,
      entryPointObjectId: string,
      entryPointObjectType: string,
      currentObjectName: string,
      currentObjectId: int,
      currentObjectType: string,
      currentOperationDuration: long
    }
    ,...
  ]
}

Get session details

Gets session information for a specific session ID.

GET /admin/{apiVersion}/applications/{applicationFamily}/environments/{environmentName}/sessions/{sessionId}

Route parameters

apiVersion - the version of the Admin Center API. Currently, the latest version is v2.29

applicationFamily - the family of the ring's application (for example, "BusinessCentral")

environmentName - the name of the targeted environment

sessionId - the ID of the session

Response

{
  environmentName: string,
  applicationFamily: string,
  sessionId: int,
  userId: string,
  clientType: string,
  logOnDate: string,
  entryPointOperation: string,
  entryPointObjectName: string,
  entryPointObjectId: string,
  entryPointObjectType: string,
  currentObjectName: string,
  currentObjectId: int,
  currentObjectType: string,
  currentOperationDuration: long
}

Stop and delete a session

Terminates and deletes an active session.

DELETE /admin/{apiVersion}/applications/{applicationFamily}/environments/{environmentName}/sessions/{sessionId}

Route parameters

apiVersion - the version of the Admin Center API. Currently, the latest version is v2.29

applicationFamily - the family of the ring's application (for example, "BusinessCentral")

environmentName - the name of the targeted environment

sessionId - The ID of the session

The Business Central Administration Center API
Manage Apps
Microsoft Dynamics 365 Business Central Server Administration Tool

  • Last updated on