REST API for Oracle Integration

Update a Deployed Project Revision

patch

/ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}

Updates the revision of a project.

Request

Supported Media Types

application/json

Path Parameters

projectId(required): string

The project ID
revision(required): string

The revision ID
targetId(required): string

Select deployment partition target

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

The change specified by following the JSON Merge Patch standard

Root Schema : RunTimeLiveInfo

Type: object

runtime information about this project revision. This changes need to conform to the JSON Merge Patch standard RFC 7386.

Show Source

mode: string

Allowed Values: [ "ACTIVE", "RETIRED" ]

the revision mode
state: string

Allowed Values: [ "ON", "OFF" ]

the revision state

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"the revision state",
            "enum":[
                "ON",
                "OFF"
            ]
        },
        "mode":{
            "type":"string",
            "description":"the revision mode",
            "enum":[
                "ACTIVE",
                "RETIRED"
            ]
        }
    },
    "description":"runtime information about this project revision. This changes need to conform to the JSON Merge Patch standard RFC 7386.",
    "xml":{
        "name":"RunTimeLiveInfo"
    }
}

Response

Supported Media Types

application/json
application/xml;qs=0.9

200 Response

Success. Deployed project succesfully updated.

Root Schema : deployedProject

Type: object

401 Response

Unauthorized

403 Response

Privileges required. User can't update the deployed project revision

500 Response

Error in un updating deployed project revision

Examples

The following example shows how to update the revision of a project by submitting a PATCH request on the REST resource by using post tunneling.

curl -X POST \
-H "Authorization: Bearer access_token\
-H 'content-type: application/json' \
-H 'x-http-method-override: PATCH' \
-d '{     "state": "ON",     "mode": "ACTIVE"   }'
https://example.com/ic/api/process/v1/targets/oracleinternalpcs/projects/DOCs/revisions/5

Send Request

The following example shows the contents of the send request:

https://example.com/ic/api/process/<version>/targets/<targetId>/projects/<projectId>/revisions/<revision>

Where,

example.com is the host where Oracle Integration is running.
<version> is the REST API version.
<targetId> is the deployment partition target of a project. Allowed values are ORACLEINTERNALPCS and ORACLEINTERNALPCSPLAYER.
<projectId> is the unique ID for a project. To retrieve available projects, see Retrieve projects
<revision> is the revision number for a project. To retrieve available revisions, see Retrieve all revisions of the specified project

Example of Request Header

Content-Type:  application/json

Example of Request Body

{
  "state": "ON",
  "mode": "ACTIVE"
}

Example of Response Header

Status Code: 200 OK
Date:   Mon, 03 Apr 2017 09:39:39 GMT 
Content-Type:  application/json

Example of Response Body

{
  "partition": "ORACLEINTERNALPCS",
  "revisionId": "1.0",
  "RunTimeLiveInfo": {
    "state": "ON",
    "mode": "ACTIVE"
  },
  "DesignTimeProjectReference": {
    "spaceId": "c8e6ce16-ce2d-4090-add5-ec0bc3cc7eeb",
    "projectId": "Mynewproject"
  },
  "RunTimeDeployInfo": {
    "deployTime": "2017-04-04,23:29:02 PDT",
    "isDefault": false
  },
  "processDefIds": [oracleinternalpcs~projecttodeploy1!1.0~TravelApproval],
  "links": [
    {
      "href": "http://example.com:7001/ic/api/process/v1/targets/oracleinternalpcs/projects/Mynewproject/revisions/1.0",
      "rel": "self"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/targets/oracleinternalpcs/projects/Mynewproject/revisions/1.0",
      "rel": "canonical"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/",
      "rel": "parent"
    }
  ]
}