BML Util Library REST APIs

The BML Util Library REST APIs aid administrators in the creation and maintenance of BML Util Library functions.

Oracle CPQ 25D introduces the following BML Util Library endpoints:

Get All BML Common Functions

Use this endpoint to retrieve a list of all BML common functions.

• Endpoint:  /rest/v19/bml/common/functions
• Method:  GET

Get a BML Common Function

Use this endpoint to retrieve the specified BML common function.

• Endpoint:  /rest/v19/bml/common/functions/{functionVarName}
• Method:  GET

Lookups

Get All BML Lookups

Use this endpoint to retrieve all BML lookup types.

• Endpoint:  /rest/v19/bml/lookups
• Method:  GET

Get a BML Lookup

Use this endpoint to retrieve the specified BML lookup type.

• Endpoint:  /rest/v19/bml/lookups/{lookupType}
• Method:  GET

Get All BML Lookup Values

Use this endpoint to retrieve all BML lookup values for the specified lookup type.

• Endpoint:  /rest/v19/bml/lookups/{lookupType}/lookupValues
• Method:  GET

Get All BML Attribute Lookups

Use this endpoint to retrieve all BML attribute lookup types.

• Endpoint:  /rest/v19/bml/attributeLookups
• Method:  GET

Get a BML Attribute Lookup

Use this endpoint to retrieve the specified BML attribute lookup type.

• Endpoint:  /rest/v19/bml/attributeLookups/{lookupType}
• Method:  GET

Get All BML Attribute Lookup Values

Use this endpoint to retrieve all BML attribute lookup values for the specified lookup type.

• Endpoint:  /rest/v19/bml/attributeLookups/{lookupType}/lookupValues
• Method:  GET

Library Functions

Get All Deployed Util Library Functions

Use this endpoint to retrieve all deployed Util Library functions.

• Endpoint:  /rest/v19/bml/deployed/library/functions
• Method:  GET

Get All Util Library Functions

Use this endpoint to retrieve all (deployed and not deployed) Util Library functions.

• Endpoint:  /rest/v19/bml/library/functions
• Method:  GET

Get a Util Library Function

Use this endpoint to retrieve the specified Util Library function details.

• Endpoint:  /rest/v19/bml/library/functions/{namespace.varName}
• Method:  GET

Get Dependent Attributes of Util Library Functions

Use this endpoint to retrieve all attributes which are referenced in the specified libraries.

• Endpoint:  /rest/v19/bml/library/functions/actions/dependentAttributes
• Method:  POST

Create a Util Library Function

Use this endpoint to create a new Util Library function.

• Endpoint:  /rest/v19/bml/library/functions
• Method:  POST

Delete Util Library Functions

Use this endpoint to delete the selected Util Library functions.

• Endpoint:  /rest/v19/bml/library/functions/actions/delete
• Method:  POST

Delete a Util Library Function

Use this endpoint to delete the specified Util Library function.

• Endpoint:  /rest/v19/bml/library/functions/{namespace.varName}
• Method:  DELETE

Update a Util Library Function

Use this endpoint to update the specified Util Library function.

• Endpoint:  /rest/v19/bml/library/functions/{namespace.varName}
• Method:  PATCH

Override a Util Library Function

Use this endpoint to create or update the specified Util Library function.

• Endpoint: /rest/v19/bml/library/functions/{namespace.varName}/actions/override
• Method:  POST

Remove Override Util Library Function

Use this endpoint to remove an override from the specified Util Library function.

• Endpoint:  /rest/v19/bml/library/functions/{namespace.varName}/actions/removeOverride
• Method:  POST

Debug Util Library Function

Use this endpoint to run the Util Library function with provided input values.

• Endpoint:  /rest/v19/bml/library/functions/actions/debug
• Method:  POST

Validate Util Library Function

Use this endpoint to validate the Util Library function.

• Endpoint:  /rest/v19/bml/library/functions/actions/validate
• Method:  POST

Deploy Util Library Functions

Use this endpoint to deploy the specified Util Library functions.

• Endpoint:  /rest/v19/bml/library/functions/actions/deploy
• Method:  POST

Export Util Library Functions

Use this endpoint to export the specified Util Library functions.

• Endpoint:  /rest/v19/bml/library/functions/actions/export
• Method:  POST

Get Util Library Folders

Use this endpoint to retrieve all the available Util Library folders.

• Endpoint:  /rest/v19/bml/library/folders
• Method:  GET

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.