Obsolete

Add customer comment to project

OBSOLETE - Use 'api/Comments/Add' instead

put/api/Projects/{projectId}/customerComment

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/Projects/{projectId}/customerComment
  • Auth: API key in header Authorization

Path parameters

projectIdstring nullable required

Project ID to add customer comment to

Query parameters

emailRecipientstring nullable

E-mail address if comment should be sent by e-mail

smsRecipientstring nullable

Phone number if comment should be sent by SMS

Request body

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)

Response

Project is saved with new customer comment. Updated project is returned.

idstring nullable

Unique Project ID. Is set by Omnium.

projectNumberstring nullable

Project number

versionIdstring nullable

Project version

externalReferencestring nullable

An external reference to project (optional)

namestring nullable

Project name

publicUrlstring nullable

URL to public project website

storeIdstring nullable

Store handling the project

typestring nullable

Project type ID

subTypestring nullable

Project subtype

statusstring nullable

Project status (Active / Completed / New etc). Populate from constant class OmniumProjectStatus.

projectTypeNamestring nullable

Name of project's project type.

hasMultiplePartnersboolean

True if project has more than one partner

createdstring date-time

Date project is created (UTC)

modifiedstring date-time

Date project is modified (UTC)

deadlinestring date-time nullable

Deadline based on current workflow step (UTC)

projectDatestring date-time nullable

Describing the date when the main activity of the project is performed.

rentalFromstring date-time nullable

Rental period start date (UTC). Only set for rental projects.

rentalTostring date-time nullable

Rental return date (UTC). The return day is not counted as a rental day. Only set for rental projects.

isRentalProjectboolean

True if this project tracks a rental lifecycle

canceledstring date-time nullable

Cancellation date of the project.

attachmentsRootDirectorystring nullable

Blob storage root directory for attachments on this project

projectCategorystring nullable

Project category (e.g. Claim, Service)

rejectedByPartnersstring[] nullable

List of partnerIds for partners who have rejected a project

cancellationCodestring nullable

Cancellation code - reason for cancelling project

cancellationReasonstring nullable

Reason for cancelling project - free text

projectValuenumber

Project value (Calculated if project has transactions)

projectAdditionalValuenumber

Additional project value. To manually adjust project value. Will be added to project value together with the transaction values.

projectBudgetValuenumber

Project budget value (Calculated if project has transactions)

tagsstring[] nullable

Project tags

rmaNumbersstring[] nullable

RMA numbers associated with the project. Set by Omnium when a claim is created from a return.

Changes

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