Jump to

• Request
• Response
• Examples

Get Data Dictionary Object Specifications

get

/bcws/webresources/v1.0/installmentManagement/ddObjectSpec

Gets the data dictionary object specifications that match the specified query criteria.

Request

Query Parameters

• className: string
  The class names to retrieve, for example: /account,/service,/device,/profile
• fetchSubClass: boolean
  Indicates whether to include subclasses in the response (true) or not (false). The default value is false.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The data dictionary object specification information was retrieved successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object dDObjectSpec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DDObjectSpec"
    }
}

Nested Schema : dDObjectSpec

Type: object

Show Source

• className(required): string
  The storable class name.
• descr(required): string
  The storable class description.
• fields(required): array fields
• label(required): string
  The storable class label.
• status(required): string
  The status of the storable class.

{
    "required":[
        "className",
        "descr",
        "fields",
        "label",
        "status"
    ],
    "type":"object",
    "properties":{
        "className":{
            "type":"string",
            "description":"The storable class name."
        },
        "status":{
            "type":"string",
            "description":"The status of the storable class."
        },
        "descr":{
            "type":"string",
            "description":"The storable class description."
        },
        "label":{
            "type":"string",
            "description":"The storable class label."
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DDObjectSpecFields"
            }
        }
    },
    "xml":{
        "name":"dDObjectSpec"
    }
}

Nested Schema : fields

Type: array

Show Source

• Array of: object DDObjectSpecFields

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DDObjectSpecFields"
    }
}

Nested Schema : DDObjectSpecFields

Type: object

Show Source

• descr(required): string
  The field's description.
• fieldName(required): string
  The field's name.
• fieldType(required): string
  The field's data type.
• label(required): string
  The field's label.
• smItemName(required): string
  The name of the table or collection.

{
    "required":[
        "descr",
        "fieldName",
        "fieldType",
        "label",
        "smItemName"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "description":"The field's name."
        },
        "fieldType":{
            "type":"string",
            "description":"The field's data type."
        },
        "smItemName":{
            "type":"string",
            "description":"The name of the table or collection."
        },
        "descr":{
            "type":"string",
            "description":"The field's description."
        },
        "label":{
            "type":"string",
            "description":"The field's label."
        }
    }
}

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to get data dictionary object specification for the /service class and subclasses by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/installmentManagement/ddObjectSpec?className=/service&fetchSubClass=true'

where:

• hostname is the URL for the Billing Care REST server.
• port is the port for the Billing Care REST server.
• version is the version of the API you're using, such as v1.0.

Example of Response Body

This example shows the contents of the response body in JSON format. The example has been abbreviated, so not all fields are shown.

[
   {
      "className":"/service",
      "status":3,
      "descr":"Generic Service Object. A service object creates an identity for the account object to which it belongs. This identity can perform actions and use resources. There can be multiple service objects associated with an account. The billing is tracked to the service level. The service object can be extended to add additional service-specific information.",
      "fields":[
         {
            "fieldName":"PIN_FLD_ALIAS_LIST",
            "fieldType":"9",
            "smItemName":"service_alias_list_t",
            "fields":[
               {
                  "fieldName":"PIN_FLD_NAME",
                  "fieldType":"5",
                  "smItemName":"name",
                  "descr":"Associated alias name. This must be globally unique per service type."
               }
            ]
         },
         {
            "fieldName":"PIN_FLD_BAL_GRP_OBJ",
            "fieldType":"7",
            "smItemName":"bal_grp_obj"
         },
         {
            "fieldName":"PIN_FLD_CLOSE_WHEN_T",
            "fieldType":"8",
            "smItemName":"close_when_t"
         },
         {
            "fieldName":"PIN_FLD_CREATED_T",
            "fieldType":"8",
            "smItemName":"created_t"
         },
         {
            "fieldName":"PIN_FLD_EFFECTIVE_T",
            "fieldType":"8",
            "smItemName":"effective_t"
         },
         {
            "fieldName":"PIN_FLD_ITEM_POID_LIST",
            "fieldType":"5",
            "smItemName":"item_poid_list"
         },
         ...
      ]
   },
   {
      "className":"/service/broadband",
      "status":3,
      "descr":"This service object provides a identity to a broadband user. Events associated with this service are typically aggregated to perform rating on cumulative usage. See /event/aggregation.",
      "fields":[
         {
            "fieldName":"PIN_FLD_IP_ADDRESSES",
            "fieldType":"9",
            "smItemName":"service_broadband_ipaddrs_t",
            "fields":[
               {
                  "fieldName":"PIN_FLD_IP_ADDRESS",
                  "fieldType":"5",
                  "smItemName":"ip_address",
                  "descr":"IP address string with a header which indicates the type of the IP address: header|address. For example, 'ip|156.151.10.10' or 'ipv6|FEDC:BA98:7654:3210:FEDC:BA98:7654:3210'."
               }
            ]
         },
         {
            "fieldName":"PIN_FLD_SERVICE_BROADBAND",
            "fieldType":"10",
            "smItemName":"service_broadband_t",
            "fields":[
               {
                  "fieldName":"PIN_FLD_EVENT_OBJ",
                  "fieldType":"7",
                  "smItemName":"event_obj",
                  "descr":"Link to the event that holds the usage of the leaseline service for current billing period."
               }
            ]
         }
      ]
   }
]

Back to Top