Comments

List comments

Changed on

List comments for an object with cursor-based pagination. Use pageInfo.nextCursor as the cursor query parameter on the next request.

get/api/v1/comment

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

objectIDstring required

Object to list comments for.

objectCode'PROJ' | 'TASK' | 'OPTASK' | 'DOCU' | 'PRGM' | 'PORT' | 'TMPL' | 'TTSK' | 'ITRN' | 'USER' | 'TSHET' | 'GOAL' | 'TEAMOB' | 'BOARD' | 'CARD' | 'RECORD' | 'GS_APPROVALS' | 'cjaProject' | 'cjaProjectStage' | 'AEM' | 'ESS_SITE_APPROVALS' | 'plays' | 'sapphire_email' | 'Sp_CommentObject' | 'intake-request' required

Object type code identifying the parent object. Supported values by platform:

Adobe Customer Journey Analytics: cjaProject, cjaProjectStage

Adobe Experience Manager: AEM

Adobe Experience Success Studio (ESS): ESS_SITE_APPROVALS

Adobe GenStudio: GS_APPROVALS

Adobe Journey Optimizer B2B Edition: sapphire_email

Adobe Plays: plays

Adobe Workfront: PROJ, TASK, OPTASK, DOCU, PRGM, PORT, TMPL, TTSK, ITRN, USER, TSHET, GOAL, TEAMOB

Adobe Workfront Boards: BOARD, CARD

Adobe Workfront Intake: intake-request

Adobe Workfront Planning: RECORD

Microsoft SharePoint: Sp_CommentObject

Object type code identifying the parent object. See the Supported object codes table for all valid values.

limitinteger required

Page size (1–500). Values above 500 are capped server-side.

cursorinteger

Numeric timestamp cursor from pageInfo.nextCursor on a previous response.

endCursorstring

Document ID cursor for advanced paging.

searchTextstring

Filter comments by text content.

filterstring

URL-encoded JSON object matching the CommentFilter schema.

Response

OK

Changes

  • 97d93391c7f0Revision changes
    • info

      added the optional property /// to the response with the status

  • 30ac4b25082aRevision changes
    • breaking

      the query request parameter objectCode was restricted to a list of enum values

    • info

      added the new enum value AEM to the query request parameter objectCode

    • info

      added the new enum value BOARD to the query request parameter objectCode

    • info

      added the new enum value CARD to the query request parameter objectCode

    • info

      added the new enum value DOCU to the query request parameter objectCode

    • info

      added the new enum value ESS_SITE_APPROVALS to the query request parameter objectCode

    • info

      added the new enum value GOAL to the query request parameter objectCode

    • info

      added the new enum value GS_APPROVALS to the query request parameter objectCode

    • info

      added the new enum value ITRN to the query request parameter objectCode

    • info

      added the new enum value OPTASK to the query request parameter objectCode

    • info

      added the new enum value PORT to the query request parameter objectCode

    • info

      added the new enum value PRGM to the query request parameter objectCode

    • info

      added the new enum value PROJ to the query request parameter objectCode

    • info

      added the new enum value RECORD to the query request parameter objectCode

    • info

      added the new enum value Sp_CommentObject to the query request parameter objectCode

    • info

      added the new enum value TASK to the query request parameter objectCode

    • info

      added the new enum value TEAMOB to the query request parameter objectCode

    • info

      added the new enum value TMPL to the query request parameter objectCode

    • info

      added the new enum value TSHET to the query request parameter objectCode

    • info

      added the new enum value TTSK to the query request parameter objectCode

    • info

      added the new enum value USER to the query request parameter objectCode

    • info

      added the new enum value cjaProject to the query request parameter objectCode

    • info

      added the new enum value cjaProjectStage to the query request parameter objectCode

    • info

      added the new enum value intake-request to the query request parameter objectCode

    • info

      added the new enum value plays to the query request parameter objectCode

    • info

      added the new enum value sapphire_email to the query request parameter objectCode