Query Versions of Product, Class, and Attribute

Method QueryPage method on SWI VOD Versions business service returns details about versioned objects: product, class, or attribute.

This method supports pagination. Before deleting versions, the caller can use this method to query available versions.

Input Arguments

Name Value Comments

Object Name

String

Name of product, class, or attribute
Object Number

String

The product Id if object type is "Product"
VOD Id

String

Class or Attribute Id
Object Type

String

Product Definition, Parent Class Definition, or Attribute Definition

Output Arguments

Name Comments
Active Flg Flag denoting the active version
Comments User entered comments
Object Name Name of product, class, or attribute
Object Number Object Number
Object Type Product, Class, or Attribute
Parent Class Name Name of the parent class
Parent Class VOD Id Parent Class VOD Id
Released Flg Released Flag
Required End Date Version end date
Required Start Date Version start date
VOD Id VOD Id
Version Version number
  • URI: https://SiebelURL.com/siebel/v1.0/service/SWI%20VOD%20Versions/QueryPage

  • HTTP Method: POST

  • Content-Type: application/json

  • Authorization: BASIC

  • Request body
    "body": {
        "PageSize": "10",
        "StartRowNum": "0",
        "SiebelMessage": {
            "MessageId": "",
            "IntObjectName": "SWI VOD Versions",
            "MessageType": "Integration Object",
            "IntObjectFormat": "Siebel Hierarchical",
            "ListOfSWI VOD Versions": {
                "SWI VOD Versions BusComp": {
                  "Object Name": "Wireless Service"
                }
            }
        }
    }
    

Response details for a successful request:

  • HTTP Code: 200
  • Content-Type: application/json
  • Response body
    {
        "LastPage": "true",
        "SiebelMessage": {
            "IntObjectFormat": "Siebel Hierarchical",
            "MessageId": "88-A8ADV",
            "IntObjectName": "SWI VOD Versions",
            "MessageType": "Integration Object",
            "ListOfSWI VOD Versions": {
                "SWI VOD Versions BusComp": [
                    {
                        "Version": "4",
                        "VOD Id": "88-3C4GYD",
                        "Comments": "",
                        "Required End Date": "",
                        "Object Name": "Wireless Service",
                        "Released Flg": "Y",
                        "Object Number": "88-3C4GY7",
                        "Required Start Date": "08/01/2050 00:12:00",
                        "Parent Class VOD Id": "88-3C4GX2",
                        "Active Flg": "Y",
                        "Object Type": "ISS_PROD_DEF",
                        "Parent Class Name": "Wireless Service Class"
                    },
                    {
                        "Version": "5",
                        "VOD Id": "88-3C4GYD",
                        "Comments": "",
                        "Required End Date": "08/01/2050 00:12:00",
                        "Object Name": "Wireless Service",
                        "Released Flg": "Y",
                        "Object Number": "88-3C4GY7",
                        "Required Start Date": "11/19/2024 03:09:00",
                        "Parent Class VOD Id": "88-3C4GX2",
                        "Active Flg": "Y",
                        "Object Type": "ISS_PROD_DEF",
                        "Parent Class Name": "Wireless Service Class"
                    },
                    {
                        "Version": "6",
                        "VOD Id": "88-3C4GYD",
                        "Comments": "",
                        "Required End Date": "",
                        "Object Name": "Wireless Service",
                        "Released Flg": "N",
                        "Object Number": "88-3C4GY7",
                        "Required Start Date": "",
                        "Parent Class VOD Id": "88-3C4GX2",
                        "Active Flg": "Y",
                        "Object Type": "ISS_PROD_DEF",
                        "Parent Class Name": "Wireless Service Class"
                    }
                ]
            }
        }
    }