Jump to

• Request
• Response

Retrieve Task Comments

get

/ic/api/process/v1/tasks/{id}/comments

Retrieves task comments.

Request

Path Parameters

• id: string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : CommentCollection

Type: object

Show Source

• hasMore(optional): boolean
• items(optional): array items
• links(optional): array links
• offset(optional): integer(int32)
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Comment"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object comment

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : comment

Type: object

Show Source

• commentScope(optional): string
• commentStr(optional): string
• updatedBy(optional): string
• updateddDate(optional): string
• userId(optional): string

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

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"
        }
    }
}

500 Response

Internal Server Error

Back to Top