Jump to

• Request
• Response
• Examples

Get Transaction Comment

get

/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/_s_transactionComments_t/{_row_number}

Use this endpoint to retrieve the specified transaction comment.

Request

Supported Media Types

• application/json

Path Parameters

• _row_number(required): integer
  Unique row number to be used as row identifier in an array set.
• id(required): integer
  Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.

Query Parameters

• excludeFieldTypes: string
  Exclude specified field types.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Comments

Type: object

Title: Comments

Show Source

• _bs_id: integer
  Title: _bs_id

  _bs_id
• _currency_pref: object _currency_pref
  Title: _currency_pref
• _document_number: integer
  Title: _document_number

  _document_number
• _row_number: integer
  Title: _row_number

  _row_number
• _s_commentDate: string
  Title: Activity Date

  The date of comment/system activity
• _s_commentor: string
  Title: Commentor

  Name of the person who created this comment.
• _s_customerComment: string
  Title: Message

  The comment text or system activity message.
• _s_isInternalComment: boolean
  Title: Is Internal Comment

  Determines if this comment should be visible to customer/buyer persona.
• _s_type: object Type
  Title: Type
• _sequence_number: integer
  Title: _sequence_number

  _sequence_number
• _state: object state
  Title: state

  Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.

{
    "type":"object",
    "properties":{
        "_sequence_number":{
            "type":"integer",
            "description":"_sequence_number",
            "title":"_sequence_number"
        },
        "_document_number":{
            "type":"integer",
            "description":"_document_number",
            "title":"_document_number"
        },
        "_s_commentDate":{
            "type":"string",
            "description":"The date of comment/system activity",
            "title":"Activity Date"
        },
        "_s_commentor":{
            "type":"string",
            "description":"Name of the person who created this comment.",
            "title":"Commentor"
        },
        "_currency_pref":{
            "type":"object",
            "description":"",
            "title":"_currency_pref",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the currency  resource.",
                    "title":"Id"
                },
                "currencyCode":{
                    "type":"string",
                    "description":"Unique currency code for the currency.",
                    "title":"Currency Code"
                }
            }
        },
        "_s_type":{
            "type":"object",
            "title":"Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"displayValue"
                }
            }
        },
        "_bs_id":{
            "type":"integer",
            "description":"_bs_id",
            "title":"_bs_id"
        },
        "_s_customerComment":{
            "type":"string",
            "description":"The comment text or system activity message.",
            "title":"Message"
        },
        "_row_number":{
            "type":"integer",
            "description":"_row_number",
            "title":"_row_number"
        },
        "_s_isInternalComment":{
            "type":"boolean",
            "description":"Determines if this comment should be visible to customer/buyer persona.",
            "title":"Is Internal Comment"
        },
        "_state":{
            "$ref":"#/definitions/resourceRowState"
        }
    },
    "title":"Comments"
}

Nested Schema : _currency_pref

Type: object

Title: _currency_pref

Show Source

• currencyCode: string
  Title: Currency Code

  Unique currency code for the currency.
• id: integer
  Title: Id

  Primary Key of the currency resource.

{
    "type":"object",
    "description":"",
    "title":"_currency_pref",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of the currency  resource.",
            "title":"Id"
        },
        "currencyCode":{
            "type":"string",
            "description":"Unique currency code for the currency.",
            "title":"Currency Code"
        }
    }
}

Nested Schema : Type

Type: object

Title: Type

Show Source

• displayValue: string
  Title: displayValue
• value: string
  Title: value

{
    "type":"object",
    "title":"Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"value"
        },
        "displayValue":{
            "type":"string",
            "title":"displayValue"
        }
    }
}

Nested Schema : state

Type: object

Title: state

Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.

Show Source

• actions: object Actions
  Title: Actions

  Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
• attributes: object Attributes
  Title: Attributes

  Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
• deletable: boolean
  Title: Deletable

  Boolean value that specifies whether the row can be deleted.
• focus: object Focused Users
  Title: Focused Users

  Details about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier.
• hasError: boolean
  Title: Has Error

  Boolean value that specifies whether any error that occurred has been assigned to the row itself.
• hasWarning: boolean
  Title: Has Warning

  Boolean value that specifies whether any warning that was issued has been assigned to the row itself.
• hidden: boolean
  Title: Hidden

  Boolean value that specifies whether the row can be hidden.
• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.
• updatable: boolean
  Title: Updatable

  Boolean value that specifies whether the row can be updated.

{
    "type":"object",
    "properties":{
        "updatable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the row can be updated.",
            "title":"Updatable"
        },
        "deletable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the row can be deleted.",
            "title":"Deletable"
        },
        "hasError":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any error that occurred has been assigned to the row itself.",
            "title":"Has Error"
        },
        "hasWarning":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any warning that was issued has been assigned to the row itself.",
            "title":"Has Warning"
        },
        "actions":{
            "type":"object",
            "description":"Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.",
            "title":"Actions"
        },
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"An error, warning, or informational message."
            }
        },
        "attributes":{
            "type":"object",
            "description":"Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.",
            "title":"Attributes"
        },
        "hidden":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the row can be hidden.",
            "title":"Hidden"
        },
        "focus":{
            "type":"object",
            "description":"Details about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier.",
            "title":"Focused Users"
        }
    },
    "title":"state",
    "description":"Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included."
}

Nested Schema : Actions

Type: object

Title: Actions

Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.

Nested Schema : Attributes

Type: object

Title: Attributes

Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.

Nested Schema : Focused Users

Type: object

Title: Focused Users

Details about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier.

Nested Schema : Messages

Type: array

Title: Messages

Array of messages that have been generated for a specific object.

Show Source

• Array of: string
  An error, warning, or informational message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"An error, warning, or informational message."
    }
}

Back to Top

Examples

The following example shows how to retrieve the specified transaction comment 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/commerceDocumentsOraclecpqoTransaction/40155914/_s_transactionComments_t/2

Response Body Sample

{
  "_sequence_number": 2,
  "_document_number": 1,
  "_s_commentDate": "2024-08-29T14:31:00Z",
  "_s_commentor": "Adam Jones",
  "_currency_pref": {
    "id": 5190368,
    "currencyCode": "USD",
    "links": [{
        "rel": "domain",
        "href": "https://sitename.oracle.com/rest/v19/currencies"
      }, {
        "rel": "canonical",
        "href": "https://sitename.oracle.com/rest/v19/currencies/USD"
      }
    ]
  },
  "_bs_id": 40155914,
  "_row_number": 2,
  "_s_customerComment": "Accepting the Quote",
  "_s_isInternalComment": true,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/40155914/_s_transactionComments_t/2"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/40155914"
    }
  ]
}

Back to Top