Jump to

• Request
• Response

Quote Summary

post

/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/actions/_s_quoteSummary_t

Generates content through Gen AI, content is generated based on prompt saved for the action.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.

Body ()

Root Schema : commerceDocumentsOraclecpqoTransaction-GenerateQuoteSummaryRequest

Type: object

Show Source

• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
• criteria: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• revisionId: string
  Title: Revision Id

  The string parameter that contains the revision information.

{
    "type":"object",
    "properties":{
        "revisionId":{
            "type":"string",
            "description":"The string parameter that contains the revision information.",
            "title":"Revision Id"
        },
        "criteria":{
            "$ref":"#/definitions/queryDef"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.",
            "title":"Cache Instance Id"
        }
    }
}

Nested Schema : Query Definition

Type: object

Title: Query Definition

Captures the query definition for the current resource request.

Show Source

• actions: array actions
  Array of actions names, whose state is requested in the state object response.
• childDefs: array childDefs
• childGroups: object Group Query Criteria
  Title: Group Query Criteria

  Criteria for grouping transactional line items.
• enableHierarchy: boolean
  Parameter value should be true to execute hierarchy search and sort. Default value is false.
• excludeFieldTypes: array excludeFieldTypes
  Array of field names that you want to exclude in the response.
• expand: array expand
  Array of child resource names that you want to expand so that the contents return with the parent in the same request.
• expandedDomainCriteria: array expandedDomainCriteria
  Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.
• expandedDomains: array expandedDomains
  Array of field names, whose expanded domains are requested in the state object response.
• expandNodes: boolean
  Boolean value that only be available when enableHierarchy is true. True = all nodes will be expanded; False = All nodes will be collapsed.Default value is true.
• fields: array fields
  Array of field names that you wanted returned in a request.
• groups: array groups
  Array of group names, whose state is requested in the state object response.
• layoutRules: string
  Enum value that specifies the state of layout rules which needs to be fetched and executed. By default, this value is set to NO_RULE indicating that layout rules is not executed. enum: [DEPLOYED, UNDEPLOYED, NO_RULE]
• limit: integer
  Positive integer value that specifies the maximum number of items returned by the server.
• nodesExceptionList: array nodesExceptionList
  Array of document_number, recording the nodes that violate current expandNodes flag
• offset: integer
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: array orderBy
  Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• parentFields: array parentFields
  Array of field names to include in the parentFields of each resource row.
• q: string
  Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied.
• rootFields: array rootFields
  Array of field names to include in the rootFields of each resource row.
• state: boolean
  Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated."
        },
        "q":{
            "type":"string",
            "description":"Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied."
        },
        "limit":{
            "type":"integer",
            "description":"Positive integer value that specifies the maximum number of items returned by the server."
        },
        "offset":{
            "type":"integer",
            "description":"Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection."
        },
        "state":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated."
        },
        "orderBy":{
            "type":"array",
            "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.",
            "items":{
                "type":"string"
            }
        },
        "expand":{
            "type":"array",
            "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
            "items":{
                "type":"string"
            }
        },
        "fields":{
            "type":"array",
            "description":"Array of field names that you wanted returned in a request.",
            "items":{
                "type":"string"
            }
        },
        "excludeFieldTypes":{
            "type":"array",
            "description":"Array of field names that you want to exclude in the response.",
            "items":{
                "type":"string"
            }
        },
        "actions":{
            "type":"array",
            "description":"Array of actions names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "groups":{
            "type":"array",
            "description":"Array of group names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "childGroups":{
            "description":"Object containing criteria for grouping child transactional line items.",
            "$ref":"#/definitions/groupQueryCriteria"
        },
        "rootFields":{
            "type":"array",
            "description":"Array of field names to include in the rootFields of each resource row.",
            "items":{
                "type":"string"
            }
        },
        "parentFields":{
            "type":"array",
            "description":"Array of field names to include in the parentFields of each resource row.",
            "items":{
                "type":"string"
            }
        },
        "expandedDomains":{
            "type":"array",
            "description":"Array of field names, whose expanded domains are requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "childDefs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/childQueryDef"
            }
        },
        "enableHierarchy":{
            "type":"boolean",
            "description":"Parameter value should be true to execute hierarchy search and sort. Default value is false."
        },
        "expandNodes":{
            "type":"boolean",
            "description":"Boolean value that only be available when enableHierarchy is true. True = all nodes will be expanded; False = All nodes will be collapsed.Default value is true."
        },
        "nodesExceptionList":{
            "type":"array",
            "description":"Array of document_number, recording the nodes that violate current expandNodes flag",
            "items":{
                "type":"string"
            }
        },
        "expandedDomainCriteria":{
            "type":"array",
            "description":"Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.",
            "items":{
                "type":"string"
            }
        },
        "layoutRules":{
            "type":"string",
            "description":"Enum value that specifies the state of layout rules which needs to be fetched and executed. By default, this value is set to NO_RULE indicating that layout rules is not executed. enum: [DEPLOYED, UNDEPLOYED, NO_RULE]"
        }
    },
    "title":"Query Definition",
    "description":"Captures the query definition for the current resource request."
}

Nested Schema : actions

Type: array

Array of actions names, whose state is requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of actions names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : childDefs

Type: array

Show Source

• Array of: object Child query criteria.
  Title: Child query criteria.

  Captures the query criteria for the child resource.

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

Nested Schema : Group Query Criteria

Type: object

Title: Group Query Criteria

Criteria for grouping transactional line items.

Show Source

• attributeName: string
  The attribute name to group by.
• expandGroups: boolean
  Whether to expand groups.
• groupLimit: integer
  The maximum number of groups to return.
• groupOffset: integer
  The group offset for pagination.
• itemsOffsetList: object itemsOffsetList
  Additional Properties Allowed: additionalProperties

  Map of group name and integer which will be offset for that group.

{
    "type":"object",
    "properties":{
        "attributeName":{
            "type":"string",
            "description":"The attribute name to group by."
        },
        "groupLimit":{
            "type":"integer",
            "description":"The maximum number of groups to return."
        },
        "groupOffset":{
            "type":"integer",
            "description":"The group offset for pagination."
        },
        "expandGroups":{
            "type":"boolean",
            "description":"Whether to expand groups."
        },
        "itemsOffsetList":{
            "type":"object",
            "description":"Map of group name and integer which will be offset for that group.",
            "additionalProperties":{
                "type":"integer"
            }
        }
    },
    "title":"Group Query Criteria",
    "description":"Criteria for grouping transactional line items."
}

Nested Schema : excludeFieldTypes

Type: array

Array of field names that you want to exclude in the response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you want to exclude in the response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expand

Type: array

Array of child resource names that you want to expand so that the contents return with the parent in the same request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expandedDomainCriteria

Type: array

Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expandedDomains

Type: array

Array of field names, whose expanded domains are requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, whose expanded domains are requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : fields

Type: array

Array of field names that you wanted returned in a request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you wanted returned in a request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : groups

Type: array

Array of group names, whose state is requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of group names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : nodesExceptionList

Type: array

Array of document_number, recording the nodes that violate current expandNodes flag

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of document_number, recording the nodes that violate current expandNodes flag",
    "items":{
        "type":"string"
    }
}

Nested Schema : orderBy

Type: array

Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.",
    "items":{
        "type":"string"
    }
}

Nested Schema : parentFields

Type: array

Array of field names to include in the parentFields of each resource row.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names to include in the parentFields of each resource row.",
    "items":{
        "type":"string"
    }
}

Nested Schema : rootFields

Type: array

Array of field names to include in the rootFields of each resource row.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names to include in the rootFields of each resource row.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Child query criteria.

Type: object

Title: Child query criteria.

Captures the query criteria for the child resource.

Show Source

• name: string
  Rest alias name of the child resource this query belongs to.
• queryDef: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• recursive: boolean
  Boolean value that specifies whether this query is a recursive expand on the current child resource query.

{
    "type":"object",
    "properties":{
        "recursive":{
            "type":"boolean",
            "description":"Boolean value that specifies whether this query is a recursive expand on the current child resource query."
        },
        "name":{
            "type":"string",
            "description":"Rest alias name of the child resource this query belongs to."
        },
        "queryDef":{
            "$ref":"#/definitions/queryDef"
        }
    },
    "title":"Child query criteria.",
    "description":"Captures the query criteria for the child resource."
}

Nested Schema : itemsOffsetList

Type: object

Additional Properties Allowed

Show Source

• integer

{
    "type":"object",
    "description":"Map of group name and integer which will be offset for that group.",
    "additionalProperties":{
        "type":"integer"
    }
}

Map of group name and integer which will be offset for that group.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : commerceDocumentsOraclecpqoTransaction-GenerateQuoteSummaryResponse

Type: object

Show Source

• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
• layoutVariableName: string
  Title: Selected Redwood Layout

  The string parameter that contains selected redwood layout's variable name.
• revisionId: string
  Title: Revision Id

  The string parameter that contains the revision information.
• summaryText: string
  Title: Summary

  Summary for actions having Generate Summary integration.
• warnings: object warnings
  Title: warnings

  warning messages

{
    "type":"object",
    "properties":{
        "revisionId":{
            "type":"string",
            "description":"The string parameter that contains the revision information.",
            "title":"Revision Id"
        },
        "summaryText":{
            "type":"string",
            "description":"Summary for actions having Generate Summary integration.",
            "title":"Summary"
        },
        "warnings":{
            "$ref":"#/definitions/warnings"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.",
            "title":"Cache Instance Id"
        },
        "layoutVariableName":{
            "type":"string",
            "description":"The string parameter that contains selected redwood layout's variable name.",
            "title":"Selected Redwood Layout"
        }
    }
}

Nested Schema : warnings

Type: object

Title: warnings

warning messages

Show Source

• messages: array Messages
  Title: Messages

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

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

Nested Schema : Messages

Type: array

Title: Messages

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

Show Source

• Array of: string
  warning message.

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

Back to Top