Jump to

• Request
• Response
• Examples

Get Dependent Attributes of Util Library Function

post

/rest/v19/bml/library/functions/actions/dependentAttributes

This operation returns all attributes which are being referenced in the specified libraries.

Request

Supported Media Types

• application/json

Body ()

Util Libraries.

Root Schema : dependentAttributes-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "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 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 : 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

dependent attributes list.

Body ()

Root Schema : BML util libraries dependent attributes list

Type: object

Title: BML util libraries dependent attributes list

Dependent attributes list.

Show Source

• items: array Util Libraries dependent attributes
  Title: Util Libraries dependent attributes

  List of BML Util Libraries dependent attributes.
• 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 Util Libraries dependent attributes.",
            "title":"Util Libraries dependent attributes",
            "items":{
                "$ref":"#/definitions/dependentAttributes"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    },
    "title":"BML util libraries dependent attributes list",
    "description":"Dependent attributes list."
}

Nested Schema : Util Libraries dependent attributes

Type: array

Title: Util Libraries dependent attributes

List of BML Util Libraries dependent attributes.

Show Source

• Array of: object dependentAttributes

{
    "type":"array",
    "description":"List of BML Util Libraries dependent attributes.",
    "title":"Util Libraries dependent attributes",
    "items":{
        "$ref":"#/definitions/dependentAttributes"
    }
}

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

Type: object

Show Source

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

  Description of the attribute.
• name: string
  Title: name

  Attribute name.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Attribute name.",
            "title":"name"
        },
        "description":{
            "type":"string",
            "description":"Description of the attribute.",
            "title":"description"
        },
        "dataType":{
            "description":"Attribute dataType.",
            "title":"dataType",
            "$ref":"#/definitions/dataType-value"
        }
    }
}

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 : 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 all attributes which are referenced in the specified libraries 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/actions/dependentAttributes

Request Body Sample

{
  "libraryFunctions": [{
      "variableName": "concatString"
    }
  ]
}

Response Body Sample

{
  "items": [{
      "name": "_user_type",
      "description": "Current User's Type",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_user_first_name",
      "description": "Current User's First Name",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_user_language_preference",
      "description": "Current User's Language Preference",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_company_name",
      "description": "Current User's Company Name",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_supplier_company_name",
      "description": "Supplier's Company Name",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_user_login",
      "description": "Current User's Login",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_user_currency_preference",
      "description": "Current User's Currency Pref",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_user_session_id",
      "description": "Current User's Session Id",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_user_group",
      "description": "Current User's Groups",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_user_number_format",
      "description": "Current User's Number Format",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_user_partner_session_Id",
      "description": "Current User's Partner Session Id",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }, {
      "name": "_user_timezone",
      "description": "Current User's Time Zone",
      "dataType": {
        "value": 2,
        "displayValue": "String"
      }
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/cpq/rest/v19/bml/library/functions/actions/dependentAttributes"
    }
  ]
}

Back to Top