Jump to

• Request
• Response

Stream message response

post

<servername>/api/fusion-ai/orchestrator/a2a/v1/{workflowCode}/stream

Start a streaming message invocation for a published workflow. The request method must be `message/stream`. The response is returned as Server-Sent Events whose event payloads contain JSON-RPC task updates.

Request

Path Parameters

• workflowCode(required): string
  Published workflow code.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• id: string
• jsonrpc: string
  Default Value: 2.0
• method(required): string
  Allowed Values: [ "message/stream" ]
• params(required): object MessageSendParams

{
    "type":"object",
    "required":[
        "method",
        "params"
    ],
    "properties":{
        "id":{
            "type":"string"
        },
        "jsonrpc":{
            "type":"string",
            "default":"2.0"
        },
        "method":{
            "type":"string",
            "enum":[
                "message/stream"
            ]
        },
        "params":{
            "$ref":"#/components/schemas/MessageSendParams"
        }
    }
}

Nested Schema : MessageSendParams

Type: object

Show Source

• configuration: object MessageSendConfiguration
• message: object Message
• metadata: object metadata
  Additional Properties Allowed: true

{
    "type":"object",
    "properties":{
        "message":{
            "$ref":"#/components/schemas/Message"
        },
        "configuration":{
            "$ref":"#/components/schemas/MessageSendConfiguration"
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        }
    }
}

Nested Schema : MessageSendConfiguration

Type: object

Show Source

• acceptedOutputModes: array acceptedOutputModes
• blocking: boolean
• historyLength: integer

{
    "type":"object",
    "properties":{
        "acceptedOutputModes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "historyLength":{
            "type":"integer"
        },
        "blocking":{
            "type":"boolean"
        }
    }
}

Nested Schema : Message

Type: object

Show Source

• contextId: string
  Conversation identifier. For `message/stream`, this must be nested under `params.message`.
• kind: string
  Default Value: message
• messageId: string
• metadata: object metadata
  Additional Properties Allowed: true
• parts: array parts
• role: string
  Allowed Values: [ "user", "agent" ]
• taskId: string
  Optional task identifier used for resumed or task-associated message flows.

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "enum":[
                "user",
                "agent"
            ]
        },
        "parts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TextPart"
            }
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "messageId":{
            "type":"string"
        },
        "contextId":{
            "type":"string",
            "description":"Conversation identifier. For `message/stream`, this must be nested under `params.message`."
        },
        "taskId":{
            "type":"string",
            "description":"Optional task identifier used for resumed or task-associated message flows."
        },
        "kind":{
            "type":"string",
            "default":"message"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : acceptedOutputModes

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : parts

Type: array

Show Source

• Array of: object TextPart

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

Nested Schema : TextPart

Type: object

Show Source

• kind: string
  Default Value: text
• metadata: object metadata
  Additional Properties Allowed: true
• text: string
  Text content.
• type: string
  Part type.

  Example: text

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Part type.",
            "example":"text"
        },
        "text":{
            "type":"string",
            "description":"Text content."
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "kind":{
            "type":"string",
            "default":"text"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Back to Top

Response

Supported Media Types

• text/event-stream

200 Response

Streaming task events started.

Body ()

Root Schema : SendMessageResponse

Type: object

Show Source

• error: object JSONRPCError
• id: string
• jsonrpc: string
  Default Value: 2.0
• method: string
• result: object task

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "jsonrpc":{
            "type":"string",
            "default":"2.0"
        },
        "method":{
            "type":"string"
        },
        "result":{
            "$ref":"#/components/schemas/Task"
        },
        "error":{
            "$ref":"#/components/schemas/JSONRPCError"
        }
    }
}

Nested Schema : JSONRPCError

Type: object

Show Source

• code: integer
  JSON-RPC error code.
• message: string
  JSON-RPC error message.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "description":"JSON-RPC error code."
        },
        "message":{
            "type":"string",
            "description":"JSON-RPC error message."
        }
    }
}

Nested Schema : task

Type: object

Show Source

• actionList: array actionList
• applicationContext: string
• applicationName: string
• assignedDate: string
• assignees: object Collection
• attachments: array attachments
• comments: object comments
• createdBy: string
• createdDate: string
• detailsURL: object link
• dueDate: string
• externalUIURL: string
• formMetadata: string
• fromUserDisplayName: string
• fromUserName: string
• getcListURL: object link
• groupByName: string
• groupByValue: string
• hasSubTasksFlag: boolean
  Default Value: false
• history: object taskHistories
• href(required): string (uri)
• hreflang: string
• identificationKey: string
• length: integer (int32)
• linkId: string
• links: array links
• mediaType(required): string
• number: integer (int32)
• outcome: string
• ownerGroup: string
• ownerRole: string
• ownerUser: string
• payload: object payload
• permissions: array permissions
• priority: integer (int32)
• rel(required): string
• rootTaskNumber: string
• startDate: string
• state: string
• taskDefinitionName: string
• taskId: string
• taskNamespace: string
• title: string
• titlePrefix: string
  shown only for current assignee or creator of task
• type: string
• updatedDate: string

{
    "required":[
        "href",
        "mediaType",
        "rel"
    ],
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "format":"uri"
        },
        "linkId":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "actionList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaskActionLink"
            }
        },
        "permissions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assignedDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "dueDate":{
            "type":"string"
        },
        "fromUserDisplayName":{
            "type":"string"
        },
        "fromUserName":{
            "type":"string"
        },
        "groupByName":{
            "type":"string"
        },
        "groupByValue":{
            "type":"string"
        },
        "number":{
            "type":"integer",
            "format":"int32"
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        },
        "taskId":{
            "type":"string"
        },
        "taskDefinitionName":{
            "type":"string"
        },
        "taskNamespace":{
            "type":"string"
        },
        "titlePrefix":{
            "type":"string",
            "description":"shown only for current assignee or creator of task"
        },
        "createdDate":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "ownerGroup":{
            "type":"string"
        },
        "ownerRole":{
            "type":"string"
        },
        "ownerUser":{
            "type":"string"
        },
        "applicationName":{
            "type":"string"
        },
        "assignees":{
            "$ref":"#/components/schemas/CollectionIdentity"
        },
        "attachments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Attachment"
            }
        },
        "history":{
            "$ref":"#/components/schemas/TaskHistories"
        },
        "comments":{
            "$ref":"#/components/schemas/Comments"
        },
        "payload":{
            "$ref":"#/components/schemas/TaskSummaryField"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "detailsURL":{
            "$ref":"#/components/schemas/Link"
        },
        "hasSubTasksFlag":{
            "type":"boolean",
            "default":false
        },
        "outcome":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "identificationKey":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "getcListURL":{
            "$ref":"#/components/schemas/Link"
        },
        "formMetadata":{
            "type":"string"
        },
        "externalUIURL":{
            "type":"string"
        },
        "rootTaskNumber":{
            "type":"string"
        },
        "applicationContext":{
            "type":"string"
        }
    },
    "xml":{
        "name":"task",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : actionList

Type: array

Show Source

• Array of: object taskactionlink

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

Nested Schema : Collection

Type: object

Show Source

• count: integer (int32)
• hasMore: boolean
  Default Value: false
• items: array items
• limit: integer (int32)
• links: array links
• offset: integer (int32)
• totalResult: boolean
  Default Value: false
• userLink: object link

{
    "type":"object",
    "properties":{
        "totalResult":{
            "type":"boolean",
            "default":false
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "userLink":{
            "$ref":"#/components/schemas/Link"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Identity"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "xml":{
        "name":"Collection",
        "namespace":"http://xmlns.oracle.com/bpm/rest/v3/common/"
    }
}

Nested Schema : attachments

Type: array

Show Source

• Array of: object attachment

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

Nested Schema : comments

Type: object

Show Source

• comment: array comment

{
    "type":"object",
    "properties":{
        "comment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Comment"
            }
        }
    },
    "xml":{
        "name":"comments",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string (uri)
  href of the provided link
• rel: string
  relationship with the returned resource

  Example: self

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"href of the provided link",
            "format":"uri"
        },
        "rel":{
            "type":"string",
            "description":"relationship with the returned resource",
            "example":"self"
        }
    },
    "xml":{
        "name":"link",
        "namespace":"http://xmlns.oracle.com/bpm/rest"
    }
}

Nested Schema : taskHistories

Type: object

Show Source

• taskHistory: array taskHistory

{
    "type":"object",
    "properties":{
        "taskHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaskHistory"
            }
        }
    },
    "xml":{
        "name":"taskHistories",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object link

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

Nested Schema : payload

Type: object

Show Source

• comment: string
• priority: integer (int32)
• summaryFields: array summaryFields
• xmlPayload: string

{
    "type":"object",
    "properties":{
        "summaryFields":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GenericMap"
            }
        },
        "comment":{
            "type":"string"
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        },
        "xmlPayload":{
            "type":"string"
        }
    },
    "xml":{
        "name":"payload",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : permissions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : taskactionlink

Type: object

Show Source

• href(required): string (uri)
• hreflang: string
• length: integer (int32)
• linkId: string
• mediaType(required): string
• rel(required): string
• title: string
• type: string

{
    "required":[
        "href",
        "mediaType",
        "rel"
    ],
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "format":"uri"
        },
        "linkId":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    },
    "xml":{
        "name":"taskactionlink",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object identity

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

Nested Schema : links

Type: array

Show Source

• Array of: object link

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

Nested Schema : identity

Type: object

Show Source

• email: string
• firstName: string
• id: string
• identity: object link
• lastName: string
• middleName: string
• mobile: string
• type: string
• workPhone: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "identity":{
            "$ref":"#/components/schemas/Link"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "middleName":{
            "type":"string"
        },
        "mobile":{
            "type":"string"
        },
        "workPhone":{
            "type":"string"
        }
    },
    "xml":{
        "name":"identity",
        "namespace":"http://xmlns.oracle.com/bpm/rest/identities"
    }
}

Nested Schema : attachment

Type: object

Show Source

• attachmentName: string
• attachmentScope: string
• content: string
• docAttributes: array docAttributes
• href: string (uri)
• input: string
• mimeType: string
• rel: string
• uri: object link

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "format":"uri"
        },
        "rel":{
            "type":"string"
        },
        "attachmentName":{
            "type":"string"
        },
        "content":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "attachmentScope":{
            "type":"string"
        },
        "docAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GenericMap"
            }
        },
        "input":{
            "type":"string"
        },
        "uri":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "xml":{
        "name":"attachment",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : docAttributes

Type: array

Show Source

• Array of: object genericMap

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

Nested Schema : genericMap

Type: object

Show Source

• category: string
• dataType: string
• displayName: string
• name: string
• readOnly: string
• value: string

{
    "type":"object",
    "properties":{
        "dataType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "readOnly":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "category":{
            "type":"string"
        }
    },
    "xml":{
        "name":"genericMap",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : comment

Type: array

Show Source

• Array of: object comment

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

Nested Schema : comment

Type: object

Show Source

• commentStr: string

{
    "type":"object",
    "properties":{
        "commentStr":{
            "type":"string"
        }
    },
    "xml":{
        "name":"comment",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : taskHistory

Type: array

Show Source

• Array of: object taskHistory

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

Nested Schema : taskHistory

Type: object

Show Source

• actionName: string
• displayName: string
• pattern: string
• reason: string
• updatedDate: string
• userId: string

{
    "type":"object",
    "properties":{
        "actionName":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "pattern":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        }
    },
    "xml":{
        "name":"taskHistory",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : summaryFields

Type: array

Show Source

• Array of: object genericMap

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

404 Response

Workflow not found.

Back to Top