Jump to

• Request
• Response

Send Message to Process Instance

post

/process/api/v1/messages

When execution flow initiates a receive task, this activity pauses instance execution. To initiate the paused instance execution, you can use this API function to send the task of resuming.

Request

Header Parameters

• oci-original-url:
  Actual endpoint which customer requested

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• appName(required): string
  Application Name
• businessKey: string
  Business Key
• instanceId: string
  Instance Id
• message: object message
• operation: string
  Operation
• processDefinitionKey: string
  Process Definition Key
• processName(required): string
  Process Name
• version(required): string
  Version

{
    "type":"object",
    "required":[
        "appName",
        "version",
        "processName"
    ],
    "properties":{
        "message":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/Message"
            }
        },
        "businessKey":{
            "type":"string",
            "description":"Business Key"
        },
        "instanceId":{
            "type":"string",
            "description":"Instance Id"
        },
        "appName":{
            "type":"string",
            "description":"Application Name"
        },
        "version":{
            "type":"string",
            "description":"Version"
        },
        "processName":{
            "type":"string",
            "description":"Process Name"
        },
        "operation":{
            "type":"string",
            "description":"Operation"
        },
        "processDefinitionKey":{
            "type":"string",
            "description":"Process Definition Key"
        }
    }
}

Nested Schema : message

Type: object

Show Source

• Array of: object Message
  Additional Properties Allowed: additionalProperties

  a (key, MapItem) map. `default`is an example key

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/Message"
    }
}

Nested Schema : Message

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"a (key, MapItem) map. `default`is an example key",
    "properties":{
        "default":{
            "type":"object"
        }
    },
    "additionalProperties":{
        "type":"object"
    }
}

a (key, MapItem) map. `default`is an example key

Show Source

• default: object default

{
    "description":"a (key, MapItem) map. `default`is an example key",
    "properties":{
        "default":{
            "type":"object"
        }
    },
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : default

Type: object

Nested Schema : additionalProperties

Type: object

Examples

Select an example Send Message To Process Instance

Back to Top

Response

202 Response

Successful operation - no content returned

401 Response

Unauthorized

429 Response

Too Many Requests

500 Response

Internal Server Error

503 Response

Too Many Exceptions or Too Slow Requests

Back to Top