REST API Services for Oracle CPQ

Get List of Product Line Actions

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions

Use this endpoint to retrieve a list of all Product Line Actions.

Request

Supported Media Types

application/json

Path Parameters

allProdFamsVarName(required): string

Variable Name of All Product Families '_allProductFamilies'
prodFamVarName(required): string

Variable Name of the Product Family.
prodLineVarName(required): string

Variable Name of the Product Line

Query Parameters

expand: string

Allows expansion of relationships.
fields: string

Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
limit: integer

The requested page size, which limits the number of elements the collection should max return.
offset: integer

The offset of the page. By default, offset is 0, which means first page will be returned.
orderby: string

Specifies a comma-separated list of pairs to order the response by.
q: string

Allows to specify one or more filtering criteria. By default, no filtering is applied.
totalResults: boolean

Specifies that the total count of records should be included in the response when doing pagination.

Response

Supported Media Types

application/json

Default Response

Root Schema : configActions-collection

Type: object

Show Source

count: integer

The number of resource instances returned in the current range.
hasMore: boolean

Returns true if more resources are available on the server than the subset returned in current page.
items: array items
limit: integer

The actual paging size used by the server.
offset: integer

The offset used in the current page.
totalResults: integer

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

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture 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."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/configActions"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Configuration Actions

Title: Configuration Actions

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

Nested Schema : Configuration Actions

Type: object

Title: Configuration Actions

Show Source

dateAdded: string

Title: Date Added

System field indicating the date on which the Resource was created.
dateModified: string

Title: Date Modified

System field indicating the date on which the Resource was last modified.
description: string

Title: Description

Description of the Config Action
id: integer

Title: Id

Primary Key of the resource
label: string

Title: Action Name

Name of the Config Action
refType: object Reference Type

Title: Reference Type

Type of the Reference
status: object Config Action Status

Title: Config Action Status

Status of Config Action
userAddedFirstName: string

Title: User Added First Name

First Name of the user who created the record
userAddedLastName: string

Title: User Added Last Name

Last Name of the user who created the record
userModifiedFirstName: string

Title: User Modified First Name

First Name of the user who modified the record
userModifiedLastName: string

Title: User Modified Last Name

Last Name of the user who modified the record
variableName: string

Title: Variable Name

Variable Name of the Config Action

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "description":{
            "type":"string",
            "description":"Description of the Config Action",
            "title":"Description"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Name of the Config Action",
            "title":"Action Name"
        },
        "refType":{
            "type":"object",
            "description":"Type of the Reference",
            "title":"Reference Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "status":{
            "type":"object",
            "description":"Status of Config Action",
            "title":"Config Action Status",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "userAddedFirstName":{
            "type":"string",
            "description":"First Name of the user who created the record",
            "title":"User Added First Name"
        },
        "userAddedLastName":{
            "type":"string",
            "description":"Last Name of the user who created the record",
            "title":"User Added  Last Name"
        },
        "userModifiedFirstName":{
            "type":"string",
            "description":"First Name of the user who modified the record",
            "title":"User Modified  First Name"
        },
        "userModifiedLastName":{
            "type":"string",
            "description":"Last Name of the user who modified the record",
            "title":"User Modified  Last Name"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the Config Action",
            "title":"Variable Name"
        }
    },
    "title":"Configuration Actions"
}

Nested Schema : Reference Type

Type: object

Title: Reference Type

Type of the Reference

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Type of the Reference",
    "title":"Reference Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Config Action Status

Type: object

Title: Config Action Status

Status of Config Action

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Status of Config Action",
    "title":"Config Action Status",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Examples

The following example shows how to retrieve a list of all Product Line actions 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/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles/_actions

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles/_actions"
    }
  ],
  "items": [{
      "variableName": "selectPromo",
      "refType": {
        "lookupCode": "3",
        "displayValue": "Product Line",
        "id": 36892931,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ACTION_REF_TYPE%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues/36892931"
          }
        ]
      },
      "description": null,
      "userModifiedLastName": "User",
      "dateModified": "2023-09-08T15:41:41.000Z",
      "label": "Select Promotion",
      "dateAdded": "2023-09-08T15:41:41.000Z",
      "userAddedFirstName": "Super",
      "userModifiedFirstName": "Super",
      "userAddedLastName": "User",
      "id": 36971947,
      "status": {
        "lookupCode": "1",
        "displayValue": "Active",
        "id": 36892935,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ACTION_STATUS%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues/36892935"
          }
        ]
      },
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles/_actions/selectPromo"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles/_actions/selectPromo/translations"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles"
        }
      ]
    }
  ]
}