LoadComments |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/LoadComments
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/LoadComments
Load comments for a certain document, case or workflow-instance, based on a timestamp.
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/LoadComments
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â–¡ CreatedBefore |
xs:string |
nillable |
Comments before this time will be loaded. If undefined then the present time will be used. (Input in ISO format.) |
â– MaxCount |
xs:int |
mandatory |
Maximum comment count to be loaded. (Value 0: all comments will be loaded.) |
â– ObjNo |
xs:int |
mandatory |
Object-No of the object (document, case or workflow-instance) to which the comment belongs. |
â– ObjType |
xs:int |
mandatory |
Object type of the object to which the comment belongs (possible values: document:2, case:38, workflow-instance:21) |
â– WFInstanceNo |
xs:int |
|
Workflow instance-no of the workflow-instance to which the comment belongs. |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/LoadCommentsResponse
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â– AllLoaded |
xs:boolean |
|
"true" when the user has the permission to change the comment. |
â–¡ Comments |
|
nillable |
The loaded comment entries. |
≡ WSCommentEntry |
|
list nillable |
|
â– AllowEdit |
xs:boolean |
|
"true" when the user has the permission to change the comment. |
â–¡ CommentText |
xs:string |
nillable |
The comment text. |
â–¡ CreatedByDisplayName |
xs:string |
nillable |
Display name of the user who created the comment. |
â– CreatedByUserNo |
xs:int |
|
User-No of the user who created the comment. |
â–¡ CreatedOn |
xs:string |
nillable |
Date and time when the comment was created. |
â– ID |
xs:string |
GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} |
Gets the GUID of the comment |
â–¡ LastModified |
xs:string |
nillable |
Date and time when the comment was last modified. |
â– ObjNo |
xs:int |
|
Object-No of the object (document, case or workflow-instance) to which the comment belongs. |
â– ObjType |
xs:int |
|
Object type of the object to which the comment belongs (possible values: document:2, case:38, workflow-instance: 21)" |
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
List of elements. |
Bold |
Mandatory element. |