Jump to

• Request
• Response

Add a Task Comment

post

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

Add a comment to a task

Request

Path Parameters

• id(required): string
  Task ID

Header Parameters

• oci-original-url:
  Endpoint requested by customer

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Comment request object

Show Source

• comment: string

{
    "type":"object",
    "properties":{
        "comment":{
            "type":"string"
        }
    },
    "description":"Comment request object"
}

Examples

Select an example Add a Task Comment

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

Comment Successfully added

Body ()

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

400 Response

Bad request

404 Response

Task not found

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Back to Top