Delete specific artifact based on type and name.

delete

/mftapp/rest/v1/artifacts/{artifactType}/{artifactName}

If you are deleting source/target which are part of a transfer, then such source/target should be deleted/detached from the transfer prior to delete, else delete operation will fail.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : schema

500 Response

Body ()
Root Schema : schema
Type: object
Show Source
Example Response (application/json)
{
    "errorCode":"MFT-7415",
    "errorKey":"MFT_UNSUPPORTED_ARTIFACT_TYPE",
    "errorMessage":"Unsupported artifact type found. Artifact type: {TYPE}."
}
Back to Top

Examples

Example of Response Body

The following example shows how to delete specific artifact based on type and name by submitting a DELETE request on the REST resource using cURL.
curl -i -X DELETE -u <username>:<password> -H "Content-Type: multipart/form-data" http://host:port/mftapp/rest/v1/artifacts/target/test

The response returns a 200 OK if delete was successful. The following example shows the contents of the response body in case of an error:

{
    "errorCode": "MFT-7463",
    "errorKey": "MFT_UTILITY_ARTIFACT_NOT_FOUND_WITH_GIVEN_NAME",
    "errorMessage": ""The target [test] is currently associated with some transfers and so cannot be deleted."
}
Back to Top