SWI Cfg Object Broker Operations

For a list of operations associated with this REST API service, see the following table.

Name Description
GetConfigObjectSet

Used to query product Id, product name, attribute, class Id, and class name present in the structure for a given product.

This API returns a complete set of versioned products and classes that satisfies the data referential integrity in denormalized format.

Message Description: SWI Cfg Object Broker – GetConfigObjectSet

For a description of the most important fields in the request section, see the following table.

Node Description Type
RootId Queries for an existing product using Row ID. String
RootName Queries for an existing product using Product Name. String
Org When RootName is used as a search criteria, Org must be provided. String
Version Can be used with RootName as search criteria.

Valid values are:

  • "0" - returns workspace

  • "" - returns last released

  • other - treated as ""

String
Vendor RootName and Vendor can be used as search criteria. String
Full

If this flag is set to N, then only root product will be included in the response.

The default value of this flag is Y.

String
ExternalIntegrationId Queries for an existing product using External Integration Id. String
FilterObjectAttr Valid values are:
  • "Y" - XA attribute information for all objects viz class and products is filtered from response

  • "N" - returns attribute info for all objects

  • "" or other - treated as "N"

String
FilterProductAttr Valid values are:
  • "Y" - XA attribute information for all products is filtered from response

  • "N" - returns attribute info for all objects

  • "" or other - treated as "N"

String
BasicInfoOnly Valid values are:
  • "Y" - filters port cardinality and local strings in the object

  • "N" - keeps port cardinality and local strings

  • "" or other - treated as "N"

String

For a description of the important fields in the response section, see the following table.

Node Description Type
ProdStruct A hierarchical structure that holds all product/class data. Hierarchy