Compartilhar via


QPP NextGen (Preview)

Quark Publishing Platform (QPP) NextGen is a cloud-based component content management system (CCMS) for automating the publishing of highly regulated enterprise content. The QPP NextGen connector helps move data from your content ecosystem in both directions to simplify processes and accelerate time to market.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Quark Technical Support
URL https://quarksoftware.my.site.com
Email support_cases@quark.com
Connector Metadata
Publisher Quark Software Inc.
Website https://www.quark.com/
Privacy policy https://www.quark.com/privacy-policy
Categories Content and Files;Productivity

Quark Publishing Platform (QPP) NextGen is a cloud-based component content management system (CCMS) for automating the publishing of highly regulated enterprise content. The QPP NextGen connector helps move data from your content ecosystem in both directions to simplify processes and accelerate time to market.

Prerequisites

  • You need a QPP-NG environment (v3.3 above) and QPP-NG licenses to use our Connector.
  • You need to have an existing client (Connection), preferably separate, created on the tenants for which they want the actions and triggers of this connector to interact. More details can be found in the Obtaining Credentials section.
  • Understand how to use power automate and get value using dynamic content or from other actions response using query creator.

How to get credentials

While creating a new connection with our connector, you will see 3 params. Details for acquiring each are shared below. Creating and manaWhile creating a new connection with our connector, users will see 3 params. Details for acquiring each are shared below. Creating and managing QPP-NG connections should be done by the admin user. Please check with your QPP-NG environments admin.

You can also name your credentials appropriately to easily identify them later. Go to Connections in Power Automate, search for the connector name, and edit an existing connection, then provide an appropriate name.

  • Client ID: You can navigate to your desired QPP-NG tenants Admin app and then Settings > Connections. Here they can create a new connection or use an existing one. Just enter the connection name for Client Id.
  • Client Secret: Like Client Id, navigate to Connections and just enter Secret for the existing connection. Regenerate the secret if you don’t have it. Secrets should be stored for existing connections securely, managed by admin. Check with admin before regenerating the secret.
  • Host name: The host name for the QPP-NG tenant you want to create connections to interact with our connector. example (yourtenantname.app.quark.com).Should be visible the URL, when you access your QPP-NG environment.

After creating Credentials, you can test the credentials to see if credentials are correct.

Simple actions like getUser can be used from our connector in a manual flow, Test the flow with default fields.

While creating a connection for the first time, some error codes that can be faced are as below:

  • Invalid host URL (500): Check your host name for the QPP-NG environment again, the client id and secret should belong to this connection.
  • Unauthorized/unauthorized_client (401): For Invalid client or Invalid client credentials, ensure the client Id and client secret are valid and belong to the host name being used.

Getting Started with QPP-NG Integration Hub

To get started, you can listen to a wide variety of events of Type Asset, Collections, etc. from your QPP-NG tenant using built-in Trigger.

  • Create a new Automation flow in Power Automate.
  • Select our QPP-NG Connector and then choose a trigger.
  • Fill in the required fields. Refer to the Webhook-trigger section in Github Readme documentation.
  • Select the appropriate Connection for the QPP-NG tenant where you want to register webhook. You can also create new connections. Follow the Steps given in the How to get credentials section.
  • Save the flow. This will execute the registration request in the back. When you return to the flow details page(or click the back button) you should see a green underline at the top mentioning that everything went well and flow is ready to be triggered.
  • Once your flow runs once, you can further get the webhook response to the flow run, and use the response to generate dynamic content. For this, you can use parse json OOTB action.
  • In case this is the first webhook with this change type (event) registered on the QPP-NG tenant, you need to wait for 15 minutes before the webhook is activated, and then you can expect the flow to be triggered.

If there are errors in the flow checker with the webhook trigger, the Power Automate will show red in the flow checker. Please open it and check the error. Below are some of the errors you may encounter, and the steps to mitigate them.

  • Webhook with name already exists Either provide a unique name for the webhook or use the Delete Webhook operation with the same connection in another manual flow. Select the webhook with the same name and delete it. More information about Webhooks can be found on the Quark Developer portal.
  • Bad Request(400) Please check the Params provided as per the documentation and error details.
  • Resource not found (404) & Location header is missing in subscribe request Please delete the flow, and then create a new webhook trigger and flow. If the flow is big, then duplicate the flow, and while enabling the flow and saving, Power Automate will try to do a fresh webhook registration.

Known Issues and Limitations

  • Currently, you won't be able to update params for an already registered webhook trigger. As a workaround, delete the current webhook operation from flow and add a new QPP-NG webhook trigger in its place. To delete the previously registered webhook from the QPP-NG environment, create a new manual flow with the delete operation, select the previous webhook from the drop-down, and run the flow. If this workaround doesn’t work and the flow is big, then duplicate the flow, and after updating webhook details, save and enable it. This will also create a new webhook registration successfully.
  • You can also turn off the flow, before deleting and creating a new Trigger. This will also ensure your new webhook will get registered.
  • If the QPP-NG webhook service can’t invoke the registered webhook-trigger for 3 times, then the webhook will be disabled.
  • Saving certain actions with no params given (empty) gives an error (expect some value in the body).
  • If this is the first webhook with this change type (event), you need to wait for 15 minutes before the webhook is activated and then you can expect the flow to be triggered.
  • Please use the Legacy designer view for the best experience as there may be issues with the new designer due to ongoing development, such actions with issues with new designer are CheckOut, SetAttributeValues , InitNewCheckin & CreateQuery.

Common errors and remedies

  • While registering Webhooks Trigger as a first step, there can be an issue in registration with our service if details are not correctly provided. This can be narrowed down after saving the flow with the trigger and returning to the Flow Details page window where the past 28 days' runs are shown. If it shows red, this means the webhook has not been properly registered. Please check the error. If the error occurs due to the Location header is missing or the resource not being found, then try deleting and creating the trigger again.
  • If your flows are not getting triggered, it might be due to an existing webhook that is registered as an endpoint that does not exist, like a deleted flow, etc. In such a situation, run API https://{Host.name}/webhooks/api/v3/registrations with your api token to get a list of all Registered webhooks on the QPP-NG environment, and use this response to remove any such webhooks using delete webhooks action. You also need to ensure the webhooks service is properly configured and running from your Quark support using (https://quarksoftware.my.site.com).
  • If you receive not a privileged user or any authentication error, please verify the user name provided for Impersonating has enough privileges in your QPP-NG tenant,
  • In case of Action specific issues, please refer to examples and documentation shared on the Open source repo on Github in Readme.md file or refer to Quark Developer portal for more information on endpoints and functionality.

Frequently Asked Questions

Can I use the actions and triggers with different QPP-NG environments?

Yes, it’s possible. You just need to fill in the Host Name param as per the environment and use appropriate connections to that environment.

Can you help us if we get stuck on something or have doubts?

Absolutely. Just email [email protected] (https://quarksoftware.my.site.com) and make sure you mention the Microsoft Power Automate Connector when you describe your problem.

Where can I get more information on the actions and endpoints?

More information on the various Quark APIs can be found here. Just navigate to the Content Platform tab. As this connector only contains a subset of the actual API possible for the QPP-NG platform, this site can be used to explore and request more actions and endpoints via logging a feature request at [email protected].

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Client ID (clientId) string Specify the Client ID from your service credentials. True
Client Secret (clientSecret) securestring Specify the Client Secret from your service credentials. True
Host name string Specify the Host name True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

CheckOut

Marks the asset with the given assetId as Checked Out. Refer to the Github docs for details.

Create Query

Create a query with definition and details in the request body. Refer to GitHub docs for details.

Creates a new attribute

Creates a new attribute and returns its ID along with a success message. See GitHub docs for details.

Creates a new List attribute

Creates a new attribute and returns its id after successful creation of attribute message. For more information, check the github documentation.

Deletes Webhook

Deletes an already existing webhook for a given event and change type. For more information, check the github documentation.

Download (Blob)

This request is used to download file by input stream from download URL. See GitHub docs for details.

Get All Queries

This request will return all the query with there definition. See Github docs for details.

Get All Users

This request is used to fetch all users. Refer to Github docs for details.

Get Asset Download Info

Request will return asset download info which can be used together with Download Blob Action to Download The asset stream. For more information check the github documentation.

Get Asset Meta Data

Get Asset Data for given Asset Id. For more information, check the Github documentation.

Get Attribute Values from Ids

Get Attribute Values for comma separated Id's. For more information, check the Github documentation.

Get Attributes by Name

Returns all existing attributes with metadata in QPPNG Server for specified names. See GitHub docs for details.

Get Attributes Values by Name

Get attribute values for comma separated names. See GitHub docs for details.

Get Child Asset Relations

Get Child Asset Relations for a give Parent Asset Id. See Github docs for details.

Get Content Types Info by Name

This request is used to retrieve content type info by content type name. See Github Docs for details.

Get Group By Name

This request will return a group specific to group name.

Get Group Members

This request will return list of users and all their metadata specific to group Id. See GitHub docs for details.

Get Groups for a Collection

This request returns an array of applicable routings groups for the given collection for the specified workflow and status. For more information check the github documentation.

Get Paginated Query Results with Filters

This request returns paginated Query Element and details of a Query stored in the system with specific filter in query. For more information check the github documentation.

Get Parent Asset Relations

This request will return the list of relations for a parent asset relation. See GitHub docs for details.

Get Publishing Status

Get Publishing Status for a given asset. Refer to the Github docs for details.

Get Token as per Grant Type

This request fetches the token for the given username and password for QPPNG. See GitHub docs for details.

Get User by Id

This request is used to fetch the metadata of a specified user. See GitHub docs for details.

Get User by Name

This request will return user metadata specific to username. See GitHub docs for details.

Get Workflow by name

This request returns all the metadata of a specified workflow by name. See Github docs for details.

Initiate Check-in and Update

Request will check-in and update an already existing asset in QPPNG. Asset Needs to be checked out before hand. Use checkout action before. For more information, check the github documentation.

Initiate New Check-in

Request will check-in a local file, as per given Qpp attribute values array, for example required attribute values are name , collection , extension etc to check-in an asset to QPPNG. For more information, check the github documentation.

Is User a Group Member

This request will return either true or false that a user is member of group specific to the userId.

Publish Asset Async

Returns Context Id for asset being published. Use with get Publishing status. See GitHub docs for details.

Set Attribute Values

Set attribute values for the QPP Platform. For more information, check the Github documentation.

Update Attribute Mapping for Content Type

Update attribute mapping of content types and children with specified attribute map in request body. See GitHub docs for details.

Upload (Blob)

This request is used to upload file by input stream. See GitHub docs for details.

CheckOut

Marks the asset with the given assetId as Checked Out. Refer to the Github docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Asset Id
assetId True integer

Variable assetId should refer to the QPP Server's Asset.

Attribute Id
attributeId integer

Identifier of the attribute.

Type
type integer

Type of the attribute.

Value
attributeValue object

Value.

Returns

Body
Asset

Create Query

Create a query with definition and details in the request body. Refer to GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Number of Attributes to Skip
_skiptoken True integer

Number of attributes to skip from attribute drop-down.

Query Name
queryName True string

Name of the query.

Parameterized
parameterized boolean

Indicates if the query is parameterized.

Attribute Id
attributeId integer

Attribute Id for Search.

Attribute Type
type integer

Type of the Attribute selected for condition.

Comparison Operator
comparisonOperator integer

Comparison operator for the condition.

Negated
negated boolean

Indicates if the condition is negated.

Value to Search Against
value string

value to Search Against.

Logical Operator
logicalOperator integer

Logical And OR operator for the condition.

Column ID
columnId True integer

ID of the display column.

Width
width True integer

Width of the display column.

Attribute Column
attributeColumn True boolean

Indicates if the column is an attribute column.

Display Mode
displayMode True integer

Display mode setting.

Returns

Newly Created Query Id.

Newly Created Query Id
integer

Creates a new attribute

Creates a new attribute and returns its ID along with a success message. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Name
name True string

Name of the attribute.

Attribute Type
valueType True integer

Type of Attribute.

Returns

Details of an attribute associated with an entity.

Creates a new List attribute

Creates a new attribute and returns its id after successful creation of attribute message. For more information, check the github documentation.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Number of domains to Show
_skiptoken True integer

Number of domains to Skip from Domain Id dropdown.

Name
name True string

Name of the attribute.

Attribute Type
valueType True integer

Type of Attribute, should be list for list type.

Multi Valued
multiValued boolean

Indicates if the attribute can hold multiple values.

Limited Access
limitedAccess boolean

Only Applicable for List Type (Indicates if the attribute has limited access need to configure roles for this before).

Domain Id
domainId integer

Domain ID associated with the existing Data Source/Domain list. Use skip token to go through 20 items in drop down.

Returns

Details of an attribute associated with an entity.

Deletes Webhook

Deletes an already existing webhook for a given event and change type. For more information, check the github documentation.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Name Or Id
nameOrId True string

Name or Id for the existing webhook on the environment.

Returns

Download (Blob)

This request is used to download file by input stream from download URL. See GitHub docs for details.

Parameters

Name Key Required Type Description
Authentication Token
authTokenforHeader True string

Authentication Token required here separately. TokenFromAuthWrapper action can be used here to fetch the token.

File Identifier
fileIdentifier True string

File Identifier refers to the type of file.

Context Id
contextId True string

Context Id refers to the resource info.

Returns

Name Path Type Description
Content type
$content-type string

The content type of the document, e.g. application/pdf.

Content
$content byte

The content of the document in Base64 encoding.

Get All Queries

This request will return all the query with there definition. See Github docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Returns

Get All Users

This request is used to fetch all users. Refer to Github docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Returns

Response element for listing users.

List Response User
ListResponseUser

Get Asset Download Info

Request will return asset download info which can be used together with Download Blob Action to Download The asset stream. For more information check the github documentation.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Asset Id
assetId True integer

AssetId should refer to the QPP Server's Asset.

Minor Version
minorVersion integer

Minor Version should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.

Major Version
majorVersion integer

Major Version should refer to the required Asset's major version. Provide null to fetch metadata of latest version.

Returns

Get Asset Meta Data

Get Asset Data for given Asset Id. For more information, check the Github documentation.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Asset Id
assetId True integer

Id for the Asset on QPPNG Platform being pointed to.

Returns

Body
Asset

Get Attribute Values from Ids

Get Attribute Values for comma separated Id's. For more information, check the Github documentation.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Asset Id
assetId True integer

Id for the Asset on QPPNG Platform being pointed to.

QPPNG Attribute Ids
attributeIds True string

Attribute ids should refer to the QPP Server's attribute ids.

Returns

Get Attributes by Name

Returns all existing attributes with metadata in QPPNG Server for specified names. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Attribute Names
attributeNames True string

Attribute Name should refer to the QPP Server's attribute name (comma separated, if multiple).

Returns

Get Attributes Values by Name

Get attribute values for comma separated names. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Asset Id
assetId True integer

AssetId should refer to the QPP Server's Asset.

Attribute Names
attributes True string

Attribute names string should refer to the QPPNG Server's attribute names, comma separated if multiple.

Returns

Get Child Asset Relations

Get Child Asset Relations for a give Parent Asset Id. See Github docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Parent Asset Id
parentAssetId True integer

Parent Asset Id should refer to the QPP Server's parent Asset.

Returns

Get Content Types Info by Name

This request is used to retrieve content type info by content type name. See Github Docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Content Type Name
contentTypeName True string

Name for the content type.

Returns

Get Group By Name

This request will return a group specific to group name.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Group Name
groupName True string

Variable groupName should refer to name of QPP Server group.

Returns

Body
Group

Get Group Members

This request will return list of users and all their metadata specific to group Id. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Group Id
groupId True integer

Group Id should refer to the QPPNG Group.

Returns

response
array of User

Get Groups for a Collection

This request returns an array of applicable routings groups for the given collection for the specified workflow and status. For more information check the github documentation.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Id for QPPNG Collection
collectionId True integer

Variable collectionId should refer to the QPPNG Collection Id.

Returns

Get Paginated Query Results with Filters

This request returns paginated Query Element and details of a Query stored in the system with specific filter in query. For more information check the github documentation.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Existing QPPNG Query Id
queryId True integer

This refers to an existing QPPNG Query Id.

Query ID
queryId integer

Unique ID of the query.

Query Name
queryName string

Name of the query.

Owner ID
ownerId integer

ID of the query owner.

Parameterized
parameterized boolean

Indicates if the query is parameterized.

Column ID
columnId True integer

ID of the display column.

Width
width True integer

Width of the display column.

Attribute Column
attributeColumn True boolean

Indicates if the column is an attribute column.

Column ID
columnId integer

ID of the column for sorting.

Descending
descending boolean

Indicates if the sorting is in descending order.

Attribute Column
attributeColumn boolean

Indicates if the sorted column is an attribute column.

Display Mode
displayMode True integer

Display mode setting.

Attribute ID
attributeId integer

ID of the attribute for grouping.

Descending
descending boolean

Indicates if the grouping is in descending order.

Explore Mode
exploreMode integer

Explore mode setting.

Logical Operator
logicalOperator True integer

Logical operator for the condition.

Comparison Operator
comparisonOperator True integer

Comparison operator for the condition.

Negated
negated True boolean

Indicates if the condition is negated.

Parameterized
parameterized True boolean

Indicates if the condition is parameterized.

Type
type True integer

Type of the condition.

Attribute Id
attributeId True integer

Attribute Id for Search.

Value to Search Against
value True string

value to Search Against.

Content Type
contentType integer

ID of the content type for the query context.

Collections
collections array of integer

List of collection IDs for the query context.

Recursive
recursive boolean

Indicates if the query context is recursive.

Include All Versions
includeAllVersions boolean

Indicates if all versions are included in the query context.

Include Branches
includeBranches boolean

Indicates if branches are included in the query context.

queryResults
queryResults

Returns

Response element for listing query results.

List Response Query Result Element
ListResponseQueryResultElement

Get Parent Asset Relations

This request will return the list of relations for a parent asset relation. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Child Asset Id
childAssetId True integer

Variable childAssetId should refer to the QPP Server's child asset which has relation with parent and for whom parent relations needs to be find out.

Returns

Get Publishing Status

Get Publishing Status for a given asset. Refer to the Github docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Context Id
contextId True string

Context Id

Returns

Get Token as per Grant Type

This request fetches the token for the given username and password for QPPNG. See GitHub docs for details.

Parameters

Name Key Required Type Description
Username
username True string

Please enter your QPPNG environment username for which you need to get token.

Password
password True string

Please enter the password for the username.

Returns

Name Path Type Description
Access Token
access_token string

The token that grants access to the protected resources.

Expires In
expires_in integer

The duration (in seconds) for which the access token is valid.

Refresh Expires In
refresh_expires_in integer

The duration (in seconds) for which the refresh token is valid.

Token Type
token_type string

The type of the token (e.g., bearer).

Not Before Policy
not-before-policy integer

The time (in seconds) before which the token cannot be used.

Scope
scope string

The scope of the access token.

Get User by Id

This request is used to fetch the metadata of a specified user. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

QPPNG user Id
userId True integer

Id for the QPPNG user.

Returns

Body
User

Get User by Name

This request will return user metadata specific to username. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Username for QPPNG user
userName True string

This refers to the Username for QPPNG user.

Returns

Body
User

Get Workflow by name

This request returns all the metadata of a specified workflow by name. See Github docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Workflow Name
workflowName True string

Workflow Name for which metadata needs to be fetched.

Returns

Details of a workflow.

Workflow
Workflow

Initiate Check-in and Update

Request will check-in and update an already existing asset in QPPNG. Asset Needs to be checked out before hand. Use checkout action before. For more information, check the github documentation.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Create Minor Version
createMinorVersion True boolean

Variable createMinorVersion should refer to true or false for creating version for checking.

Asset Id
assetId integer

Asset Id for the asset to be checked-in.

Returns

Initiate New Check-in

Request will check-in a local file, as per given Qpp attribute values array, for example required attribute values are name , collection , extension etc to check-in an asset to QPPNG. For more information, check the github documentation.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Number of Attributes/domains to Skip
_skiptoken True integer

Number of Attributes/domains to Skip.

Create Minor Version
createMinorVersion True boolean

Variable createMinorVersion should refer to true or false for creating version for checking.

Attribute Id
attributeId integer

Attribute Id.

Attribute Type
type integer

Type of Attribute.

Multi Valued
multiValued boolean

Indicates if the attribute is multi-valued.

Id
id integer

Id corresponding to the name, such as for Home collection Id 1 is taken.

Name
name string

Name for Attribute, such as content type name or collection name.

Domain Id
domainId integer

Domain ID associated with the existing Data Source/Domain list. Its Id for the domain.

Value
value string

Value of the attribute to be set.

Domain Value Id
id integer

Id for the Domain Value itself, for example Id for a Domain Value for a User will be the user Id, since Users list is the Domain.

Returns

Is User a Group Member

This request will return either true or false that a user is member of group specific to the userId.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Id of QPPNG user
userId True integer

Id of QPPNG user.

Id for Group In QPPNG
groupId True integer

Id for Group In QPPNG.

Returns

Publish Asset Async

Returns Context Id for asset being published. Use with get Publishing status. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Asset Id
assetId True string

Variable assetId should refer to the QPP Server's Asset.

Publishing Channel Id
publishingChannelId True string

variable channelId should refer to the Id of channel to be used.

Returns

Context Id for asset being published. Use with get Publishing status to check publishing status.

Context Id
string

Set Attribute Values

Set attribute values for the QPP Platform. For more information, check the Github documentation.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Asset Id
assetId True string

QPP Platform Asset Id.

Attribute Id
attributeId integer

Identifier of the attribute.

Type
type integer

Type of the attribute.

Multi Valued
multiValued boolean

Indicates if the attribute is multi-valued.

Value
attributeValue object

Value.

Returns

Update Attribute Mapping for Content Type

Update attribute mapping of content types and children with specified attribute map in request body. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Attribute Id
attributeId True integer

Attribute ids that needs to be mapped.

Content Type Ids
contentTypeIds True string

Content Types on which these attributes needs to be mapped to.

Returns

Upload (Blob)

This request is used to upload file by input stream. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

File Identifier
fileIdentifier True string

File Identifier refers to type of file.

context Id
contextId True string

Context Id refers to resource info.

Input Stream Resource
InputStreamResource True

Input Stream for resource, needs binary input.

Returns

Triggers

Triggers when an event occurs for an already registered Webhook

Registers a webhook for a given event and change type. See GitHub docs for details.

Triggers when an event occurs for an already registered Webhook

Registers a webhook for a given event and change type. See GitHub docs for details.

Parameters

Name Key Required Type Description
Impersonation User
user_name True string

Username for the QPPNG user, which needs to be impersonated.

Webhook Name
name True string

Unique name to describe webhooks's purpose and meaning.

Webhook Type
type True string

Describe the Webhook Type that will be listened to, such as Event etc.

Object
object True string

Describes the type of Object to listen to Like ASSET etc.

Change Type
changeType True array of string
Filter Criteria
filter string

Filter Criteria can be defined to filter the type of event.

Version used
version True string

Version used as per webhook Service in QPPNG platform.

Returns

Name Path Type Description
Version used
version string

Version used as per webhook service in QPPNG platform.

Webhook Type
webhookInfo.type string

Describe the Webhook Type that will be listened to, such as Event etc.

Webhook Id
webhookInfo.id string

Webhook Id.

Webhook Name
webhookInfo.name string

Unique Name to describe webhooks's purpose and meaning.

AuxData
webhookInfo.auxData string

AuxData if provided any while registering.

Definitions

PublishingOutputDownloadInfo

Defines the Publishing Output Download Info.

Name Path Type Description
attributesMap
attributesMap object
Direct Download
directDownload boolean

Defines if Direct Download is allowed.

Download Url
downloadUrl string

Provides download URL which can be used with download blob action to download from the blob location.

WebhookSuccessResponse

Name Path Type Description
ID
id string

Defines the ID for the webhook success response.

Status
status string

Defines the status for the webhook success response.

Message
message string

Defines the message for the webhook success response.

Version
version string

Defines the version for the webhook success response.

AttributeValue

Name Path Type Description
Attribute ID
attributeId integer

Defines the Attribute ID for the QPPNG attribute.

Attribute Name
attributeName string

Defines the Attribute Name for the QPPNG attribute.

Type
type integer

Defines the type for the QPPNG attribute.

MultiValued
multiValued boolean

Defines if the attribute is multi-valued.

Value
attributeValue Value

Value.

AssetUploadInfo

Name Path Type Description
Context ID
contextId string

Defines the context ID for the asset upload.

Upload URL
uploadUrl string

Defines the upload URL for the asset.

Asset

Name Path Type Description
Asset ID
assetId integer

Defines the Asset ID for the QPPNG asset.

assetVersion
assetVersion AssetVersion
attributeValues
attributeValues array of AttributeValue

User

Name Path Type Description
ID
id integer

User ID.

Name
name string

User's name.

Domain ID
domainId integer

Domain ID of the user.

Source Reference
sourceReference string

Source reference for the user.

Child Domain Values
childDomainValues array of DomainValue

Array of child domain values.

Has Children
hasChildren boolean

Indicates if the user has children.

Is Deleted
isDeleted boolean

Indicates if the user is deleted.

Is User
user boolean

Indicates if the entity is a user.

LDAP Profile ID
ldapProfileId integer

LDAP profile ID for the user.

Default User Class ID
defaultUserClassId integer

Default user class ID.

Email Address
emailAddress string

User's email address.

Is Deleted
deleted boolean

Indicates if the user is deleted.

LDAP Distinguished Name
ldapDistinguishedName string

LDAP distinguished name for the user.

Native Trustee
nativeTrustee boolean

Indicates if the user is a native trustee.

First Name
firstName string

User's first name.

Last Name
lastName string

User's last name.

Phone Number
phoneNumber string

User's phone number.

Is Enabled
enabled boolean

Indicates if the user is enabled.

Externally Authenticated
externallyAuthenticated boolean

Indicates if the user is externally authenticated.

Name for Authentication
nameForAuthentication string

Name for authentication.

ListResponseCollectionGroup

Name Path Type Description
Count
get_count integer

Number of items in the response.

Next Link
get_nextLink string

URL for the next set of results.

Value
get_value array of CollectionGroup

Array of collection groups.

Value

Value.

Name Path Type Description
Value
object

Value.

AssetVersion

Name Path Type Description
Major Version
majorVersion integer

Major Version of the asset.

Minor Version
minorVersion integer

Minor Version of the asset.

Branch ID
branchId integer

Branch Version ID.

System Name
systemName string

System Name for Asset Version.

DomainValue

Name Path Type Description
ID
id integer

Domain value ID.

Name
name string

Name of the domain value.

Domain ID
domainId integer

Domain ID of the domain value.

Source Reference
sourceReference string

Source reference of the domain value.

Child Domain Values
childDomainValues string

Array of child domain values.

Has Children
hasChildren boolean

Indicates if the domain value has children.

Is Deleted
isDeleted boolean

Indicates if the domain value is deleted.

CollectionGroup

Name Path Type Description
Group ID
groupId integer

ID of the collection group.

groupInfo
groupInfo GroupInfo
Overridden User Class ID
overriddenUserClassId integer

ID of the overridden user class.

GroupInfo

Name Path Type Description
ID
id integer

Group ID.

Name
name string

Name of the group.

Domain ID
domainId integer

Domain ID of the group.

Source Reference
sourceReference string

Source reference of the group.

Child Domain Values
childDomainValues array of DomainValue

Array of child domain values.

Has Children
hasChildren boolean

Indicates if the group has children.

Is Deleted
isDeleted boolean

Indicates if the group is deleted.

Is User
user boolean

Indicates if the group represents a user.

LDAP Profile ID
ldapProfileId integer

LDAP profile ID.

Default User Class ID
defaultUserClassId integer

ID of the default user class.

Email Address
emailAddress string

Email address of the group.

Deleted
deleted boolean

Indicates if the group is deleted.

LDAP Distinguished Name
ldapDistinguishedName string

LDAP distinguished name of the group.

Native Trustee
nativeTrustee boolean

Indicates if the group is a native trustee.

AssetDownloadInfo

Name Path Type Description
Context ID
contextId string

ID of the context.

Download URL
downloadUrl string

URL for downloading the asset.

Workflow

Details of a workflow.

Name Path Type Description
ID
id integer

Unique identifier for the workflow.

Name
name string

Name of the workflow.

Domain ID
domainId integer

Identifier of the domain associated with the workflow.

Source Reference
sourceReference string

Reference associated with the source of the workflow.

Child Domain Values
childDomainValues array of DomainValue

List of child domain values associated with the workflow.

Has Children
hasChildren boolean

Indicates if the workflow has children.

Is Deleted
isDeleted boolean

Indicates if the workflow has been marked as deleted.

Statuses
statuses array of Status

List of statuses in the workflow.

Created By
createdBy integer

User ID of the creator of the workflow.

Created Date
created string

Date when the workflow was created.

Last Modified By
lastModifiedBy integer

User ID of the last modifier of the workflow.

Last Modified Date
lastModified string

Date when the workflow was last modified.

Constrained Status Transition
constrainedStatusTransition boolean

Defines if status transition is constrained.

Status Routing User Classes
statusRoutingUserclasses array of StatusRoutingUserClasses

List of status routing user classes.

Status Transitions
statusTransitions array of StatusTransition

List of status transitions.

Status

Represents a status.

Name Path Type Description
ID
id integer

Unique identifier for the status.

Name
name string

Name of the status.

Domain ID
domainId integer

Domain identifier for the status.

Source Reference
sourceReference string

Reference to the source of the status.

Child Domain Values
childDomainValues array of DomainValue

Array of child domain values.

Has Children
hasChildren boolean

Indicates if the status has child statuses.

Is Deleted
isDeleted boolean

Indicates if the status is deleted.

Workflow ID
workflowId integer

ID of the workflow associated with the status.

Color Red
colorRed integer

Red component of the status color.

Color Green
colorGreen integer

Green component of the status color.

Color Blue
colorBlue integer

Blue component of the status color.

Position
position integer

Position of the status.

StatusRoutingUserClasses

Mapping of status to user classes for routing.

Name Path Type Description
Status ID
statusId integer

ID of the status for routing.

Routing User Class IDs
routingUserClassIds array of integer

Array of user class IDs for routing.

User Class Based Routing
userClassBasedRouting boolean

Indicates if user class-based routing is enabled.

StatusTransition

Details of a status transition within a workflow.

Name Path Type Description
Status ID
statusId integer

ID of the status transition.

Workflow Initiating Status
workflowInitiatingStatus boolean

Indicates if the transition is initiated by the workflow.

Next Possible Status IDs
nextPossibleStatusIds array of integer

IDs of the next possible statuses after this transition.

AssetRelation

Details of a relationship between assets.

Name Path Type Description
ID
id integer

Unique ID of the asset relation.

Parent Asset ID
parentAssetId integer

ID of the parent asset in the relation.

parentAssetVersion
parentAssetVersion AssetVersion
Child Asset ID
childAssetId integer

ID of the child asset in the relation.

childAssetVersion
childAssetVersion AssetVersion
Relation Type ID
relationTypeId integer

ID of the type of relation.

Relation State
relationState integer

State of the relation.

Locked to Child Version
lockedToChildVersion boolean

Flag indicating if the relation is locked to the child version.

Freeze to Current Version
freezeToCurrentVersion boolean

Flag indicating if the relation is frozen to the current version.

Relation Attributes
relationAttributes array of AttributeValue

Attributes associated with the relation.

Attribute

Details of an attribute associated with an entity.

Name Path Type Description
ID
id integer

Unique ID of the attribute.

Name
name string

Name of the attribute.

Value Type
valueType integer

Type of value that the attribute holds.

User Defined
userDefined boolean

Indicates if the attribute is user-defined.

Queryable
queryable boolean

Indicates if the attribute is queryable.

Multi Valued
multiValued boolean

Indicates if the attribute can hold multiple values.

Modification Level
modificationLevel integer

Level of modification of the attribute.

Created Date
created string

Date when the attribute was created.

Last Modified Date
lastModified string

Date when the attribute was last modified.

Creator
creator integer

ID of the user who created the attribute.

Last Modifier
lastModifier integer

ID of the user who last modified the attribute.

Displayable
displayable boolean

Indicates if the attribute is displayable.

Limited Access
limitedAccess boolean

Indicates if the attribute has limited access.

Limited Access Changeable
limitedAccessChangeable boolean

Indicates if the limited access setting can be changed.

Constraints Changeable
constraintsChangeable boolean

Indicates if the constraints of the attribute can be changed.

Value Preferences Changeable
valuePreferencesChangeable boolean

Indicates if the value preferences can be changed.

Boolean Value Preferences
booleanValuePreferences BooleanValuePreferences

Preferences for boolean values.

Numeric Value Preferences
numericValuePreferences NumericValuePreferences

Preferences for numeric values.

Date Value Preferences
dateValuePreferences DateValuePreferences

Preferences for date values.

DateTime Value Preferences
dateTimeValuePreferences DateTimeValuePreferences

Preferences for DateTime values.

Time Value Preferences
timeValuePreferences TimeValuePreferences

Preferences for time values.

Measurement Value Preferences
measurementValuePreferences MeasurementValuePreferences

Preferences for measurement values.

Text Value Preferences
textValuePreferences TextValuePreferences

Preferences for text values.

Domain Value List Preferences
domainValueListPreferences DomainValueListPreferences

Preferences for domain value lists.

Domain Value Preferences
domainValuePreferences DomainValuePreferences

Preferences for domain values.

CreateAttributeSchema

Details of an attribute associated with an entity.

Name Path Type Description
ID
id integer

Unique ID of the attribute.

Name
name string

Name of the attribute.

Value Type
valueType integer

Type of value that the attribute holds 1 for text type etc.

User Defined
userDefined boolean

Indicates if the attribute is user-defined.

Queryable
queryable boolean

Indicates if the attribute is queryable.

Multi Valued
multiValued boolean

Indicates if the attribute can hold multiple values.

Modification Level
modificationLevel integer

Level of modification of the attribute.

Created Date
created string

Date when the attribute was created.

Last Modified Date
lastModified string

Date when the attribute was last modified.

Creator
creator integer

ID of the user who created the attribute.

Last Modifier
lastModifier integer

ID of the user who last modified the attribute.

Displayable
displayable boolean

Indicates if the attribute is displayable.

Limited Access
limitedAccess boolean

Indicates if the attribute has limited access.

Limited Access Changeable
limitedAccessChangeable boolean

Indicates if the limited access setting can be changed.

Constraints Changeable
constraintsChangeable boolean

Indicates if the constraints of the attribute can be changed.

Value Preferences Changeable
valuePreferencesChangeable boolean

Indicates if the value preferences can be changed.

Boolean Value Preferences
booleanValuePreferences BooleanValuePreferences

Preferences for boolean values.

Numeric Value Preferences
numericValuePreferences NumericValuePreferences

Preferences for numeric values.

Date Value Preferences
dateValuePreferences DateValuePreferences

Preferences for date values.

DateTime Value Preferences
dateTimeValuePreferences DateTimeValuePreferences

Preferences for DateTime values.

Time Value Preferences
timeValuePreferences TimeValuePreferences

Preferences for time values.

Measurement Value Preferences
measurementValuePreferences MeasurementValuePreferences

Preferences for measurement values.

Text Value Preferences
textValuePreferences TextValuePreferences

Preferences for text values.

Domain Value List Preferences
domainValueListPreferences DomainValueListPreferences

Preferences for domain value lists.

Domain Value Preferences
domainValuePreferences DomainValuePreferences

Preferences for domain values.

ContentTypeInfo

Details of a content type.

Name Path Type Description
ID
id integer

Unique ID of the content type.

Name
name string

Name of the content type.

Domain ID
domainId integer

Domain ID associated with the content type.

Source Reference
sourceReference string

Reference to the source of the content type.

Child Domain Values
childDomainValues array of DomainValue

List of child domain values associated with the content type.

Has Children
hasChildren boolean

Indicates if the content type has children.

Is Deleted
isDeleted boolean

Indicates if the content type is deleted.

System Defined
systemDefined boolean

Indicates if the content type is system-defined.

Children Available
childrenAvailable boolean

Indicates if children are available for the content type.

Extensible
extensible boolean

Indicates if the content type is extensible.

BooleanValuePreferences

Preferences for boolean values.

Name Path Type Description
Boolean Value
defaultValue BooleanValue

Boolean value.

BooleanValue

Boolean value.

Name Path Type Description
Value
value boolean

The boolean value.

NumericValuePreferences

Preferences for numeric values.

Name Path Type Description
Numeric Value
minimumPossibleValue NumericValue

Numeric value.

Numeric Value
maximumPossibleValue NumericValue

Numeric value.

Numeric Value
defaultValue NumericValue

Numeric value.

NumericValue

Numeric value.

Name Path Type Description
Value
value integer

The numeric value.

DateValue

Date value.

Name Path Type Description
Value
value string

The date value.

DateValuePreferences

Preferences for date values.

Name Path Type Description
Date Value
minimumPossibleValue DateValue

Date value.

Date Value
maximumPossibleValue DateValue

Date value.

Date Value
defaultValue DateValue

Date value.

DateTimeValue

DateTime value.

Name Path Type Description
Value
value string

The DateTime value.

DateTimeValuePreferences

Preferences for DateTime values.

Name Path Type Description
DateTime Value
minimumPossibleValue DateTimeValue

DateTime value.

DateTime Value
maximumPossibleValue DateTimeValue

DateTime value.

DateTime Value
defaultValue DateTimeValue

DateTime value.

TimeValue

Time value.

Name Path Type Description
Value
value string

The time value.

TimeValuePreferences

Preferences for time values.

Name Path Type Description
Time Value
minimumPossibleValue TimeValue

Time value.

Time Value
maximumPossibleValue TimeValue

Time value.

Time Value
defaultValue TimeValue

Time value.

MeasurementValue

Measurement value.

Name Path Type Description
Value
value double

The measurement value.

MeasurementValuePreferences

Preferences for measurement values.

Name Path Type Description
Measurement Unit
measurementUnit integer

Measurement unit.

Only Measurement Unit Changeable
onlyMeasurementUnitChangeable boolean

Indicates if only the measurement unit is changeable.

Measurement Value
minimumPossibleValue MeasurementValue

Measurement value.

Measurement Value
maximumPossibleValue MeasurementValue

Measurement value.

Measurement Value
defaultValue MeasurementValue

Measurement value.

TextValue

Text value

Name Path Type Description
Value
value string

The text value.

TextValuePreferences

Preferences for text values.

Name Path Type Description
Text Value
defaultValue TextValue

Text value

Max Length Possible
maxLengthPossible integer

Maximum possible length for text value.

Text Search Enabled
textSearchEnabled boolean

Indicates if text search is enabled.

DomainValueList

List of domain values.

Name Path Type Description
Domain Values
domainValues array of DomainValue

List of domain values.

DomainValueListPreferences

Preferences for domain value lists.

Name Path Type Description
Domain Value List
defaultValue DomainValueList

List of domain values.

Domain ID
domainId integer

Domain ID associated with the domain value list.

DomainValuePreferences

Preferences for domain values.

Name Path Type Description
defaultValue
defaultValue DomainValue
Domain ID
domainId integer

Domain ID associated with the domain value.

QueryDefinition

Definition of a query.

Name Path Type Description
Query ID
queryId integer

Unique ID of the query.

Query Name
queryName string

Name of the query.

Owner ID
ownerId integer

ID of the query owner.

Parameterized
parameterized boolean

Indicates if the query is parameterized.

Query Display
queryDisplay QueryDisplay

Display settings for a query.

Query Conditions
queryConditions array of QueryCondition

List of query conditions.

Query Context
queryContext QueryContext

Context settings for a query.

queryResults
queryResults

QueryDisplay

Display settings for a query.

Name Path Type Description
Display Columns
displayColumns array of DisplayColumn

List of display columns.

Sorting
sorting array of SortInfo

List of sorting settings.

Display Mode
displayMode integer

Display mode setting.

Grouping Attributes
groupingAttributes array of GroupingInfo

List of grouping attributes.

Explore Mode
exploreMode integer

Explore mode setting.

QueryCondition

Condition for a query.

Name Path Type Description
Logical Operator
logicalOperator integer

Logical operator for the condition.

Comparison Operator
comparisonOperator integer

Comparison operator for the condition.

Negated
negated boolean

Indicates if the condition is negated.

Parameterized
parameterized boolean

Indicates if the condition is parameterized.

Type
type integer

Type of the condition.

Attribute Id
attributeId integer

Attribute Id for Search.

Value to Search Against
value string

value to Search Against.

QueryContext

Context settings for a query.

Name Path Type Description
Content Type
contentType integer

ID of the content type for the query context.

Collections
collections array of integer

List of collection IDs for the query context.

Recursive
recursive boolean

Indicates if the query context is recursive.

Include All Versions
includeAllVersions boolean

Indicates if all versions are included in the query context.

Include Branches
includeBranches boolean

Indicates if branches are included in the query context.

DisplayColumn

Column for display in a query.

Name Path Type Description
Column ID
columnId integer

ID of the display column.

Width
width integer

Width of the display column.

Attribute Column
attributeColumn boolean

Indicates if the column is an attribute column.

SortInfo

Sorting settings for a query.

Name Path Type Description
Column ID
columnId integer

ID of the column for sorting.

Descending
descending boolean

Indicates if the sorting is in descending order.

Attribute Column
attributeColumn boolean

Indicates if the sorted column is an attribute column.

GroupingInfo

Grouping settings for a query.

Name Path Type Description
Attribute ID
attributeId integer

ID of the attribute for grouping.

Descending
descending boolean

Indicates if the grouping is in descending order.

ListResponseQueryResultElement

Response element for listing query results.

Name Path Type Description
Count
get_count integer

Number of results in the list response.

Next Link
get_nextLink string

Link to the next page of results.

Value
get_value array of QueryResultElement

Array of query result elements.

QueryResultElement

Element in a query result.

Name Path Type Description
ID
id integer

Unique identifier for the element.

Child Available
childAvailable boolean

Indicates if child elements are available.

Element Type
elementType integer

Type of the element.

ListResponseUser

Response element for listing users.

Name Path Type Description
Count
get_count integer

Number of users in the list response.

Next Link
get_nextLink string

Link to the next page of results.

Value
get_value array of User

Array of user elements.

PublishingStatusInfo

Name Path Type Description
PublishingFailedException
publishingFailedException PublishingFailedException

Exception thrown when publishing fails

publishingOutputDownloadInfo
publishingOutputDownloadInfo array of PublishingOutputDownloadInfo
Publishing Status
publishingStatus string

Status of publishing of the asset, Possible Return Values are PUBLISHING_IN_PROGESS, PUBLISHING_FAILED, PUBLISHING_COMPLETED

PublishingFailedException

Exception thrown when publishing fails

Name Path Type Description
Additional Information
additionalInfo array of string

Additional information related to the exception

Throwable
cause Throwable

Base class for exceptions and errors

Exception Code
exceptionCode string

Code associated with the exception

Localized Message
localizedMessage string

Localized message describing the exception

Message
message string

Message describing the exception

stackTrace
stackTrace array of StackTraceElement
suppressed
suppressed array of Throwable

Throwable

Base class for exceptions and errors

Name Path Type Description
Cause
cause string

The cause of the throwable

Localized Message
localizedMessage string

Localized message describing the throwable

Message
message string

Message describing the throwable

stackTrace
stackTrace array of StackTraceElement
Suppressed
suppressed array of string

Other throwables suppressed by this throwable

StackTraceElement

An element representing a single stack frame

Name Path Type Description
Class Name
className string

Name of the class containing the execution point

File Name
fileName string

Name of the file containing the execution point

Line Number
lineNumber integer

Line number in the file containing the execution point

Method Name
methodName string

Name of the method containing the execution point

Native Method
nativeMethod boolean

Indicates if the method is a native method

Group

Name Path Type Description
childDomainValues
childDomainValues array of DomainValue
Default User Class ID
defaultUserClassId integer

The default user class ID for the group.

Deleted
deleted boolean

Indicates whether the group is deleted.

Domain ID
domainId integer

The ID of the domain to which the group belongs.

Email Address
emailAddress string

The email address associated with the group.

Has Children
hasChildren boolean

Indicates whether the group has children.

ID
id integer

The ID of the group.

Is Deleted
isDeleted boolean

Indicates whether the group is deleted.

LDAP Distinguished Name
ldapDistinguishedName string

The distinguished name in LDAP for the group.

LDAP Profile ID
ldapProfileId integer

The LDAP profile ID for the group.

Member IDs
memberIds array of integer

An array of member IDs associated with the group.

Name
name string

The name of the group.

Native Trustee
nativeTrustee boolean

Indicates whether the group is a native trustee.

Source Reference
sourceReference string

The source reference for the group.

User
user boolean

Indicates whether the group is a user.

integer

This is the basic data type 'integer'.

string

This is the basic data type 'string'.