UserComment

Represents a comment pointing to a particular object on Limecraft Flow, or a part of that object.

Property reference

Field Name	Required	Type	Description	Format
accountId	✘	Long		int64
created	✘	Date	The time when this resource was created	date-time
createdBy	✘	String	The request or process that created this resource
creatorId	✘	Long	The id of the user who created this resource	int64
deleted	✘	Date		date-time
description	✘	String
funnel	✘	String
id	✔	Long	The id of this resource	int64
lastUpdated	✘	Date	The time when this resource was last updated	date-time
mentionIds	✘	Set of long		int64
mentions	✘	Set of User
modifiedBy	✔	String	The request or process responsible for the last update of this resource
objectType	✘	String	The data model type or class name of this resource
parentCommentId	✘	Long		int64
productionId	✘	Long		int64
resolutionStatus	✔	String	Is the submission active, or is it archived?	Enum: Open, In Progress, Resolved, Rejected,
subscopes	✘	List of UserCommentSubscope
tags	✘	List of string
targetIds	✘	Set of string
targetObjectType	✘	String
version	✔	Long	The version of this resource, used for Optimistic Locking	int64

Field Name

Required

Type

Description

Format

accountId

✘

Long

int64

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

deleted

✘

Date

date-time

description

✘

String

funnel

✘

String

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

mentionIds

✘

Set of long

int64

mentions

✘

Set of User

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

parentCommentId

✘

Long

int64

productionId

✘

Long

int64

resolutionStatus

✔

String

Is the submission active, or is it archived?

Enum: Open, In Progress, Resolved, Rejected,

subscopes

✘

List of UserCommentSubscope

Partial Reject

A UserComment with funnel "PartialReject" represents a change request on a particular part of a DeliveryRequestSubmission.

{
    "objectType": "UserComment",
    "funnel": "PartialReject",
    "targetObjectType": "DeliveryRequestSubmission",
    "targetIds": [
        "21227"
    ],
    "description": "There is a problem with \"spokenLanguages\"",
    "resolutionStatus": "Resolved",
    "subscopes": [
        {
            "withinTargetPointer": "/formFieldValues/spokenLanguages/values/:EyuuyVUYUpn"
        }
    ]
}

The targetObjectType and targetIds is used to point to the DeliveryRequestSubmission. The subscopes contains a subscope with a withinTargetPointer. It can point to a particular Form Field Value or to an attached clip. See also withinTargetPointer.

The resolutionStatus is either the default "Open" or it is "Resolved".

How Limecraft Flow UI shows the change request status of a particular object depends on the state of the DeliveryRequestSubmission and on the presence of linked PartialReject UserComments and their resolutionStatus.