REST API Services for CPQ Cloud

Delete Row from an Array

post

/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_set_arraySetVarName/actions/_delete

This action deletes a specified index or row in a payload from the given Array set.

Request

Supported Media Types

application/json

Root Schema : _set_arraySetVarName-_deleteRequest

Type: object

Show Source

cacheInstanceId: string

Title: Cache Instance Id

The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.
removeIndex(optional): integer

Title: Remove Index

Index which has to be removed from the array set.

{
    "type":"object",
    "required":[
        "cacheInstanceId"
    ],
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        },
        "removeIndex":{
            "type":"integer",
            "description":"Index which has to be removed from the array set.",
            "title":"Remove Index"
        }
    }
}

Response

Supported Media Types

application/json

Default Response

Root Schema : _set_arraySetVarName-_deleteResponse

Type: object

Show Source

cacheInstanceId(optional): string

Title: Cache Instance Id

The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.
items(optional): array items

{
    "type":"object",
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/_set_arraySetVarName"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object applicationSoftwareCounter array key

Title: applicationSoftwareCounter array key

applicationSoftwareCounter array key

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

Nested Schema : applicationSoftwareCounter array key

Type: object

Title: applicationSoftwareCounter array key

applicationSoftwareCounter array key

Show Source

_arraySetVarName(optional): string

Title: applicationSoftwareCounter array key

applicationSoftwareCounter array key
_index(optional): integer

Title: Index

Index of the element in the array set.

{
    "type":"object",
    "properties":{
        "_index":{
            "type":"integer",
            "description":"Index of the element in the array set.",
            "title":"Index"
        },
        "_arraySetVarName":{
            "type":"string",
            "description":"applicationSoftwareCounter array key",
            "title":"applicationSoftwareCounter array key"
        }
    },
    "title":"applicationSoftwareCounter array key",
    "description":"applicationSoftwareCounter array key"
}

Examples

The following example shows how to delete an index or row for a given Array set by submitting a POST request to the REST resource using cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/_set_array_key_applicationSoftwareCounter/actions/_delete

Request Body Sample

{
  "cacheInstanceId": "WOSeTwyqtdOO2BnrSShDZoRTTVq4oj1tSfGP3bjdSTUxJFiU4SkYcTgUuC8QZgZW",
  "removeIndex": 1
}

Response Body Sample

The following example shows the contents of the response body in JSON format:

{
  "items": [{
      "_index": 0,
      "softwarePackage_array": {
        "value": "Cloud Management",
        "displayValue": "Cloud Management"
      },
      "licenses_array": 1,
      "maintenance_array": "Data Protection Software Maintenance",
      "qty_array": 1,
      "startDate_array": "2018-12-06",
      "endDate_array": "2021-12-05"
    }
  ],
  "cacheInstanceId": "WOSeTwyqtdOO2BnrSShDZoRTTVq4oj1tSfGP3bjdSTUxJFiU4SkYcTgUuC8QZgZW"
}