Create or Import a New Project into the Space
/ic/api/process/v1/spaces/{spaceId}/projects
Request
-
description: string
The project description
-
exp: file
The project .exp file to be imported
-
projectName(required): string
The project name
-
quickStartAppId: string
If provided, it will create a new project from a quickstart app
Response
- application/json
- application/xml;qs=0.9
200 Response
object
201 Response
400 Response
401 Response
403 Response
404 Response
409 Response
500 Response
Examples
The following example shows how to create or import a project by submitting a POST request on the REST resource.
curl -X POST --header 'Content-Type: multipart/form-data' --header 'Accept: application/json' -H 'Authorization: Bearer access_token' -F 'projectName=MyProject321' -F 'description=This is my new project' -F 'quickStartAppId=Travel Approval' 'http://example.com.com:7001/ic/api/process/v1/spaces/<spaceId>/projects'
Where,
-
example.com
is the host where Oracle Integration is running. -
<version> is the REST API version.
-
Content-Type
:multipart/form-data
-
Request URL
:http://example.com:7001/ic/api/process/<version>/spaces/<spaceId>/projects
-
<spaceId> is the unique ID for a space. To retrieve available spaces, see Retrieve Spaces.
The following shows the request parameters to create a project. You need to provide all the parameters as multipart/form-data
.
-
projectName
: Specify the name of the project, for exampleMyProject
-
description
: Specify the description of the project. -
quickStartAppId
: (Optional) Specify the Id of the QuickStart APP. If you provide this option, a new project is created from aQuickStart APP
. To retrieve available QuickStart APPs, see Retrieve QuickStart Apps.The following is the example of the Response body of the
Retrieve Quick Start Apps
REST API. In this example,Form Approval
is thequickStartAppId.
{ "name": "Form Approval", "description": "In this application, the process owner submits a request for approval and fulfillment. If the request is denied, the applicant may resubmit with additional information.", "type": "ORACLE", "links": [ { "href": "http://example.com:7001/ic/api/processs/v1/quickStartApps/Form%20Approval", "rel": "self" }, ] },
-
exp
: (Optional) Specify the project.exp
file to be imported. If you provide this option, the created project will be imported..
Example of Response Header
Status Code: 201 Created Date: Mon, 03 Apr 2017 09:39:39 GMT Content-Type: application/json
Example of Response Body
{ "id": "MyProject", "name": "MyProject", "description": "This is my new project", "type": "BPM", "creator": "jsmith", "creation": "2017-04-03,02:39:39 PDT", "links": [ { "href": "http://example.com:7001/ic/api/processs/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project1", "rel": "self" }, { "href": "http://example.com:7001/ic/api/processs/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project1", "rel": "canonical" }, { "href": "http://example.com:7001/ic/api/processs/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23", "rel": "parent" }, { "href": "http://example.com:7001/ic/api/processs/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project1/processes", "rel": "child" }, { "href": "http://example.com:7001/ic/api/processs/v1/spaces/89f7e082-6855-4a75-b2a6-6a726aff7f23/projects/My%20Project1/snapshots", "rel": "child" } ] }