REST API for Fleet Patching and Provisioning

Delete working copy

delete

/workingcopies/{workingCopyId}

Delete the specified workingcopy from the server.

Request

Supported Media Types

application/json

Path Parameters

workingCopyId: string

Name of the working copy.

describe

Root Schema : DeleteWorkingCopyBody

Type: object

Show Source

auth(optional): string

Use an authentication plugin to access the remote node
authArgs(optional): object authArgs

Additional Properties Allowed: additionalProperties

Additional properties for the selected authentication plugin
cc(optional): string

List of users to whom email notifications will be sent, in addition to owner of working copy
cred(optional): string

Credential name to associate the user/password credentials to access a remote node
force(optional): boolean

To forcibly delete the database working copy
notify(optional): boolean

Send email notification
root(optional): boolean

Use root credentials to access the remote node
schedule(optional): string

Preferred time to execute the operation
sudoPath(optional): string

location of sudo binary
sudoUser(optional): string

perform super user operations as sudo user name
superUserPasswd(optional): string

The password for the super user account
targetNode(optional): string

Name of a node in a remote cluster with no Rapid Home Provisioning Client
userActionData(optional): string

Value to be passed to useractiondata parameter of useraction script

{
    "type":"object",
    "properties":{
        "auth":{
            "description":"Use an authentication plugin to access the remote node",
            "type":"string"
        },
        "authArgs":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object",
            "description":"Additional properties for the selected authentication plugin"
        },
        "cc":{
            "description":"List of users to whom email notifications will be sent, in addition to owner of working copy",
            "type":"string"
        },
        "cred":{
            "description":"Credential name to associate the user/password credentials to access a remote node",
            "type":"string"
        },
        "force":{
            "description":"To forcibly delete the database working copy",
            "type":"boolean"
        },
        "notify":{
            "description":"Send email notification",
            "type":"boolean"
        },
        "root":{
            "description":"Use root credentials to access the remote node",
            "type":"boolean"
        },
        "schedule":{
            "description":"Preferred time to execute the operation",
            "type":"string"
        },
        "sudoPath":{
            "description":"location of sudo binary",
            "type":"string"
        },
        "sudoUser":{
            "description":"perform super user operations as sudo user name",
            "type":"string"
        },
        "superUserPasswd":{
            "description":"The password for the super user account",
            "type":"string"
        },
        "targetNode":{
            "description":"Name of a node in a remote cluster with no Rapid Home Provisioning Client",
            "type":"string"
        },
        "userActionData":{
            "description":"Value to be passed to useractiondata parameter of useraction script",
            "type":"string"
        }
    }
}

Nested Schema : authArgs

Type: object

Additional Properties Allowed

Show Source

string

{
    "additionalProperties":{
        "type":"string"
    },
    "type":"object",
    "description":"Additional properties for the selected authentication plugin"
}

Additional properties for the selected authentication plugin

Security

basicAuthentication: basic

Type: basic

Response

Supported Media Types

application/json

202 Response

Accepted. A JSON object containing job resource details of the accepted operation to obtain status and output of the progress.

Headers

Location: string

URL to the job that will execute the operation

Root Schema : jobResource

Type: object

Show Source

jobId(optional): string
links(optional): array links
operation(optional): string
output(optional): object jobOutputResource
status(optional): string

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "operation":{
            "type":"string"
        },
        "output":{
            "$ref":"#/definitions/jobOutputResource"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResourceLinks"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object singleResourceLinks

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

Nested Schema : jobOutputResource

Type: object

Show Source

hasMore(optional): boolean

Default Value: false
limit(optional): integer
links(optional): array links
offset(optional): integer
output(optional): string

{
    "type":"object",
    "properties":{
        "output":{
            "type":"string"
        },
        "limit":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/collectionResourceLinks"
            }
        }
    }
}

Nested Schema : singleResourceLinks

Type: object

Show Source

href(optional): string

The referenced hyperlink element provided in an absolute format.
rel(optional): string

Allowed Values: [ "self", "collection", "up", "describedBy" ]

Specify the type of relationship the link has with the described resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Specify the type of relationship the link has with the described resource.",
            "enum":[
                "self",
                "collection",
                "up",
                "describedBy"
            ]
        },
        "href":{
            "type":"string",
            "description":"The referenced hyperlink element provided in an absolute format."
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object collectionResourceLinks

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

Nested Schema : collectionResourceLinks

Type: object

Show Source

href(optional): string

The referenced hyperlink element provided in an absolute format with the correct URL parameters.
rel(optional): string

Allowed Values: [ "next", "prev", "first", "last" ]

Specify the type of relationship the link has with the described resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Specify the type of relationship the link has with the described resource.",
            "enum":[
                "next",
                "prev",
                "first",
                "last"
            ]
        },
        "href":{
            "type":"string",
            "description":"The referenced hyperlink element provided in an absolute format with the correct URL parameters."
        }
    }
}

400 Response

Bad Request. A JSON object containing error details of the issue found while parsing a parameter value or name.

Root Schema : errorResource

Type: object

Show Source

errorCode(optional): string

Application specific error code, related to the error message shown at title.
errorDetails(optional): array errorDetails

If multiple errors are reported they can be organized in a hierarchical structure in this array.
errorPath(optional): string

XPath or JSON path to indicate where the error occurs.
instance(optional): string

URI to the link that provides more detail about the error.
status(optional): integer

HTTP status code.
title(optional): string

Summary error message.
type(optional): 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 title."
        }
    }
}

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"
    }
}

Default Response

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

Root Schema : errorResource

Type: object

Show Source

errorCode(optional): string

Application specific error code, related to the error message shown at title.
errorDetails(optional): array errorDetails

If multiple errors are reported they can be organized in a hierarchical structure in this array.
errorPath(optional): string

XPath or JSON path to indicate where the error occurs.
instance(optional): string

URI to the link that provides more detail about the error.
status(optional): integer

HTTP status code.
title(optional): string

Summary error message.
type(optional): 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 title."
        }
    }
}

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"
    }
}