GraphQL Overview

Name of the custom attribute

Type of the custom attribute. It can be of LINE_ITEM or LICENSE_MODEL

Value assigned to the custom attribute. If the value is of type Date, then it should use yyyy/MM/dd format. Similarly, appropriate value corresponding to the type of custom attribute must be provided

Unique identifier of the account (short account name). Example: "12345"

Defines the account type. Valid values: CUSTOMER, PUBLISHER, CHANNEL_PARTNER. Default: CUSTOMER. (Using GraphQL, a new account cannot be created with an accountType of SELF_REGISTERED) Example: "CUSTOMER"

First line of account's address. Example: "123 Flexera St"

Second line of account's address. Example: "Suite 100"

List of custom attributes attached to this account. Note that mandatory custom attributes must be included in this list

City portion of account's address. Example: "Chicago"

Two-letter country code. Example: "US"

Description of the account. Example: "Flexera Software LLC - Main Office"

Display name of the account (full account name). Example: "Flexera Software LLC"

Region in which this account's address exists. Example: "North America"

State portion of account's address. Example: "IL"

Applicable to CUSTOMER and CHANNEL_PARTNER accounts, visible determines whether or not an account unrelated to this account can see the name of this account when it is in a channel partner tier of an entitlement, line item, or device. If visible is false, this account will appear as Name Withheld to unrelated accounts. Default: true. Example: true

Zip/Postal code of the account's address. Example: "60601"

List of accounts associated with the entitlement. If account is not provided, the entitlement will be associated with UNKNOWN_ORG_UNIT(default account)

Whether the customer can use the entitlement ID to log into the End-User Portal after the entitlement is deployed

List of entitlement custom attributes. Note that mandatory custom attributes must be included in this list

Flag to indicate if the entitlement should be auto-deployed

Whether the entitlement ID is to be auto-generated. Example: false

Description of the entitlement. Example: "Description for entitlement"

Name of the email template to be used for entitlement related emails. Example: "DEFAULT"

Entitlement ID of the entitlement. If you specify the entitlement ID, then it must be unique across all entitlements and line items. If you specify the entitlement ID here, then the autoGenerate flag must be set to false. Example: "ent-id-1234"

List of line items contained in the entitlement

Address of the ship-to contact. Example: "Building-Street-City"

Email address of the ship-to contact. Example: "Joe@example.com"

Auto Deploy flag to indicate whether the feature bundle should be deployed or not. If true, the feature bundle will be automatically deployed after creation.

Describe the characteristics of this feature bundle that make it unique. Example: "This feature bundle enables advanced reporting."

Name to uniquely identify the feature bundle. Must contain only ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyFeatureBundle"

Optional feature list for the feature bundle.

Select an Aggregation Type for the feature. Valid values: NONE, SUM, MAX. Example: "SUM"

Auto Deploy flag to indicate whether the feature should be deployed or not. If true, the feature will be automatically deployed after creation.

Describe the characteristics of this feature that make it unique. Maximum length: 2000 characters. Example: "This feature enables advanced reporting."

Name to uniquely identify the feature. Must contain only ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyFeature"

Optional override parameters for the feature.

Specify maxVersion of the feature. Format: yyyy.MMdd, yyyy.MM.dd, or yyyy.MM . Example: "2023.10.15"

If a FIXED version format is selected, specify version of the feature. Must not contain whitespace characters. Maximum length: 64 characters. Example: "1.0"

Select a FIXED or DATEBASED version format. Valid values: FIXED, DATEBASED. Example: "FIXED"

List of line item input objects

Allow renewals flag to indicate whether the maintenance product can be renewed. Example: true

Allow upgrades flag to indicate whether the maintenance product can be upgraded. Example: true

Allow upsells flag to indicate whether the maintenance product can be upsold. Example: true

Description of the maintenance product. Example: "This maintenance product is for advanced maintenance."

Name to uniquely identify the maintenance product. Can only contain ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyMaintenanceProduct"

Optional part number list for the maintenance product.

Maintenance product product line. Example: "Uncategorized Products"

Optional product list for the maintenance product.

Maintenance product version. Maximum length: 64 characters. Example: "1.0"

List of part numbers to create. Must not be empty.

Allow obsolete fulfillment in end user portal. Example: true

Allow obsolete fulfillment in producer portal. Example: true

Auto deploy flag to indicate whether the product should be deployed automatically. If true, validations are performed and dependent features/bundles will be deployed. Example: true

Product description. Example: "This is a sample product description"

End date in YYYY-MM-DD format. Example: "2025-02-01"

List of feature bundles associated with product.

List of features associated with product.

List of host types. Example: ["Flexnet Server"]

License generator name. If not provided, it will be fetched based on licenseTechnology. Example: "TestGenerator"

List of license model names associated with product. Example: ["Embedded Counted"]

License technology name. If not provided, defaults to 'FlexNet Licensing'. Example: "Test"

List of part numbers associated with product (must be unique across products).

Product category name. If not provided, defaults to 'Uncategorized Products'. Example: "Uncategorized Products"

Product category custom attributes.

Product custom attributes.

Name of the product. Maximum length: 128 characters. Example: "Product A"

Upgrade email template associated with product. Use 'none' for no template or 'default' for the default template. Example: "default"

Start date in YYYY-MM-DD format. Example: "2024-01-01"

Trusted Key Configuration name. Example: "Trusted Key"

Used on device flag (only applies when license technology is FlexNet Licensing). Example: true

Version of the product. Maximum length: 64 characters. Example: "1.0.0"

Virtual Trusted Key Configuration name. Example: "Virtual Trusted Key"

Allow download obsolete fulfillment record in Admin. Example: false

Allow download obsolete fulfillment record in Portal. Example: false

Auto deploy flag to indicate whether the suite should be deployed automatically. Example: true

List of custom attributes for the suite.

Description of the suite. Example: "Enterprise product suite"

List of supported host types. Example: ["Windows", "Linux"]

License generator used by the suite. Example: "GeneratorX"

List of license models for the suite. Example: ["Embedded Counted", "Subscription"]

License technology used by the suite. Example: "FlexNet"

Package properties for the suite.

List of part numbers with optional license model associations.

Product category name. If not provided, defaults to "Uncategorized Products". Example: "Enterprise Software"

List of product category attributes.

List of products included in this suite.

Name of the suite. Maximum length: 128 characters. Example: "Suite A"

Trusted key for the suite. Example: "TrustedKey123"

Indicates if the suite is used on a device. Example: true

Version of the suite. Example: "1.0"

Virtual trusted key for the suite. Example: "VirtualTrustedKey456"

List of account associated with user. Set user's account and list of the user's roles. User name and roles are required if the user can log in.

List of user custom attributes. Note that mandatory custom attributes must be included in this list

City portion of address. Example: "New York"

Two-letter country code. Example: "US"

Display name of the user. Example: "John Doe"

Email address of the user. Example: "johndoe@xyz.com"

User's fax number. Example: "01154785"

First Name of the user. Example: "John"

Last Name of the user. Example: "Doe"

User's locale. Example: "en_US"

Whether the User should opt to receive email notifications. Example: false

User's phone number. Example: "989915487"

Indicates whether created user can login to portal or not. If portalLogin is false, the user is treated as a contact. Example: true

Is this a shared login among several users? Example: false

State portion of address. Example: "The Empire State"

Flag to indicate if the user should be Active or Inactive. Status can be one of the following values: Active, Inactive. Example: "Active"

Street portion of address. Example: "High Street"

Provide time zone setting in the format: GMT#.#DST#. When a user is saved, this offset is converted to a time zone string and the time zone string is displayed when a user is retrieved. Example: "GMT-6.0DST0"

Important: The user name must match the email address for the user. If portalLogin is set to false, this field is ignored. If portalLogin is set to true, this field is required. Example: "johndoe@xyz.com"

Postal code of address. Example: "10118"