Jump to

• Request
• Response
• Examples

Create Util Library Function

post

/rest/v19/bml/library/functions

This operation creates a new Util Library function.

Request

Supported Media Types

• application/json

Body ()

Create Util Library.

Root Schema : createUtilibrary-request

Type: object

Show Source

• attributes: array The library attributes list to add into library
  Title: The library attributes list to add into library

  The attributes list to add into library.
• description: string
  Title: description

  Usage and info about the library function.
• libraryFunctions: array The library functions list to add into library
  Title: The library functions list to add into library

  The library functions list to add into library.
• name: string
  Title: name

  Name of the library function.
• parameters: array The parameters list to add into library
  Title: The parameters list to add into library

  The parameters list to add into library.
• returnType: object dataType-value
• scriptText: string
  Title: scriptText

  Code functionality of the library function.
• testScript: string
  Title: testScript

  Debbuger test script.
• useTestScript: string
  Title: useTestScript

  Sample test script.
• 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":"Usage and info about the library function.",
            "title":"description"
        },
        "returnType":{
            "description":"Parameter Data Type.",
            "title":"returnType",
            "$ref":"#/definitions/dataType-value"
        },
        "parameters":{
            "type":"array",
            "description":"The parameters list to add into library.",
            "title":"The parameters list to add into library",
            "items":{
                "$ref":"#/definitions/parametersList"
            }
        },
        "libraryFunctions":{
            "type":"array",
            "description":"The library functions list to add into library.",
            "title":"The library functions list to add into library",
            "items":{
                "$ref":"#/definitions/libraryFunctions"
            }
        },
        "attributes":{
            "type":"array",
            "description":"The attributes list to add into library.",
            "title":"The library attributes list to add into library",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"Name of the attribute.",
                        "title":"name"
                    }
                }
            }
        },
        "testScript":{
            "type":"string",
            "description":"Debbuger test script.",
            "title":"testScript"
        },
        "scriptText":{
            "type":"string",
            "description":"Code functionality of the library function.",
            "title":"scriptText"
        },
        "useTestScript":{
            "type":"string",
            "description":"Sample test script.",
            "title":"useTestScript"
        }
    }
}

Nested Schema : The library attributes list to add into library

Type: array

Title: The library attributes list to add into library

The attributes list to add into library.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The attributes list to add into library.",
    "title":"The library attributes list to add into library",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "description":"Name of the attribute.",
                "title":"name"
            }
        }
    }
}

Nested Schema : The library functions list to add into library

Type: array

Title: The library functions list to add into library

The library functions list to add into library.

Show Source

• Array of: object libraryFunctions

{
    "type":"array",
    "description":"The library functions list to add into library.",
    "title":"The library functions list to add into library",
    "items":{
        "$ref":"#/definitions/libraryFunctions"
    }
}

Nested Schema : The parameters list to add into library

Type: array

Title: The parameters list to add into library

The parameters list to add into library.

Show Source

• Array of: object parametersList

{
    "type":"array",
    "description":"The parameters list to add into library.",
    "title":"The parameters list to add into library",
    "items":{
        "$ref":"#/definitions/parametersList"
    }
}

Nested Schema : dataType-value

Type: object

Show Source

• displayValue: string
  Title: displayValue

  The library or field data type.
• value: integer
  Title: value

  the data type representative value.

{
    "type":"object",
    "properties":{
        "displayValue":{
            "type":"string",
            "description":"The library or field data type.",
            "title":"displayValue"
        },
        "value":{
            "type":"integer",
            "description":"the data type representative value.",
            "title":"value"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Title: name

  Name of the attribute.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the attribute.",
            "title":"name"
        }
    }
}

Nested Schema : libraryFunctions

Type: object

Show Source

• namespace: string
  Title: namespace

  Util library floder name.
• type: string
  Title: type

  Library function type either util or commerce.
• variableName: string
  Title: variableName

  variableName of the libaray function.

{
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"variableName of the libaray function.",
            "title":"variableName"
        },
        "type":{
            "type":"string",
            "description":"Library function type either util or commerce.",
            "title":"type"
        },
        "namespace":{
            "type":"string",
            "description":"Util library floder name.",
            "title":"namespace"
        }
    }
}

Nested Schema : parametersList

Type: object

Show Source

• dataType: object dataType-value
• name: string
  Title: name

  Name of the parameter.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the parameter.",
            "title":"name"
        },
        "dataType":{
            "description":"Parameter Data Type.",
            "title":"dataType",
            "$ref":"#/definitions/dataType-value"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Create Util Library Response.

Body ()

Root Schema : utilLibrary-response

Type: object

Show Source

• attributes: array The library attributes list to add into library
  Title: The library attributes list to add into library

  The attributes list to add into library.
• description: string
  Title: description

  Usage and info about the library function.
• 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?
• libraryFunctions: array The library functions list to add into library
  Title: The library functions list to add into library

  The library functions list to add into library.
• 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.
• parameters: array The parameters list to add into library
  Title: The parameters list to add into library

  The parameters list to add into library.
• referencesUrl: string
  Title: referencesUrl

  Reference info.
• returnType: object dataType-value
• scriptText: string
  Title: scriptText

  Code functionality of the library function.
• testScript: string
  Title: testScript

  Debbuger test script.
• useTestScript: string
  Title: useTestScript

  Sample test script
• 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":"Usage and info about the library function.",
            "title":"description"
        },
        "testScript":{
            "type":"string",
            "description":"Debbuger test script.",
            "title":"testScript"
        },
        "scriptText":{
            "type":"string",
            "description":"Code functionality of the library function.",
            "title":"scriptText"
        },
        "useTestScript":{
            "type":"string",
            "description":"Sample test script",
            "title":"useTestScript"
        },
        "returnType":{
            "description":"Parameter Data Type.",
            "title":"returnType",
            "$ref":"#/definitions/dataType-value"
        },
        "parameters":{
            "type":"array",
            "description":"The parameters list to add into library.",
            "title":"The parameters list to add into library",
            "items":{
                "$ref":"#/definitions/parametersList"
            }
        },
        "libraryFunctions":{
            "type":"array",
            "description":"The library functions list to add into library.",
            "title":"The library functions list to add into library",
            "items":{
                "$ref":"#/definitions/libraryFunctions"
            }
        },
        "attributes":{
            "type":"array",
            "description":"The attributes list to add into library.",
            "title":"The library attributes list to add into library",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"Name of the attribute.",
                        "title":"name"
                    }
                }
            }
        },
        "referencesUrl":{
            "type":"string",
            "description":"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"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    }
}

Nested Schema : The library attributes list to add into library

Type: array

Title: The library attributes list to add into library

The attributes list to add into library.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The attributes list to add into library.",
    "title":"The library attributes list to add into library",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "description":"Name of the attribute.",
                "title":"name"
            }
        }
    }
}

Nested Schema : The library functions list to add into library

Type: array

Title: The library functions list to add into library

The library functions list to add into library.

Show Source

• Array of: object libraryFunctions

{
    "type":"array",
    "description":"The library functions list to add into library.",
    "title":"The library functions list to add into library",
    "items":{
        "$ref":"#/definitions/libraryFunctions"
    }
}

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 : The parameters list to add into library

Type: array

Title: The parameters list to add into library

The parameters list to add into library.

Show Source

• Array of: object parametersList

{
    "type":"array",
    "description":"The parameters list to add into library.",
    "title":"The parameters list to add into library",
    "items":{
        "$ref":"#/definitions/parametersList"
    }
}

Nested Schema : dataType-value

Type: object

Show Source

• displayValue: string
  Title: displayValue

  The library or field data type.
• value: integer
  Title: value

  the data type representative value.

{
    "type":"object",
    "properties":{
        "displayValue":{
            "type":"string",
            "description":"The library or field data type.",
            "title":"displayValue"
        },
        "value":{
            "type":"integer",
            "description":"the data type representative value.",
            "title":"value"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Title: name

  Name of the attribute.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the attribute.",
            "title":"name"
        }
    }
}

Nested Schema : libraryFunctions

Type: object

Show Source

• namespace: string
  Title: namespace

  Util library floder name.
• type: string
  Title: type

  Library function type either util or commerce.
• variableName: string
  Title: variableName

  variableName of the libaray function.

{
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"variableName of the libaray function.",
            "title":"variableName"
        },
        "type":{
            "type":"string",
            "description":"Library function type either util or commerce.",
            "title":"type"
        },
        "namespace":{
            "type":"string",
            "description":"Util library floder name.",
            "title":"namespace"
        }
    }
}

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

Nested Schema : parametersList

Type: object

Show Source

• dataType: object dataType-value
• name: string
  Title: name

  Name of the parameter.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the parameter.",
            "title":"name"
        },
        "dataType":{
            "description":"Parameter Data Type.",
            "title":"dataType",
            "$ref":"#/definitions/dataType-value"
        }
    }
}

Back to Top

Examples

The following example shows how to create a new Util Library function by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST  -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/bml/library/functions

Request Body Sample

{
  "name": "ConcatString",
  "variableName": "concatString",
  "description": "This function returns a string. The 2 parameters are concatenated and returned to the calling function.",
  "returnType": {
    "value": 1
  },
  "attributes": [],
  "parameters": [{
      "dataType": {
        "value": 2
      },
      "name": "stringOne"
    }, {
      "dataType": {
        "value": 2
      },
      "name": "stringTwo"
    }
  ],
  "libraryFunctions": [],
  "scriptText": "return stringOne + \" \" + stringTwo;"
}

Response Body Sample

{
  "name": "ConcatString",
  "variableName": "concatString",
  "description": "This function returns a string. The 2 parameters are concatenated and returned to the calling function.",
  "folderName": "util",
  "scriptText": "return stringOne + \" \" + stringTwo;",
  "useTestScript": false,
  "returnType": {
    "value": 1,
    "displayValue": "String"
  },
  "parameters": [{
      "name": "stringOne",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "stringTwo",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/concatString"
    }
  ],
  "referencesUrl": "/admin/bmllib/list_rules.jsp?id=3024451356&folder_id=5751277&process_id=-1&doc_id=-1",
  "isReferred": false,
  "isLocked": false,
  "isOverridden": false
}

Back to Top