- UserAccount
Complete suite details including products, part numbers, and attributes.
Creation date (ISO 8601 format)
Description of the suite
List of supported host types
License generator
List of license models
License technology
Obsolete fulfillment download for end user
Obsolete fulfillment download for producer
Package name
Package version
Package version format
List of part numbers associated with the suite
List of products in the suite
State of the suite (e.g., DRAFT, DEPLOYED, OBSOLETE, INACTIVE)
Suite attributes (custom attributes)
Suite category
Name of the suite
Last modified date (ISO 8601 format)
Indicates if suite is used on device
Version of the suite
{ "createdOn": "Example String", "description": "Example String", "hostTypes": [ "Example String" ], "licenseGenerator": "Example String", "licenseModels": [ { "__typename": "LicenseModel" } ], "licenseTechnology": "Example String", "obsoleteFulfillmentDownloadEndUser": true, "obsoleteFulfillmentDownloadProducer": true, "packageName": "Example String", "packageVersion": "Example String", "packageVersionFormat": "Example String", "partNumbers": [ "Example String" ], "products": [ { "__typename": "SuiteProductDTO" } ], "state": "Example String", "suiteAttributes": [ "Example Custom Scalar" ], "suiteCategory": "Example String", "suiteName": "Example String", "updatedOn": "Example String", "usedOnDevice": true, "version": "Example String" }
Suite list item with basic information.
Creation date (ISO 8601 format)
Description of the suite
License generator
License technology
Obsolete fulfillment download for end user
Obsolete fulfillment download for producer
Package name
Package version
Package version format
State of the suite (e.g., DRAFT, DEPLOYED, OBSOLETE, INACTIVE)
Suite category
Name of the suite
Last modified date (ISO 8601 format)
Indicates if suite is used on device
Version of the suite
{ "createdOn": "Example String", "description": "Example String", "licenseGenerator": "Example String", "licenseTechnology": "Example String", "obsoleteFulfillmentDownloadEndUser": true, "obsoleteFulfillmentDownloadProducer": true, "packageName": "Example String", "packageVersion": "Example String", "packageVersionFormat": "Example String", "state": "Example String", "suiteCategory": "Example String", "suiteName": "Example String", "updatedOn": "Example String", "usedOnDevice": true, "version": "Example String" }
Paginated response containing a list of suites.
Pagination information
List of suites
{ "pagination": { "__typename": "Pagination" }, "suiteList": [ { "__typename": "SuiteListItemDTO" } ] }
Suite product details in response.
Name of the product
Quantity of the product
State of the product
Version of the product
{ "productName": "Example String", "quantity": 40, "state": "Example String", "version": "Example String" }
Response containing a single suite.
The suite data
{ "suite": { "__typename": "SuiteDTO" } }
Account information associated with a user
Unique identifier for the account
Name of the account
Type of the account
Expiration date of the account access
Roles assigned to the user for this account
{ "accountId": "Example String", "accountName": "Example String", "accountType": "Example String", "expiryDate": "Example String", "roles": [ "Example String" ] }
Response returned after attempting to create a user
User creation success message
Status of the user created
{ "message": "Example String", "status": "Example String" }
Response returned after getting user details with account information
Accounts associated with the user
Represents the custom attributes associated with the account
City of the user
Country of the user
Display name of the user
Email address of the user
Fax number of the user
First name of the user
Last name of the user
Locale preference of the user
Whether the user has opted in for communications
Phone number of the user
Whether the user can login
Whether the user is shared across accounts
State or province of the user
Status of the user account (active/inactive)
Street address of the user
Timezone preference of the user
Username of the user
Postal/ZIP code of the user
{ "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" }
Response returned after getting user info without account information
Represents the custom attributes associated with the account
City of the user
Country of the user
Display name of the user
Email address of the user
Fax number of the user
First name of the user
Last name of the user
Locale preference of the user
Whether the user has opted in for communications
Phone number of the user
Whether the user can login
Whether the user is shared across accounts
State or province of the user
Status of the user account (active/inactive)
Street address of the user
Timezone preference of the user
Username of the user
Postal/ZIP code of the user
{ "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" }