Jump to

• Request
• Response

Delete jobs.

post

/rhp-restapi/rhp/jobs/actions/delete

Request

Supported Media Types

• application/json

Header Parameters

• Authorization(required): string
  Base64 encoding of the user name and password of the user making the request. For more information, see Authentication for Fleet Patching and Provisioning.

Body ()

Root Schema : DeleteJobsBody

Type: object

Show Source

• client: string
  Client name attribute of the jobs to be deleted
• jobsIds: string
  Comma separated list of one or more jobs to be deleted
• status: string
  Allowed Values: [ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ]

  Job status for which to get the jobs.
• user: string
  User name attribute of the jobs to be deleted

{
    "type":"object",
    "properties":{
        "jobsIds":{
            "type":"string",
            "description":"Comma separated list of one or more jobs to be deleted"
        },
        "status":{
            "type":"string",
            "description":"Job status for which to get the jobs.",
            "enum":[
                "SCHEDULED",
                "UNKNOWN",
                "EXECUTING",
                "PAUSED",
                "ABORTED",
                "TERMINATED",
                "FAILED",
                "SUCCEEDED"
            ]
        },
        "user":{
            "type":"string",
            "description":"User name attribute of the jobs to be deleted"
        },
        "client":{
            "type":"string",
            "description":"Client name attribute of the jobs to be deleted"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• text/html

200 Response

OK. HTTP Status code 200 indicating delete is succesful.

Body ()

Root Schema : schema

Default Response

Unexpected error. A JSON object containing error details of the issue while executing the operation.

Body ()

Root Schema : errorResource

Type: object

Show Source

• errorCode: string
  Application specific error code, related to the error message shown at tittle.
• errorDetails: array errorDetails
  If multiple errors are reported they can be organized in a hierarchical structure in this array.
• errorPath: string
  XPath or JSON path to indicate where the error occurs.
• instance: string
  URI to the link that provides more detail about the error.
• status: integer
  HTTP status code.
• title: string
  Summary error message.
• type: string
  Link to HTTP error code page.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorDetails":{
            "type":"array",
            "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
            "items":{
                "$ref":"#/definitions/errorResource"
            }
        },
        "errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code, related to the error message shown at tittle."
        }
    }
}

Nested Schema : errorDetails

Type: array

If multiple errors are reported they can be organized in a hierarchical structure in this array.

Show Source

• Array of: object errorResource

{
    "type":"array",
    "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
    "items":{
        "$ref":"#/definitions/errorResource"
    }
}

Back to Top