Jump to

• Request
• Response

List Task Comments

get

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

List task comments

Request

Path Parameters

• id(required): string
  Task ID

Query Parameters

• isTaskLevelComments: boolean
  Fetch task level comments only (Deprecated from April 2023)
• isTaskSpecificComments: boolean
  Fetch task specific comments only

Header Parameters

• oci-original-url:
  Endpoint requested by customer

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : CommentCollection

Match All

Show Source

• object CommonModel
• object CommentCollection-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Comment"
                    }
                },
                "taskId":{
                    "type":"string"
                },
                "processInstanceId":{
                    "type":"string"
                },
                "dpInstanceId":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : CommentCollection-allOf[1]

Type: object

Show Source

• dpInstanceId: string
• items: array items
• processInstanceId: string
• taskId: string

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Comment"
            }
        },
        "taskId":{
            "type":"string"
        },
        "processInstanceId":{
            "type":"string"
        },
        "dpInstanceId":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

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

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Comment

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

Nested Schema : Comment

Type: object

Show Source

• addedBy: User
• addedDate: string (date)
• comment: string
• commentId: string
• href: string

{
    "type":"object",
    "properties":{
        "commentId":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "addedBy":{
            "$ref":"#/components/schemas/User"
        },
        "addedDate":{
            "type":"string",
            "format":"date"
        }
    }
}

Nested Schema : User

Match All

Show Source

• object IdentityCommon

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        }
    ]
}

Nested Schema : IdentityCommon

Type: object

Show Source

• displayName: string
• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

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