Jump to

• Request
• Response
• Examples

Retrieve Projects

get

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

It will retrieve only projects you are authorized to see

Request

Path Parameters

• spaceId(required): string
  The space ID

Query Parameters

• expand: array[string]
  Collection Format: multi

  Specify expanded information the returned models should contain

  • Allowed Values: [ "SNAPSHOTS" ]

• userMode: string
  Applicable only for Administrators. Executes the API in given user mode.

  Default Value: none

  Allowed Values: [ "DEVELOPER", "NONE" ]

Back to Top

Response

Supported Media Types

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

200 Response

Success. Retrieve Projects.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object project
  the representation of a design time project

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

Nested Schema : project

Type: object

the representation of a design time project

401 Response

Unauthorized

500 Response

Error in retrieving projects

Back to Top

Examples

The following example shows how to retrieve the projects that you are authorized to view by submitting a GET request on the REST resource.

Send Request

The following example shows the contents of the send request:

https://example.com/ic/api/process/v1/spaces/<spaceId>/projects

Where,

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

• <spaceId> is the unique ID for a space. To retrieve available spaces, see Retrieve Spaces.

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

The following example shows the contents of the response body in JSON format, including the updated description of the project.

{
  "items": [
    {
      "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"
        }
      ]
    },
    {
      "id": "MyNewProject",
      "name": "MyNewProject",
      "description": "",
      "type": "BPM",
      "creator": "jsmith",
      "creation": "2017-04-03,02:14:37 PDT",
      "links": [
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project",
          "rel": "self"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project",
          "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%20Project/processes",
          "rel": "child"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project/snapshots",
          "rel": "child"
        }
      ]
    },
    {
      "id": "oldproject",
      "name": "oldproject",
      "description": "This is my old project",
      "type": "BPM",
      "creator": "jsmith",
      "creation": "2017-04-03,03:03:56 PDT",
      "links": [
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/old%20project1",
          "rel": "self"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/old%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/old%20project1/processes",
          "rel": "child"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/old%20project1/snapshots",
          "rel": "child"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects",
      "rel": "self"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects",
      "rel": "canonical"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23",
      "rel": "parent"
    }
  ]
}

Back to Top