Jump to

• Request
• Response
• Examples

Get All BML Common Functions

get

/rest/v19/bml/common/functions

This operation returns all BML common functions. BML common functions are the functions used within BML such as atoi() or len().

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.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.

Back to Top

Response

Supported Media Types

• application/json

Default Response

All BML Common Functions

Body ()

Root Schema : BML Common Functions

Type: object

Title: BML Common Functions

Common library functions.

Show Source

• items: array BML Common Functions list
  Title: BML Common Functions list

  List of BML Common Functions
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of BML Common Functions",
            "title":"BML Common Functions list",
            "items":{
                "$ref":"#/definitions/bmlCommonFunction"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    },
    "title":"BML Common Functions",
    "description":"Common library functions."
}

Nested Schema : BML Common Functions list

Type: array

Title: BML Common Functions list

List of BML Common Functions

Show Source

• Array of: object bmlCommonFunction

{
    "type":"array",
    "description":"List of BML Common Functions",
    "title":"BML Common Functions list",
    "items":{
        "$ref":"#/definitions/bmlCommonFunction"
    }
}

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

Type: object

Show Source

• category: string
  Title: category

  Return type of the library function.
• description: string
  Title: description

  Description of the library function.
• example: string
  Title: example

  Sample data for a common library function.
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• name: string
  Title: name

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

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

  Format of a library function.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the library function.",
            "title":"name"
        },
        "category":{
            "type":"string",
            "description":"Return type of the library function.",
            "title":"category"
        },
        "description":{
            "type":"string",
            "description":"Description of the library function.",
            "title":"description"
        },
        "syntax":{
            "type":"string",
            "description":"Format of a library function.",
            "title":"syntax"
        },
        "example":{
            "type":"string",
            "description":"Sample data for a common library function.",
            "title":"example"
        },
        "shortSyntax":{
            "type":"string",
            "description":"Format of a library function.",
            "title":"shortSyntax"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    }
}

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 : 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 a list of all BML Common 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/common/functions

Response Body Sample

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

Back to Top