openapi: 3.1.0
info:
  title: Helpcenter TaskComments API
  version: 1.0.0
tags:
- name: TaskComments
paths:
  /api/v1/tasks/{entityId}/comments/{commentId}:
    get:
      tags:
      - TaskComments
      summary: Get a task comment
      description: This API fetches a task comment from the portal.
      operationId: getTaskComment
      parameters:
      - $ref: '#/components/parameters/commentId'
      - $ref: '#/components/parameters/entityId'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/addTaskComment'
      security:
      - iam-oauth2-schema:
        - Desk.activities.tasks.READ
        - Desk.tasks.READ
      x-audience:
      - external-public
    put:
      tags:
      - TaskComments
      summary: Update a task comment
      description: This API updates an existing task comment.
      operationId: updateTaskComment
      parameters:
      - $ref: '#/components/parameters/commentId'
      - $ref: '#/components/parameters/entityId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/addTaskCommentRequest'
      responses:
        '200':
          $ref: '#/components/responses/addTaskComment'
        '422':
          $ref: ./Common.json#/components/responses/invalidDataErrorResponse
      security:
      - iam-oauth2-schema:
        - Desk.activities.tasks.UPDATE
        - Desk.tasks.UPDATE
      x-audience:
      - external-public
  /api/v1/tasks/{entityId}/comments:
    get:
      tags:
      - TaskComments
      summary: List all task comments
      description: This API lists a particular number of comments recorded on a task, based on the limit specified.
      operationId: getTaskComments
      parameters:
      - name: limit
        in: query
        description: No. of comments to fetch
        required: false
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          - integer
          format: int32
          description: No. of comments to fetch
          pattern: ([0-9]+)
      - name: from
        in: query
        description: Index number starting from which the comments must be fetched
        required: false
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          - integer
          format: int32
          description: Index number starting from which the comments must be fetched
          pattern: ([0-9]+)
      - name: sortBy
        in: query
        description: Sort comments by the @commentedTime@ attribute. The default sorting order is ascending. A @-@ prefix denotes descending order of sorting.
        required: false
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          description: Sort comments by the @commentedTime@ attribute. The default sorting order is ascending. A @-@ prefix denotes descending order of sorting.
          maxLength: 100
          minLength: 0
          pattern: -?(commentedTime)
      - $ref: '#/components/parameters/entityId'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/listTaskComment'
      security:
      - iam-oauth2-schema:
        - Desk.activities.tasks.READ
        - Desk.tasks.READ
      x-audience:
      - external-public
    post:
      tags:
      - TaskComments
      summary: Create a task comment
      description: This API adds a comment to a task.
      operationId: createTaskComment
      parameters:
      - $ref: '#/components/parameters/entityId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/addTaskComment_addTaskCommentRequest'
      responses:
        '422':
          $ref: ./Common.json#/components/responses/invalidDataErrorResponse
        '200':
          $ref: '#/components/responses/addTaskComment'
      security:
      - iam-oauth2-schema:
        - Desk.activities.tasks.UPDATE
        - Desk.tasks.UPDATE
      x-audience:
      - external-public
components:
  responses:
    addTaskComment:
      description: addTaskComment template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              modifiedTime:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
                pattern: (((19|20)\d\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\d]{0,3})?(Z))
              attachments:
                type:
                - 'null'
                - array
                items:
                  type:
                  - 'null'
                  - object
                  additionalProperties: false
                uniqueItems: false
              encodedContent:
                type:
                - string
                - 'null'
                maxLength: 32000
                minLength: 0
              commentedTime:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
                pattern: (((19|20)\d\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\d]{0,3})?(Z))
              id:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              contentType:
                type:
                - string
                - 'null'
                enum:
                - html
                - plainText
                maxLength: 100
                minLength: 0
              content:
                type:
                - string
                - 'null'
                maxLength: 32000
                minLength: 0
              commenterId:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              commenter:
                $ref: ./TicketComment.json#/components/schemas/commenter
              impersonatedUser:
                $ref: ./TicketComment.json#/components/schemas/impersonatedUser
            required:
            - attachments
            - commentedTime
            - commenter
            - commenterId
            - content
            - contentType
            - encodedContent
            - id
            - impersonatedUser
            - modifiedTime
          examples:
            Valid responses Definitions:
              value:
                modifiedTime: null
                attachments:
                - size: '12734'
                  name: Attachment.png
                  id: '4000000008994'
                  href: https://desk.zoho.com/api/v1/tasks/4000000528005/comments/4000000529001/attachments/4000000008994/content
                commentedTime: 1485269673534
                id: '4000000530003'
                contentType: html
                content: First Task comment.
                commenterId: '4000000008692'
                commenter:
                  firstName: Jade
                  lastName: Tywin
                  photoURL: https://desk.zoho.com/api/v1/agents/4000000008692/photo?orgId=292828
                  name: Jade Tywin
                  roleName: LightAgent
                  type: AGENT
                  email: jade12tywin@zylker.com
    listTaskComment:
      description: listTaskComment template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              data:
                $ref: ./TaskComments.json#/components/schemas/data
            required:
            - data
          examples:
            Valid responses Definitions:
              value:
                data:
                - modifiedTime: null
                  commentedTime: 1485270287000
                  id: '4000000530005'
                  contentType: plainText
                  commenterId: '4000000008692'
                  content: Second Task Comment......
                  mention: []
                  commenter:
                    firstName: Jade
                    lastName: Tywin
                    photoURL: https://desk.zoho.com/api/v1/agents/4000000008692/photo?orgId=292828
                    name: Jade Tywin
                    roleName: LightAgent
                    type: AGENT
                    email: jade12tywin@zylker.com
                - modifiedTime: 1485269780000
                  attachments:
                  - size: '12734'
                    name: Attachment_list.png
                    id: '4000000008994'
                    href: https://desk.zoho.com/api/v1/tasks/4000000528005/comments/4000000529001/attachments/4000000008994/content
                  commentedTime: 1485269673000
                  id: '4000000530003'
                  contentType: html
                  commenterId: '4000000008692'
                  content: Edit Task comment
                  mention: []
                  commenter:
                    firstName: Jade
                    lastName: Tywin
                    photoURL: https://desk.zoho.com/api/v1/portalUser/4000000008692/photo?orgId=292828
                    name: Jade Tywin
                    roleName: PortalUser
                    type: END_USER
                    email: jade12tywin@zylker.com
  requestBodies:
    addTaskCommentRequest:
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              contentType:
                type:
                - string
                - 'null'
                enum:
                - html
                - plainText
                maxLength: 100
                minLength: 0
              content:
                type:
                - string
                - 'null'
                maxLength: 32000
                minLength: 0
          examples:
            Valid requestBody Definitions:
              value:
                content: Edit Task comment
    addTaskComment_addTaskCommentRequest:
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              contentType:
                type:
                - string
                - 'null'
                enum:
                - html
                - plainText
                maxLength: 100
                minLength: 0
              content:
                type:
                - string
                - 'null'
                maxLength: 32000
                minLength: 0
            required:
            - content
          examples:
            Valid requestBody Definitions:
              value:
                contentType: html
                content: First Task comment.
  parameters:
    entityId:
      name: entityId
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        pattern: ([0-9]+)
    commentId:
      name: commentId
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        pattern: ([0-9]+)
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter