Jump to

• Request
• Response
• Examples

Get All Deployed Util Library Functions

get

/rest/v19/bml/deployed/library/functions

This operation returns all deployed 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.

Back to Top

Response

Supported Media Types

• application/json

Default Response

All BML Util Deployed 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 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/deployed/library/functions

Response Body Sample

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

Back to Top