Jump to

• Request
• Response
• Examples

Get All Util Library Functions

get

/rest/v19/bml/library/functions

This operation returns all Util Library functions.

Request

Query Parameters

• excludeLinks: string
  Exclude specified link types.
• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Criteria to filter the library functions. By default no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

All BML Util Functions

Body ()

Root Schema : BML deployed libraries

Type: object

Title: BML deployed libraries

Deployed Util Libraries.

Show Source

• count: integer
  Title: count

  Number records are available.
• hasMore: boolean
  Title: hasMore

  Is more available?
• items: array BML deployed libraries list
  Title: BML deployed libraries list

  List of BML Deployed Util Libraries.
• limit: integer
  Title: limit

  The requested page size, which limits the number of elements the collection should max return.
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• offset: integer
  Title: offset

  The offset of the page. By default, offset is 0, which means first page will be returned.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of BML Deployed Util Libraries.",
            "title":"BML deployed libraries list",
            "items":{
                "$ref":"#/definitions/deployedLibrary"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset of the page. By default, offset is 0, which means first page will be returned.",
            "title":"offset"
        },
        "limit":{
            "type":"integer",
            "description":"The requested page size, which limits the number of elements the collection should max return.",
            "title":"limit"
        },
        "count":{
            "type":"integer",
            "description":"Number records are available.",
            "title":"count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Is more available?",
            "title":"hasMore"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    },
    "title":"BML deployed libraries",
    "description":"Deployed Util Libraries."
}

Nested Schema : BML deployed libraries list

Type: array

Title: BML deployed libraries list

List of BML Deployed Util Libraries.

Show Source

• Array of: object deployedLibrary

{
    "type":"array",
    "description":"List of BML Deployed Util Libraries.",
    "title":"BML deployed libraries list",
    "items":{
        "$ref":"#/definitions/deployedLibrary"
    }
}

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 : deployedLibrary

Type: object

Show Source

• description: string
  Title: description

  Description of the library.
• folderName: string
  Title: folderName

  Name of the folder the library is in present.
• isLocked: boolean
  Title: isLocked

  Is this library lock?
• isOverridden: boolean
  Title: isOverridden

  Is this library is overridden?
• isReferred: boolean
  Title: isReferred

  Is this library is using anywhere?
• lastDeployed: string
  Title: lastDeployed

  The last deployed date of the library, in a presentable string format..
• lastModified: string
  Title: lastModified

  The last modified date of the library, in a presentable string format.
• name: string
  Title: name

  Name of the library function.
• referencesUrl: string
  Title: referencesUrl

  Library reference info
• shortSyntax: string
  Title: shortSyntax

  Format of a library function.
• syntax: string
  Title: syntax

  Format of a library function.
• variableName: string
  Title: variableName

  This field represents the variableName of the resource.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the library function.",
            "title":"name"
        },
        "variableName":{
            "type":"string",
            "description":"This field represents the variableName of the resource.",
            "title":"variableName"
        },
        "description":{
            "type":"string",
            "description":"Description of the library.",
            "title":"description"
        },
        "folderName":{
            "type":"string",
            "description":"Name of the folder the library is in present.",
            "title":"folderName"
        },
        "lastModified":{
            "type":"string",
            "description":"The last modified date of the library, in a presentable string format.",
            "title":"lastModified"
        },
        "lastDeployed":{
            "type":"string",
            "description":"The last deployed date of the library, in a presentable string format..",
            "title":"lastDeployed"
        },
        "syntax":{
            "type":"string",
            "description":"Format of a library function.",
            "title":"syntax"
        },
        "shortSyntax":{
            "type":"string",
            "description":"Format of a library function.",
            "title":"shortSyntax"
        },
        "referencesUrl":{
            "type":"string",
            "description":"Library reference info",
            "title":"referencesUrl"
        },
        "isReferred":{
            "type":"boolean",
            "description":"Is this library is using anywhere?",
            "title":"isReferred"
        },
        "isLocked":{
            "type":"boolean",
            "description":"Is this library lock?",
            "title":"isLocked"
        },
        "isOverridden":{
            "type":"boolean",
            "description":"Is this library is overridden?",
            "title":"isOverridden"
        }
    }
}

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"
}

Back to Top

Examples

The following example shows how to retrieve all (deployed and not deployed) Util Library functions 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/functions

Response Body Sample

{
  "items": [{
      "name": "RecommendationRule_StringArrayAttribute",
      "variableName": "recommendationRule_StringArrayAttribute",
      "description": "This Library Function Return String[]. It is used for returning Recommended Values for a Particular Selection in an Array Attribute.",
      "folderName": "util",
      "lastModified": "2025-09-01T09:26:23.000Z",
      "lastDeployed": "2025-09-01T09:26:23.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/recommendationRule_StringArrayAttribute"
        }
      ],
      "referencesUrl": "/admin/bmllib/list_rules.jsp?id=5769003&folder_id=5751277&process_id=-1&doc_id=-1",
      "isReferred": true,
      "isDeployed": true,
      "isLocked": false,
      "isOverridden": false
    }, {
      "name": "TranslatedLanguage",
      "variableName": "translatedLanguage",
      "description": "Return Transalated Language string based on User's Language.",
      "folderName": "util",
      "lastModified": "2025-09-01T09:26:24.000Z",
      "lastDeployed": "2025-09-01T09:26:24.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/translatedLanguage"
        }
      ],
      "referencesUrl": "/admin/bmllib/list_rules.jsp?id=5769019&folder_id=5751277&process_id=-1&doc_id=-1",
      "isReferred": true,
      "isDeployed": true,
      "isLocked": false,
      "isOverridden": false
    }, {
      "name": "US_States",
      "variableName": "uS_States",
      "description": "This will populate the 'State' fields in commerce if the entry is in abbreviated form.",
      "folderName": "util",
      "lastModified": "2025-09-01T09:26:30.000Z",
      "lastDeployed": "2025-09-01T09:26:30.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/uS_States"
        }
      ],
      "referencesUrl": "/admin/bmllib/list_rules.jsp?id=5791888&folder_id=5751277&process_id=-1&doc_id=-1",
      "isReferred": true,
      "isDeployed": true,
      "isLocked": false,
      "isOverridden": false
    }, {
      "name": "Util BMQL For DataTables",
      "variableName": "utilBMQLForDataTables",
      "folderName": "util",
      "lastModified": "2025-09-01T09:26:35.000Z",
      "lastDeployed": "2025-09-01T09:26:35.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/utilBMQLForDataTables"
        }
      ],
      "referencesUrl": "/admin/bmllib/list_rules.jsp?id=8325299&folder_id=5751277&process_id=-1&doc_id=-1",
      "isReferred": true,
      "isDeployed": true,
      "isLocked": false,
      "isOverridden": false
    }, {
      "name": "ConcatenatedStrings",
      "variableName": "concatenatedStrings",
      "description": "This function return a string. The 2 parameters are concatenated and returned to the calling function.",
      "folderName": "util",
      "lastModified": "2025-09-01T09:26:15.000Z",
      "lastDeployed": "2025-09-01T09:26:15.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/concatenatedStrings"
        }
      ],
      "referencesUrl": "/admin/bmllib/list_rules.jsp?id=8343195&folder_id=5751277&process_id=-1&doc_id=-1",
      "isReferred": true,
      "isDeployed": true,
      "isLocked": false,
      "isOverridden": false
    }, {
      "name": "Migration",
      "variableName": "migration",
      "folderName": "util",
      "lastModified": "2025-09-01T09:26:37.000Z",
      "lastDeployed": "2025-09-01T09:26:37.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/migration"
        }
      ],
      "referencesUrl": "/admin/bmllib/list_rules.jsp?id=12075830&folder_id=5751277&process_id=-1&doc_id=-1",
      "isReferred": false,
      "isDeployed": true,
      "isLocked": false,
      "isOverridden": false
    }, {
      "name": "ConcatString",
      "variableName": "concatString",
      "folderName": "util",
      "lastModified": "2025-09-03T12:31:34.000Z",
      "lastDeployed": "2025-09-03T12:31:42.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/concatString"
        }
      ],
      "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3024451704&folder_id=5751277&process_id=-1&doc_id=-1",
      "isReferred": false,
      "isDeployed": true,
      "isLocked": false,
      "isOverridden": false
    }, {
      "name": "ConcatString",
      "variableName": "concatString",
      "folderName": "nameSpace11",
      "namespace": "nameSpace11",
      "lastModified": "2025-09-03T12:39:05.000Z",
      "lastDeployed": "2025-09-03T12:39:06.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/nameSpace11.concatString"
        }
      ],
      "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3024451728&folder_id=3024451726&process_id=-1&doc_id=-1",
      "isReferred": false,
      "isDeployed": true,
      "isLocked": false,
      "isOverridden": false
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 76,
  "hasMore": false,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/cpq/rest/v19/bml/common/functions"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/cpq/rest/v19/bml/common/functions?offset=0&limit=1000"
    }
  ]
}

Back to Top