Data Access API Entity Relationship Diagram and Field Descriptions

Equivalent to:

• device: DeviceAccountID

• entitlement: CustomersAndPartners.EndCustomerAccountID

• fulfillment: AccountID

• user: AccountID

Equivalent to:

• device: DeviceAccountName

• entitlement:

  CustomersAndPartners.EndCustomerAccountName

• fulfillment: AccountName

• user: AccountName

Identifies an account as one of the following types:

• CUSTOMER—Regular customer accounts.
• SELF_REGISTERED—Self-registered accounts.
• CHANNEL_PARTNER—Channel partner accounts.
• PUBLISHER—Producer accounts.

Accounts without a standard account type are shown as UNKNOWN.

The state of the account as one of the following:

• ACTIVE
• INACTIVE

Indicates whether partners in different distribution tiers are permitted to see information about this account.

Also referred to in:

• device: AccountDeleted
• served-device: AccountDeleted
• fulfillment: AccountDeleted

A 19-digit unique identifier of the device record as defined in FlexNet Operations. The ID is the primary key for the Device dimension.

Equivalent to:

• served-device: ServerHostID

A 64-character machine type. The possible machine type values are:

• PHYSICAL
• VIRTUAL
• UNKNOWN

This field may be empty.

The status of the device:

• ACTIVE
• OBSOLETE
• RETURNED

Identifies the device type as one of the following:

• CLIENT— Standalone devices (including anonymous devices).
• SERVER—FlexNet Embedded Local License Server or Cloud License Server.

One of several possible device host ID types:

• Ethernet
• Internet
• Internet IPV6
• FlexID 9
• FlexID 10
• String
• User
• VM UUID
• Container Id
• Extended
• Publisher defined

The ID of the customer or partner account that owns the device.

Exception: Anonymous devices are not associated with an account.

Equivalent to:

• account: AccountID

• entitlement: CustomersAndPartners.EndCustomerAccountID

• fulfillment: AccountID

• user: AccountID

The name of the customer or partner account that owns the device.

Exception: Anonymous devices are not associated with an account.

Equivalent to:

• account: AccountName

• entitlement:

  CustomersAndPartners.EndCustomerAccountName

• fulfillment: AccountName

• user: AccountName

The data returned by this API represents events that occur on the device. This field indicates the event type name for the event ID number in EVENT_ID. EventType may be one of the following values:

• ACTIVATABLE_ITEM_ADDED
• ACTIVATABLE_ITEM_REMOVED
• ACTIVATABLE_ITEM_INCREASED
• ACTIVATABLE_ITEM_DECREASED
• ACTIVATABLE_ITEM_MARK_REMOVED
• CAPABILITY_RESPONSE_SENT
• CAPABILITY_RESPONSE_GENERATED

The ID of the entitlement whose line item has been mapped to the device.

Exception: Anonymous devices are not associated with an entitlement ID.

Equivalent to:

• entitlement: EntitlementID

The Activation ID of a line item mapped to the device.

Exception: Anonymous devices are not associated with an activation ID.

Equivalent to:

• entitlement: ActivationID
• fulfillment: ActivationID

The name of the account owning the license mapped to the device. This is the same value as the AccountName field in the accounts API.

The name of the product entitled by the line item mapped to the device.

Note:  A product is uniquely identified by its name and version.

Exception:  Products cannot be specified for anonymous devices.

Equivalent to:

• entitlement: ProductName
• fulfillment: ProductName
• product-feature: ProductName 

The version of the product entitled by the line item mapped to the device.

Note:  A product is uniquely identified by its name and version.

Equivalent to:

• entitlement: ProductVersion

Equivalent to:

• entitlement: ProductVersion

Indicates whether the license mapped to the device is permanent or will expire by specifying one of the following:

• NONE: If it is set to NONE, the decision to decide if these licenses are permanent or expiring is deferred until the time an entitlement line ite is configured.

• PERMANENT: These licenses never expire.

• EXPIRING: These licenses will expire in a duration of n days, weeks, months, or years, which are specified in EndDurationUnits and EndDuration in the entitlement entity.

Equivalent to:

• entitlement: EndDate or EndDuration *
• fulfillment: ExpirationDate

* Depends on how Expiration is defined for the line item.

LicenseModel1

The license model for the primary activation on the device at the time of this event on the device.

Equivalent to:

• entitlement: LicenseModel
• fulfillment: LicenseModel

The license model of a second activation that has occurred on the device. This field may be empty.

The license model of a third activation that has occurred on the device. This field may be empty.

Also referred to in:

• entitlement: ProductDeleted
• fulfillment: ProductDeleted
• product-feature: ProductDeleted

Also referred to in:

• entitlement: ActivationDeleted
• fulfillment: ActivationDeleted

Also referred to in:

• account: AccountDeleted
• served-device: AccountDeleted
• fulfillment: AccountDeleted

Also referred to in:

• served-device: UserDeleted
• fulfillment: UserDeleted
• user: UserDeleted

Equivalent to:

• device: DeviceID

This field lists the user assigned to the device. This is dependent on the value set for the Device user option under System > Configure > FlexNet Operations > Embedded Device Settings. You use the Device user option setting to elect to offer the option to assign a user to a device, as well as whether the system will check the validity of the user. There are three possible values:

• Off: Nothing to be validated.
• On with no validation: This means any user can be added to the device, basically any string.
• On with validation: Only the user belonging to the device owner account can be added to the device.

For more information, see About the Device–Device User Association In the FlexNet Operations User Guide.

The status of the served device. A served device status can be one of the following:

• NORMAL
• EXPIRED
• DROPPED

The ID of the customer or partner account that owns the device.

Exception: Anonymous devices are not associated with an account.

Equivalent to:

• entitlement: CustomersAndPartners.EndCustomerAccountID
• fulfillment: AccountID
• user: AccountID

The name of the customer or partner account that owns the device.

Exception: Anonymous devices are not associated with an account.

Equivalent to:

• entitlement: CustomersAndPartners.EndCustomerAccountName
• fulfillment: AccountName
• user: AccountName

The time of the last update about this served device sent by the license server for processing.

The name of the feature request by the served device from the license server.

Note:  A feature is uniquely identified by its name and its version.

 Equivalent to: 

• product-feature: FeatureName

The version of the feature request by the served device from the license server.

Note:  A feature is uniquely identified by its name and its version.

 Equivalent to: 

• product-feature: FeatureVersion

This is an internal field used by the license server and FlexNet Operations.

Note:  This value is not the same as “overdraft”, which would be caused by a served device requesting more of a feature than is available on the license server.

The time when the served client was last modified.

A served client is modified whenever a synchronization message is sent to the back office (FlexNet Operations) from the Local License Service or Cloud License Server for this device as a result of a capability request.

The vendor dictionary provides a way for an implementer to send custom data in a capability request (in addition to the FlexNet Embedded–specific data) to the license server and vice-versa. Basically, the vendor dictionary provides a means to send information back and forth between the client and server for any producer-defined purposes, as needed; FlexNet Embedded does not interpret this data.

Vendor dictionary data is stored as key-value pairs. The key name is always a string, while a value can be a string or a 32-bit integer value, or an array of those types (arrays are only supported when using the Cloud Monetization REST API). Keys are unique in a dictionary and hence allow direct access to the value associated with them.

Communicate the available vendor dictionary data to your enterprise customer’s license server administrator if you want to enable them to use the vendor dictionary rule.

Also referred to in:

• account: AccountDeleted
• device: AccountDeleted
• fulfillment: AccountDeleted

Also referred to in:

• device: UserDeleted
• fulfillment: UserDeleted
• user: UserDeleted

A 19-digit unique identifier of the entitlement record as defined in FlexNet Operations.

Equivalent to:

• device: EntitlementID

An entitlement is created in a DRAFT, TEST, or DEPLOYED state.

Once an entitlement is no longer required, it can be made INACTIVE or OBSOLETE.

(Optional) Specify an email template.

• If no template is specified, then the email template configured for the license technology is used.
• If there is no email template configured for the license technology, then the default email template is chosen.
• If the chosen template is not active or the send indicator is not switched on, no email is sent.

Equivalent to:

• device: ActivationID
• fulfillment:ActivationID

The quantity of the product entitled by the line item.

Order line number.

Note: This may be imported from your ERM/CRP application.

Order ID.

Note: This may be imported from your ERM/CRP application.

Type of defined start date, as one of the following:

• Specify at each activation: (Not available for FlexNet Embedded licensing.) The user is prompted to specify a start date each time the line item is activated. Each fulfillment record gets a new start date, and for duration-based entitlements, each fulfillment record’s expiration date is set to start date specified + duration.
• Specify value now: The start date was specified at the time of the entitlement’s creation. All fulfillment records of this line item get this start date.
• Use first activation date: The date of the first activation is used as the start date. All fulfillment records for this line item get the same start date.
• Specify at first activation: (Not available for FlexNet Embedded licensing.) The user is prompted to specify a start date when first activating the line item. This start date is used for all fulfillment records.
• Use each activation date: Every time the line item is activated, the activation date is used as the start date. Each fulfillment record gets a new start date. As a result, for duration-based entitlements, each fulfillment record’s expiration date is set to activation date + duration.

Expiration date of the line item.

Equivalent to:

• device: ExpirationDate
• fulfillment: ExpirationDate

Indicates whether the license model is permanent or will expire by specifying one of the following:

• NONE: If it is set to NONE, the decision to decide if these licenses are permanent or expiring is deferred until the time an entitlement line ite is configured.
• PERMANENT:These licenses never expire.
• EXPIRING: These licenses will expire in a duration of n days, weeks, months, or years, which are specified in EndDurationUnits and EndDuration.

If IsActivationPermanent is set to EXPIRING, specify the end duration units as one of the following:

• DAYS
• WEEKS
• MONTHS
• YEARS

Equivalent to:

• device: ExpirationDate
• fulfillment: ExpirationDate

VersionDateType

VersionDate

VersionDurationUnits

VersionDuration

as described in the following topic:

Creating a FlexNet Publisher Licensing Toolkit License Generator (VCG) Configuration

Possible Order Types are:

• UPSELL
• UPGRADE
• RENEWAL
• NEW

The name of the product entitled by the line item.

Note: A product is uniquely identified by its name and version.

Equivalent to:

• device: ProductName
• fulfillment: ProductName
• product-feature: ProductName

Identifies the product type as one of the following:

• PRODUCT
• SUITE
• MAINTENANCE

The version of the product entitled by the line item.

Note: A product is uniquely identified by its name and version.

Equivalent to:

• device: ProductVersion

Identifies the quantity of product features entitled by this line item. The format of the ProductCount is as follows:

productID|featureID-n.featureID-n.featureID-n

where:

• productID|: A database identifier for the product, followed by a pipe (|) character. This ID appears in the URL when viewing a product in the FlexNet Operations Producer Portal.
• featureID-n: A database identifier for a product feature or feature bundle of the specified product, followed by a hyphen and a number identifying the quantity of that feature. Multiple features/feature bundles are separated by a period.

For example, this entry:

37850|37830-1.37831-1.37832-1

... means that Product ID 37850 has three features (37830, 37831, and 37832), each with an entitled quantity of 1.

Equivalent to:

• device: PartNumber
• fulfillment: PartNumber

Equivalent to:

• device: LicenseModel1, LicenseModel2, LicenseModel3
• fulfillment: LicenseModel

The account ID for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

Equivalent to:

• account: AccountID
• device: DeviceAccountID
• fulfillment: AccountID
• user: AccountID

A display name for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

Equivalent to:

• account: AccountName
• device: DeviceAccountName
• fulfillment: AccountName
• user: AccountName

Email address for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

First name for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

Last name for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

User name for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

Phone number for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

The account ID for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

The account name for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

The email address for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

First name for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

Last name for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

User name for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

Phone number for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

The activation ID of Maintenance, if it is associated with this line item.

The product name of Maintenance, if it is associated with this line item.

The part number of Maintenance, if it is associated with this line item.

The date on which Maintenance begins, if it is associated with this line item.

The date on which Maintenance ends, if it is associated with this line item.

The order line number of Maintenance, if it is associated with this line item.

The order ID of Maintenance, if it is associated with this line item.

The product version of Maintenance, if it is associated with this line item.

The line item activation ID link of Maintenance, if it is associated with this line item.

Also referred to in:

• device: ActivationDeleted
• fulfillment: ActivationDeleted

Also referred to in:

• device: ProductDeleted
• fulfillment: ProductDeleted

The state of the line item:

• MASTER
• INACTIVE
• OBSOLETE

Equivalent to:

• device: ActivationID
• entitlement: ActivationID

The method of activation, which is one of the following:.

• SHORTCODE—Trusted storage fulfillment records generated using short code activation.
  
• MANUAL—Trusted storage fulfillment records generated using manual (or offline activation) processing of the request and response XML files.
  
• PROGRAMMATIC—Trusted storage fulfillment records generated using regular online activation from the client.
  
• CERTIFICATE—Certificate licenses.
  
• TRUSTED—Legacy trusted storage fulfillment records which do not have specific information about how they were activated.
  
• EMBEDDED—Licenses generated using FlexNet Embedded for hardware devices.
  
• CUSTOM—Fulfillment records that belong to any non-FlexNet licensing technology.
  

Equivalent to:

• device: ExpirationDate
• entitlement: EndDate or End Duration *

* Depends on how Expiration is defined for the line item.

Email address that FlexNet Operations sends the license to.

User who created the fulfillment.

The activation process used for fulfillment. Fulfillment Source can be:

• ONLINE—For fulfillment records generated using web services.
• APPLICATION—For fulfillment records generated using the FlexNet Operations user interface.
• LEGACY—Used for legacy fulfillment records that do not have information about how the fulfillment records were generated.

The host on which the license was activated.

• For certificate licenses, Host ID is the usual host identifier (such as INTERNET=64.0.0.1).
• For trusted licenses, Host ID is UMN or Machine Identifier.
• For non-FlexNet technologies, Host ID is the custom host identifier.

Note: See Special Host ID Types in the FlexNet Operations User Guide for more information about host ID types.

Equivalent to:

• device: LicenseModel1, LicenseModel2, LicenseModel3
• entitlement: LicenseModel

Equivalent to:

• device: ProductName
• entitlement: ProductName
• product-feature: ProductName 

Equivalent to:

• device: PartNumber
• entitlement: PartNumber

A unique identifier of an organization’s account as defined in FlexNet Operations. (For example, Stark International Enterprises.)

Equivalent to:

• account: AccountID
• device: DeviceAccountID
• served-device: DeviceAccountID
• entitlement: CustomersAndPartners.EndCustomerAccountID
• user: AccountID

A display name for an organization’s account as defined in FlexNet Operations. (For example, Stark.) The Account Name is what FlexNet Operations displays on most of the Producer Portal and End-User Portal pages.

Equivalent to:

• account: AccountName
• device: DeviceAccountName
• entitlement: CustomersAndPartners.EndCustomerAccountName
• user: AccountName

Also referred to in:

• device: ProductDeleted
• entitlement: ProductDeleted
• product-feature: ProductDeleted

Also referred to in:

• device: ActivationDeleted
• entitlement: ActivationDeleted

Also referred to in:

• account: AccountDeleted
• device: AccountDeleted
• served-device: AccountDeleted

Also referred to in:

• device: UserDeleted
• served-device: UserDeleted
• user: UserDeleted

Equivalent to:

• entitlement: ProductName
• fulfillment: ProductName
• device: ProductName

Specifies count of the feature in the Product.

For example, if the count of Feature A is 2, a license generated for the product contains 2 counts of Feature A.

A feature can be in one of two states: DRAFT or DEPLOYED.

• DRAFT: A feature is created as a draft that can be modified or deleted. Both draft and deployed features can be added to a feature bundle or a product in a draft state.
• DEPLOYED: A deployed feature cannot be modified or deleted. If a feature bundle or product is deployed, all the draft features it contains are also deployed. After a feature is deployed to use in production, it cannot be deleted or modified.

Counts the number of seats deployed to customers.

• YES: Counts the number of seats deployed to customers.
• NO: Provides unlimited copies.
• DO NOT OVERRIDE: If this is set at the feature level, the license model will decides the countedness of the feature.

Applies only for metered features.

Specifies the units to be used for usage reporting. For example, if usage-capture clients are capturing usage of data, producers may want to label the reported counts as bytes or kilobytes or gigabytes.

FeatureUnits and FeatureScale(below) work together to describe what the metered feature is counting.

Applies only for metered features.

Represents how much is a unit for usage reporting purposes. For example, if usage-capture clients are capturing usage of data in bytes but the usage should be reported in kilobytes, entering 1024 for FeatureScale will achieve this.

FeatureUnits (above) and FeatureScale work together to describe what the metered feature is counting.

FeatureVersionFormat is either FIXED or DATE BASED.

• FIXED
• DATE BASED: Using date-based versions is a product versioning strategy. The version number that the application asks for when it checks out a license is a representation of the date it was built. Therefore, a customer has the right to use a version (the build date) of the application less than or equal to the date that the maintenance expires (the version in the license)

The date-based version in the license varies from license certificate to license certificate, whereas a fixed version is the same for all licenses generated for that product-version combination. If a feature is created that uses a date-based version format, the date that is expressed in that format is specified when an entitlement line item containing that product is configured.

For a date of May 15, 2009, yyyy.MM gives 2009.05 and yyyy.MMdd gives 2009.0515.

Also referred to in:

• device: ProductDeleted
• entitlement: ProductDeleted
• fulfillment: ProductDeleted

User's first name.

User’s last name.

Display name for the user.

User’s email address.

The status of the User. Possible values are:

• ACTIVE
• INACTIVE

Equivalent to:

• account: AccountID
• device: DeviceAccountID
• served-device: DeviceAccountID
• entitlement: CustomersAndPartners.EndCustomerAccountID
• fulfillment: AccountID

Equivalent to:

• account: AccountName
• device: DeviceAccountName
• entitlement: CustomersAndPartners.EndCustomerAccountName
• fulfillment: AccountName

If this user account is a shared login, logged in history is not written to the database. It is useful when the same user account is used to log into FlexNet Operations simultaneously from different instances, like web services.

Shared users should only be used for integration users. This is to allow concurrent requests from this user through APIs. For example, the same user can be used to authenticate the API to create an entitlement, while there is another API that is being used to add users to an account. If shared login is not enabled for the user that is being used to authenticate these web service requests, the requests will fail.

User’s street address.

User’s city.

User’s state.

Users' zip code.

User’s country.

User’s time zone.

User’s phone number.

User’s fax number.

The date and time at which the user was created in the FlexNet Operations system.

User expiration date. This will be displayed if the configuration Enable User Expiration’ under System > Configure > FlexNet Operations > General Options is enabled.

This is applicable to all users except Contacts and Shared Users. When this is enabled, an option to provide expiration date is displayed next to the account on the View user page.

The user expiration date will be displayed if the Enable User Expiration option under System > Configure > FlexNet Operations > General Options is enabled. It is applicable to all users except Contacts and Shared Users. When this option is enabled, an option to provide expiration date is displayed next to the account on the View user page.

The date and time of the user’s last login to FlexNet Operations.

Note: This date and time may or may not include authentications to API calls. If a user is a shared login, its last login date will not be updated when an API call is made . However, when a normal user fires an API call, it will be considered as a login and the last login date will get updated.

The type of the user. Possible values are:

• PRODUCER
• CUSTOMER
• PARTNER
• SELF-REGISTERED

Also referred to in:

• device: UserDeleted
• served-device: UserDeleted
• fulfillment: UserDeleted

"OrgUnitCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

"EntitlementCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

LicenseModelCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

"LicenseModelAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

"LineItemCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

MaintenanceLineItemCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

"UserCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}