Jump to

• Request
• Response
• Examples

Get Transaction Line Item Pricing Items

get

/rest/v16/pricingSetup/preview/{bsId}/items/{docNumber}

Use this endpoint to retrieve the line level pricing items for the specified transaction line item.

Request

Path Parameters

• bsId(required): integer(int64)
• docNumber(required): integer(int32)

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingPreviewLineItem

Type: object

Show Source

• bomItemName: string()
  Title: Bom Item Name

  Read Only: true

  Bom Item Name.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• documentNumber: integer()
  Title: Line Item Document Number

  Read Only: true

  Line Item Document Number.
• itemAttributeValues: object itemAttributeValues
• 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.
• partNumber: string()
  Title: Part Number

  Read Only: true

  Part Number.
• rootBomItemName: string()
  Title: Root Bom Item Name

  Read Only: true

  Root Bom Item Name.

{
    "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"
                }
            ]
        },
        "documentNumber":{
            "type":"integer",
            "format":"",
            "description":"Line Item Document Number.",
            "title":"Line Item Document Number",
            "readOnly":true
        },
        "partNumber":{
            "type":"string",
            "format":"",
            "description":"Part Number.",
            "title":"Part Number",
            "readOnly":true
        },
        "bomItemName":{
            "type":"string",
            "format":"",
            "description":"Bom Item Name.",
            "title":"Bom Item Name",
            "readOnly":true
        },
        "rootBomItemName":{
            "type":"string",
            "format":"",
            "description":"Root Bom Item Name.",
            "title":"Root Bom Item Name",
            "readOnly":true
        },
        "itemAttributeValues":{
            "type":"object"
        },
        "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

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

Type: object

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

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

Back to Top

Examples

The following example shows how to retrieve the line level pricing items for the specified transaction line item by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/pricingSetup/preview/38635017/items/6

Response Body Sample

{
  "documentNumber": 6,
  "partNumber": "Mental Wellness Apps",
  "bomItemName": "Mental Wellness Apps",
  "rootBomItemName": "Telehealth and Wellness",
  "itemAttributeValues": {
    "_bomItemVariableName": "04881379b2350a612db0cb1bb40de11a2e53f8dfe3320d598c6c489d8b399068",
    "_quantity": 11,
    "_serviceDurationPeriod": "",
    "_serviceDuration": "",
    "_requestedAgreementNumber": "",
    "_requestedRatePlanNumber": "mentalWellnessAppsPlan1"
  }
}

Back to Top