REST API for Oracle Integration

Create a DesignTime Process

post

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

Creates a new designtime process and returns details for the newly created design time process including the name, description and the ID of the design time process.

Request

Supported Media Types

application/json

Path Parameters

projectId(required): string

The project ID
spaceId(required): string

The space ID

The process creation options

Root Schema : creationProperties

Type: object

Properties for the process creation

Show Source

customProperties: object customProperties

Additional Properties Allowed: additionalProperties

Properties to customize the process creation. Applicable only to some templates
description: string

process description

Example: My process description
name: string

process name

Example: MyProcess
type: string

Allowed Values: [ "NONE", "FORM", "MESSAGE", "FORM_APPROVAL", "MESSAGE_APPROVAL", "FORM_RULE_APPROVAL", "FORM_APPROVAL_INTEGRATION", "FORM_MULTI_STAGE_APPROVAL", "MESSAGE_RULE_APPROVAL", "SAAS_EVENT_TRIGGER", "CROSS_APPLICATION", "ABCS_INTEGRATION", "MP_INTEGRATION" ]

process type

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"MyProcess",
            "description":"process name"
        },
        "type":{
            "type":"string",
            "description":"process type",
            "enum":[
                "NONE",
                "FORM",
                "MESSAGE",
                "FORM_APPROVAL",
                "MESSAGE_APPROVAL",
                "FORM_RULE_APPROVAL",
                "FORM_APPROVAL_INTEGRATION",
                "FORM_MULTI_STAGE_APPROVAL",
                "MESSAGE_RULE_APPROVAL",
                "SAAS_EVENT_TRIGGER",
                "CROSS_APPLICATION",
                "ABCS_INTEGRATION",
                "MP_INTEGRATION"
            ]
        },
        "description":{
            "type":"string",
            "example":"My process description",
            "description":"process description"
        },
        "customProperties":{
            "type":"object",
            "description":"Properties to customize the process creation. Applicable only to some templates",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"Properties for the process creation",
    "xml":{
        "name":"creationProperties"
    }
}

Nested Schema : customProperties

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "description":"Properties to customize the process creation. Applicable only to some templates",
    "additionalProperties":{
        "type":"string"
    }
}

Properties to customize the process creation. Applicable only to some templates

Response

Supported Media Types

application/json
application/xml;qs=0.9

200 Response

successful operation

Root Schema : process

Type: object

process data

201 Response

Success. Process succesfully created.

401 Response

Unauthorized

500 Response

Error in creating process

Examples

The following example shows how to create a process by submitting a POST 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>/processes

Where,

example.com is the host where Oracle Integration is running.
<version> is the REST API version.
<projectId> is the unique ID for a project. To retrieve available projects, see Retrieve projects

Example of Request Header

Content-Type:  application/json

Example of Request Body

{
  "name": "MyProcess",
  "type": "FORM",
  "description": "My process description",
  "customProperties": {}
}

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": "MyProcess",
    "name": "MyProcess",
    "description": "My process description",
    "author": "jsmith",
    "entryPoints": [
        {
            "id": "EVT18969321890787",
            "bpmnType": "START_EVENT",
            "interfaceElements": {}
        }
    ],
    "links": [
        {
            "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/old%20project/processes/MyProcess1",
            "rel": "self"
        },
        {
            "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/old%20project/processes/MyProcess1",
            "rel": "canonical"
        },
        {
            "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/old%20project",
            "rel": "parent"
        }
    ]
}