BML Util Library REST API

Overview

The BML Util Library Functions REST API services support BML common functions, BML Lookups, and BML Library functions and folders.

Administration

Util Library Functions

Get All Deployed Util Library Functions

Get All Deployed Util Library Functions
Description	Use this endpoint to retrieve all deployed Util Library functions.
URI Endpoint	/rest/v19/bml/deployed/library/functions
Endpoint Query Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. excludeLinks - Exclude links from the response. fields - A list of fields to be returned.
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing all deployed Util Library functions.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/deployed/library/functions

Sample Response Body

{ "items": [{ "name": "Approver Selection UTIL", "variableName": "approverSelection_UTIL", "description": "Advanced approver selection calls this UTIL function. The 'Child Reason' in Submit Testbed action has 2 parallel approver nodes. The first node uses 'Advanced approver selection' and calls this function.", "folderName": "util", "lastModified": "2025-09-01T09:26:39.000Z", "lastDeployed": "2025-09-01T09:26:39.000Z", "syntax": "String approverSelection_UTIL(String Approvers_List)", "shortSyntax": "util.approverSelection_UTIL(Approvers_List)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=15248341&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": 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", "syntax": "String concatString(String stringOne, String stringTwo)", "shortSyntax": "util.concatString(stringOne, stringTwo)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3024451704&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": false, "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", "syntax": "String concatString(String stringOne, String stringTwo)", "shortSyntax": "util._nameSpace11.concatString(stringOne, stringTwo)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3024451728&folder_id=3024451726&process_id=-1&doc_id=-1", "isReferred": false, "isLocked": false, "isOverridden": false }, { "name": "ConcatString11", "variableName": "concatString11", "folderName": "util", "lastModified": "2025-09-03T12:22:26.000Z", "lastDeployed": "2025-09-03T12:30:18.000Z", "syntax": "String concatString11(String stringOne, String stringTwo)", "shortSyntax": "util.concatString11(stringOne, stringTwo)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3024451675&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": false, "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", "syntax": "String concatenatedStrings(String stringOne, String stringTwo)", "shortSyntax": "util.concatenatedStrings(stringOne, stringTwo)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=8343195&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": true, "isLocked": false, "isOverridden": false }, { "name": "Convert BOM", "variableName": "convertBOMUtil", "folderName": "util", "lastModified": "2025-09-01T09:26:58.000Z", "lastDeployed": "2025-09-01T09:26:58.000Z", "syntax": "Json convertBOMUtil(Json inputBOM, String convertTo)", "shortSyntax": "util.convertBOMUtil(inputBOM, convertTo)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3022077488&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": true, "isLocked": false, "isOverridden": false }, { "name": "Create Advanced BOM Item", "variableName": "createAdvancedBOMItem", "description": "Takes input parameters and creates a single BOM item JSON to be used in Advanced BOM Mapping rules.\n\n\"category\" and \"ItemType\" are set by default to \"sales\" and \"Standard Item\" respectively.\n\nOther fields not referenced (manufacturing, configurablePrice, etc) or overrides for category/ItemType must be declared separately.", "folderName": "util", "lastModified": "2025-09-01T09:26:58.000Z", "lastDeployed": "2025-09-01T09:26:58.000Z", "syntax": "Json createAdvancedBOMItem(String variableName, String partNumber, Integer quantity, Boolean isModel, String ItemId, Integer SequenceNum)", "shortSyntax": "util.createAdvancedBOMItem(variableName, partNumber, quantity, isModel, ItemId, SequenceNum)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3022041743&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": true, "isLocked": false, "isOverridden": false }, { "name": "DN Sample Setup: Mass Clone Quote", "variableName": "cpd_dn_sampleSetup_massCloneQuote", "folderName": "util", "lastModified": "2025-09-01T09:26:55.000Z", "lastDeployed": "2025-09-01T09:26:55.000Z", "syntax": "String cpd_dn_sampleSetup_massCloneQuote(Integer count_of_copies, Integer bs_id)", "shortSyntax": "util.cpd_dn_sampleSetup_massCloneQuote(count_of_copies, bs_id)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3021859404&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": true, "isLocked": false, "isOverridden": false }, { "name": "DN Sample Setup: Mass Update", "variableName": "cpq_dn_sampleSetup_massUpdate", "folderName": "util", "lastModified": "2025-09-01T09:26:56.000Z", "lastDeployed": "2025-09-01T09:26:56.000Z", "syntax": "String cpq_dn_sampleSetup_massUpdate()", "shortSyntax": "util.cpq_dn_sampleSetup_massUpdate()", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3021859425&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": false, "isLocked": false, "isOverridden": false }, { "name": "DN Sample Setup: _update a quote", "variableName": "cpq_dn_sampleSetup_updateAQuote", "folderName": "util", "lastModified": "2025-09-01T09:26:55.000Z", "lastDeployed": "2025-09-01T09:26:56.000Z", "syntax": "String cpq_dn_sampleSetup_updateAQuote(Integer bs_id, String[] commerceAttrVarnames, String[] commerceAttrValues)", "shortSyntax": "util.cpq_dn_sampleSetup_updateAQuote(bs_id, commerceAttrVarnames, commerceAttrValues)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3021859414&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": true, "isLocked": false, "isOverridden": false }, { "name": "DN Sample Setup:_invokeBmRestService", "variableName": "cpq_dn_sampleSetup_invokeBmRestService", "folderName": "util", "lastModified": "2025-09-01T09:26:54.000Z", "lastDeployed": "2025-09-01T09:26:55.000Z", "syntax": "Json cpq_dn_sampleSetup_invokeBmRestService(String relativeUrl, String restAction, String payload)", "shortSyntax": "util.cpq_dn_sampleSetup_invokeBmRestService(relativeUrl, restAction, payload)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3021859394&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": true, "isLocked": false, "isOverridden": false }, { "name": "Data Types: Boolean", "variableName": "dataTypesBoolean", "folderName": "util", "lastModified": "2025-09-01T09:26:18.000Z", "lastDeployed": "2025-09-01T09:26:18.000Z", "syntax": "Boolean dataTypesBoolean(Boolean input)", "shortSyntax": "util.dataTypesBoolean(input)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=17931179&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": true, "isLocked": false, "isOverridden": false }, { "name": "Data Types: Boolean 1D Array", "variableName": "dataTypesBoolean1DArray", "folderName": "util", "lastModified": "2025-09-01T09:26:25.000Z", "lastDeployed": "2025-09-01T09:26:25.000Z", "syntax": "Boolean[] dataTypesBoolean1DArray(Boolean[] input)", "shortSyntax": "util.dataTypesBoolean1DArray(input)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=17931199&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": true, "isLocked": false, "isOverridden": false }, { "name": "Data Types: Boolean 2D Array", "variableName": "dataTypesBoolean2DArray", "folderName": "util", "lastModified": "2025-09-01T09:26:28.000Z", "lastDeployed": "2025-09-01T09:26:28.000Z", "syntax": "Boolean[][] dataTypesBoolean2DArray(Boolean[][] input)", "shortSyntax": "util.dataTypesBoolean2DArray(input)", "referencesUrl": "/admin/bmllib/list_rules.jsp?id=17931219&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": true, "isLocked": false, "isOverridden": false } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/deployed/library/functions" } ] }

Get All Util Library Functions

Get All Util Library Functions
Description	Use this endpoint to retrieve all (deployed and not deployed) Util Library functions.
URI Endpoint	/rest/v19/bml/library/functions
Endpoint Query Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. excludeLinks - Exclude links from the response. fields - A list of fields to be returned. limit – Specifies the pagination size to limit the number of elements the collection returns at a maximum. offset – The offset of the page. By default, offset is 0, which means first page will be returned. orderby - Specifies a comma-separated list of fields to order the response by. totalResults - Specifies that the total count of records that should be included in the response when doing pagination. Only effective when limit or offset are specified.
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing all Util Library functions.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/functions

Sample Response Body

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

Get a Util Library Function

Get a Util Library Function
Description	Use this endpoint to retrieve the specified Util Library function details.
URI Endpoint	/rest/v19`/bml/library/functions/{varName}` or /rest/v19`/bml/library/functions/{namespace.varName}`
Endpoint Parameters	varName	The variable name of the function. This parameter is applicable for library functions in the Util Folder.
	namespace.varName	The variable name of the function with name space This parameter is applicable only for namespaced library where the original function has been overridden. To retrieve the override function, pass the overridden values as `override = true`.
	This endpoint supports the following query specifications. For more information, see Manage Collections. excludeLinks - Exclude links from the response. fields - A list of fields to be returned. override -(boolean value) Is override function? true or false.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the specified Util Library function details.

URI Endpoint Sample

Example when function is in the Util Library Folder:

https://site.oracle.com/rest/v19/bml/library/functions/concatString

Example for name spaced library where the original function is overridden:

https://site.oracle.com/rest/v19/bml/library/functions/nameSpace11.concatString?overriden=true

Sample Response Body

{ "name": "ConcatString", "variableName": "concatString", "description": "This function return a string. The 2 parameters are concatenated and returned to the calling function.", "folderName": "util", "scriptText": "return stringOne + \" \" + stringTwo;", "useTestScript": false, "returnType": { "value": 1, "displayValue": "String" }, "parameters": [{ "name": "stringOne", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "stringTwo", "dataType": { "value": 2, "displayValue": "String" } } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/concatString" } ], "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3024451356&folder_id=5751277&process_id=-1&doc_id=-1", "isReferred": false, "isLocked": false, "isOverridden": false }

Get Dependent Attributes of Util Library Function

Get Dependent Attributes of Util Library Function
Description	Use this endpoint to retrieve all attributes which are referenced in the specified libraries.
URI Endpoint	/rest/v19/bml/library/functions/actions/dependentAttributes
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	namespace	The name of the library folder
	type	The library function type either util or commerce
	varName	The variable name of the libaray function
Response Body Parameters	JSON data containing all attributes which are referenced in the specified libraries.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/functions/actions/dependentAttributes

Sample Request Body

{ "libraryFunctions": [{ "variableName": "concatString" } ] }

Sample Response Body

{ "items": [{ "name": "_user_type", "description": "Current User's Type", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_user_first_name", "description": "Current User's First Name", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_user_language_preference", "description": "Current User's Language Preference", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_company_name", "description": "Current User's Company Name", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_supplier_company_name", "description": "Supplier's Company Name", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_user_login", "description": "Current User's Login", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_user_currency_preference", "description": "Current User's Currency Pref", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_user_session_id", "description": "Current User's Session Id", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_user_group", "description": "Current User's Groups", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_user_number_format", "description": "Current User's Number Format", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_user_partner_session_Id", "description": "Current User's Partner Session Id", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "_user_timezone", "description": "Current User's Time Zone", "dataType": { "value": 2, "displayValue": "String" } } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/actions/dependentAttributes" } ] }

Create a Util Library Function

Create a Util Library Function
Description	Use this endpoint to create a new Util Library function.
URI Endpoint	/rest/v19/bml/library/functions
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	name	(string)The name of the library function
	varName	(string) The variable name of the resource
	description	(string) The usage and description about the library function
	returnType	(array) Parameter data type
	parameters	(array) The parameters list to add into library
	libraryFunctions	(array) The library functions list to add into library
	attributes	(array) The library attributes list to add into library
	testScript	(string) Debbuger test script
	scriptText	(string) Code functionality of the library function
	usetestScript	(string) Sample test script
Response Body Parameters	JSON data for the Util library function.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/functions

Sample Request Body

{ "name": "ConcatString", "variableName": "concatString", "description": "This function return a string. The 2 parameters are concatenated and returned to the calling function.", "returnType": { "value": 1 }, "attributes": [], "parameters": [{ "dataType": { "value": 2 }, "name": "stringOne" }, { "dataType": { "value": 2 }, "name": "stringTwo" } ], "libraryFunctions": [], "scriptText": "return stringOne + \" \" + stringTwo;" }

Sample Response Body

Delete Util Libarary Functions

Delete Util Library Functions
Description	Use this endpoint to delete a single or multiple specified Util Library function(s).
URI Endpoint	/rest/v19/bml/library/functions/actions/delete
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	object	(array) The library functions list to add into library
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/functions/actions/delete

Sample Request Body

{ "items": [ { "variableName": "concatString" }, { "variableName": "concatString", "namespace": "nameSpace11" } ] }

Delete a Util Library Function

Delete a Util Library Function
Description	Use this endpoint to delete the specified Util Library function.
URI Endpoint	/rest/v19/bml/library/functions/{namespace.varName}
Endpoint Parameters	namespace.varName	The variable name with name space
HTTP Method	DELETE
Request Body Parameters	None
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/functions/concatString

Update a Util Library Function

Update a Util Library Function
Description	Use this endpoint to update the specified Util Library function.
URI Endpoint	/rest/v19`/bml/library/functions/{varName}` or /rest/v19`/bml/library/functions/{namespace.varName}`
Endpoint Parameters	varName	The variable name of the function. This parameter is applicable for library functions in the Util Folder.
Endpoint Parameters	namespace.varName	The name of the lookup to fetch. This parameter is applicable only for namespaced library.
HTTP Method	PATCH
Request Body Parameters	name	(string)The name of the library function
	varName	(string) The variable name of the resource
	description	(string) The usage and description about the library function
	returnType	(array) Parameter data type
	parameters	(array) The parameters list to add into library
	libraryFunctions	(array) The library functions list to add into library
	attributes	(array) The library attributes list to add into library
	testScript	(string) Debbuger test script
	scriptText	(string) Code functionality of the library function
	usetestScript	(string) Sample test script
Response Body Parameters	JSON data for the specified Util Library function.

URI Endpoint Sample

https://site.oracle.com/rest/v19/bml/library/functions/concatString

Sample Request Body

{ "name": "ConcatString", "variableName": "concatString", "returnType": { "value": 1 }, "attributes": [], "description": "This function return a string. The 2 parameters are concatenated and returned to the calling function.", "libraryFunctions": [], "parameters": [{ "dataType": { "value": 2 }, "name": "stringOne" }, { "dataType": { "value": 2 }, "name": "stringTwo" } ], "scriptText": "return stringOne + \" \" + stringTwo;", "useTestScript": false }

Sample Response Body

Override a Util Library Function

Override a Util Library Function
Description	Use this endpoint to create or update the override for the specified Util Library function.
URI Endpoint	/rest/v19`/bml/library/functions/{namespace.varName}`/actions/override
Endpoint Parameters	namespace.varName	The name of the lookup to fetch. This parameter is applicable only for namespaced library.
HTTP Method	POST
Request Body Parameters	name	(string)The name of the library function
	varName	(string) The variable name of the resource
	description	(string) The usage and description about the library function
	returnType	(array) Parameter data type
	parameters	(array) The parameters list to add into library
	libraryFunctions	(array) The library functions list to add into library
	attributes	(array) The library attributes list to add into library
	testScript	(string) Debbuger test script
	scriptText	(string) Code functionality of the library function
	usetestScript	(string) Sample test script
Response Body Parameters	JSON data for the Util Library function override.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/functions/nameSpace11.concatString/actions/override

Sample Request Body

{ "scriptText": "return stringOne + \" \" + stringTwo;" }

Sample Response Body

{ "name": "ConcatString", "variableName": "concatString", "folderName": "nameSpace11", "scriptText": "return stringOne + \" \" + stringTwo;", "useTestScript": false, "namespace": "nameSpace11", "returnType": { "value": 1, "displayValue": "String" }, "parameters": [{ "name": "stringOne", "dataType": { "value": 2, "displayValue": "String" } }, { "name": "stringTwo", "dataType": { "value": 2, "displayValue": "String" } } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/nameSpace11.concatString" } ], "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3024451554&folder_id=3024451552&process_id=-1&doc_id=-1", "isReferred": false, "isLocked": false, "isOverridden": true }

Remove Override Util Library Function

Remove Override Util Library Function
Description	Use this endpoint to remove an override from the specified Util Library function.
URI Endpoint	/rest/v19/bml/library/functions/{namespace.varName}/actions/removeOverride
Endpoint Parameters	namespace.varName	The name of the lookup to fetch.
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	None
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/functions/nameSpace11.concatString/actions/removeOverride

Debug Util Library Function

Debug Util Library Function
Description	Use this endpoint to run the Util Library function with provided input values.
URI Endpoint	/rest/v19/bml/library/functions/actions/debug
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	name	(string)The name of the library function
	varName	(string) The variable name of the resource
	description	(string) The usage and description about the library function
	returnType	(array) Parameter data type
	parameters	(array) The parameters list to add into library
	libraryFunctions	(array) The library functions list to add into library
	attributes	(array) The library attributes list to add into library
	testScript	(string) Debbuger test script
	scriptText	(string) Code functionality of the library function
	usetestScript	(string) Sample test script
Resonse Body Parameters	returnData	(string)Specifies the script data
Resonse Body Parameters	scriptSize	(string)Specifies the compliled script size

URI Endpoint Sample

https://site.oracle.com/rest/v19/bml/library/funtions/actions/debug

Sample Request Body

{ "returnType": { "value": 1 }, "namespace": "nameSpace11", "attributes": [], "name": "ConcatString", "libraryFunctions": [], "parameters": [ { "dataType": { "value": 2 }, "name": "stringOne", "value": "Debuging" }, { "dataType": { "value": 2 }, "name": "stringTwo", "value": "Script" } ], "scriptText": "return stringOne + \" \" + stringTwo;", "variableName": "concatString", "useTestScript": false }

Sample Response Body

{ "returnData": "Debuging Script", "scriptSize": "*** Compiled script size: 85 bytes ***" }

Validate Util Library Function

Validate Util Library Function
Description	Use this endpoint to validate the Util Library function.
URI Endpoint	/rest/v19/bml/library/functions/actions/validate
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	name	(string)The name of the library function
	varName	(string) The variable name of the resource
	description	(string) The usage and description about the library function
	returnType	(array) Parameter data type
	parameters	(array) The parameters list to add into library
	libraryFunctions	(array) The library functions list to add into library
	attributes	(array) The library attributes list to add into library
	testScript	(string) Debbuger test script
	scriptText	(string) Code functionality of the library function
	usetestScript	(string) Sample test script
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/functions/actions/validate

Sample Request Body

{ "variableName": "concatString", "returnType": { "value": 1 }, "attributes": [], "description": "This function return a string. The 2 parameters are concatenated and returned to the calling function.", "name": "ConcatString", "libraryFunctions": [], "parameters": [{ "dataType": { "value": 2 }, "name": "stringOne" }, { "dataType": { "value": 2 }, "name": "stringTwo" } ], "scriptText": "return stringOne + \" \" + stringTwo;", "useTestScript": false }

Deploy Util Library Functions

Deploy Util Library Functions
Description	Use this endpoint to deploy the specified Util Library functions.
URI Endpoint	/rest/v19/bml/library/functions/actions/deploy
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	namespace	(string)The name of the library folder
	varName	(string) The variable name of the library function
	type	(string) The function library type either util or commerce
Success Response	204

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/functions/actions/deploy

Sample Request Body

{ "items": [{ "variableName": "concatString" } ] }

Export Util Library Functions

Export Util Library Functions
Description	Use this endpoint to export the specified Util Library functions.
URI Endpoint	/rest/v19/bml/library/functions/actions/export
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	namespace	(string)The name of the library folder
	varName	(string) The variable name of the library function
	type	(string) The function library type either util or commerce
Request Body Parameters	taskId	The task Id for the export task. For more information about retrieving tasks, refer to Task REST APIs.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/functions/actions/export

Sample Request Body

{ "items": [{ "variableName": "concatString" }, { "variableName": "concatString", "namespace": "nameSpace11" } ] }

Sample Response Body

{ "taskId": 3024451712, "links": [{ "rel": "related", "href": "https://sitename.oracle.com/cpq/rest/v19/tasks/3024451712" } ] }

Get Util Library Folders

Get All Util Library Folders
Description	Use this endpoint to retrieve all the available Util Library folders.
URI Endpoint	/rest/v19/bml/library/folders
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	namespace	(string) The name of the library folder
	type	(string) The library function type either util or commerce
	varName	(string) The variable name of the library function
Response Body Parameters	JSON data containing all Util Library folders.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/library/folders

Sample Response Body

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

BML Common Functions

Get All BML Common Functions

Get All BML Common Functions
Description	Use this endpoint to retrieve a list of all BML common functions. BML common functions are the functions used within BML such as `atoi()` or `len()`.
URI Endpoint	/rest/v19/bml/common/functions
Endpoint Query Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. excludeLinks - Exclude links from the response. fields - A list of fields to be returned.
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing the BML Common Functions.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/common/functions

Sample Response Body

{ "items": [ { "name": "atof", "category": "STRING", "description": "Converts text that represents a number into a float number", "syntax": "Float atof(String str)", "example": "1. atof(\"\") throws an exception.", "shortSyntax": "atof(str)", "links": [ { "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/common/functions/atof" } ] }, { "name": "atoi", "category": "STRING", "description": "Converts text that represents a number into an integer number", "syntax": "Integer atoi(String str)", "example": "1. atoi(\"\") throws an exception.", "shortSyntax": "atoi(str)", "links": [ { "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/common/functions/atoi" } ] }, { "name": "decodebase64", "category": "STRING", "description": "Takes an encoded Base64 string and returns it as a plain text string.", "syntax": "String decodebase64(String str)", "example": "1. This function parses the string parameter which has been encoded into a Base64 format and decodes it into plain text string. Example: decodebase64(\"YWJj\"); will return the plain text format of String \"abc\".", "shortSyntax": "decodebase64(str)", "links": [ { "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/common/functions/decodebase64" } ] }, { "name": "encodebase64", "category": "STRING", "description": "Takes a string and returns it as a Base64 encoded string.", "syntax": "String encodebase64(String str)", "example": "1. This function parses the string parameter and converts it into its Base64 equivalent. Example: encodebase64(\"abc\"); will return the Base64 format of String \"abc\".", "shortSyntax": "encodebase64(str)", "links": [ { "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/common/functions/encodebase64" } ] }, { "name": "endswith", "category": "STRING", "description": "Checks whether a string ends with a provided substring", "syntax": "Boolean endswith(String str, String substring)", "example": "1. This function is case-sensitive. 2. If string ends with provided substring, the function returns true, false if not", "shortSyntax": "endswith(str, substring)", "links": [ { "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/common/functions/endswith" } ] } ], "links": [ { "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19bml/common/functions" } ] }

Get a BML Common Function

Get a BML Common Function
Description	Use this endpoint to retrieve the specified BML common function. BML common functions are the functions used within BML such as `atoi()` or `len()`.
URI Endpoint	/rest/v19/bml/common/functions/{functionVarName}
Endpoint Parameters	functionVarName	The name of the common library function to fetch
Endpoint Parameters	This endpoint supports the following query specification. For more information, see Manage Collections. excludeLinks - Exclude links from the response.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the specified BML common library function.

URI Endpoint Sample

https://site.oracle.com/rest/v19/bml/common/functions/atof

Sample Response Body

{ "name": "atof", "category": "STRING", "description": "Converts text that represents a number into a float number", "syntax": "Float atof(String str)", "example": "1. atof(\"\") throws an exception.", "shortSyntax": "atof(str)", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/common/functions/atof" } ] }

BML Lookups

Get All BML Lookups

Get All BML Lookups
Description	Use this endpoint to retrieve all BML lookup types.
URI Endpoint	/rest/v19/bml/lookups
Endpoint Parameters	This endpoint supports the following query specification. For more information, see Manage Collections. excludeLinks - Exclude links from the response.
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for all BML lookup types.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/lookups

Sample Response Body

{ "items": [{ "lookupType": "functionCategory", "displayLabel": "Function Category", "description": "BML Function Categories", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionCategory" }, { "rel": "child", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionCategory/lookupValues" } ] }, { "lookupType": "functionParamDataTypes", "displayLabel": "Function Param Data Types", "description": "BML Function Parameter types", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionParamDataTypes" }, { "rel": "child", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionParamDataTypes/lookupValues" } ] }, { "lookupType": "functionReturnTypes", "displayLabel": "Function Return Type", "description": "BML function return types", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionReturnTypes" }, { "rel": "child", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionReturnTypes/lookupValues" } ] }, { "lookupType": "operators", "displayLabel": "Operators", "description": "BML Operators", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/operators" }, { "rel": "child", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/operators/lookupValues" } ] } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups" } ] }

Get a BML Lookup

Get a BML Lookup
Description	Use this endpoint to retrieve the specified BML lookup type.
URI Endpoint	/rest/v19/bml/lookups/{lookupType}
Endpoint Parameters	lookupType	The name of the lookup to fetch
Endpoint Parameters	This endpoint supports the following query specification. For more information, see Manage Collections. excludeLinks - Exclude links from the response.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the specified BML lookup type.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/lookups/functionCategory

Sample Response Body

{ "lookupType": "functionCategory", "displayLabel": "Function Category", "description": "BML Function Categories", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionCategory" }, { "rel": "parent", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups" }, { "rel": "child", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionCategory/lookupValues" } ] }

Get All BML Lookup Values

Get All BML Lookup Values
Description	Use this endpoint to retrieve all BML lookup values for the specified lookup type.
URI Endpoint	/rest/v19/bml/lookups/{lookupType}/lookupValues
Endpoint Parameters	lookupType	The name of the lookup type to fetch lookup values
Endpoint Parameters	This endpoint supports the following query specification. For more information, see Manage Collections. excludeLinks - Exclude links from the response.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for all BML lookup values for the specified BML lookup type.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/lookups/functionCategory/lookupValues

Sample Response Body

{ "items": [{ "lookupCode": "ALL", "displayLabel": "All Functions" }, { "lookupCode": "MATH", "displayLabel": "Math" }, { "lookupCode": "URL", "displayLabel": "URL Access" }, { "lookupCode": "ARRAY", "displayLabel": "Array" }, { "lookupCode": "JSON", "displayLabel": "Json" }, { "lookupCode": "DIRECT_DB_ACCESS", "displayLabel": "Direct DB Access" }, { "lookupCode": "XML", "displayLabel": "XML" }, { "lookupCode": "LOGICAL", "displayLabel": "Conditional" }, { "lookupCode": "STRING", "displayLabel": "String" }, { "lookupCode": "OTHERS", "displayLabel": "Others" }, { "lookupCode": "DATE", "displayLabel": "Date" }, { "lookupCode": "DICTIONARY", "displayLabel": "Dictionary" } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionCategory/lookupValues" }, { "rel": "parent", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionCategory" } ] }

Get All BML Attribute Lookups

Get All BML Attribute Lookups
Description	Use this endpoint to retrieve all BML attribute lookup types.
URI Endpoint	/rest/v19/bml/attributeLookups
Endpoint Query Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. excludeLinks - Exclude links from the response.
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing all BML attribute lookup types.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/attributeLookups

Sample Response Body

{ "items": [{ "lookupType": "commonVariables", "displayLabel": "Common Variables", "description": "Common Variables", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/attributeLookups/commonVariables" }, { "rel": "child", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/attributeLookups/commonVariables/lookupValues" } ] } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/attributeLookups" } ] }

Get a BML Attribute Lookup

Get a BML Attribute Lookup
Description	Use this endpoint to retrieve the specified BML attribute lookup type.
URI Endpoint	/rest/v19/bml/attributeLookups/{lookupType}
Endpoint Parameters	lookupType	The name of the lookup to fetch
Endpoint Parameters	This endpoint supports the following query specification. For more information, see Manage Collections. excludeLinks - Exclude links from the response.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the specified BML attribute lookup type.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/attributeLookups/commonVariables

Sample Response Body

{ "lookupType": "commonVariables", "displayLabel": "Common Variables", "description": "Common Variables", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/attributeLookups/commonVariables" }, { "rel": "parent", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/attributeLookups" }, { "rel": "child", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/attributeLookups/commonVariables/lookupValues" } ] }

Get All BML Attribute Lookup Values

Get All BML Attribute Lookup Values
Description	Use this endpoint to retrieve all BML attribute lookup values for the specified lookup type.
URI Endpoint	/rest/v19/bml/attributeLookups/{lookupType}/lookupValues
Endpoint Parameters	lookupType	The name of the lookup to fetch
Endpoint Parameters	This endpoint supports the following query specification. For more information, see Manage Collections. excludeLinks - Exclude links from the response.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the BML attribute lookup values for the specified lookup type.

URI Endpoint Sample

https://site.oracle.com/rest/v19/bml/attributeLookups/commonVariables/lookupValues

Sample Response Body

{ "items": [{ "lookupCode": "_user_billing_city", "displayLabel": "Current User's Billing City", "description": "Current User's Billing City", "dataType": { "lookupCode": 2, "displayLabel": "String" } }, { "lookupCode": "_user_shipping_last_name", "displayLabel": "Current User's Shipping Last Name", "description": "Current User's Shipping Last Name", "dataType": { "lookupCode": 2, "displayLabel": "String" } }, { "lookupCode": "_user_shipping_zip", "displayLabel": "Current User's Shipping Zip", "description": "Current User's Shipping Zip", "dataType": { "lookupCode": 2, "displayLabel": "String" } } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/cpq/rest/v19/bml/attributeLookups/commonVariables/lookupValues" }, { "rel": "parent",/rest/v19 "href": "https://sitename.oracle.com/cpq/bml/attributeLookups/commonVariables" } ] }

BML Global Search

BML Global Search
Description	Use this endpoint to search BML scripts containing the specified string and retrieve the corresponding script texts and their locations.
URI Endpoint	/rest/v19/bml/scripts
Endpoint Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. excludeLinks - Exclude links from the response. fields - A list of fields to be returned. limit – Specifies the pagination size to limit the number of elements the collection returns at a maximum. offset – The offset of the page. By default, offset is 0, which means first page will be returned. orderby - Specifies a comma-separated list of fields to order the response by. totalResults - Specifies that the total count of records that should be included in the response when doing pagination. Only effective when limit or offset are specified.
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the corresponding script texts and locations containing the specified BML string.

URI Endpoint Sample

https://sitename.oracle.com/rest/v19/bml/scripts?q={'scriptText':{$contains:'counter', $options:"I"}}&orderby=dateAdded:DESC,dateModified&excludeLinks=self

Sample Response Body

{ "items": [{ "scriptText": "recordset = bmql(\"SELECT Part, RAM FROM RAM\");\nquantity = 0;\ncounter = 0;\nret = \"\";\n\npartDict = dict(\"string\");\nfor record in recordset{\n\tput(partDict, get(record, \"RAM\"), get(record, \"Part\"));\n}\nquantityArray = integer[];\nfor each in ram_advArray{\n\tquantityArray[counter] = atoi(substring(each, 0, 1));\n\tcounter = counter + 1;\n}\ncounter = 0;\nfor each in memory_advArray{\n\tret = ret + get(partDict, each) + \"~\" + string(quantityArray[counter]) + \"~RAM~~\" + \"|^|\";\n\tcounter = counter + 1;\n}\nreturn ret;", "path": "Configuration Recommended Item : allEquipment:vision:servers : Recommended Items Rule (RAM [Hard but Awesome])", "dateAdded": "2025-07-31T08:04:53.000Z", "dateModified": "2025-07-31T08:16:06.000Z" }, { "scriptText": "ret = \"\";\ncounter = 0;\nfor each in sLAPrice_array{\n\tret = ret + \"WR11513~1~SLA Agreement~\" + string(each) + \"~\" /*+ string(counter)*/ + \"|^|\";\n\tcounter = counter + 1;\n}\n\nreturn ret;", "path": "Configuration Recommended Item : allEquipment:vision:servers : Recommended Items Rule (SLA Parts)", "dateAdded": "2025-07-31T08:04:53.000Z", "dateModified": "2025-07-31T08:16:06.000Z" } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/bml/scripts" } ] }

BML Util Library REST API

Overview

Administration

Util Library Functions

BML Common Functions

BML Lookups

BML Global Search

Related Topics