Jump to

• Request
• Response
• Examples

Get a BML Common Function

get

/rest/v19/bml/common/functions/{name}

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

Request

Path Parameters

• name(required): string
  Name of the common library function to fetch.

Query Parameters

• excludeLinks: string
  Exclude specified link types.

Back to Top

Response

Supported Media Types

• application/json

Default Response

BML Common Function

Body ()

Root 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 the specified BML common function 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/atof

Response Body Sample

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

Back to Top