Records
Responses
200
Success
application/json
401
Authentication / Authorization error
application/json
404
Not Found
application/json
500
Internal server error
application/json
get
GET /chatroom HTTP/1.1
Host:
Accept: */*
[
{
"message": "Message",
"owner": "<uuid>",
"updatedAt": "2024-01-04T06:39:58.231Z",
"whitelistedGroups": "example",
"lastMessage": "Last",
"versionCount": 1,
"priority": "normal",
"statusTitle": "Pending",
"privacy": "none",
"age": 24.9,
"createdAt": "2024-01-04T06:39:58.141Z",
"members": [
"<uuid1>",
"<uuid2>"
],
"parent": "parent",
"relatedConversations": {
"count": 0,
"parent": 25,
"children": [
12,
34
],
"fosterParents": [
11,
21
],
"fosterChildren": [
13,
47
]
},
"whitelist": null,
"id": 181,
"privacySettings": "settings",
"count": 0,
"completedAt": "<TIME>",
"originSeqNo": 46,
"creator": "<uuid>",
"originChatroomId": 11,
"reminders": null,
"currentVersion": true,
"autoNo": "46",
"archived": true,
"seqNo": 46,
"address": "75E4R6EQM",
"derivedTitle": "Approval Test #46: title",
"status": -1,
"processWhitelistGroups": "example",
"versionComment": "example",
"lastMessageAuthor": "unibot",
"processTitle": "Approval Test",
"title": "TItle",
"type": "workflow",
"childCount": 0,
"version": 1,
"meta": "example",
"completedBy": "<uuid>",
"memberCount": 1,
"dueDate": null,
"active": true,
"templateId": 33,
"outcome": "example",
"breadcrumbs": "example",
"orgId": 1,
"processWhitelist": "example",
"description": "description",
"canceled": false
}
]
Path parameters
idintegerRequiredExample:
ID of the chatroom
12
Responses
200
Success
application/json
401
Authentication / Authorization error
application/json
404
Not Found
application/json
500
Internal server error
application/json
get
GET /chatroom/{id} HTTP/1.1
Host:
Accept: */*
{
"message": "Message",
"owner": "<uuid>",
"updatedAt": "2024-01-04T06:39:58.231Z",
"whitelistedGroups": "example",
"lastMessage": "Last",
"versionCount": 1,
"priority": "normal",
"statusTitle": "Pending",
"privacy": "none",
"age": 24.9,
"createdAt": "2024-01-04T06:39:58.141Z",
"members": [
"<uuid1>",
"<uuid2>"
],
"parent": "parent",
"relatedConversations": {
"count": 0,
"parent": 25,
"children": [
12,
34
],
"fosterParents": [
11,
21
],
"fosterChildren": [
13,
47
]
},
"whitelist": null,
"id": 181,
"privacySettings": "settings",
"count": 0,
"completedAt": "<TIME>",
"originSeqNo": 46,
"creator": "<uuid>",
"originChatroomId": 11,
"reminders": null,
"currentVersion": true,
"autoNo": "46",
"archived": true,
"seqNo": 46,
"address": "75E4R6EQM",
"derivedTitle": "Approval Test #46: title",
"status": -1,
"processWhitelistGroups": "example",
"versionComment": "example",
"lastMessageAuthor": "unibot",
"processTitle": "Approval Test",
"title": "TItle",
"type": "workflow",
"childCount": 0,
"version": 1,
"meta": "example",
"completedBy": "<uuid>",
"memberCount": 1,
"dueDate": null,
"active": true,
"templateId": 33,
"outcome": "example",
"breadcrumbs": "example",
"orgId": 1,
"processWhitelist": "example",
"description": "description",
"canceled": false
}
Body
titlestringOptionalExample:
Title
Purchase
typestringOptionalExample:
Type
workflow
ownerstringOptionalExample:
User ID of the owner
Q79THCOJ5CcvWRMPeIVZiq1ezu42
membersstring[]OptionalExample:
List of user IDs
["Q79THCOJ5CcvWRMPeIVZiq1ezu42"]
groupsinteger[]OptionalExample:
List of group IDs
[26]
templateIdintegerRequiredExample:
ID of the process
33
descriptionstringOptionalExample:
Description
For purchase order
privacystringOptionalExample:
Privacy
none
Responses
200
Success
application/json
401
Authentication / Authorization error
application/json
404
Not Found
application/json
500
Internal server error
application/json
post
POST /chatroom HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 202
{
"title": "Purchase",
"type": "workflow",
"owner": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
"members": [
"Q79THCOJ5CcvWRMPeIVZiq1ezu42"
],
"groups": [
26
],
"templateId": 33,
"description": "For purchase order",
"privacy": "none"
}
{
"message": "Message",
"owner": {
"departmentName": "Engineer",
"department": 22,
"orgRole": "admin",
"lastLogin": "2024-02-02T04:17:21.859Z",
"displayName": "Abrar Ahmed",
"email": "[email protected]",
"emailVerified": true,
"uid": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
"joinDate": "2023-06-11",
"passwordNotSet": false,
"inviteDate": "2023-06-11",
"orgRoleId": 2,
"phoneNumber": "9999988888",
"photoUrl": "<url>",
"disabled": false,
"orgId": 1,
"invitePending": false
},
"updatedAt": "2024-02-02T04:29:09.335Z",
"whitelistedGroups": [
"Group1",
"Group2"
],
"lastMessage": "Completed",
"versionCount": 1,
"priority": "normal",
"statusTitle": "Pending",
"privacy": "none",
"age": 0,
"createdAt": "2024-02-02T04:29:09.182Z",
"members": [
{
"departmentName": "Engineer",
"department": 22,
"orgRole": "admin",
"lastLogin": "2024-02-02T04:17:21.859Z",
"displayName": "Abrar Ahmed",
"email": "[email protected]",
"emailVerified": true,
"uid": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
"joinDate": "2023-06-11",
"passwordNotSet": false,
"inviteDate": "2023-06-11",
"orgRoleId": 2,
"phoneNumber": "9999988888",
"photoUrl": "<url>",
"disabled": false,
"orgId": 1,
"invitePending": false
}
],
"parent": 11,
"relatedConversations": {
"count": 1,
"parent": 12,
"children": [
12,
33
],
"fosterParents": [
11,
31
],
"fosterChildren": [
12,
33
]
},
"whitelist": [
"UID1",
"UID2"
],
"id": 208,
"files": [
{
"description": "New file",
"fileId": 20
}
],
"privacySettings": {},
"count": 0,
"completedAt": "2024-02-02T04:17:21.859Z",
"originSeqNo": 61,
"creator": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
"originChatroomId": 11,
"reminders": {},
"currentVersion": true,
"autoNo": "61",
"archived": false,
"seqNo": 61,
"address": "Y1GW0PGZK",
"derivedTitle": "Approval Test #61: New-chatroom",
"status": -1,
"checklists": [
{
"id": 45
}
],
"processWhitelistGroups": [
"text"
],
"versionComment": "Comment",
"lastMessageAuthor": "unibot",
"processTitle": "Approval Test",
"title": "New-chatroom",
"type": "workflow",
"childCount": 0,
"processOwners": [
"text"
],
"version": 1,
"meta": "Meta Information",
"completedBy": "UID",
"memberCount": 2,
"dueDate": "2023-01-22",
"active": true,
"groupMembers": {},
"templateId": 33,
"outcome": "text",
"breadcrumbs": "text",
"groups": [
"text"
],
"orgId": 1,
"processWhitelist": [
"text"
],
"description": "text",
"canceled": false
}
Path parameters
idintegerRequiredExample:
ID
12
Body
titlestringOptionalExample:
Title
Andromeda
due-datestringOptionalExample:
Due date as an ISO timestamp
2025-02-27T18:30:00.000Z
ownerstringOptionalExample:
User ID
Q79THCOJWRMPeIVZiq1e42
descriptionstringOptionalExample:
Description
abc
parentintegerOptionalExample:
Parent ID
10
prioritystringOptionalExample:
Priority
high
privacystringOptionalExample:
Privacy
content
statusintegerOptionalExample:
Status ID
-2
commentstringOptionalExample:
Additional comment (used when updating the status)
Completed
archivedbooleanOptionalExample:
Archive record
true
remindersbooleanOptionalExample:
Toggle reminders
true
unreadbooleanOptionalExample:
Clear unread count for user (use false
to clear)
false
currentVersionbooleanOptionalExample:
Mark as current revision
true
versionCommentstringOptionalExample:
Adds comment when marking as current
This is the new version!
Responses
200
Success
application/json
401
Authentication / Authorization error
application/json
404
Not Found
application/json
500
Internal server error
application/json
patch
PATCH /chatroom/{id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 310
{
"title": "Andromeda",
"due-date": "2025-02-27T18:30:00.000Z",
"owner": "Q79THCOJWRMPeIVZiq1e42",
"description": "abc",
"parent": 10,
"priority": "high",
"privacy": "content",
"status": -2,
"comment": "Completed",
"archived": true,
"reminders": true,
"unread": false,
"currentVersion": true,
"versionComment": "This is the new version!"
}
{
"message": "Message",
"owner": {
"departmentName": "Engineer",
"department": 22,
"orgRole": "admin",
"lastLogin": "2024-02-02T04:17:21.859Z",
"displayName": "Abrar Ahmed",
"email": "[email protected]",
"emailVerified": true,
"uid": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
"joinDate": "2023-06-11",
"passwordNotSet": false,
"inviteDate": "2023-06-11",
"orgRoleId": 2,
"phoneNumber": "9999988888",
"photoUrl": "<url>",
"disabled": false,
"orgId": 1,
"invitePending": false
},
"updatedAt": "2024-02-02T04:29:09.335Z",
"whitelistedGroups": [
"Group1",
"Group2"
],
"lastMessage": "Completed",
"versionCount": 1,
"priority": "normal",
"statusTitle": "Pending",
"privacy": "none",
"age": 0,
"createdAt": "2024-02-02T04:29:09.182Z",
"members": [
{
"departmentName": "Engineer",
"department": 22,
"orgRole": "admin",
"lastLogin": "2024-02-02T04:17:21.859Z",
"displayName": "Abrar Ahmed",
"email": "[email protected]",
"emailVerified": true,
"uid": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
"joinDate": "2023-06-11",
"passwordNotSet": false,
"inviteDate": "2023-06-11",
"orgRoleId": 2,
"phoneNumber": "9999988888",
"photoUrl": "<url>",
"disabled": false,
"orgId": 1,
"invitePending": false
}
],
"parent": 11,
"relatedConversations": {
"count": 1,
"parent": 12,
"children": [
12,
33
],
"fosterParents": [
11,
31
],
"fosterChildren": [
12,
33
]
},
"whitelist": [
"UID1",
"UID2"
],
"id": 208,
"files": [
{
"description": "New file",
"fileId": 20
}
],
"privacySettings": {},
"count": 0,
"completedAt": "2024-02-02T04:17:21.859Z",
"originSeqNo": 61,
"creator": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
"originChatroomId": 11,
"reminders": {},
"currentVersion": true,
"autoNo": "61",
"archived": false,
"seqNo": 61,
"address": "Y1GW0PGZK",
"derivedTitle": "Approval Test #61: New-chatroom",
"status": -1,
"checklists": [
{
"id": 45
}
],
"processWhitelistGroups": [
"text"
],
"versionComment": "Comment",
"lastMessageAuthor": "unibot",
"processTitle": "Approval Test",
"title": "New-chatroom",
"type": "workflow",
"childCount": 0,
"processOwners": [
"text"
],
"version": 1,
"meta": "Meta Information",
"completedBy": "UID",
"memberCount": 2,
"dueDate": "2023-01-22",
"active": true,
"groupMembers": {},
"templateId": 33,
"outcome": "text",
"breadcrumbs": "text",
"groups": [
"text"
],
"orgId": 1,
"processWhitelist": [
"text"
],
"description": "text",
"canceled": false
}
Last updated