Message Thread object representation

The messagethread object representation and fields are described below.

messagethread was introduced in API version V1

messagethread has not been marked for deprecation

Usages

Description

Representation of a message thread which can be used for general chat or discussions associated with other concepts.

Example create representation

{
  "name" : "Hello world chat",
  "group" : {
    "urn" : "822ff206-f4f8-412e-a648-2b4fab3fea10",
    "url" : "/n/v1/group/822ff206-f4f8-412e-a648-2b4fab3fea10"
  }
}

Example response representation

{
  "urn" : "91ec0651-f0fd-495e-a1c7-f3e1e018bf7f",
  "name" : "Hello world chat",
  "group" : {
    "urn" : "822ff206-f4f8-412e-a648-2b4fab3fea10",
    "url" : "/n/v1/group/822ff206-f4f8-412e-a648-2b4fab3fea10"
  },
  "tasks" : [ {
    "urn" : "365550cd-612b-4593-b4c5-ec30f25fc04d",
    "url" : "/n/v1/task/365550cd-612b-4593-b4c5-ec30f25fc04d",
    "blockedBy" : [ ],
    "blocking" : [ ],
    "associatedTasks" : [ ],
    "associatedEntities" : [ ],
    "associatedIdentities" : [ ],
    "associatedCompanies" : [ ]
  } ]
}

Fields

NameTypeDescriptionConstraints
urnString representation of a Unique Resource Name. Typically a UUID with 36 characters.The URN of the message thread
urlURL represented as a stringThe URL for accessing this thread
nameString literalThe friendly name for the chat thread or thread associated with other concepts
purposeA string representation of a enumeration name restricted to the documented valuesThe purpose for the thread for info

Allowed values:

  • GENERAL
  • CHANGELOG
  • UNRECOGNIZED
groupGroupThe membership group this chat/message thread is associated withRequired on create. Ignored on update.
companiesCompany[]Associated companiesIgnored on update.
invoicesPayment Invoice[]Associated payment invoicesIgnored on update.
tasksTask[]Associated work tasksIgnored on update.
projectsProject[]Associated projectsIgnored on update.
entitiesEntity[]Associated content entitiesIgnored on update.