Jump to

• Request
• Response

Retrieve Conversations for a Process Instance

get

/ic/api/process/v1/processes/{processId}/conversations

Retrieves the conversations associated with the process instance.

Request

Path Parameters

• processId(required): string
  Value of process ID.

Query Parameters

• name: string
  Retrieves only the conversation for the specified conversation name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success. Returns the conversations or empty list when there aren't any.

Body ()

Root Schema : conversationInstances

Type: object

Show Source

• conversations: array conversationInstanceList
• host: string
• instanceName: string
• levels: integer(int32)
• links: array links
• title: string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "conversations":{
            "type":"array",
            "xml":{
                "name":"conversationInstanceList"
            },
            "items":{
                "xml":{
                    "name":"conversationInstanceList"
                },
                "$ref":"#/definitions/ConversationInstance"
            }
        },
        "host":{
            "type":"string"
        },
        "instanceName":{
            "type":"string"
        }
    },
    "xml":{
        "name":"conversationInstances",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : conversationInstanceList

Type: array

Show Source

• Array of: object conversationInstanceList

{
    "type":"array",
    "xml":{
        "name":"conversationInstanceList"
    },
    "items":{
        "xml":{
            "name":"conversationInstanceList"
        },
        "$ref":"#/definitions/ConversationInstance"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : conversationInstanceList

Type: object

Show Source

• appLink: string
• clistURL: string
• conversationId: string
• conversationName: string
• conversationTitle: string
• flowId: string
• levels: integer(int32)
• links: array links
• processId: string
• title: string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "conversationId":{
            "type":"string"
        },
        "conversationName":{
            "type":"string"
        },
        "flowId":{
            "type":"string"
        },
        "processId":{
            "type":"string"
        },
        "appLink":{
            "type":"string"
        },
        "conversationTitle":{
            "type":"string"
        },
        "clistURL":{
            "type":"string"
        }
    },
    "xml":{
        "name":"conversationInstanceList",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

500 Response

Error in retrieving the conversation information

Back to Top