Jump to

• Request
• Response

Retrieve Conversation Metadata

get

/ic/api/process/v1/process-definitions/{processDefId}/conversations/{conversationName}

Retrieves the conversation metadata for a conversation associated with this process, if any.

Request

Path Parameters

• conversationName: string
  conversation name
• processDefId: string
  Value of process definition ID.

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 : Conversation

Type: object

Show Source

• conversationId(optional): string
• description(optional): string
• levels(optional): integer(int32)
• links(optional): array links
• name(optional): string
• postHumanTaskMessagesFlag(optional): boolean
• postMessageOnActivityEntryFlag(optional): boolean
• postMessageOnActivityExitFlag(optional): boolean
• title(optional): 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"
        },
        "postMessageOnActivityEntryFlag":{
            "type":"boolean"
        },
        "postMessageOnActivityExitFlag":{
            "type":"boolean"
        },
        "postHumanTaskMessagesFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "conversationId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

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(optional): string
• mediaType(optional): string
• rel(optional): string

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

401 Response

Unauthorized

500 Response

Error in retrieving the folder information

Back to Top