Retrieve a Space by ID
get
/ic/api/process/v1/spaces/{spaceId}
Returns information of a space based on the specified ID.
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:
[ "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" ]
Response
Supported Media Types
- application/json
- application/xml;qs=0.9
200 Response
Success. Retrieve Space.
Root Schema : space
Type:
object
The representation of a Space
401 Response
Unauthorized
404 Response
Space is not found.
500 Response
Error in retrieving space
Examples
The following example shows how to retrieve details for the specified space ID 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>
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: Tue, 21 Mar 2017 08:39:54 GMT Content-Type: application/json
Example of Response Body
{ "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" } ] }