Delete an Object

post/delete/{TypeCode}

Deletes an object.

Only one object can be deleted per request (unless batched). Some object types may be blocked from being deleted by the update command as special processing is done by a dedicated manager command.

Note: Some object types are only soft-deleted, some are hard-deleted in the database. This behavior cannot be influenced by the client.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
TypeCode
required
string

Enter the type code of the entity you want to delete the object from. See the list of Type Codes in the Pricefx Knowledge Base article.

Possible values: "ACTT" "AP" "APIK" "BD" "BPT" "BR" "C" "CA" "CAM" "CDESC" "CF" "CFS" "CFT" "CH" "CLLI" "CN" "CS" "CT" "CTAM" "CTLI" … 131 more
Example: P
Request Body schema: application/json
required
object
typedId
required
string non-empty
Responses
200

OK

Response Schema: application/json
required
object
node
required
string non-empty
required
Array of objects non-empty unique
Array (non-empty)
version
required
number
typedId
required
string non-empty
sku
required
string non-empty
label
required
string non-empty
unitOfMeasure
required
string non-empty
userGroupEdit
required
string non-empty
userGroupViewDetails
required
string non-empty
currency
required
string non-empty
formulaName
required
string non-empty
image
required
boolean
createDate
required
string non-empty
createdBy
required
number
lastUpdateDate
required
string non-empty
lastUpdateBy
required
number
attribute1
required
string non-empty
attribute2
required
string non-empty
attribute3
any
attribute4
any
attribute5
any
attribute6
any
attribute7
any
attribute8
any
attribute9
any
attribute10
any
attribute11
any
attribute12
any
attribute13
any
attribute14
any
attribute15
any
attribute16
any
attribute17
any
attribute18
any
attribute19
any
attribute20
any
attribute21
any
attribute22
any
attribute23
any
attribute24
any
attribute25
any
attribute26
any
attribute27
any
attribute28
any
attribute29
any
attribute30
any
status
required
number
Request samples
application/json
{
  • "data": {
    • "typedId": "2147501187.P"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "sku": "string",
        • "label": "string",
        • "unitOfMeasure": "string",
        • "userGroupEdit": "string",
        • "userGroupViewDetails": "string",
        • "currency": "string",
        • "formulaName": "string",
        • "image": true,
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0,
        • "attribute1": "string",
        • "attribute2": "string",
        • "attribute3": null,
        • "attribute4": null,
        • "attribute5": null,
        • "attribute6": null,
        • "attribute7": null,
        • "attribute8": null,
        • "attribute9": null,
        • "attribute10": null,
        • "attribute11": null,
        • "attribute12": null,
        • "attribute13": null,
        • "attribute14": null,
        • "attribute15": null,
        • "attribute16": null,
        • "attribute17": null,
        • "attribute18": null,
        • "attribute19": null,
        • "attribute20": null,
        • "attribute21": null,
        • "attribute22": null,
        • "attribute23": null,
        • "attribute24": null,
        • "attribute25": null,
        • "attribute26": null,
        • "attribute27": null,
        • "attribute28": null,
        • "attribute29": null,
        • "attribute30": null
        }
      ],
    • "status": 0
    }
}