Jump to

• Request
• Response
• Examples

Update the application properties on the server

put

/mftapp/rest/v1/artifacts/appProperties

Updates the application properties on the server.

Request

Supported Media Types

• application/json

Header Parameters

• location: string
  Relative URL of the update SFTP properties event.

Body ()

Root Schema : schema

Type: object

Show Source

• calloutDirectory(optional): string
• controlDirectory(optional): string
• externalAddress(optional): string
• externalFtp(optional): integer
• externalFtps(optional): integer
• externalSftp(optional): integer
• generateChecksum(optional): boolean
  Whether to generate checksum.
• inboundDatasource(optional): string
• instanceProcessors(optional): integer
• internalAddress(optional): string
• internalFtp(optional): integer
• internalFtps(optional): integer
• internalSftp(optional): integer
• outboundDatasource(optional): string
• payloadStorageDirectory(optional): string
  Directory where the payload is stored.
• sourceProcessors(optional): integer
• storeInlinePayload(optional): string
• storeReferencePayload(optional): boolean
• targetProcessors(optional): integer

{
    "type":"object",
    "properties":{
        "outboundDatasource":{
            "type":"string",
            "description":""
        },
        "internalFtp":{
            "type":"integer",
            "description":""
        },
        "controlDirectory":{
            "type":"string",
            "description":""
        },
        "internalAddress":{
            "type":"string",
            "description":""
        },
        "externalFtp":{
            "type":"integer",
            "description":""
        },
        "sourceProcessors":{
            "type":"integer",
            "description":""
        },
        "instanceProcessors":{
            "type":"integer",
            "description":""
        },
        "storeReferencePayload":{
            "type":"boolean",
            "description":""
        },
        "payloadStorageDirectory":{
            "type":"string",
            "description":"Directory where the payload is stored. "
        },
        "inboundDatasource":{
            "type":"string",
            "description":""
        },
        "storeInlinePayload":{
            "type":"string",
            "description":""
        },
        "externalSftp":{
            "type":"integer",
            "description":""
        },
        "targetProcessors":{
            "type":"integer",
            "description":""
        },
        "generateChecksum":{
            "type":"boolean",
            "description":"Whether to generate checksum."
        },
        "externalFtps":{
            "type":"integer",
            "description":""
        },
        "internalFtps":{
            "type":"integer",
            "description":""
        },
        "internalSftp":{
            "type":"integer",
            "description":""
        },
        "calloutDirectory":{
            "type":"string",
            "description":""
        },
        "externalAddress":{
            "type":"string",
            "description":""
        }
    }
}

Example Request (application/json)

{
    "outboundDatasource":"outds",
    "internalFtp":21,
    "controlDirectory":"/test/milton",
    "internalAddress":"127.0.0.1",
    "externalFtp":21,
    "sourceProcessors":1,
    "instanceProcessors":2,
    "storeReferencePayload":true,
    "payloadStorageDirectory":"/test",
    "inboundDatasource":"inds",
    "storeInlinePayload":"fileSystem",
    "externalSftp":22,
    "targetProcessors":3,
    "generateChecksum":true,
    "externalFtps":990,
    "internalFtps":990,
    "internalSftp":22,
    "calloutDirectory":"/tester",
    "externalAddress":"127.0.0.1"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

App properties were updated.

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-6036",
    "errorKey":"MFT_CSF_KEY_DOES_NOT_EXIST_EXCEPTION",
    "errorMessage":"Key not found for the given key alias aliasName in credential store."
}

Back to Top

Examples

The following example shows how to update the application properties on the server by submitting a PUT request on the REST resource using cURL.

curl -i -X PUT -u <username>:<password> -H "Content-type: application/json" -d '{"internalFtp":21, "internalAddress":"127.0.0.1",  "externalFtp":21,   "sourceProcessors":1, "instanceProcessors":2, "storeReferencePayload":true, "payloadStorageDirectory":"/.../user_projects/domains/base_domain/mft/storage", "storeInlinePayload":"fileSystem", "externalSftp":22, "targetProcessors":3, "generateChecksum":true, "externalFtps":990, "internalFtps":990, "internalSftp":22, "calloutDirectory":"/.../user_projects/domains/base_domain/mft/callouts", "externalAddress":"127.0.0.1"}' http://host:port/mftapp/rest/v1/artifacts/appProperties 

 

Back to Top