---
title: "CommentsData"
url: "https://developers.zinnia.com/apis/market-connect-order-entry/versions/50f981c3-db50-4358-884f-31eb427255ec/schemas/CommentsData"
---

> Full API specification: https://developers.zinnia.com/apis/market-connect-order-entry/versions/50f981c3-db50-4358-884f-31eb427255ec.md

# CommentsData

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Market Connect Order Entry API
  version: 1.0.3
servers:
  - url: https://dev.api.zinnia.io
  - url: https://qa.api.zinnia.io
  - url: https://uat.api.zinnia.io
components:
  schemas:
    CommentItem:
      type: object
      properties:
        commentId:
          type: string
          description: Unique identifier of the comment (positive integer encoded as a
            string)
          nullable: true
        commentSource:
          type: string
          description: Source system or user group that authored the comment
          nullable: true
        commentText:
          type: string
          description: Free-form comment text
          nullable: true
        createdDateTime:
          type: string
          description: Date and time the comment was created
          nullable: true
        lastUpdatedDateTime:
          type: string
          description: Date and time the comment was last updated
          nullable: true
        logonID:
          type: string
          description: Logon identifier of the user who authored the comment
          nullable: true
        statusAtStep:
          type: string
          description: Status code of the transaction at the step the comment was added
          nullable: true
        statusDisplayName:
          type: string
          description: Display name for the status at the step the comment was added
          nullable: true
        stepTitle:
          type: string
          description: Title of the wizard step the comment was added on
          nullable: true
        userName:
          type: string
          description: Name of the user who authored the comment
          nullable: true
      additionalProperties: false
    CommentsData:
      type: object
      properties:
        comments:
          type: array
          items:
            $ref: "#/components/schemas/CommentItem"
          description: List of comments for the current page
          nullable: true
        totalCount:
          type: integer
          description: Total number of comments for the transaction across all pages
          format: int32
        page:
          type: integer
          description: Current page number (1-based). Present when pagination query
            parameters are supplied.
          format: int32
          nullable: true
        pageSize:
          type: integer
          description: Number of comments per page. Present when pagination query
            parameters are supplied.
          format: int32
          nullable: true
      additionalProperties: false
```