Comments

Get comment.

Only used for Project comments at the moment. For comments related to other objects comments should be managed on the objects themselves or through dedicated endpoints.

get/api/Comments/{commentId}

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Comments/{commentId}
  • Auth: API key in header Authorization

Path parameters

commentIdstring nullable required

Response

Success

idstring nullable

Comment ID

objectIdstring nullable

Id of object to which the comment is related (i.e. projectId if a ObjectType is Project)

objectTypestring nullable

The type of object to which the comment is related (Available types: [Project])

typestring nullable

Specifies type of comment (Available types: [ProjectCustomerComment, ProjectInternalComment, ProjectPartnerComment])

createdstring date-time

Comment created date

customerIdstring nullable

Comment customer ID

detailstring nullable

Comment main content

titlestring nullable

Comment header

lineItemIdstring nullable

Optional line item reference

creatorstring nullable

Name of comment creator

userIdstring nullable

ID of comment creator

parentIdstring nullable

Parent comment ID

tagsstring[] nullable

Comment tags (for categories / anchors / threads)

sendNotificationboolean nullable

Send out notification. Requires delivery method and recipient(-s)

deliveryMethodstring nullable

Type of notification (Available types: [Email, Sms, EmailAndSms])

emailRecipientstring nullable

Recipient of email notification (must be valid email address)

smsRecipientstring nullable

Recipient of sms notification (must be valid phone number)

emailFromNamestring nullable

Name displayed as sender of the email

emailFromAddressstring nullable

Email address displayed as sender of the email

emailSubjectstring nullable

Email subject

smsFromstring nullable

Name displayed as sender of the sms (if empty - set to StandardSmsSender from settings)

Changes

No recorded changes to this operation across all 1 revision of this API.