REST API for Oracle Managed File Transfer

Delete specific artifact based on type and name.

delete

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

Deletes a specific artifact based on type and name. 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

artifactName(required): string

Name of Artifact
artifactType(required): string

Type of Artifact

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

500 Response

Root Schema : schema

Type: object

Show Source

errorCode: string

The error code that Oracle Managed File Transfer returns.
errorKey: string

The error key that Oracle Managed File Transfer returns.
errorMessage: string

A message describing the error that Oracle Managed File Transfer returns.

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"The error code that Oracle Managed File Transfer returns."
        },
        "errorKey":{
            "type":"string",
            "description":"The error key that Oracle Managed File Transfer returns."
        },
        "errorMessage":{
            "type":"string",
            "description":"A message describing the error that Oracle Managed File Transfer returns."
        }
    }
}

Example Response (application/json)

{
    "errorCode":"MFT-7415",
    "errorKey":"MFT_UNSUPPORTED_ARTIFACT_TYPE",
    "errorMessage":"Unsupported artifact type found. Artifact type: {TYPE}."
}

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