persistDelete

Description

Permanently removes information from the database. The information to be removed is denoted by the deleteType property, which is required by the persistDelete-req schema for all persistDelete requests. Depending on deleteType, additional properties may be available and/or required. See the persistDelete-req schema for more information.

See here for more details on Persist.

Remarks

The following deleteType values are supported:

• job
• jobsAll
• jobRun
• jobRunsByJobID
• jobRunsAll

Example for Delete Specific Job

Request

This request deletes the specified job from the persist database.

{
  "deleteType": "Job",
  "jobID": 42
}

Reply

{
  "countDeleteTaskRuns": 24,
  "countDeleteJobRuns": 8,
  "countDeleteTasks": 3,
  "countDeleteJobs": 1
}

Example for Delete All Jobs

Request

{
  "deleteType": "jobsAll",
}

Reply

{
"countDeleteTaskRuns": 249,
"countDeleteJobRuns": 83,
"countDeleteTasks": 747,
"countDeleteJobs": 12
}

Request Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "definitions":{
    "jobID":{
      "title":"Job ID",
      "description":"Identifies a Job record.",
      "type":"integer"
    }
  },
  "oneOf":[
    {
      "description":"Deletes a JobRun and related records.",
      "type":"object",
      "required":[
        "deleteType",
        "jobRunID"
      ],
      "additionalProperties":false,
      "properties":{
        "deleteType":{
          "title":"Delete Type",
          "description":"Specifies which records are to be deleted.",
          "enum":[
            "jobRun"
          ]
        },
        "jobRunID":{
          "title":"JobRun ID",
          "description":"Identifies a JobRun record.",
          "type":"integer"
        }
      }
    },
    {
      "description":"Deletes all JobRun and related records by JobID.",
      "type":"object",
      "required":[
        "deleteType",
        "jobID"
      ],
      "additionalProperties":false,
      "properties":{
        "deleteType":{
          "title":"Delete Type",
          "description":"Specifies which records are to be deleted.",
          "enum":[
            "jobRunsByJobID"
          ]
        },
        "jobID":{
          "$ref":"#/definitions/jobID"
        }
      }
    },
    {
      "description":"Deletes all JobRun and related records.",
      "type":"object",
      "required":[
        "deleteType"
      ],
      "additionalProperties":false,
      "properties":{
        "deleteType":{
          "title":"Delete Type",
          "description":"Specifies which records are to be deleted.",
          "enum":[
            "jobRunsAll"
          ]
        }
      }
    },
    {
      "description":"Deletes the specified Job and related records.",
      "type":"object",
      "required":[
        "deleteType",
        "jobID"
      ],
      "additionalProperties":false,
      "properties":{
        "deleteType":{
          "title":"Delete Type",
          "description":"Specifies which records are to be deleted.",
          "enum":[
            "job"
          ]
        },
        "jobID":{
          "$ref":"#/definitions/jobID"
        }
      }
    },
    {
      "description":"Deletes all Job and related records.",
      "type":"object",
      "required":[
        "deleteType"
      ],
      "additionalProperties":false,
      "properties":{
        "deleteType":{
          "title":"Delete Type",
          "description":"Specifies which records are to be deleted.",
          "enum":[
            "jobsAll"
          ]
        }
      }
    }
  ]
}

Reply Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "definitions":{
    "countDeleteTaskRuns":{
      "title":"Deleted TaskRun Count",
      "description":"Number of TaskRun records deleted.",
      "type":"integer"
    },
    "countDeleteJobRuns":{
      "title":"Deleted JobRun Count",
      "description":"Number of JobRun records deleted.",
      "type":"integer"
    }
  },
  "oneOf":[
    {
      "description":"Reply for `job` and `jobsAll` delete types.",
      "type":"object",
      "required":[
        "countDeleteTaskRuns",
        "countDeleteJobRuns",
        "countDeleteTasks",
        "countDeleteJobs"
      ],
      "additionalProperties":false,
      "properties":{
        "countDeleteTaskRuns":{
          "$ref":"#/definitions/countDeleteTaskRuns"
        },
        "countDeleteJobRuns":{
          "$ref":"#/definitions/countDeleteJobRuns"
        },
        "countDeleteTasks":{
          "title":"Deleted Task Count",
          "description":"Number of Task records deleted.",
          "type":"integer"
        },
        "countDeleteJobs":{
          "title":"Deleted Job Count",
          "description":"Number of Job records deleted.",
          "type":"integer"
        }
      }
    },
    {
      "description":"Reply for `jobRun`, `jobRunsByJobID` and `jobRunsAll` delete types.",
      "type":"object",
      "required":[
        "countDeleteTaskRuns",
        "countDeleteJobRuns"
      ],
      "additionalProperties":false,
      "properties":{
        "countDeleteTaskRuns":{
          "$ref":"#/definitions/countDeleteTaskRuns"
        },
        "countDeleteJobRuns":{
          "$ref":"#/definitions/countDeleteJobRuns"
        }
      }
    }
  ]
}