REST API Services for Oracle CPQ

Get an Agreement Attribute

get

/rest/v19/pricingSetup/agreementAttributes/{attributeVariableName}

Use this endpoint to retrieve the specified price agreement attribute.

Request

Path Parameters

attributeVariableName(required): string

Query Parameters

expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). More than one child can be specified using comma as a separator. Example: ?expand=mappings. To include all the children and grandchildren, specify the value of this query parameter to be 'all'.
fields: string

This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : PricingAgreementAttribute

Type: object

Show Source

active: boolean()

Title: Active

Indicates whether Agreement Attribute is active.
arrayType: boolean()

Title: Array Type

Indicates whether Pricing Agreement Attribute is an array type.
attributeLevel: string()

Title: Attribute Level

Allowed Values: [ "Header", "Line", "Charge" ]

Pricing Agreement Attribute Level.
attributeLevelCode: integer()

Title: Attribute Level Code

Read Only: true

Attribute level code.
createdBy: Created By

Title: Created By

Read Only: true

The details of the user who created the record.
dataType: string()

Title: Data Type

Allowed Values: [ "Boolean", "Currency", "String", "Decimal", "Date", "Integer", "Text Area" ]

Data Type of the Pricing Agreement Attribute.
dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

Title: Date Added

Read Only: true

Creation date of the Pricing Agreement Attribute.
dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

Title: Date Modified

Read Only: true

Last modified date of the Pricing Agreement Attribute.
description: string()

Title: Description

Description of the Pricing Agreement Attribute.
lastModifiedBy: Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.
links: array Links

Title: Links

Read Only: true

The link relations associated with the resource instance.
lookupType: string()

Title: Lookup Type

The lookup type variable name for the Pricing Agreement Attribute.
lookupTypeLabel: string()

Title: Lookup Type Display Label

Read Only: true

The lookup type display label for the Pricing Agreement Attribute.
mappings: Attribute Mappings

Title: Attribute Mappings

Read Only: true

List of mappings for the Pricing Agreement Attribute.
name: string()

Title: Name

Name of the Pricing Agreement Attribute.
templateVariableKey: string()

Title: Template Variable Key

Read Only: true

Allowed Values: [ "Custom", "AgreementName", "AgreementDescription", "AgreementStartDate", "AgreementEndDate", "AccountID", "Account", "PartNumber", "ServiceDuration", "ServiceDurationPeriod", "ItemContractStartDate", "ItemContractEndDate", "RatePlanNumber", "ProductListPrice", "ProductPriceType", "ProductPricePeriod", "ProductNetPrice", "SourceTransactionId", "ChargeType", "ChargePriceType", "ChargePricePeriod", "ChargeUsageUOM", "ChargeDynamicPricingType", "ChargeDefinitionCode", "ChargeNetPrice", "RateCardStructure", "AgreementStatus", "AgreementNumber" ]

Pricing Agreement Attribute template variable key.
valid: boolean()

Title: Valid

Read Only: true

Indicates whether Pricing Agreement Attribute is valid.
variableName: string()

Title: Variable Name

Variable Name of the Pricing Agreement Attribute.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Pricing Agreement Attribute.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Pricing Agreement Attribute.",
            "title":"Variable Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Pricing Agreement Attribute.",
            "title":"Description"
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Agreement Attribute.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Agreement Attribute.",
            "title":"Date Added",
            "readOnly":true
        },
        "dataType":{
            "type":"string",
            "format":"",
            "description":"Data Type of the Pricing Agreement Attribute.",
            "title":"Data Type",
            "enum":[
                "Boolean",
                "Currency",
                "String",
                "Decimal",
                "Date",
                "Integer",
                "Text Area"
            ]
        },
        "attributeLevel":{
            "type":"string",
            "format":"",
            "description":"Pricing Agreement Attribute Level.",
            "title":"Attribute Level",
            "enum":[
                "Header",
                "Line",
                "Charge"
            ]
        },
        "templateVariableKey":{
            "type":"string",
            "format":"",
            "description":"Pricing Agreement Attribute template variable key.",
            "title":"Template Variable Key",
            "readOnly":true,
            "enum":[
                "Custom",
                "AgreementName",
                "AgreementDescription",
                "AgreementStartDate",
                "AgreementEndDate",
                "AccountID",
                "Account",
                "PartNumber",
                "ServiceDuration",
                "ServiceDurationPeriod",
                "ItemContractStartDate",
                "ItemContractEndDate",
                "RatePlanNumber",
                "ProductListPrice",
                "ProductPriceType",
                "ProductPricePeriod",
                "ProductNetPrice",
                "SourceTransactionId",
                "ChargeType",
                "ChargePriceType",
                "ChargePricePeriod",
                "ChargeUsageUOM",
                "ChargeDynamicPricingType",
                "ChargeDefinitionCode",
                "ChargeNetPrice",
                "RateCardStructure",
                "AgreementStatus",
                "AgreementNumber"
            ]
        },
        "valid":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Pricing Agreement Attribute is valid.",
            "title":"Valid",
            "readOnly":true
        },
        "arrayType":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Pricing Agreement Attribute is an array type.",
            "title":"Array Type"
        },
        "mappings":{
            "format":"",
            "description":"List of mappings for the Pricing Agreement Attribute.",
            "title":"Attribute Mappings",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingAgreementMappedDataSourceAttribute"
                }
            ]
        },
        "attributeLevelCode":{
            "type":"integer",
            "format":"",
            "description":"Attribute level code.",
            "title":"Attribute Level Code",
            "readOnly":true
        },
        "lookupType":{
            "type":"string",
            "format":"",
            "description":"The lookup type variable name for the Pricing Agreement Attribute.",
            "title":"Lookup Type"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Agreement Attribute is active.",
            "title":"Active"
        },
        "lookupTypeLabel":{
            "type":"string",
            "format":"",
            "description":"The lookup type display label for the Pricing Agreement Attribute.",
            "title":"Lookup Type Display Label",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Attribute Mappings

Title: Attribute Mappings

Read Only: true

List of mappings for the Pricing Agreement Attribute.

Match All

List of mappings for the Pricing Agreement Attribute.

Show Source

object PricingResourceCollection_PricingAgreementMappedDataSourceAttribute

{
    "format":"",
    "description":"List of mappings for the Pricing Agreement Attribute.",
    "title":"Attribute Mappings",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingAgreementMappedDataSourceAttribute"
        }
    ]
}

Nested Schema : UserDetails

Type: object

Show Source

emailId: string()

Title: Email Id

Email Id of the user
firstName: string()

Title: First Name

First Name of the user
lastName: string()

Title: Last Name

Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
name: string
rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : PricingResourceCollection_PricingAgreementMappedDataSourceAttribute

Type: object

Show Source

count: integer()

Title: Count

Read Only: true

The number of resource instances returned in the current range.
createdBy: Created By

Title: Created By

Read Only: true

The details of the user who created the record.
hasMore: boolean()

Title: HasMore

Read Only: true

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array items
lastModifiedBy: Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.
limit: integer()

Title: Limit

Read Only: true

The actual paging size used by the server.
links: array Links

Title: Links

Read Only: true

The link relations associated with the resource instance.
offset: integer()

Title: OffSet

Read Only: true

The offset value used in the current page.
totalResults: integer()

Title: Total Results

Read Only: true

Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingAgreementMappedDataSourceAttribute"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

Array of: object PricingAgreementMappedDataSourceAttribute

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingAgreementMappedDataSourceAttribute"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PricingAgreementMappedDataSourceAttribute

Type: object

Show Source

attributeLabel: string()

Title: Attribute Label

Read Only: true

The label of the Pricing Data Source Attribute.
createdBy: Created By

Title: Created By

Read Only: true

The details of the user who created the record.
dataSourceAttribute: string()

Title: Data Source Attribute.

Read Only: true

The mapped data source attribute.
dataSourceLabel: string()

Title: Data Source Label

Read Only: true

The mapped label of the data source.
dataSourceProviderVariableName: string()

Title: Data Source Provider Variable Name

Read Only: true

The variable name of the data source provider.
dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

Title: Date Added

Read Only: true

Creation date of the Pricing Data Source Entity.
dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

Title: Date Modified

Read Only: true

Last modified date of the Pricing Data Source Entity.
id: integer()

Title: Id

Read Only: true

The Unique Identifier of the Pricing Data Source Attribute.
lastModifiedBy: Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.
links: array Links

Title: Links

Read Only: true

The link relations associated with the resource instance.
orderNumber: integer()

Title: Order Number

The position(starting from 1) of the Pricing Data Source Attribute in the ordered list.
readOnly: boolean()

Title: Read Only

Read Only: true

Indicates if the attribute has any restrictions for edits.
sourceEntity: string()

Title: Source Entity

Read Only: true

The name of the Pricing Data Source Entity
validMapping: boolean()

Title: Has Valid Mapping

Read Only: true

Indicates whether the Pricing Data Source Attribute has a valid mapping
variableName: string()

Title: Variable Name

Read Only: true

The variable name of the Pricing Data Source Attribute.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The position(starting from 1) of the Pricing Data Source Attribute in the ordered list.",
            "title":"Order Number"
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Pricing Data Source Attribute.",
            "title":"Id",
            "readOnly":true
        },
        "dataSourceAttribute":{
            "type":"string",
            "format":"",
            "description":"The mapped data source attribute.",
            "title":"Data Source Attribute.",
            "readOnly":true
        },
        "dataSourceLabel":{
            "type":"string",
            "format":"",
            "description":"The mapped label of the data source.",
            "title":"Data Source Label",
            "readOnly":true
        },
        "dataSourceProviderVariableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the data source provider.",
            "title":"Data Source Provider Variable Name",
            "readOnly":true
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the Pricing Data Source Attribute.",
            "title":"Variable Name",
            "readOnly":true
        },
        "attributeLabel":{
            "type":"string",
            "format":"",
            "description":"The label of the Pricing Data Source Attribute.",
            "title":"Attribute Label",
            "readOnly":true
        },
        "validMapping":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the Pricing Data Source Attribute has a valid mapping",
            "title":"Has Valid Mapping",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Data Source Entity.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Data Source Entity.",
            "title":"Date Added",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "readOnly":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the attribute has any restrictions for edits.",
            "title":"Read Only",
            "readOnly":true
        },
        "sourceEntity":{
            "type":"string",
            "format":"",
            "description":"The name of the Pricing Data Source Entity",
            "title":"Source Entity",
            "readOnly":true
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Examples

The following example shows how to retrieve the specified pricing agreement attribute 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 "Accept: application/json"
https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes/_agreementStatus

Response Body Sample

{
  "createdBy": {
    "firstName": "John",
    "lastName": "Smith",
    "emailId": "john.smith@companyname.com"
  },
  "lastModifiedBy": {
    "firstName": "John",
    "lastName": "Smith",
    "emailId": "john.smith@companyname.com"
  },
  "name": "Agreement Status",
  "variableName": "_agreementStatus",
  "description": "Current status of the Agreement.",
  "dateModified": "2024-08-01T17:22:57Z",
  "dateAdded": "2024-08-01T17:22:57Z",
  "dataType": "String",
  "attributeLevel": "Header",
  "templateVariableKey": "AgreementStatus",
  "arrayType": false,
  "attributeLevelCode": 0,
  "active": true,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes/_agreementStatus"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes/_agreementStatus/mappings"
    }
  ]
}