Jump to

• Request
• Response
• Examples

BML Global Search

get

/rest/v19/bml/scripts

This endpoint searches BML scripts containing the specified string and retrieves the corresponding script texts and their locations.

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

BML Global Script Search

Body ()

Root Schema : BML global scripts

Type: object

Title: BML global scripts

BML Global Scripts.

Show Source

• count: integer
  Title: count

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

  Is more available?
• items: array List all bml functions.
  Title: List all bml functions.

  List of BML 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 Libraries.",
            "title":"List all bml functions.",
            "items":{
                "$ref":"#/definitions/globalScript"
            }
        },
        "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 global scripts",
    "description":"BML Global Scripts."
}

Nested Schema : List all bml functions.

Type: array

Title: List all bml functions.

List of BML Libraries.

Show Source

• Array of: object globalScript

{
    "type":"array",
    "description":"List of BML Libraries.",
    "title":"List all bml functions.",
    "items":{
        "$ref":"#/definitions/globalScript"
    }
}

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

Type: object

Show Source

• dateAdded: string
  Title: Date created

  Library created date.
• dateModified: string
  Title: date last modified

  Last modification date of library.
• path: string
  Title: path

  Library info of matching script contains.
• scriptText: string
  Title: scriptText

  Code functionality of the library function.

{
    "type":"object",
    "properties":{
        "scriptText":{
            "type":"string",
            "description":"Code functionality of the library function.",
            "title":"scriptText"
        },
        "path":{
            "type":"string",
            "description":"Library info of matching script contains.",
            "title":"path"
        },
        "dateModified":{
            "type":"string",
            "description":"Last modification date of library.",
            "title":"date last modified"
        },
        "dateAdded":{
            "type":"string",
            "description":"Library created date.",
            "title":"Date created"
        }
    }
}

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 search BML scripts containing the specified string and retrieve the corresponding script texts and their locations 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/scripts?q={'scriptText':{$contains:'counter', $options:"I"}}&orderby=dateAdded:DESC,dateModified&excludeLinks=self

Response Body Sample

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

Back to Top