Jump to

• Request
• Response

Updates a comment.

put

/ec-comment-svc/rest/v1.0/studies/{studyId}/comments/{commentId}

Updates a particular comment/reply - updates either its content or marks it as resolved.

Request

Path Parameters

• commentId(required): string(uuid)
  The object id associated to the comment.
• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Show Source

• dateCreated: string (date-time)
  The timestamp when the message was posted
• firstName: string
  The first name of the person who made the comment

  Example: system
• fullName: string
  The localized full name of the person who made the comment
• id: string (uuid)
  Object Unique GUID
• isRead: boolean
  Was comment read by the user making the request

  Example: true
• lastName: string
  The last name of the person who made the comment

  Example: clinicalOne
• message: string
  The comment made by the user

  Example: This is a sample comment
• objectId: string (uuid)
  The GUID of object the comment belongs to
• objectType: string
  The type of object the comment belongs to
• objectVersionNumber: number
  The object version number

  Example: 2
• operationType: string
  The operation type
• origin: string
  Where the comment thread was originally started

  Example: DESIGN
• parentId: string (uuid)
  The GUID of object the reply to this comment, if applicable
• replies: array replies
  The list of all replies to this comment
• softwareVersionNumber: number
  The software version number

  Example: 2
• status: string
  The status of the comment, such as resolved or unresolved

  Example: UNRESOLVED
• studyId: string (uuid)
  The GUID of the study where this comment belong to
• tags: object CommentTagDto
  The email notification metadata for users tagged on the comment
• userId: string (uuid)
  The GUID of the user posting the comment
• versionEnd: string (date-time)
  The precise version start date
• versionStart: string (date-time)
  The version start date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Object Unique GUID",
            "format":"uuid"
        },
        "objectId":{
            "type":"string",
            "description":"The GUID of object the comment belongs to",
            "format":"uuid"
        },
        "parentId":{
            "type":"string",
            "description":"The GUID of object the reply to this comment, if applicable",
            "format":"uuid"
        },
        "message":{
            "type":"string",
            "description":"The comment made by the user",
            "example":"This is a sample comment"
        },
        "userId":{
            "type":"string",
            "description":"The GUID of the user posting the comment",
            "format":"uuid"
        },
        "status":{
            "type":"string",
            "description":"The status of the comment, such as resolved or unresolved",
            "example":"UNRESOLVED"
        },
        "objectType":{
            "type":"string",
            "description":"The type of object the comment belongs to"
        },
        "versionStart":{
            "type":"string",
            "description":"The version start date",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The precise version start date",
            "format":"date-time"
        },
        "operationType":{
            "type":"string",
            "description":"The operation type"
        },
        "studyId":{
            "type":"string",
            "description":"The GUID of the study where this comment belong to",
            "format":"uuid"
        },
        "dateCreated":{
            "type":"string",
            "description":"The timestamp when the message was posted",
            "format":"date-time"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"The software version number",
            "example":"2"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"The object version number",
            "example":"2"
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the person who made the comment",
            "example":"system"
        },
        "lastName":{
            "type":"string",
            "description":"The last name of the person who made the comment",
            "example":"clinicalOne"
        },
        "fullName":{
            "type":"string",
            "description":"The localized full name of the person who made the comment"
        },
        "origin":{
            "type":"string",
            "description":"Where the comment thread was originally started",
            "example":"DESIGN"
        },
        "isRead":{
            "type":"boolean",
            "description":"Was comment read by the user making the request",
            "example":true
        },
        "replies":{
            "type":"array",
            "description":"The list of all replies to this comment",
            "items":{
                "$ref":"#/components/schemas/CommentDto"
            }
        },
        "tags":{
            "$ref":"#/components/schemas/CommentTagDto"
        }
    }
}

Nested Schema : replies

Type: array

The list of all replies to this comment

Show Source

• Array of: object CommentDto
  The list of all replies to this comment

{
    "type":"array",
    "description":"The list of all replies to this comment",
    "items":{
        "$ref":"#/components/schemas/CommentDto"
    }
}

Nested Schema : CommentTagDto

Type: object

The email notification metadata for users tagged on the comment

Show Source

• commentUrl: string
  The url to reply to the message from the email
• eventTitle: string
  The title of the event on which the object commented on is associated with

  Example: Demography Visit
• mainObjectTitle: string
  The title of the main object where the comment is made, such as the form name
• objectRefName: string
  The reference name of the object commented on

  Example: TEXT_01
• objectTitle: string
  The title of the object commented on

  Example: Race
• studyTitle: string
  The study title
• subjectNumber: string
  the subject associated with object commented on

  Example: 100-01
• userIds: array userIds
  list of users to send email notification to

{
    "type":"object",
    "properties":{
        "studyTitle":{
            "type":"string",
            "description":"The study title"
        },
        "mainObjectTitle":{
            "type":"string",
            "description":"The title of the main object where the comment is made, such as the form name"
        },
        "objectRefName":{
            "type":"string",
            "description":"The reference name of the object commented on",
            "example":"TEXT_01"
        },
        "objectTitle":{
            "type":"string",
            "description":"The title of the object commented on",
            "example":"Race"
        },
        "eventTitle":{
            "type":"string",
            "description":"The title of the event on which the object commented on is associated with",
            "example":"Demography Visit"
        },
        "subjectNumber":{
            "type":"string",
            "description":"the subject associated with object commented on",
            "example":"100-01"
        },
        "commentUrl":{
            "type":"string",
            "description":"The url to reply to the message from the email"
        },
        "userIds":{
            "type":"array",
            "description":"list of users to send email notification to",
            "items":{
                "type":"string",
                "description":"list of users to send email notification to",
                "format":"uuid"
            }
        }
    },
    "description":"The email notification metadata for users tagged on the comment"
}

Nested Schema : CommentDto

Type: object

The list of all replies to this comment

Show Source

• dateCreated: string (date-time)
  The timestamp when the message was posted
• firstName: string
  The first name of the person who made the comment

  Example: system
• fullName: string
  The localized full name of the person who made the comment
• id: string (uuid)
  Object Unique GUID
• isRead: boolean
  Was comment read by the user making the request

  Example: true
• lastName: string
  The last name of the person who made the comment

  Example: clinicalOne
• message: string
  The comment made by the user

  Example: This is a sample comment
• objectId: string (uuid)
  The GUID of object the comment belongs to
• objectType: string
  The type of object the comment belongs to
• objectVersionNumber: number
  The object version number

  Example: 2
• operationType: string
  The operation type
• origin: string
  Where the comment thread was originally started

  Example: DESIGN
• parentId: string (uuid)
  The GUID of object the reply to this comment, if applicable
• softwareVersionNumber: number
  The software version number

  Example: 2
• status: string
  The status of the comment, such as resolved or unresolved

  Example: UNRESOLVED
• studyId: string (uuid)
  The GUID of the study where this comment belong to
• tags: object CommentTagDto
  The email notification metadata for users tagged on the comment
• userId: string (uuid)
  The GUID of the user posting the comment
• versionEnd: string (date-time)
  The precise version start date
• versionStart: string (date-time)
  The version start date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Object Unique GUID",
            "format":"uuid"
        },
        "objectId":{
            "type":"string",
            "description":"The GUID of object the comment belongs to",
            "format":"uuid"
        },
        "parentId":{
            "type":"string",
            "description":"The GUID of object the reply to this comment, if applicable",
            "format":"uuid"
        },
        "message":{
            "type":"string",
            "description":"The comment made by the user",
            "example":"This is a sample comment"
        },
        "userId":{
            "type":"string",
            "description":"The GUID of the user posting the comment",
            "format":"uuid"
        },
        "status":{
            "type":"string",
            "description":"The status of the comment, such as resolved or unresolved",
            "example":"UNRESOLVED"
        },
        "objectType":{
            "type":"string",
            "description":"The type of object the comment belongs to"
        },
        "versionStart":{
            "type":"string",
            "description":"The version start date",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The precise version start date",
            "format":"date-time"
        },
        "operationType":{
            "type":"string",
            "description":"The operation type"
        },
        "studyId":{
            "type":"string",
            "description":"The GUID of the study where this comment belong to",
            "format":"uuid"
        },
        "dateCreated":{
            "type":"string",
            "description":"The timestamp when the message was posted",
            "format":"date-time"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"The software version number",
            "example":"2"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"The object version number",
            "example":"2"
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the person who made the comment",
            "example":"system"
        },
        "lastName":{
            "type":"string",
            "description":"The last name of the person who made the comment",
            "example":"clinicalOne"
        },
        "fullName":{
            "type":"string",
            "description":"The localized full name of the person who made the comment"
        },
        "origin":{
            "type":"string",
            "description":"Where the comment thread was originally started",
            "example":"DESIGN"
        },
        "isRead":{
            "type":"boolean",
            "description":"Was comment read by the user making the request",
            "example":true
        },
        "tags":{
            "$ref":"#/components/schemas/CommentTagDto"
        }
    },
    "description":"The list of all replies to this comment"
}

Nested Schema : userIds

Type: array

list of users to send email notification to

Show Source

• Array of: string(uuid)
  list of users to send email notification to

{
    "type":"array",
    "description":"list of users to send email notification to",
    "items":{
        "type":"string",
        "description":"list of users to send email notification to",
        "format":"uuid"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : CommentDto

Type: object

The list of all replies to this comment

Show Source

• dateCreated: string (date-time)
  The timestamp when the message was posted
• firstName: string
  The first name of the person who made the comment

  Example: system
• fullName: string
  The localized full name of the person who made the comment
• id: string (uuid)
  Object Unique GUID
• isRead: boolean
  Was comment read by the user making the request

  Example: true
• lastName: string
  The last name of the person who made the comment

  Example: clinicalOne
• message: string
  The comment made by the user

  Example: This is a sample comment
• objectId: string (uuid)
  The GUID of object the comment belongs to
• objectType: string
  The type of object the comment belongs to
• objectVersionNumber: number
  The object version number

  Example: 2
• operationType: string
  The operation type
• origin: string
  Where the comment thread was originally started

  Example: DESIGN
• parentId: string (uuid)
  The GUID of object the reply to this comment, if applicable
• softwareVersionNumber: number
  The software version number

  Example: 2
• status: string
  The status of the comment, such as resolved or unresolved

  Example: UNRESOLVED
• studyId: string (uuid)
  The GUID of the study where this comment belong to
• tags: object CommentTagDto
  The email notification metadata for users tagged on the comment
• userId: string (uuid)
  The GUID of the user posting the comment
• versionEnd: string (date-time)
  The precise version start date
• versionStart: string (date-time)
  The version start date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Object Unique GUID",
            "format":"uuid"
        },
        "objectId":{
            "type":"string",
            "description":"The GUID of object the comment belongs to",
            "format":"uuid"
        },
        "parentId":{
            "type":"string",
            "description":"The GUID of object the reply to this comment, if applicable",
            "format":"uuid"
        },
        "message":{
            "type":"string",
            "description":"The comment made by the user",
            "example":"This is a sample comment"
        },
        "userId":{
            "type":"string",
            "description":"The GUID of the user posting the comment",
            "format":"uuid"
        },
        "status":{
            "type":"string",
            "description":"The status of the comment, such as resolved or unresolved",
            "example":"UNRESOLVED"
        },
        "objectType":{
            "type":"string",
            "description":"The type of object the comment belongs to"
        },
        "versionStart":{
            "type":"string",
            "description":"The version start date",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The precise version start date",
            "format":"date-time"
        },
        "operationType":{
            "type":"string",
            "description":"The operation type"
        },
        "studyId":{
            "type":"string",
            "description":"The GUID of the study where this comment belong to",
            "format":"uuid"
        },
        "dateCreated":{
            "type":"string",
            "description":"The timestamp when the message was posted",
            "format":"date-time"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"The software version number",
            "example":"2"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"The object version number",
            "example":"2"
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the person who made the comment",
            "example":"system"
        },
        "lastName":{
            "type":"string",
            "description":"The last name of the person who made the comment",
            "example":"clinicalOne"
        },
        "fullName":{
            "type":"string",
            "description":"The localized full name of the person who made the comment"
        },
        "origin":{
            "type":"string",
            "description":"Where the comment thread was originally started",
            "example":"DESIGN"
        },
        "isRead":{
            "type":"boolean",
            "description":"Was comment read by the user making the request",
            "example":true
        },
        "tags":{
            "$ref":"#/components/schemas/CommentTagDto"
        }
    },
    "description":"The list of all replies to this comment"
}

Nested Schema : CommentTagDto

Type: object

The email notification metadata for users tagged on the comment

Show Source

• commentUrl: string
  The url to reply to the message from the email
• eventTitle: string
  The title of the event on which the object commented on is associated with

  Example: Demography Visit
• mainObjectTitle: string
  The title of the main object where the comment is made, such as the form name
• objectRefName: string
  The reference name of the object commented on

  Example: TEXT_01
• objectTitle: string
  The title of the object commented on

  Example: Race
• studyTitle: string
  The study title
• subjectNumber: string
  the subject associated with object commented on

  Example: 100-01
• userIds: array userIds
  list of users to send email notification to

{
    "type":"object",
    "properties":{
        "studyTitle":{
            "type":"string",
            "description":"The study title"
        },
        "mainObjectTitle":{
            "type":"string",
            "description":"The title of the main object where the comment is made, such as the form name"
        },
        "objectRefName":{
            "type":"string",
            "description":"The reference name of the object commented on",
            "example":"TEXT_01"
        },
        "objectTitle":{
            "type":"string",
            "description":"The title of the object commented on",
            "example":"Race"
        },
        "eventTitle":{
            "type":"string",
            "description":"The title of the event on which the object commented on is associated with",
            "example":"Demography Visit"
        },
        "subjectNumber":{
            "type":"string",
            "description":"the subject associated with object commented on",
            "example":"100-01"
        },
        "commentUrl":{
            "type":"string",
            "description":"The url to reply to the message from the email"
        },
        "userIds":{
            "type":"array",
            "description":"list of users to send email notification to",
            "items":{
                "type":"string",
                "description":"list of users to send email notification to",
                "format":"uuid"
            }
        }
    },
    "description":"The email notification metadata for users tagged on the comment"
}

Nested Schema : userIds

Type: array

list of users to send email notification to

Show Source

• Array of: string(uuid)
  list of users to send email notification to

{
    "type":"array",
    "description":"list of users to send email notification to",
    "items":{
        "type":"string",
        "description":"list of users to send email notification to",
        "format":"uuid"
    }
}

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top