Jump to

• Request
• Response
• Examples

Retrieve Spaces

get

/ic/api/process/v1/spaces

Returns information of all available spaces that you are authorized to view.

Request

Query Parameters

• expand: array[string]
  Collection Format: multi

  Specify expanded information the returned models should contain

  • Allowed Values: [ "PROJECTS", "PERMISSIONS", "CURRENT_USER_ROLE" ]

• 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 Spaces.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object space
  The representation of a Space

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

Nested Schema : space

Type: object

The representation of a Space

401 Response

Unauthorized

500 Response

Error in retrieving spaces

Back to Top

Examples

The following example shows how to retrieve spaces you are authorized 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

Where,

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

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

{
  "items": [
    {
      "id": "89f7e082-6855-4a75-b2a6-6a726aff7f23",
      "name": "space1",
      "creator": "jsmith",
      "creation": "2017-03-28,11:36:31 PDT",
      "links": [
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23",
          "rel": "self"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23",
          "rel": "canonical"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/",
          "rel": "parent"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects",
          "rel": "child"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/permissions",
          "rel": "child"
        }
      ]
    },
    {
      "id": "8c4ebcfb-e9e0-4f11-bfc3-af36a75351c9",
      "name": "My Space2",
      "creator": "jsmith",
      "creation": "2017-04-03,02:08:58 PDT",
      "links": [
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/8c4ebcfb-e9e0-4f11-bfc3-af36a75351c9",
          "rel": "self"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/8c4ebcfb-e9e0-4f11-bfc3-af36a75351c9",
          "rel": "canonical"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/",
          "rel": "parent"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/8c4ebcfb-e9e0-4f11-bfc3-af36a75351c9/projects",
          "rel": "child"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/8c4ebcfb-e9e0-4f11-bfc3-af36a75351c9/permissions",
          "rel": "child"
        }
      ]
    },
    {
      "id": "7fcae089-54d0-4315-b452-002ac8d74097",
      "name": "My Space",
      "creator": "jsmith",
      "creation": "2017-04-03,01:25:04 PDT",
      "links": [
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/7fcae089-54d0-4315-b452-002ac8d74097",
          "rel": "self"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/7fcae089-54d0-4315-b452-002ac8d74097",
          "rel": "canonical"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/",
          "rel": "parent"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/7fcae089-54d0-4315-b452-002ac8d74097/projects",
          "rel": "child"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/7fcae089-54d0-4315-b452-002ac8d74097/permissions",
          "rel": "child"
        }
      ]
    },
    {
      "id": "ab5f6943-0711-4c63-9037-1b6b08019770",
      "name": "My Space2",
      "creator": "jsmith",
      "creation": "2017-04-03,21:56:53 PDT",
      "links": [
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/ab5f6943-0711-4c63-9037-1b6b08019770",
          "rel": "self"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/ab5f6943-0711-4c63-9037-1b6b08019770",
          "rel": "canonical"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/",
          "rel": "parent"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/ab5f6943-0711-4c63-9037-1b6b08019770/projects",
          "rel": "child"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/ab5f6943-0711-4c63-9037-1b6b08019770/permissions",
          "rel": "child"
        }
      ]
    },
    {
      "id": "46423b0a-a6a1-4748-b677-e8160bf50ce9",
      "name": "My Space 2",
      "creator": "jsmith",
      "creation": "2017-03-30,23:01:11 PDT",
      "links": [
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9",
          "rel": "self"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9",
          "rel": "canonical"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/",
          "rel": "parent"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects",
          "rel": "child"
        },
        {
          "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/permissions",
          "rel": "child"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces",
      "rel": "self"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces",
      "rel": "canonical"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/",
      "rel": "parent"
    }
  ]
}

Back to Top