OpenLM Server 4.0 API changes - OpenLM Software License Management
Israel +972 4 6308447         USA +1 619 831 0029              JAPAN +81 3 45208991 担当:萩原

OpenLM Server 4.0 API changes

 

OpenLM Server 4.0 API changes

Contents

 

New Methods

GetSupportSummaryReport

GetPortsSettings

GetDenials

GetDenialSeries

GetDenialsChart

GetLicensesActivityByGroup

GetLicensesActivityGroupColumns

GetLicensesTotalUsageTime

GetProjectsList

GetUsers

GetUserDetails

GetGroupsList

GetGroupDetails

GetGroupTotalUsers

ApproveLicenseServer

IgnoreLicenseServer

GetUniqueUsersWorkStationsPerVendor

New Classes

PortsSettingsResponse

DenialsRequest

DenialsResponse

DenialSeriesRequest

DenialChartRequest

DenialsChartResponse

LicensesActivityByGroupResponse

LicenseActivityByGroupResponse

LicensesActivityGroupColumnsResponse

LicensesTotalUsageTimeResponse

ProjectsListRequest

ProjectsListResponse

UsersForPageRequest

UsersResponse

UserDetailsRequest

UserDetailsResponse

UserDetailsRequest

GroupsListRequest

GroupsListResponse

GroupDetailsRequest

GroupDetailsResponse

GroupTotalUsersRequest

ApproveLicenseServerRequest

IgnoreLicenseServerRequest

GetUniqueUsersWorkStationsPerVendorRequest

UniqueUsersWorkStationsPerVendorResponse

Changed Classes

LicensesActivityRequest

LicenseProcurement

AlertRuleDestination

ProjectDisplay

User

Denial

LicenseUsageReportRequest

GroupsListRequest

AlertRuleCondition

Common Classes

SlimDateTime

FeatureVendorServer

BaseRequest

Property

Type

Description

RequestBaseInfo

SessionRefresh

Property

Type

Description

PagingData

Property

Type

Description

UserLocalSettings

Property

Type

Description

TimeFormat

TimezoneStandardName

DecimalSeparator

ThousandsSeparator

Thousands separator sign

BaseResponse

Property

Type

Description

Error

Property

Type

Description

KeyValueStringPair

Property

Type

Description

Denial

ProjectDisplay

GroupVO

Property

Type

Description

ID

Name

Enabled

Editable

Whether a group can be edited

DefaultProjectID

The ID of default project of group

User

UserWorkstation

LicenseServerDC

LicensesActivityRequest

Enumeration Classes

BrokerCommands

ProjectSource

ProjectPriority

LicenseTypes

DenialCategory

LogicalOperator

DenialStatus

ExportContentType

Removed Methods

GetGroupsNames

 

New Methods

 

Name

Request / Response

Description

GetSupportSummaryReport

BaseRequest

BaseResponse

Returns a report includes summary of brokers, servers, routers, ldap sync definitions, services ports,  db version and server version.

GetPortsSettings

BaseRequest

PortsSettingsResponse

Returns a list of service ports.

GetDenials

DenialsRequest

DenialsResponse

Returns a list of license denials (paged).

GetDenialSeries

DenialSeriesRequest

DenialsResponse

Returns a list of denials related to a specific series.

GetDenialsChart

DenialChartRequest

DenialsChartResponse

Returns denials data fits to denials chart.

GetLicensesActivityByGroup

LicensesActivityRequest

LicensesActivityByGroupResponse

Returns license activity grouped by:

User, Feature, Server, Vendor Group, Project, Workstation

GetLicensesActivityGroupColumns

BaseRequest

LicensesActivityGroupColumnsResponse

Returns a list of columns that can be grouped by in license activity report.

GetLicensesTotalUsageTime

LicensesActivityRequest

LicensesTotalUsageTimeResponse

Returns license activity total usage time.

GetProjectsList

ProjectsListRequest

ProjectsListResponse

Returns a list of projects.

GetUsers

UsersForPageRequest

UsersResponse

Returns a list of users.

GetUserDetails

UserDetailsRequest

UserDetailsResponse

Returns user’s details such as:

Username, FirstName, LastName
Department, Email, Enabled
Projects, Groups
and etc.

GetGroupsList

GroupsListRequest

GroupsListResponse

Returns list of groups.

GetGroupDetails

GroupDetailsRequest

GroupDetailsResponse

Returns group details such as:

Name, Enabled, Editable, DefaultProjectID and parent groups.

GetGroupTotalUsers

GroupTotalUsersRequest

UsersResponse

Returns all users of group and of child groups.

ApproveLicenseServer

ApproveLicenseServerRequest

BaseResponse

Approves LM server to be added to servers configuration.

IgnoreLicenseServer

IgnoreLicenseServerRequest

BaseResponse

Ignores LM server to be added to servers configuration.

GetUniqueUsersWorkStationsPerVendor

GetUniqueUsersWorkStationsPerVendorRequest

UniqueUsersWorkStationsPerVendorResponse

Returns a list of users and workstations per vendor.

New Classes

PortsSettingsResponse

 

Property

Type

Description

AgentListenerPort

Int32

The port of agent listener

AgentListenerPortUseSSL

Boolean

Whether to use SSL in agent listener

UIListenerPort

Int32

The port of UI listener (the XML API for UI requests)

UIListenerPortUseSSL

Boolean

Whether to use SSL in UI listener

BrokerListenerPort

Int32

The port of broker listener

BrokerListenerPortUseSSL

Boolean

Whether to use SSL in broker listener

AdminAPIServicePort

Int32

The port of Admin API SOAP service

AdminAPIServicePortUseSSL

Boolean

Whether to use SSL in  Admin API service

RouterServicePort

Int32

The port of Router API SOAP service

RouterServicePortUseSSL

Boolean

Whether to use SSL in Router API service

 

DenialsRequest

 

Property

Type

Description

StartTime

SlimDateTime

Start time of denial time

EndTime

SlimDateTime

End time of denial time

ServerName

String

The name of LM server

Vendor

String

The vendor

UserNames

String[]

A list of user names

Workstations

String[]

A list of workstation

Features

FeatureVendorServer[]

A list of features

SearchByError

String

An error text to search

GetTrueDenialsOnly

Boolean

Whether to return true denials only

LicenseTypes

LicenseTypes[]

A list of license types

AdditionalKey

String[]

A list of additional keys

GroupIDS

Int32[]

A list of group IDs

DenialCategories

DenialCategory[]

A list of denial categories (types)

DenialsResponse

 

Property

Type

Description

Denials

Denial[]

A list of denials (pagged)

TotalNumOfDenials

Int64

A total number of denials.

DenialSeriesRequest

 

Property

Type

Description

ID

Int32

The ID of denial series

DenialChartRequest

 

Property

Type

Description

StartTime

SlimDateTime

Start time of denial time

EndTime

SlimDateTime

End time of denial time

ServerName

String

The name of LM server

Vendor

String

The vendor

UserNames

String[]

A list of user names

Workstations

String[]

A list of workstation

Features

FeatureVendorServer[]

A list of features

GroupBy

String

Group by column:

User, Group, Server, Vendor, Feature, Hour, Day, Week, Month, Workstation

GetTrueDenialsOnly

Boolean

Whether to return true denials only

SearchByError

String

An error text to search

DenialCategories

DenialCategory[]

A list of denial categories (types)

LicenseTypes

LicenseTypes[]

A list of license types

AdditionalKey

String[]

A list of additional keys

GroupIDS

Int32[]

A list of group IDs

DenialsChartResponse

 

Property

Type

Description

Points

KeyValuePair<String, Int64>[]

A list of points pairs (group by value, deinals count)

LicensesActivityByGroupResponse

 

Property

Type

Description

TotalNumOfLicensesActivities

Int64

A total number of license activities by group

LicensesActivities

LicenseActivityByGroupResponse[]

A list of license activities by group (pagged)

LicenseActivityByGroupResponse

 

Property

Type

Description

GroupByField

String

Group by field value

UsageTime

Double

License Usage time in hours

FilterUsageTime

Double

License Usage time w\in filter period in hours

TokenUsageTime

Double

Token Usage time in hours

TokenFilterUsageTime

Double

Token Usage time w\in filter period in hours

 

LicensesActivityGroupColumnsResponse

 

Property

Type

Description

Columns

String[]

A list of group by column names

 

LicensesTotalUsageTimeResponse

 

Property

Type

Description

UsageTime

Double

Total License Usage time in hours

FilterUsageTime

Double

Total License Usage time w\in filter period in hours

TokenUsageTime

Double

Total Token Usage time in hours

TokenFilterUsageTime

Double

Total Token Usage time w\in filter period in hours

ProjectsListRequest

 

Property

Type

Description

ProjectIDs

Int32[]

A list of project IDs

ShowDisabled

Boolean

Whether to return disabled projects

ProjectName

String

A name of project

Priority

Nullable<ProjectPriority>

A priority of project:

Low, Medium, High
 

CreationSource

Nullable<ProjectSource>

Project’s creation source:

Agent, EasyAdmin

StartTime

SlimDateTime

The start time of project

EndTime

SlimDateTime

The end time of project

ProjectsListResponse

 

Property

Type

Description

Projects

ProjectDisplay[]

A list of projects

UsersForPageRequest

 

Property

Type

Description

ShowDisabled

Boolean

Whether to return disabled users

GroupID

Nullable<Int32>

The ID of group, users assigned to

RoleID

Nullable<Int32>

The ID of role, users assigned to

ProjectID

Nullable<Int32>

The ID of project, users assigned to

UsersResponse

 

Property

Type

Description

Users

User[]

A list of users (pagged)

TotalNumOfUsers

Int64

The total number of users

 

UserDetailsRequest

 

Property

Type

Description

UserID

Int32

The ID of user

Username

String

The username

UserDetailsResponse

 

Property

Type

Description

UserBaseDetails

User

A details of user such as:

Username, FirstName, LastName
Department, Email, Enabled
Projects, Groups
and etc.

Projects

ProjectDisplay[]

A list of projects, the users assigned to

DefaultProject

ProjectDisplay

The default project of user

Groups

GroupVO[]

A list of groups, the user belongs to

DefaultGroup

GroupVO

The default group of user

UserDetailsRequest

 

Property

Type

Description

UserID

Int32

The ID of user

Username

String

The username

 

GroupsListRequest

 

Property

Type

Description

ShowDisabled

Booelan

Whether to return disabled group

GroupsListResponse

 

Property

Type

Description

Groups

GroupVO[]

A list of groups

GroupDetailsRequest

 

Property

Type

Description

GroupID

Int32

The ID of group

GroupDetailsResponse

 

Property

Type

Description

BaseDetails

GroupVO

Group details such as:

Name, Enabled, Editable, DefaultProjectID and parent groups.

ParentGroups

GroupVO[]

The parent groups of group

GroupTotalUsersRequest

 

Property

Type

Description

GroupId

Int32

The ID of group

IncludeDisabled

Boolean

Whether to return disabled users and groups

ApproveLicenseServerRequest

 

Property

Type

Description

Host

String

A name or IP of host

Port

Int32

A port

ServerDescription

String

A description of LM server

IgnoreLicenseServerRequest

 

Property

Type

Description

Host

String

A name or IP of host

Port

Int32

A port

GetUniqueUsersWorkStationsPerVendorRequest

 

Property

Type

Description

StartTimeUTC

DateTime

 

EndTimeUTC

Nullable<DateTime>

Start and End times range the users have used licenses in

Vendor

String

A vendor

UniqueUsersWorkStationsPerVendorResponse

 

Property

Type

Description

UsersAndWorkstationsList

UserWorkstation[]

A list of user and workstation pairs

 

Changed Classes

LicensesActivityRequest

 

Property

Type

Description

ProjectIDs

Int32[]

Changed from ProjectIDS – A list project IDs

GroupIDs

Int32[]

Changed from GroupIDS – A list of group IDs

GroupBy

String

Added – The column to group by

ConsiderWorkHours

Boolean

Removed (Not supported anymore)

LicenseProcurement

 

Property

Type

Description

ComponentsInfo

String

Added – A list of package components

IsCloseToExpiration

Boolean

Added – Whether license procurement is expired within 7 days

IsFuture

Boolean

Added – Whether license procurement has future date

 

AlertRuleDestination

 

Property

Type

Description

IncludeInvolvedEntities

Nullable<Char>

Changed from IncludeInvolvedUsers – Whether to send alert also to users that were involved in conditions match

Servers

LicenseServerDC[]

Added – A list of LM servers

BrokerCommand

BrokerCommands

Added – Broker command to be run on LM server:

Start, Stop, Reread, Restart

CustomTitle

String

Added – A customized subject to be displayed in alert mail.

 

ProjectDisplay

 

Property

Type

Description

Enabled

Boolean

Added – Whether project is enabled

StartDate

SlimDateTime

Added

EndDate

SlimDateTime

Added – Start and End dates are dates range of project

CreationSource

ProjectSource

Added – The creation source of project:

Agent or Admin

AllocatedTime

Int32

Added – The time allocated for a project

Priority

ProjectPriority

Added – The priority of project:

Low, High, Medium

PercentDone

Int32

Added– Percentages of project done

DeletionEnabled

Boolean

Added – Whether the deletion of project should be enabled

AssociatedGroupName

String

Added – The name of group associated to a project.

 

User

 

Property

Type

Description

FirstName

String

Added

LastName

String

Added

Department

String

Added

DisplayName

String

Added

Title

String

Added

PhoneNumber

String

Added

Office

String

Added

Description

String

Added

Email

String

Added

Enabled

Boolean

Added – Whether a user is enabled

DefaultGroupName

String

Added – The default group of user

DefaultProjectName

String

Added The default project of user

 

Denial

 

Property

Type

Description

LicenseType

Nullable<LicenseTypes>

Type changed from LicenseTypes – A list of license types

Email

String

Added – The email of denied user

Version

String

Added – The version of denied feature

LicenseUsageReportRequest

 

Property

Type

Description

Workstations

 String[]

Added – A list of workstations

GroupsListRequest

 

Property

Type

Description

Search

String

Changed from Prefix – The text to search group name

 

AlertRuleCondition

 

Property

Type

Description

AlertRuleCondition

Nullable<LogicalOperator>

Type changed from LogicalOperator – The logical operato: And, Or, Not

 

Common Classes

SlimDateTime

Property

Type

Description

Year

Int32

 

Month

Int32

 

Day

Int32

 

Hour

Int32

 

Minute

Int32

 

Second

Int32

 

FeatureVendorServer

Property

Type

Description

Feature

String

The name of feature

Version

String

Version

Vendor

String

The name of vendor

Server

String

The name of LM server

LicenseType

Nullable<LicenseTypes>

The type of license:

Floating, NodeLocked, NamedUser, SingleUse, NamedUserCasual, HostBased
Unmanaged, UserNameLocked
Token

AdditionalKey

String

The additional key

BaseRequest

Property

Type

Description

BaseInfo

RequestBaseInfo

General request information includes: Session, Paging, User local settings, etc.

RequestBaseInfo

Property

Type

Description

SessionData

SessionRefresh

Session Data

PagingData

PagingData

Paging Data

UserLocalSettings

UserLocalSettings

User localization settings:

Date time format, timezone and etc.

IsExport

Boolean

Whether to get exported to csv results

CustomerId

String

Customer’s identifier
Relevant to SAAS system only.

SessionRefresh

Property

Type

Description

SessionID

String

The ID of session

Refresh

Boolean

Is manual refresh

PagingData

Property

Type

Description

StartRecord

Int32

Number of paging start record

NumOfRecord

Int32

Max result set size

Sort

String[]

Columns by which to sort the results

Search

String

Data to search

SearchColumns

String[]

Columns that will be used for search

Direction

String

Sorting direction (“asc” or “desc”)

UserLocalSettings

Property

Type

Description

TimeFormat

String

 For example::

 dd/mm/yyyy hh:mm:ss

 mm/dd/yyyy hh:mm:ss

 yyyy-mm-dd hh:mm:ss

 

TimezoneStandardName

String

Timezone standard name, according to System.TimeZoneInfo.Id

DecimalSeparator

String

Decimal separator sign

ThousandsSeparator

String

Thousands separator sign

BaseResponse

 

Property

Type

Description

SaasToken

String

An authentication session ID in SaaS mode.

Error

Error

Error data (if error exists)

ExportString

String

The export response (if export requested)

ExportContentType

ExportContentType

The content type of export:

Text or URL

Error

 

Property

Type

Description

Code

Int32

The error code

Message

String

The error message

Parameters

KeyValueStringPair[]

A list of error parameters

KeyValueStringPair

 

Property

Type

Description

Key

String

The key of pair

Value

String

The value of pair

Denial

 

Property

Type

Description

ID

Int32

The ID of denial

UserName

String

The username of denied user

FirstName

String

The first name of denied user

LastName

String

The last name of denied user

Email

String

The email of denied user

UserGroupName

String

The default group of denied user

WorkstationName

String

The workstation of denied user

DenialTime

SlimDateTime

The time of denial

FeatureName

String

The feature of denied license

LicenseType

Nullable<LicenseTypes>

The license type of denied license

AdditionalKey

String

The additional key of denied license

ServerDescription

String

The name of LM server of denied license

Vendor

String

The vendor of denied license

LMHostName

String

The host name of denied license

Category

DenialCategory

The category of denial

NumOfLicenses

Int32

The number of licenses of denied license

ErrorMsg

String

The error message of denial

Status

Nullable<DenialStatus>

The status of denial:

True Denial,

False Denial,

Duplicate

HasSeries

Boolean

Whether the denial has underlying denial series

Version

String

The version of denied license

ProjectDisplay

 

Property

Type

Description

Id

Int32

The ID of project

Name

String

The name of project

Enabled

Boolean

Whether project is enabled

StartDate

SlimDateTime

The start date of project

EndDate

SlimDateTime

The end date of project

CreationSource

ProjectSource

The creation source of project:

Agent or Admin

AllocatedTime

Int32

The time allocated for a project

Priority

ProjectPriority

The priority of project:

Low, High, Medium

PercentDone

Int32

Percentages of project done

DeletionEnabled

Boolean

Whether the deletion of project should be enabled

AssociatedGroupName

String

The name of group associated to a project.

GroupVO

Property

Type

Description

ID

Int32

The ID of group

Name

String

The name of group

Enabled

Boolean

Whether a group is enabled

Editable

Boolean

Whether a group can be edited
DefaultProjectID

Nullable<Int32>

The ID of default project of group

User

 

Property

Type

Description

ID

Int32

 

Username

String

 

FirstName

String

 

LastName

String

 

Department

String

 

DisplayName

String

 

Title

String

 

PhoneNumber

String

 

Office

String

 

Description

String

 

Email

String

 

Enabled

Boolean

Whether a user is enabled

DefaultGroupName

String

The default group name of user

DefaultProjectName

String

The default project name of user

UserWorkstation

 

Property

Type

Description

UserName

String

The username

Workstation

String

The workstation

LicenseServerDC

 

Property

Type

Description

ID

Int32

The ID of LM server

Description

String

The description of LM server

LMHostsIDs

Int32[]

A list of LM hosts IDs

LicensesActivityRequest

 

Property

Type

Description

IncludeCurrentUsage

Boolean

Whether to return current activity

StartTime

SlimDateTime

Start time of license activity

EndTime

SlimDateTime

End time of license activity

ServerName

String

The name of LM server

Vendor

String

The name of vendor

UserIDs

Int32[]

A list of users’ IDs

Features

FeatureVendorServer[]

A list of used features

Products

FeatureVendorServer[]

A list of used products

Workstations

String[]

A list of used workstations

LicenseTypes

LicenseTypes[]

A list of used license types

AdditionalKey

String[]

A list of used licenses’ additional keys

ProjectIDs

Int32[]

A list of used licenses’ projects

GroupIDs

Int32[]

A list of used licenses’ groups

GroupBy

String

The column to group by in LicenseActivityByGroup request

 

Enumeration Classes

BrokerCommands

 

Name

Value

Description

start

3

 

stop

4

 

reread

5

 

restart

16

 

 

ProjectSource

 

Name

Value

Description

Admin

0

EasyAdmin

Agent

1

 

ProjectPriority

 

Name

Value

Description

Low

0

 

Medium

1

 

High

2

 

LicenseTypes

 

Name

Value

Description

Floating

0

 

NodeLocked

1

 

NamedUser

2

 

SingleUse

3

 

NamedUserCasual

4

 

HostBased

5

 

Unmanaged

6

 

UserNameLocked

7

 

Token

8

 

 

DenialCategory

 

Name

Value

Description

Other

0

 

UnspecifiedReason

1

 

LimitReached

2

 

LicenseServerError

3

 

RestrictionOrAuthorization

4

 

ProblemWithLicense

5

 

LogicalOperator

 

Name

Value

Description

And

1

 

Or

2

 

Not

3

 

DenialStatus

 

Name

Value

Description

Unknown

0

 

TrueDenial

1

Denial of license that have not been consumed from other server or pool within 1 minute from denial’s actual date

FalseDenial

2

Denial of license that finally consumed from other server or pool

within 1 minute from denial’s actual date

Duplicate

3

Duplicate of another (false or true) denial belongs to same denial series that denied within 1 minute from denial’s actual date

 

ExportContentType

 

Name

Value

Description

Text

0

Export Text

Link

1

Export File URL

 

Removed Methods

 

Name

Description

GetGroupsNames

This method was replaced by GetGroupsList

 

 

in API

Related Articles