Jump to

• Request
• Response
• Examples

List Process Interfaces

get

/process/api/v1/process-interfaces

List process interfaces for the current user.

Request

Query Parameters

• applicationName: string
  Filter by Application Name. Exact match.
• canInstantiate: boolean
  Filter by Applications which can be instantiated by users.

  Default Value: false
• defaultVersion: boolean
  Include only Interfaces of Applications with Default versions
• definitionId: string
  Filter by definition ID
• definitionIdIn: array[string]
  Filter by definition IDs in the array.
• definitionKey: string
  Filter by definition key
• definitionKeyIn: array[string]
  Filter by definition keys in the array.
• definitionType: string
  Filter by definition type

  Allowed Values: [ "DP", "PROCESS" ]
• expandSchema: boolean
  AdditionalInfo. Include expanded schema of arguments having complex data types

  Default Value: false
• keyword: string
  Keyword search against process or case definition name and applicationName.
• limit: integer
  Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

  Default Value: 25
• offset: integer
  Pagination of results. Specifies the index of the first result to return.

  Default Value: 0
• sortBy: string
  Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

  Default Value: applicationName

  Allowed Values: [ "applicationName" ]
• sortOrder: string
  Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

  Default Value: ASC

  Allowed Values: [ "ASC", "DESC" ]
• totalResults: boolean
  Specifies if total number of results need to be returned

  Default Value: false
• totalResultsGrouped: boolean
  AdditionalInfo. Specifies if count by group statistics across all pages need to be returned. Grouped by "DEFAULT","ALL" Definition Versions.

  Default Value: false
• type: string
  Filter by inteface type. Exact match.

  Allowed Values: [ "NONE_START", "FORM_START", "MESSAGE_START" ]

Header Parameters

• Accept-Language:
  Accept-Language header in IETF BCP 47.
• oci-original-url:
  Actual endpoint which customer requested

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ProcessInterfaces

Match All

Show Source

• object CommonModel
• object ProcessInterfaces-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProcessInterface"
                    }
                },
                "totalResults":{
                    "type":"integer",
                    "description":"total number of rows that satisfy the request"
                },
                "limit":{
                    "type":"integer",
                    "description":"actual page size used by the server"
                },
                "count":{
                    "type":"integer",
                    "description":"total number of records in the current response"
                },
                "hasMore":{
                    "type":"boolean",
                    "description":"whether there are more pages to fetch"
                },
                "offset":{
                    "type":"integer",
                    "description":"the actual index from which the singular resources are returned"
                },
                "totalResultsGrouped":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/GroupedCount"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : ProcessInterfaces-allOf[1]

Type: object

Show Source

• count: integer
  total number of records in the current response
• hasMore: boolean
  whether there are more pages to fetch
• items: array items
• limit: integer
  actual page size used by the server
• offset: integer
  the actual index from which the singular resources are returned
• totalResults: integer
  total number of rows that satisfy the request
• totalResultsGrouped: array totalResultsGrouped

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessInterface"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"total number of rows that satisfy the request"
        },
        "limit":{
            "type":"integer",
            "description":"actual page size used by the server"
        },
        "count":{
            "type":"integer",
            "description":"total number of records in the current response"
        },
        "hasMore":{
            "type":"boolean",
            "description":"whether there are more pages to fetch"
        },
        "offset":{
            "type":"integer",
            "description":"the actual index from which the singular resources are returned"
        },
        "totalResultsGrouped":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GroupedCount"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: ProcessInterface

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessInterface"
    }
}

Nested Schema : totalResultsGrouped

Type: array

Show Source

• Array of: object GroupedCount

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/GroupedCount"
    }
}

Nested Schema : ProcessInterface

Match All

Show Source

• object CommonModel
• object ProcessInterface-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "required":[
                "id"
            ],
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"ID of interface"
                },
                "type":{
                    "type":"string",
                    "description":"Type of Interface"
                },
                "title":{
                    "type":"string",
                    "description":"Interface of Title"
                },
                "description":{
                    "type":"string",
                    "description":"Interface description"
                },
                "formMetadataURL":{
                    "type":"string",
                    "description":"Form url associated with the process"
                },
                "inputs":{
                    "type":"array",
                    "description":"Input arguments of this interface",
                    "items":{
                        "$ref":"#/components/schemas/IOArgument"
                    }
                },
                "outputs":{
                    "type":"array",
                    "description":"Output arguments of this interface",
                    "items":{
                        "$ref":"#/components/schemas/IOArgument"
                    }
                },
                "defaultInterface":{
                    "type":"boolean",
                    "description":"If this is the default interface of the definition"
                },
                "definitionId":{
                    "type":"string",
                    "description":"Definition ID"
                },
                "definitionType":{
                    "type":"string",
                    "description":"Definition type. PROCESS or DP"
                },
                "activityId":{
                    "type":"string",
                    "description":"Id of the Activity in definition"
                },
                "applicationName":{
                    "type":"string",
                    "description":"Application Name"
                },
                "applicationTitle":{
                    "type":"string",
                    "description":"Application Title"
                },
                "applicationDescription":{
                    "type":"string",
                    "description":"Application Description"
                },
                "definitionTitle":{
                    "type":"string",
                    "description":"Definition Title"
                },
                "definitionDescription":{
                    "type":"string",
                    "description":"Definition Description"
                },
                "version":{
                    "type":"string",
                    "description":"Application Version"
                },
                "defaultVersion":{
                    "type":"boolean",
                    "description":"If application is the default version"
                },
                "definitionName":{
                    "type":"string",
                    "description":"Definition name"
                },
                "definitionKey":{
                    "type":"string",
                    "description":"Definition key"
                },
                "operationName":{
                    "type":"string",
                    "description":"operation name"
                }
            }
        }
    ]
}

Nested Schema : ProcessInterface-allOf[1]

Type: object

Show Source

• activityId: string
  Id of the Activity in definition
• applicationDescription: string
  Application Description
• applicationName: string
  Application Name
• applicationTitle: string
  Application Title
• defaultInterface: boolean
  If this is the default interface of the definition
• defaultVersion: boolean
  If application is the default version
• definitionDescription: string
  Definition Description
• definitionId: string
  Definition ID
• definitionKey: string
  Definition key
• definitionName: string
  Definition name
• definitionTitle: string
  Definition Title
• definitionType: string
  Definition type. PROCESS or DP
• description: string
  Interface description
• formMetadataURL: string
  Form url associated with the process
• id(required): string
  ID of interface
• inputs: array inputs
  Input arguments of this interface
• operationName: string
  operation name
• outputs: array outputs
  Output arguments of this interface
• title: string
  Interface of Title
• type: string
  Type of Interface
• version: string
  Application Version

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of interface"
        },
        "type":{
            "type":"string",
            "description":"Type of Interface"
        },
        "title":{
            "type":"string",
            "description":"Interface of Title"
        },
        "description":{
            "type":"string",
            "description":"Interface description"
        },
        "formMetadataURL":{
            "type":"string",
            "description":"Form url associated with the process"
        },
        "inputs":{
            "type":"array",
            "description":"Input arguments of this interface",
            "items":{
                "$ref":"#/components/schemas/IOArgument"
            }
        },
        "outputs":{
            "type":"array",
            "description":"Output arguments of this interface",
            "items":{
                "$ref":"#/components/schemas/IOArgument"
            }
        },
        "defaultInterface":{
            "type":"boolean",
            "description":"If this is the default interface of the definition"
        },
        "definitionId":{
            "type":"string",
            "description":"Definition ID"
        },
        "definitionType":{
            "type":"string",
            "description":"Definition type. PROCESS or DP"
        },
        "activityId":{
            "type":"string",
            "description":"Id of the Activity in definition"
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name"
        },
        "applicationTitle":{
            "type":"string",
            "description":"Application Title"
        },
        "applicationDescription":{
            "type":"string",
            "description":"Application Description"
        },
        "definitionTitle":{
            "type":"string",
            "description":"Definition Title"
        },
        "definitionDescription":{
            "type":"string",
            "description":"Definition Description"
        },
        "version":{
            "type":"string",
            "description":"Application Version"
        },
        "defaultVersion":{
            "type":"boolean",
            "description":"If application is the default version"
        },
        "definitionName":{
            "type":"string",
            "description":"Definition name"
        },
        "definitionKey":{
            "type":"string",
            "description":"Definition key"
        },
        "operationName":{
            "type":"string",
            "description":"operation name"
        }
    }
}

Nested Schema : inputs

Type: array

Input arguments of this interface

Show Source

• Array of: object IOArgument

{
    "type":"array",
    "description":"Input arguments of this interface",
    "items":{
        "$ref":"#/components/schemas/IOArgument"
    }
}

Nested Schema : outputs

Type: array

Output arguments of this interface

Show Source

• Array of: object IOArgument

{
    "type":"array",
    "description":"Output arguments of this interface",
    "items":{
        "$ref":"#/components/schemas/IOArgument"
    }
}

Nested Schema : IOArgument

Type: object

Show Source

• name(required): string
  Name of argument
• schemaDefinition: string
  Schema definition
• schemaRef: string
  Schema link if data type is complex
• type(required): string
  Data type of argument or name of schema (if not primitive)

{
    "required":[
        "name",
        "type"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of argument"
        },
        "type":{
            "type":"string",
            "description":"Data type of argument or name of schema (if not primitive)"
        },
        "schemaRef":{
            "type":"string",
            "description":"Schema link if data type is complex"
        },
        "schemaDefinition":{
            "type":"string",
            "description":"Schema definition"
        }
    }
}

Nested Schema : GroupedCount

Type: object

Show Source

• count: integer
  Count of items in group
• name: string
  Group name

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Group name"
        },
        "count":{
            "type":"integer",
            "description":"Count of items in group"
        }
    }
}

400 Response

Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

520 Response

Server-side Processing Error

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows the response payload.

Example: List of Process interfaces for current user

Response Body:

The following example shows the contents of the response body in JSON format.

{
    "links": [
        {
            "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces",
            "rel": "self"
        },
        {
            "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1",
            "rel": "parent"
        },
        {
            "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces?offset=25",
            "rel": "next"
        }
    ],
    "items": [
        {
            "links": [
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces/2951c8f5-faec-4b87-9d61-10ab201b8c26",
                    "rel": "self"
                },
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces",
                    "rel": "parent"
                }
            ],
            "id": "ef543d64yg5-faec-4b87-9d61-adsdw3f43vv5t345ft3cg",
            "type": "NONE_START",
            "title": "Start event",
            "inputs": [
                {
                    "name": "input1",
                    "type": "json",
                    "schemaRef": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces/2951c8f5-faec-4b87-9d61-10ab201b8c26/schemas/9c54e539-34f3-4245-8083-f2c2aa7b22a4.schema.json?applicationName=APAC1-UC2-NASA-6&applicationVersion=1.0",
                    "schemaDefinition": "9c54e539-34f3-4245-8083-f2c2aa7b22a4.schema.json#/definitions/8e054ad0-4f24-4c1d-8ada-1591e276a23e"
                }
            ],
            "outputs": [],
            "defaultInterface": true,
            "definitionId": "02a92355-e565-11ed-9ebc-12ae00835bb2",
            "definitionType": "PROCESS",
            "activityId": "flow_845d2730-1932-11ed-920d-87b738d41a72",
            "applicationName": "APAC1-UC2-NASA-6",
            "applicationTitle": "APAC1-UC2-NASA-6",
            "definitionTitle": "Wave Hight Alert Sub-Process",
            "definitionDescription": "Wave Hight Alert Process",
            "version": "1.0",
            "defaultVersion": true,
            "definitionName": "WaveHightAlertSub-Process",
            "definitionKey": "APAC1-UC2-NASA-6--1.0--WaveHightAlertSub-Process"
        },
        {
            "links": [
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces/93eced57-a4d7-480b-9f27-a2068fc8091b",
                    "rel": "self"
                },
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces",
                    "rel": "parent"
                }
            ],
            "id": "93eced57-a4d7-480b-9f27-a2068fc8091b",
            "type": "MESSAGE_START",
            "title": "NASA Satelite Event",
            "description": "process for handling dynamic events",
            "inputs": [
                {
                    "name": "satEvent",
                    "type": "json",
                    "schemaRef": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces/93eced57-a4d7-480b-9f27-a2068fc8091b/schemas/9c54e539-34f3-4245-8083-f2c2aa7b22a4.schema.json?applicationName=APAC1-UC2-NASA-6&applicationVersion=1.0",
                    "schemaDefinition": "9c54e539-34f3-4245-8083-f2c2aa7b22a4.schema.json#/definitions/bd1fe455-a1a9-4579-b607-286108988ed0"
                }
            ],
            "outputs": [],
            "defaultInterface": false,
            "definitionId": "02b642b7-e565-11ed-9ebc-12ae00835bb2",
            "definitionType": "DP",
            "applicationName": "APAC1-UC2-NASA-6",
            "applicationTitle": "APAC1-UC2-NASA-6",
            "definitionTitle": "NASA Satelite Event",
            "definitionDescription": "process for handling dynamic events",
            "version": "1.0",
            "defaultVersion": true,
            "definitionName": "NASASateliteEvent",
            "definitionKey": "APAC1-UC2-NASA-6--1.0--NASASateliteEvent"
        },
        {
            "links": [
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces/5f5d0f16-b502-4a33-b8c6-973136828183",
                    "rel": "self"
                },
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces",
                    "rel": "parent"
                }
            ],
            "id": "5f5d0f16-b502-4a33-b8c6-973136828183",
            "type": "FORM_START",
            "title": "Create Purchase Requisition",
            "formMetadataURL": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/forms/AlterFlowPMDemo/1.0/cc6c6a02-bcd1-4e15-b364-f53cba324258",
            "inputs": [
                {
                    "name": "purchaseReqFormArgs",
                    "type": "json",
                    "schemaRef": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces/5f5d0f16-b502-4a33-b8c6-973136828183/schemas/0140193c-46fc-4a1b-bf0d-62af7d8b7e8e.schema.json?applicationName=AlterFlowPMDemo&applicationVersion=1.0",
                    "schemaDefinition": "0140193c-46fc-4a1b-bf0d-62af7d8b7e8e.schema.json#/definitions/241d4cc6-e1cd-34e7-3479-b83989564a4d"
                }
            ],
            "outputs": [],
            "defaultInterface": true,
            "definitionId": "c6e4bf41-d280-11ed-b4e7-8a4d8adc6026",
            "definitionType": "PROCESS",
            "activityId": "flow_cd4f98c0-cf5c-11ed-a845-c78223068812",
            "applicationName": "AlterFlowPMDemo",
            "applicationTitle": "AlterFlowPMDemo",
            "definitionTitle": "ProcurementProcessV2",
            "version": "1.0",
            "defaultVersion": true,
            "definitionName": "ProcurementProcessV2",
            "definitionKey": "AlterFlowPMDemo--1.0--ProcurementProcessV2"
        },
        {
            "links": [
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces/3xyz244e-530a-4hbf-9f21-245d00000123",
                    "rel": "self"
                },
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces",
                    "rel": "parent"
                }
            ],
            "id": "3ecd244d-530b-4fbf-9f21-238d06009543",
            "type": "NONE_START",
            "title": "Start event",
            "inputs": [],
            "outputs": [],
            "defaultInterface": true,
            "definitionId": "c6e58294-d280-11ed-b4e7-8a4d8adc6026",
            "definitionType": "PROCESS",
            "activityId": "flow_cd4f98c0-cf5c-11ed-a845-c78223068812",
            "applicationName": "AlterFlowPMDemo",
            "applicationTitle": "AlterFlowPMDemo",
            "definitionTitle": "PlaceOrder",
            "version": "1.0",
            "defaultVersion": true,
            "definitionName": "PlaceOrder",
            "definitionKey": "AlterFlowPMDemo--1.0--PlaceOrder"
        },
        {
            "links": [
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces/948adff0-6ce6-46ca-a555-0b4095f8a58b",
                    "rel": "self"
                },
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces",
                    "rel": "parent"
                }
            ],
            "id": "948adff0-6ce6-46ca-a555-0b4095f8a58b",
            "type": "FORM_START",
            "title": "Create Purchase Requisition",
            "formMetadataURL": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/forms/AlterFlowPMDemo/1.0/cc6c6a02-bcd1-4e15-b364-f53cba324258",
            "inputs": [
                {
                    "name": "purchaseReqFormArgs",
                    "type": "json",
                    "schemaRef": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces/948adff0-6ce6-46ca-a555-0b4095f8a58b/schemas/0140193c-46fc-4a1b-bf0d-62af7d8b7e8e.schema.json?applicationName=AlterFlowPMDemo&applicationVersion=1.0",
                    "schemaDefinition": "0140193c-46fc-4a1b-bf0d-62af7d8b7e8e.schema.json#/definitions/241d4cc6-e1cd-34e7-3479-b83989564a4d"
                }
            ],
            "outputs": [],
            "defaultInterface": true,
            "definitionId": "c6ddba5c-d280-11ed-b4e7-8a4d8adc6026",
            "definitionType": "PROCESS",
            "activityId": "flow_cd4f98c0-cf5c-11ed-a845-c78223068812",
            "applicationName": "AlterFlowPMDemo",
            "applicationTitle": "AlterFlowPMDemo",
            "definitionTitle": "ProcurementProcess",
            "version": "1.0",
            "defaultVersion": true,
            "definitionName": "ProcurementProcess",
            "definitionKey": "AlterFlowPMDemo--1.0--ProcurementProcess"
        },
        {
            "links": [
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces/8c51c2d5-00cb-4387-b474-a242da79ba12",
                    "rel": "self"
                },
                {
                    "href": "https://ABCD-user123-asdfghj.process.oci.oraclecloud.com/process/api/v1/process-interfaces",
                    "rel": "parent"
                }
            ],
            "id": "8c51c2d5-00cb-4387...

Back to Top