REST API for Oracle Integration

Deploy the Latest Published Version of a Project

post

/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/deploy

Returns the deployed project version

Request

Supported Media Types

application/json

Path Parameters

projectId(required): string

The project ID
spaceId(required): string

The space ID

Query Parameters

targetId: string

Select deployment partition target

Default Value: ORACLEINTERNALPCS

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

The endpoints configuration

Root Schema : DeployConfig

Type: object

configuration for deploying a new revision of the project

Show Source

addMeToAllRoles: boolean

add current user to all process roles. Its applicable to PLAYER partition only
businessParameters: array businessParameters
defaultRetries: boolean

includes fault policies by default to handle system exceptions
endpointsConfig: object endpointsConfig
forceDefault: boolean

whether the deployed project should be used as default. Always true for PLAYER partition.
overwrite: boolean

This property is deprecated for OracleInternaPCS partition. Always true for OracleInternalPCSPlayer partition
revisionId: string

the deployed project revision. Not applicable for PLAYER partition as we deploy only 1.0 version on PLAYER.

Example: 1.0
useFaultPolicies: boolean

includes fault policies by default to handle system exceptions

{
    "type":"object",
    "properties":{
        "revisionId":{
            "type":"string",
            "example":"1.0",
            "description":"the deployed project revision. Not applicable for PLAYER partition as we deploy only 1.0 version on PLAYER."
        },
        "overwrite":{
            "type":"boolean",
            "description":"This property is deprecated for OracleInternaPCS partition. Always true for OracleInternalPCSPlayer partition"
        },
        "forceDefault":{
            "type":"boolean",
            "description":"whether the deployed project should be used as default.  Always true for PLAYER partition."
        },
        "addMeToAllRoles":{
            "type":"boolean",
            "description":"add current user to all process roles. Its applicable to PLAYER partition only"
        },
        "useFaultPolicies":{
            "type":"boolean",
            "description":"includes fault policies by default to handle system exceptions\n"
        },
        "defaultRetries":{
            "type":"boolean",
            "description":"includes fault policies by default to handle system exceptions\n"
        },
        "endpointsConfig":{
            "$ref":"#/definitions/RestEndpointsConfig"
        },
        "businessParameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RestBusinessParameter"
            }
        }
    },
    "description":"configuration for deploying a new revision of the project",
    "xml":{
        "name":"DeployConfig"
    }
}

Nested Schema : businessParameters

Type: array

Show Source

Array of: object businessParameters

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RestBusinessParameter"
    }
}

Nested Schema : endpointsConfig

Type: object

Nested Schema : businessParameters

Type: object

Show Source

name: string
value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "xml":{
        "name":"businessParameters"
    }
}

Response

Supported Media Types

application/json
application/xml;qs=0.9

200 Response

successful operation

Root Schema : deployedProject

Type: object

201 Response

Success. Project succesfully deployed.

401 Response

Unauthorized

403 Response

Privileges required. User can't deploy the project

404 Response

Space/Project not found.

500 Response

Error in deploying project

Examples

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

Send Request

The following example shows the contents of the send request:

https://example.com/ic/api/process/<version>/spaces/<spaceId>/projects/<projectId>/snapshots/<snapshotId>/deploy?target=<targetId>

Where,

example.com is the host where Oracle Integration is running.
<version> is the REST API version.
<spaceId> is the unique ID for a space. To retrieve available spaces, see Retrieve Spaces.
<projectId> is the unique ID for a project. To retrieve available projects, see Retrieve projects
<snapshotId> is the unique ID for a snapshot. To retrieve available snapshots, see Retrieve the snapshots of a given project
<targetId> is the deployment partition target of a project. Allowed values are ORACLEINTERNALPCS and ORACLEINTERNALPCSPLAYER.

Example of Request Header

Content-Type:  application/json

Example of Request Body

  {
  "revisionId": "1.0",
  "overwrite": false,
  "forceDefault": false,
  "addMeToAllRoles": false,
 }

Example of Response Header

Status Code: 200 OK
Date:  Tue, 21 Mar 2017 08:39:54 GMT
Content-Type:  application/json

Example of Response Body

{
  "partition": "ORACLEINTERNALPCS",
  "revisionId": "1.0",
  "RunTimeLiveInfo": {
    "state": "ON",
    "mode": "ACTIVE"
  },
  "DesignTimeProjectReference": {
    "spaceId": "89f7e082-6855-4a75-b2a6-6a726aff7f23",
    "projectId": "myprojectdeploy",
    "snapshotId": "Snapshot"
  },
  "RunTimeDeployInfo": {
    "deployTime": "2017-04-04,22:09:40 PDT",
    "isDefault": false
  },
  "processDefIds": [
    "oracleinternalpcs~myprojectdeploy!4.0~FormApprovalProcess"
  ],
  "links": [
    {
      "href": "http://example.com:7001/ic/api/process/v1/targets/oracleinternalpcs/projects/myprojectdeploy/revisions/4.0",
      "rel": "self"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/targets/oracleinternalpcs/projects/myprojectdeploy/revisions/4.0",
      "rel": "canonical"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/",
      "rel": "parent"
    }
  ]
}