REST API Services for Oracle CPQ

Get Util Library Folders

get

/rest/v19/bml/library/folders

This operation retrieves all the available Util Library folders.

Request

Supported Media Types

application/json

Util Libraries list.

Root Schema : libraries-request

Type: object

Show Source

items: array The library functions list

Title: The library functions list

List of library functions.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of library functions.",
            "title":"The library functions list",
            "items":{
                "$ref":"#/definitions/libraryFunctions"
            }
        }
    }
}

Nested Schema : The library functions list

Type: array

Title: The library functions list

List of library functions.

Show Source

Array of: object libraryFunctions

{
    "type":"array",
    "description":"List of library functions.",
    "title":"The library functions list",
    "items":{
        "$ref":"#/definitions/libraryFunctions"
    }
}

Nested Schema : libraryFunctions

Type: object

Show Source

namespace: string

Title: namespace

Util library floder name.
type: string

Title: type

Library function type either util or commerce.
variableName: string

Title: variableName

variableName of the libaray function.

{
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"variableName of the libaray function.",
            "title":"variableName"
        },
        "type":{
            "type":"string",
            "description":"Library function type either util or commerce.",
            "title":"type"
        },
        "namespace":{
            "type":"string",
            "description":"Util library floder name.",
            "title":"namespace"
        }
    }
}

Response

Supported Media Types

application/json

Default Response

Util Library folders.

Root Schema : utilFolders

Type: object

Show Source

items: array List of util folders.

Title: List of util folders.

List of util folders.
links: array Links to the related objects

Title: Links to the related objects

Links to the related objects

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of util folders.",
            "title":"List of util folders.",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"Util library folder name.",
                        "title":"name"
                    },
                    "links":{
                        "type":"array",
                        "description":"Links to the related objects",
                        "title":"Links to the related objects",
                        "items":{
                            "$ref":"#/definitions/referenceLinks"
                        }
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    }
}

Nested Schema : List of util folders.

Type: array

Title: List of util folders.

List of util folders.

Show Source

Array of: object items

{
    "type":"array",
    "description":"List of util folders.",
    "title":"List of util folders.",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "description":"Util library folder name.",
                "title":"name"
            },
            "links":{
                "type":"array",
                "description":"Links to the related objects",
                "title":"Links to the related objects",
                "items":{
                    "$ref":"#/definitions/referenceLinks"
                }
            }
        }
    }
}

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

Links to the related objects

Show Source

Array of: object referenceLinks

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/referenceLinks"
    }
}

Nested Schema : items

Type: object

Show Source

links: array Links to the related objects

Title: Links to the related objects

Links to the related objects
name: string

Title: name

Util library folder name.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Util library folder name.",
            "title":"name"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    }
}

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

Links to the related objects

Show Source

Array of: object referenceLinks

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/referenceLinks"
    }
}

Nested Schema : referenceLinks

Type: object

Reference links for the Parent, Self, Children and Related as applicable

Show Source

href: string

Title: URL to the related object

URL to the related object
rel: string

Title: Link Relationship to the current object

Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Examples

The following example shows how to retrieve all the available Util Library folders by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET  -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/bml/library/folders

Response Body Sample

{
  "items": [{
      "name": "util",
      "links": [{
          "rel": "related",
          "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions?q=%7B%22namespace%22%3Anull%7D"
        }
      ]
    }, {
      "name": "nameSpace11",
      "links": [{
          "rel": "related",
          "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions?q=%7B%22namespace%22%3A%22nameSpace11%22%7D"
        }
      ]
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/folders"
    }
  ]
}