Skip to content
GraphQL API Reference
/
/
getSuite

GraphQL Overview

Download GraphQL schema
fno-schema.gql

Queries

Overview

getFeatureBundles

(...args)
FeatureBundleListResponse

Get feature bundles with filtering and pagination support. Filters can be applied on featureBundleName, state, creationDate, and lastModifiedDate.

Arguments

creationDate
String

Filter by creation date in ISO 8601 format. Example: "2024-01-15"

featureBundleName
String

Filter by feature bundle name. Example: "MyFeatureBundle"

lastModifiedDate
String

Filter by last modified date in ISO 8601 format. Example: "2024-01-20"

limit
Int

Number of records per page. Default: 25

page
Int

Requested page number for pagination. Default: 1

state
String

Filter by feature bundle state. Valid values: DRAFT, DEPLOYED, OBSOLETE, INACTIVE. Example: "DEPLOYED"

Return type

FeatureBundleListResponse
featureBundles
[FeatureBundleResponseDTO]

List of feature bundles

pagination
Pagination

Pagination information

Query sample
query getFeatureBundles(
  $creationDate: String
  $featureBundleName: String
  $lastModifiedDate: String
  $limit: Int
  $page: Int
  $state: String
) {
  getFeatureBundles(
    creationDate: $creationDate
    featureBundleName: $featureBundleName
    lastModifiedDate: $lastModifiedDate
    limit: $limit
    page: $page
    state: $state
  ) {
    featureBundles {
      __typename
      # ...FeatureBundleResponseDTOFragment
    }
    pagination {
      __typename
      # ...PaginationFragment
    }
  }
}
Variables
{
  "creationDate": "Example String",
  "featureBundleName": "Example String",
  "lastModifiedDate": "Example String",
  "limit": 40,
  "page": 40,
  "state": "Example String"
}
Response sample
{
  "data": {
    "featureBundles": [
      {
        "__typename": "FeatureBundleResponseDTO"
      }
    ],
    "pagination": {
      "__typename": "Pagination"
    }
  }
}

getFeatures

(...args)
PagedFeatureResponse

Get features with filtering and pagination support. Filters can be applied on name, version, versionFormat, state, creationDate, lastModifiedDate, and vendorAuthString.

Arguments

creationDate
String

Filter by creation date in ISO 8601 format. Example: "2024-01-15"

lastModifiedDate
String

Filter by last modified date in ISO 8601 format. Example: "2024-01-20"

limit
Int

Number of records per page. Default: 25

name
String

Filter feature by name. Example: "MyFeature"

page
Int

Requested page number for pagination. Default: 1

state
String

Feature state (e.g., DRAFT, DEPLOYED). Valid values: DRAFT, DEPLOYED, OBSOLETE, INACTIVE. Example: "DEPLOYED"

vendorAuthString
String

Vendor authorization string for filtering.

version
String

Filter feature by version. Example: "1.0"

versionFormat
String

Filter feature by versionFormat. Valid values: FIXED, DATEBASED. Example: "FIXED"

Return type

PagedFeatureResponse
features
[FeaturesResponseDTO]

List of features

pagination
Pagination

Pagination information

Query sample
query getFeatures(
  $creationDate: String
  $lastModifiedDate: String
  $limit: Int
  $name: String
  $page: Int
  $state: String
  $vendorAuthString: String
  $version: String
  $versionFormat: String
) {
  getFeatures(
    creationDate: $creationDate
    lastModifiedDate: $lastModifiedDate
    limit: $limit
    name: $name
    page: $page
    state: $state
    vendorAuthString: $vendorAuthString
    version: $version
    versionFormat: $versionFormat
  ) {
    features {
      __typename
      # ...FeaturesResponseDTOFragment
    }
    pagination {
      __typename
      # ...PaginationFragment
    }
  }
}
Variables
{
  "creationDate": "Example String",
  "lastModifiedDate": "Example String",
  "limit": 40,
  "name": "Example String",
  "page": 40,
  "state": "Example String",
  "vendorAuthString": "Example String",
  "version": "Example String",
  "versionFormat": "Example String"
}
Response sample
{
  "data": {
    "features": [
      {
        "__typename": "FeaturesResponseDTO"
      }
    ],
    "pagination": {
      "__typename": "Pagination"
    }
  }
}

getMaintenanceProducts

(...args)
MaintenanceProductListDTO

Get maintenance products with filtering, sorting, and pagination support. Filters can be applied on maintenanceName, version, partNumber, state, creationDate, and lastModifiedDate.

Arguments

creationDate
String

Filter by creation date (ISO 8601 format). Example: "2023-10-15T10:30:00Z"

lastModifiedDate
String

Filter by last modified date (ISO 8601 format). Example: "2023-11-20T14:45:00Z"

limit
Int

Number of records per page. Default: 25

maintenanceName
String

Filter by maintenance product name. Example: "MyMaintenanceProduct"

page
Int

Requested page number for pagination. Default: 1

partNumber
String

Filter by part number. Example: "PN-12345"

sort_by
String

Field to sort by. Valid values: maintenanceName, state, partNumber, version, creationDate, lastModifiedDate. Example: "maintenanceName"

sort_order
String

Order to sort by. Valid values: asc, desc. Example: "asc"

state
String

Filter by maintenance product state. Valid values: DRAFT, DEPLOYED, OBSOLETE, INACTIVE. Example: "DEPLOYED"

version
String

Filter by maintenance product version. Example: "1.0"

Return type

MaintenanceProductListDTO
maintenanceProducts
[MaintenanceProductDTO]

List of maintenance products

pagination
Pagination

Pagination information

Query sample
query getMaintenanceProducts(
  $creationDate: String
  $lastModifiedDate: String
  $limit: Int
  $maintenanceName: String
  $page: Int
  $partNumber: String
  $sort_by: String
  $sort_order: String
  $state: String
  $version: String
) {
  getMaintenanceProducts(
    creationDate: $creationDate
    lastModifiedDate: $lastModifiedDate
    limit: $limit
    maintenanceName: $maintenanceName
    page: $page
    partNumber: $partNumber
    sort_by: $sort_by
    sort_order: $sort_order
    state: $state
    version: $version
  ) {
    maintenanceProducts {
      __typename
      # ...MaintenanceProductDTOFragment
    }
    pagination {
      __typename
      # ...PaginationFragment
    }
  }
}
Variables
{
  "creationDate": "Example String",
  "lastModifiedDate": "Example String",
  "limit": 40,
  "maintenanceName": "Example String",
  "page": 40,
  "partNumber": "Example String",
  "sort_by": "Example String",
  "sort_order": "Example String",
  "state": "Example String",
  "version": "Example String"
}
Response sample
{
  "data": {
    "maintenanceProducts": [
      {
        "__typename": "MaintenanceProductDTO"
      }
    ],
    "pagination": {
      "__typename": "Pagination"
    }
  }
}

getPartNumbers

(...args)
PartNumberResponseListDTO

Get part numbers with filtering, sorting, and pagination support. Filters can be applied on partNumber, productName, licenseModel, dates, and mapping status.

Arguments

creationDate
String

Filter by creation date in ISO 8601 format. Example: "2024-01-15"

lastModifiedDate
String

Filter by last modified date in ISO 8601 format. Example: "2024-01-20"

licenseModel
String

Filter by license model. Example: "LicenseModelName"

limit
Int

Number of records per page. Default: 25

page
Int

Requested page number for pagination. Default: 1

partNumber
String

Filter by part number name. Example: "MyPartNumber"

productName
String

Filter by product name. Example: "SampleProduct"

sort_by
String

Field to sort by. Valid values: partNumber, productName, licenseModel, creationDate, lastModifiedDate. Example: "partNumber"

sort_order
String

Order to sort by. Valid values: asc, desc. Default: asc.

unmappedWithLicenseModel
Boolean

Filter by unmapped with license model. Example: false.

unmappedWithProduct
Boolean

Filter by unmapped with product. Example: true.

Return type

PartNumberResponseListDTO
pagination
Pagination

Pagination information

partNumbers
[PartNumberResponseDTO]

List of part numbers

Query sample
query getPartNumbers(
  $creationDate: String
  $lastModifiedDate: String
  $licenseModel: String
  $limit: Int
  $page: Int
  $partNumber: String
  $productName: String
  $sort_by: String
  $sort_order: String
  $unmappedWithLicenseModel: Boolean
  $unmappedWithProduct: Boolean
) {
  getPartNumbers(
    creationDate: $creationDate
    lastModifiedDate: $lastModifiedDate
    licenseModel: $licenseModel
    limit: $limit
    page: $page
    partNumber: $partNumber
    productName: $productName
    sort_by: $sort_by
    sort_order: $sort_order
    unmappedWithLicenseModel: $unmappedWithLicenseModel
    unmappedWithProduct: $unmappedWithProduct
  ) {
    pagination {
      __typename
      # ...PaginationFragment
    }
    partNumbers {
      __typename
      # ...PartNumberResponseDTOFragment
    }
  }
}
Variables
{
  "creationDate": "Example String",
  "lastModifiedDate": "Example String",
  "licenseModel": "Example String",
  "limit": 40,
  "page": 40,
  "partNumber": "Example String",
  "productName": "Example String",
  "sort_by": "Example String",
  "sort_order": "Example String",
  "unmappedWithLicenseModel": true,
  "unmappedWithProduct": true
}
Response sample
{
  "data": {
    "pagination": {
      "__typename": "Pagination"
    },
    "partNumbers": [
      {
        "__typename": "PartNumberResponseDTO"
      }
    ]
  }
}

getProducts

(...args)
ProductListDTO

Fetches a list of Products based on various filters

Arguments

description
String

Filter by description

hostType
String

Filter by host type

licenseTechnology
String

Filter by license technology

limit
Int

Number of records per page

page
Int

Requested page number

partNumber
String

Filter by part number

productId
ID

Filter by product ID

productName
String

Filter by product name

sortBy
String

Field to sort by (productName,state,partNumber,hosttype,licenseTechnology,version,usedOnDevice)

sortOrder
String

Order to sort by (asc/desc)

state
String

Filter by product state

usedOnDevice
String

Filter by used on device

version
String

Filter by product version

Return type

ProductListDTO
pagination
Pagination

Represents pagination information

productList
[Product]

List of product entities

Query sample
query getProducts(
  $description: String
  $hostType: String
  $licenseTechnology: String
  $limit: Int
  $page: Int
  $partNumber: String
  $productId: ID
  $productName: String
  $sortBy: String
  $sortOrder: String
  $state: String
  $usedOnDevice: String
  $version: String
) {
  getProducts(
    description: $description
    hostType: $hostType
    licenseTechnology: $licenseTechnology
    limit: $limit
    page: $page
    partNumber: $partNumber
    productId: $productId
    productName: $productName
    sortBy: $sortBy
    sortOrder: $sortOrder
    state: $state
    usedOnDevice: $usedOnDevice
    version: $version
  ) {
    pagination {
      __typename
      # ...PaginationFragment
    }
    productList {
      __typename
      # ...ProductFragment
    }
  }
}
Variables
{
  "description": "Example String",
  "hostType": "Example String",
  "licenseTechnology": "Example String",
  "limit": 40,
  "page": 40,
  "partNumber": "Example String",
  "productId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "productName": "Example String",
  "sortBy": "Example String",
  "sortOrder": "Example String",
  "state": "Example String",
  "usedOnDevice": "Example String",
  "version": "Example String"
}
Response sample
{
  "data": {
    "pagination": {
      "__typename": "Pagination"
    },
    "productList": [
      {
        "__typename": "Product"
      }
    ]
  }
}

getSuite

(...args)
SuiteResponseDTO

Get a single suite by its name and version.

Arguments

suiteName
String!,non-nullrequired

Suite name of the suite to retrieve. Example: "Suite A"

suiteVersion
String!,non-nullrequired

Suite version of the suite to retrieve. Example: "1.0"

Return type

SuiteResponseDTO
suite
SuiteDTO

The suite data

Query sample
query getSuite($suiteName: String!, $suiteVersion: String!) {
  getSuite(suiteName: $suiteName, suiteVersion: $suiteVersion) {
    suite {
      __typename
      # ...SuiteDTOFragment
    }
  }
}
Variables
{
  "suiteName": "Example String",
  "suiteVersion": "Example String"
}
Response sample
{
  "data": {
    "suite": {
      "__typename": "SuiteDTO"
    }
  }
}

getSuites

(...args)
SuiteListResponseDTO

Get suites with filtering, sorting, and pagination support. Filters can be applied on suiteName, version, description, partNumber, state, packageName, packageVersion, hostType, licenseTechnology, licenseGenerator, usedOnDevice, creationDate, and lastModifiedDate.

Arguments

creationDate
String

Filter by creation date (ISO 8601 format). Example: "2023-10-15T10:30:00Z"

description
String

Filter by description. Example: "Product suite for enterprise"

hostType
String

Filter by host type. Example: "Windows"

lastModifiedDate
String

Filter by last modified date (ISO 8601 format). Example: "2023-11-20T14:45:00Z"

licenseGenerator
String

Filter by license generator. Example: "GeneratorX"

licenseTechnology
String

Filter by license technology. Example: "FlexNet"

limit
Int

Number of records per page. Default: 25

packageName
String

Filter by package name. Example: "PackageA"

packageVersion
String

Filter by package version. Example: "2.0"

page
Int

Requested page number for pagination. Default: 1

partNumber
String

Filter by part number. Example: "PN-12345"

sort_by
String

Field to sort by. Valid values: suiteName, createdOn. Example: "suiteName"

sort_order
String

Order to sort by. Valid values: asc, desc. Example: "asc"

state
String

Filter by suite state. Valid values: DRAFT, DEPLOYED, OBSOLETE, INACTIVE. Example: "DEPLOYED"

suiteName
String

Filter by suite name. Example: "Suite A"

usedOnDevice
Boolean

Filter by used on device flag. Example: true

version
String

Filter by suite version. Example: "1.0"

Return type

SuiteListResponseDTO
pagination
Pagination

Pagination information

suiteList
[SuiteListItemDTO]

List of suites

Query sample
query getSuites(
  $creationDate: String
  $description: String
  $hostType: String
  $lastModifiedDate: String
  $licenseGenerator: String
  $licenseTechnology: String
  $limit: Int
  $packageName: String
  $packageVersion: String
  $page: Int
  $partNumber: String
  $sort_by: String
  $sort_order: String
  $state: String
  $suiteName: String
  $usedOnDevice: Boolean
  $version: String
) {
  getSuites(
    creationDate: $creationDate
    description: $description
    hostType: $hostType
    lastModifiedDate: $lastModifiedDate
    licenseGenerator: $licenseGenerator
    licenseTechnology: $licenseTechnology
    limit: $limit
    packageName: $packageName
    packageVersion: $packageVersion
    page: $page
    partNumber: $partNumber
    sort_by: $sort_by
    sort_order: $sort_order
    state: $state
    suiteName: $suiteName
    usedOnDevice: $usedOnDevice
    version: $version
  ) {
    pagination {
      __typename
      # ...PaginationFragment
    }
    suiteList {
      __typename
      # ...SuiteListItemDTOFragment
    }
  }
}
Variables
{
  "creationDate": "Example String",
  "description": "Example String",
  "hostType": "Example String",
  "lastModifiedDate": "Example String",
  "licenseGenerator": "Example String",
  "licenseTechnology": "Example String",
  "limit": 40,
  "packageName": "Example String",
  "packageVersion": "Example String",
  "page": 40,
  "partNumber": "Example String",
  "sort_by": "Example String",
  "sort_order": "Example String",
  "state": "Example String",
  "suiteName": "Example String",
  "usedOnDevice": true,
  "version": "Example String"
}
Response sample
{
  "data": {
    "pagination": {
      "__typename": "Pagination"
    },
    "suiteList": [
      {
        "__typename": "SuiteListItemDTO"
      }
    ]
  }
}

getAccounts

(...args)
PagedAccountResponse

Gets accounts with filtering and pagination

Arguments

accountId
String

Unique identifier of the account to filter by

accountName
String

Name of the account to filter by

accountType
[String]
Default:["CUSTOMER"]

Type of the account to filter by. Valid values: CUSTOMER, PUBLISHER, CHANNEL_PARTNER, SELF_REGISTERED. Default: CUSTOMER

limit
Int

Number of records per page

page
Int

Page number for pagination

rootAccountOnly
Boolean
Default:false

Whether to return only root accounts (accounts without parent). Default: false

Return type

PagedAccountResponse
accounts
[Account!],non-null

List of accounts

pagination
Pagination

Pagination information

Query sample
query getAccounts(
  $accountId: String
  $accountName: String
  $accountType: [String]
  $limit: Int
  $page: Int
  $rootAccountOnly: Boolean
) {
  getAccounts(
    accountId: $accountId
    accountName: $accountName
    accountType: $accountType
    limit: $limit
    page: $page
    rootAccountOnly: $rootAccountOnly
  ) {
    accounts {
      __typename
      # ...AccountFragment
    }
    pagination {
      __typename
      # ...PaginationFragment
    }
  }
}
Variables
{
  "accountId": "Example String",
  "accountName": "Example String",
  "accountType": [
    "Example String"
  ],
  "limit": 40,
  "page": 40,
  "rootAccountOnly": true
}
Response sample
{
  "data": {
    "accounts": [
      {
        "__typename": "Account"
      }
    ],
    "pagination": {
      "__typename": "Pagination"
    }
  }
}

getUserByID

(UserID)
UserDetail

Gets the user account details by the user ID

Arguments

UserID
String!,non-nullrequired

UserId of the user to retrieve details for

Return type

UserDetail
accounts
[UserAccount!]!,non-null

Accounts associated with the user

attributes
[Attribute]

Represents the custom attributes associated with the account

city
String

City of the user

country
String

Country of the user

displayName
String

Display name of the user

emailAddress
String

Email address of the user

faxNumber
String

Fax number of the user

firstName
String

First name of the user

lastName
String

Last name of the user

locale
String

Locale preference of the user

optIn
Boolean

Whether the user has opted in for communications

phoneNumber
String

Phone number of the user

portalLogin
Boolean

Whether the user can login

shared
Boolean

Whether the user is shared across accounts

state
String

State or province of the user

status
String

Status of the user account (active/inactive)

street
String

Street address of the user

timezone
String

Timezone preference of the user

userName
String

Username of the user

zipcode
String

Postal/ZIP code of the user

Query sample
query getUserByID($UserID: String!) {
  getUserByID(UserID: $UserID) {
    accounts {
      __typename
      # ...UserAccountFragment
    }
    attributes {
      __typename
      # ...AttributeFragment
    }
    city 
    country 
    displayName 
    emailAddress 
    faxNumber 
    firstName 
    lastName 
    locale 
    optIn 
    phoneNumber 
    portalLogin 
    shared 
    state 
    status 
    street 
    timezone 
    userName 
    zipcode 
  }
}
Variables
{
  "UserID": "Example String"
}
Response sample
{
  "data": {
    "accounts": [
      {
        "__typename": "UserAccount"
      }
    ],
    "attributes": [
      {
        "__typename": "Attribute"
      }
    ],
    "city": "Example String",
    "country": "Example String",
    "displayName": "Example String",
    "emailAddress": "Example String",
    "faxNumber": "Example String",
    "firstName": "Example String",
    "lastName": "Example String",
    "locale": "Example String",
    "optIn": true,
    "phoneNumber": "Example String",
    "portalLogin": true,
    "shared": true,
    "state": "Example String",
    "status": "Example String",
    "street": "Example String",
    "timezone": "Example String",
    "userName": "Example String",
    "zipcode": "Example String"
  }
}

getUsers

(...args)
PagedUserResponse

Gets all users with optional filtering, sorting, and pagination

Arguments

accountId
String

Unique identifier of the account to filter users by

accountName
String

Name of the account to filter users by

accountType
String

Type of the account to filter users by. Valid values: HOME, PUBLISHER, END_CUSTOMER, CHANNEL_PARTNER, SELF_REGISTERED

displayName
String

Display name of the user to filter by

email
String

Email address of the user to filter by

limit
Int

Number of records per page. Default: 25

page
Int

Page number for pagination. Default: 1

sort_by
String

Field to sort results by. Valid values: displayName, email, status. Default: displayName

sort_order
String

Sort order for the results. Valid values: asc, desc. Default: asc

status
String

Status of the user account to filter by. Valid values: active, inactive

userName
String

Username to filter by

Return type

PagedUserResponse
pagination
Pagination

Pagination information

userList
[UserInfo!],non-null

List of user accounts

Query sample
query getUsers(
  $accountId: String
  $accountName: String
  $accountType: String
  $displayName: String
  $email: String
  $limit: Int
  $page: Int
  $sort_by: String
  $sort_order: String
  $status: String
  $userName: String
) {
  getUsers(
    accountId: $accountId
    accountName: $accountName
    accountType: $accountType
    displayName: $displayName
    email: $email
    limit: $limit
    page: $page
    sort_by: $sort_by
    sort_order: $sort_order
    status: $status
    userName: $userName
  ) {
    pagination {
      __typename
      # ...PaginationFragment
    }
    userList {
      __typename
      # ...UserInfoFragment
    }
  }
}
Variables
{
  "accountId": "Example String",
  "accountName": "Example String",
  "accountType": "Example String",
  "displayName": "Example String",
  "email": "Example String",
  "limit": 40,
  "page": 40,
  "sort_by": "Example String",
  "sort_order": "Example String",
  "status": "Example String",
  "userName": "Example String"
}
Response sample
{
  "data": {
    "pagination": {
      "__typename": "Pagination"
    },
    "userList": [
      {
        "__typename": "UserInfo"
      }
    ]
  }
}

Mutations

Overview

Objects

Overview

Inputs

Overview

Scalars

Overview