getcommentsresponse.md

GetCommentsResponse

List Comments

Example Usage

import { GetCommentsResponse } from "@apideck/unify/models/components";

let value: GetCommentsResponse = {
  statusCode: 200,
  status: "OK",
  service: "jira",
  resource: "Tickets",
  operation: "all",
  data: [
    {
      id: "12345",
      body: "What internet provider do you use?",
      createdBy: "12345",
      updatedAt: new Date("2020-09-30T07:43:32.000Z"),
      createdAt: new Date("2020-09-30T07:43:32.000Z"),
      passThrough: [
        {
          serviceId: "<id>",
          extendPaths: [
            {
              path: "$.nested.property",
              value: {
                "TaxClassificationRef": {
                  "value": "EUC-99990201-V1-00020000",
                },
              },
            },
          ],
        },
      ],
    },
  ],
  meta: {
    itemsOnPage: 50,
    cursors: {
      previous: "em9oby1jcm06OnBhZ2U6OjE=",
      current: "em9oby1jcm06OnBhZ2U6OjI=",
      next: "em9oby1jcm06OnBhZ2U6OjM=",
    },
    totalCount: 1,
    warnings: [
      {
        type: "downstream_request_failed",
        statusCode: 429,
        operation: "getManager",
      },
    ],
  },
  links: {
    previous:
      "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    current: "https://unify.apideck.com/crm/companies",
    next:
      "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM",
  },
};

Fields

Field	Type	Required	Description	Example
statusCode	number	✔️	HTTP Response Status Code	200
status	string	✔️	HTTP Response Status	OK
service	string	✔️	Apideck ID of service provider	jira
resource	string	✔️	Unified API resource name	Tickets
operation	string	✔️	Operation performed	all
data	components.CollectionTicketComment[]	✔️	N/A
meta	components.Meta	➖	Response metadata
links	components.Links	➖	Links to navigate to previous or next pages through the API
raw	Record<string, any>	➖	Raw response from the integration when raw=true query param is provided