Irreversibly delete (destroy) stage
  • 14 Aug 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Irreversibly delete (destroy) stage

  • Dark
    Light
  • PDF

Irreversibly Delete a Stage

Method for deleting (irreversibly deleting) a Stage from the recycle bin (Trash).

postman Download our collection of Postman queries to see more examples of Corezoid API v2.

URL

https://api.corezoid.com/api/2/json/{API_LOGIN}/{TIMESTAMP}/{SIGNATURE}

Request Body

{
    "ops": [
        {
            "type": "destroy",
            "obj": "stage",
            "obj_id": {{OBJECT_ID}},
            "project_id": {{PROJECT_ID}},
            "company_id": {{COMPANY_ID}}
        }
    ]
}
Parameter Type Required Description Possible value
ops JSON Object + The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations * The number is user-limited by RPS limit.
type string + Request type destroy
obj string + An object of request stage
obj_id number + ID of the Stage, which will be irreversibly deleted. You can use the obj_short_name instead ID of the deleted Stage
obj_short_name string +* Short name of the Stage, which will be irreversibly deleted, optional. *You can use it instead of the obj_id Short name of a deleted Stage
project_id number + ID of the Project, in which the Stage will be irreversibly deleted. You can use project_short_name instead ID of an existing Project
project_short_name string +* Short name of the Project, in which the Stage will be irreversibly deleted, optional. *You can use it instead of the project_id Short name of an existing Project
company_id string + An ID of a Company, which contains the Stage An ID of the existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj_id": {{OBJECT_ID}},
            "obj_type": stage
        }
    ]
}
Parameter Type Description Possible value
request_proc string Overall processing status of all transactions from the request ok, error
ops array The list of request results
id string Request ID empty
proc string Processing status of a specific operation ok, error
obj_id number ID of the irreversibly deleted Stage
obj_type string Type of the irreversibly deleted object stage