Retrieve a Project by ID
get
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}
Request
Path Parameters
-
projectId(required): string
The project ID
-
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" ]
Response
Supported Media Types
- application/json
- application/xml;qs=0.9
200 Response
Success. Retrieve Project.
Root Schema : project
Type:
object
the representation of a design time project
401 Response
Unauthorized
404 Response
Space/Project not found.
500 Response
Error in retrieving project
Examples
The following example shows how to retrieve the details of a project based on the 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/<version>/spaces/<spaceId>/projects/<projectId>
Where,
-
example.com
is the host where Oracle Integration is running. -
<version> is the REST API version.
-
<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
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": "NewProject", "name": "NewProject", "description": "This is my new project", "type": "BPM", "creator": "jsmith", "creation": "2017-03-31,00:08:39 PDT", "links": [ { "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/New%20Project", "rel": "self" }, { "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/New%20Project", "rel": "canonical" }, { "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9", "rel": "parent" }, { "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/New%20Project/processes", "rel": "child" }, { "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/New%20Project/snapshots", "rel": "child" } ] }