Records

PreviousProcesses NextField Values

Last updated 8 days ago

Get all records

get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/chatroom'

200

401

404

500

[
  {
    "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
  }
]

Success

Get record

get

Path parameters

idintegerrequired

ID of the chatroom

Example: 12

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/chatroom/{id}'

200

401

404

500

{
  "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
}

Success

Create record

post

Body

titlestringoptional

Title

Example: Purchase

typestringoptional

Type

Example: workflow

ownerstringoptional

User ID of the owner

Example: Q79THCOJ5CcvWRMPeIVZiq1ezu42

membersstring[]optional

List of user IDs

Example: ["Q79THCOJ5CcvWRMPeIVZiq1ezu42"]

groupsinteger[]optional

List of group IDs

Example: [26]

templateIdintegerrequired

ID of the process

Example: 33

descriptionstringoptional

Description

Example: For purchase order

privacystringoptional

Privacy

Example: none

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/chatroom' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Purchase",
    "type": "workflow",
    "owner": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
    "members": [
      "Q79THCOJ5CcvWRMPeIVZiq1ezu42"
    ],
    "groups": [
      26
    ],
    "templateId": 33,
    "description": "For purchase order",
    "privacy": "none"
  }'

200

401

404

500

{
  "message": "Message",
  "owner": {
    "departmentName": "Engineer",
    "department": 22,
    "orgRole": "admin",
    "lastLogin": "2024-02-02T04:17:21.859Z",
    "displayName": "Abrar Ahmed",
    "email": "abrar.ahmed@unifize.com",
    "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": "abrar.ahmed@unifize.com",
      "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
}

Success

Update record

patch

Path parameters

idintegerrequired

Example: 12

Body

titlestringoptional

Title

Example: Andromeda

due-datestringoptional

Due date as an ISO timestamp

Example: 2025-02-27T18:30:00.000Z

ownerstringoptional

User ID

Example: Q79THCOJWRMPeIVZiq1e42

descriptionstringoptional

Description

Example: abc

parentintegeroptional

Parent ID

Example: 10

prioritystringoptional

Priority

Example: high

privacystringoptional

Privacy

Example: content

statusintegeroptional

Status ID

Example: -2

commentstringoptional

Additional comment (used when updating the status)

Example: Completed

archivedbooleanoptional

Archive record

Example: true

remindersbooleanoptional

Toggle reminders

Example: true

unreadbooleanoptional

Clear unread count for user (use false to clear)

Example: false

currentVersionbooleanoptional

Mark as current revision

Example: true

versionCommentstringoptional

Adds comment when marking as current

Example: This is the new version!

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/chatroom/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "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!"
  }'

200

401

404

500

{
  "message": "Message",
  "owner": {
    "departmentName": "Engineer",
    "department": 22,
    "orgRole": "admin",
    "lastLogin": "2024-02-02T04:17:21.859Z",
    "displayName": "Abrar Ahmed",
    "email": "abrar.ahmed@unifize.com",
    "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": "abrar.ahmed@unifize.com",
      "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
}

Success