REST API for Oracle Integration

Update the Project Description

put

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

Returns the updated project

Request

Supported Media Types

application/x-www-form-urlencoded

Path Parameters

projectId(required): string

The project ID
spaceId(required): string

The space ID

Form Parameters

description: string

Response

Supported Media Types

application/json
application/xml;qs=0.9

200 Response

Success. Project successfully updated.

Root Schema : project

Type: object

the representation of a design time project

401 Response

Unauthorized

403 Response

Privileges required. User can't update the project

404 Response

Space/Project not found.

500 Response

Error in updating project

Examples

The following example shows how to update the description of the project by submitting a PUT request on the REST resource.

curl -X PUT --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' -H 'Authorization: Bearer access_token' -d 'description=This is my New project' 'http://example.com:7001/ic/api/process/v1/spaces/<spaceId>/projects/<projectId>'

Where,

example.com is the host where Oracle Integration is running.
<version> is the REST API version.
Content-Type: application/x-www-form-urlencoded
Request URL: http://example.com:7001/ic/api/process/<version>/spaces/<spaceId>/projects/<projectId>
<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

The following shows the required request parameters to update a project. You need to provide application/x-www-form-urlencoded parameter.

description: Specify the description of the project.

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

{
  "id": "MyProject",
  "name": "MyProject",
  "description": "New project",
  "type": "BPM",
  "creator": "jsmith",
  "creation": "2017-04-03,02:39:39 PDT",
  "links": [
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project1",
      "rel": "self"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project1",
      "rel": "canonical"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23",
      "rel": "parent"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project1/processes",
      "rel": "child"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project1/snapshots",
      "rel": "child"
    }
  ]
}