Skip to content

getcommentresponse.md

Latest commit

 

History

History
51 lines (45 loc) · 4.81 KB

getcommentresponse.md

File metadata and controls

51 lines (45 loc) · 4.81 KB

GetCommentResponse

Get a Comment

Example Usage

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

let value: GetCommentResponse = {
  statusCode: 200,
  status: "OK",
  service: "sage-hr",
  resource: "Tickets",
  operation: "one",
  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",
              },
            },
          },
        ],
      },
    ],
  },
};

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 sage-hr
resource string ✔️ Unified API resource name Tickets
operation string ✔️ Operation performed one
data components.CollectionTicketComment ✔️ N/A
raw Record<string, any> ➖ Raw response from the integration when raw=true query param is provided