Get a Util Library Function
get
/rest/v19/bml/library/functions/{namespace.variableName}
This operation returns specified Util Library function details.
Request
Path Parameters
-
namespace.variableName(required): string
VariableName with name space.
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.
-
override: boolean
Is overrided function?
Response
Supported Media Types
- application/json
Default Response
Util Library Response.
Root Schema : utilLibrary-response
Type:
Show Source
object-
attributes:
array The library attributes list to add into library
Title:
The library attributes list to add into libraryThe attributes list to add into library. -
description:
string
Title:
descriptionUsage and info about the library function. -
isLocked:
boolean
Title:
isLockedIs this library lock? -
isOverridden:
boolean
Title:
isOverriddenIs this library is overridden? -
isReferred:
boolean
Title:
isReferredIs this library is using anywhere? -
libraryFunctions:
array The library functions list to add into library
Title:
The library functions list to add into libraryThe library functions list to add into library. -
links:
array Links to the related objects
Title:
Links to the related objectsLinks to the related objects -
name:
string
Title:
nameName of the library function. -
parameters:
array The parameters list to add into library
Title:
The parameters list to add into libraryThe parameters list to add into library. -
referencesUrl:
string
Title:
referencesUrlReference info. -
returnType:
object dataType-value
-
scriptText:
string
Title:
scriptTextCode functionality of the library function. -
testScript:
string
Title:
testScriptDebbuger test script. -
useTestScript:
string
Title:
useTestScriptSample test script -
variableName:
string
Title:
variableNameThis field represents the variableName of the resource.
Nested Schema : The library attributes list to add into library
Type:
arrayTitle:
The library attributes list to add into libraryThe attributes list to add into library.
Show Source
Nested Schema : The library functions list to add into library
Type:
arrayTitle:
The library functions list to add into libraryThe library functions list to add into library.
Show Source
Nested Schema : Links to the related objects
Type:
arrayTitle:
Links to the related objectsLinks to the related objects
Show Source
-
Array of:
object referenceLinks
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : The parameters list to add into library
Type:
arrayTitle:
The parameters list to add into libraryThe parameters list to add into library.
Show Source
Nested Schema : dataType-value
Type:
Show Source
object-
displayValue:
string
Title:
displayValueThe library or field data type. -
value:
integer
Title:
valuethe data type representative value.
Nested Schema : libraryFunctions
Type:
Show Source
object-
namespace:
string
Title:
namespaceUtil library floder name. -
type:
string
Title:
typeLibrary function type either util or commerce. -
variableName:
string
Title:
variableNamevariableName of the libaray function.
Nested Schema : referenceLinks
Type:
objectReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related objectURL to the related object -
rel:
string
Title:
Link Relationship to the current objectLink Relationship to the current object
Nested Schema : parametersList
Type:
Show Source
object-
dataType:
object dataType-value
-
name:
string
Title:
nameName of the parameter.
Examples
The following example shows how to retrieve the specified Util Library function details 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/library/functions/concatString
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
}