Jump to

• Request
• Response
• Examples

Deploy a Project

post

/ic/api/process/v1/targets/{targetId}

Deploys a project and returns the deployed project version.

Request

Supported Media Types

• multipart/form-data
• application/octet-stream
• application/zip

Path Parameters

• targetId(required): string
  The target ID

  Allowed Values: [ "ORACLEINTERNALPCS", "ORACLEINTERNALPCSPLAYER" ]

Form Parameters

• exp(required): file
  The project .exp file to be deployed
• restDeployConfig(required): string
  The deploy and endpoints configuration json string. Please refer to the body of API RestDeployConfig.

  "

Back to Top

Response

Supported Media Types

• application/json
• application/xml;qs=0.9

200 Response

successful operation

Body ()

Root Schema : deployedProject

Type: object

201 Response

Success. Project successfully deployed.

401 Response

Unauthorized

403 Response

Privileges required. User can't deploy the project

500 Response

Error in deploying project

Back to Top

Examples

The following example shows how to deploy a project by submitting a POST request on the REST resource.

Send Request

curl -X POST --header 'Content-Type: multipart/form-data' --header 'Accept: application/json' --header 'Authorization: Bearer access_token' -F 'restDeployConfig={"revisionId": "2.0", "overwrite": true, "forceDefault": true, "addMeToAllRoles": false}' -F 'exp=@Application.exp' 'http://example.oracle.com/ic/api/process/v1/targets/<targetId>'

Where

• example.com is the host where Oracle Integration is running.

• content-type: multipart/form-data

• <targetId>is the deployment partition target of a project. The allowed value is ORACLEINTERNALPCS and this endpoint does not support ORACLEINTERNALPCSPLAYER.

Example of Response Body

{
    "partition": "oracleinternalpcs",
    "revisionId": "2.0",
    "RunTimeLiveInfo": {
        "state": "ON",
        "mode": "ACTIVE"
    },
    "DesignTimeProjectReference": {
        "spaceId": "NA",
        "projectId": "callableapp"
    },
    "RunTimeDeployInfo": {
        "deployTime": "2018-07-25,09:16:38 UTC",
        "isDefault": true
    },
    "processDefIds": [
        "oracleinternalpcs~callableapp!2.0~ProcessMessagereceive"
    ],
    "links": [
        {
            "href": "http://example.com/ic/api/process/v1/targets/oracleinternalpcs/projects/callableapp/revisions/2.0",
            "rel": "self"
        },
        {
            "href": "http://example.com/ic/api/process/v1/targets/oracleinternalpcs/projects/callableapp/revisions/2.0",
            "rel": "canonical"
        },
        {
            "href": "http://example.com:/ic/api/process/v1/",
            "rel": "parent"
        }
    ]
}

Back to Top