Jump to

• Request
• Response
• Examples

Check if artifact exists in MFT Repository

get

/mftapp/rest/v1/artifacts/repository

Check if artifact exists in MFT repository.

Request

Query Parameters

• artifactName: string
  Name of the artifact to be verified.
• artifactType: string
  Type of the artifact to be verified, only supports TRANSFER artifactType.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• artifactExists(optional): boolean

{
    "type":"object",
    "properties":{
        "artifactExists":{
            "type":"boolean"
        }
    }
}

500 Response

Body ()

Root Schema : schema

Type: object

Show Source

• errorCode(optional): string
  The error code that Oracle Managed File Transfer returns.
• errorKey(optional): string
  The error key that Oracle Managed File Transfer returns.
• errorMessage(optional): 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: {SOURCE}."
}

Back to Top

Examples

Example of Response Body

The following example shows how to check if an artifact exists in the repository by submitting a GET request on the REST resource using cURL.

curl -v  GET -u username:welcome1' -H "Content-Type: multipart/form-data" http://host:port/mftapp/rest/v1/artifacts/repository?artifactName=test2&artifactType=SOURCE' 

The following example shows the contents of the response body for a successful response:

{
	"artifactExists": true
}

The following example shows the contents of the response body if there is an error:

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

Back to Top