API Reference

HTTP API lets you access and work with a lot of Space modules and functionality (see the table of contents to the left for the entire list.)

The API uses a number of specific object types and enums described on this page.

Object types

ATimeZone type


object with fields: `id`: `string` ( Required )

ATimeZoneWithOffset type


object with fields: `id`: `string` ( Required ) `offset`: `integer` (format: int32) ( Required )

AbsenceApproval type


object with fields: `approved`: `boolean` ( Required ) `approvedBy`: `TD_MemberProfile` ( Required ) `approvedAt`: `string` (format: date-time) ( Required )

AbsenceEvent type


object with fields: `profile`: `TD_MemberWithTeam` ( Required ) `events`: array of `AbsenceRecord` ( Required )

AbsenceReasonRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `name`: `string` ( Required ) `description`: `string` ( Required ) `defaultAvailability`: `boolean` ( Required ) `approvalRequired`: `boolean` ( Required ) `icon`: `string` ( Required )

AbsenceRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `member`: `TD_MemberProfile` ( Required ) `icon`: `string` ( Required ) `reason`: `AbsenceReasonRecord` ( Nullable and Optional , defaults to `null`) `description`: `string` ( Nullable and Optional , defaults to `null`) `since`: `string` (format: full-date) ( Required ) `till`: `string` (format: full-date) ( Required ) `location`: `TD_Location` ( Nullable and Optional , defaults to `null`) `available`: `boolean` ( Required ) `approval`: `AbsenceApproval` ( Nullable and Optional , defaults to `null`) `customFields`: key-value object of string keys and values of `CFValue` ( Required )

object with fields:

id: string ( Required )
archived: boolean ( Required )
member: TD_MemberProfile ( Required )
icon: string ( Required )
reason: AbsenceReasonRecord ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
since: string (format: full-date) ( Required )
till: string (format: full-date) ( Required )
location: TD_Location ( Nullable and Optional , defaults to null)
available: boolean ( Required )
approval: AbsenceApproval ( Nullable and Optional , defaults to null)
customFields: key-value object of string keys and values of CFValue ( Required )

AccessRecord type


object with fields: `time`: `string` (format: date-time) ( Required ) `address`: `string` ( Required ) `userAgent`: `string` ( Nullable and Optional , defaults to `null`)

AllChannelsListEntry type


object with fields: `channelId`: `string` ( Required ) `name`: `string` ( Required ) `description`: `string` ( Required ) `access`: `M2.Access` ( Required ) `icon`: `string` ( Nullable and Optional , defaults to `null`) `created`: `string` (format: date-time) ( Required ) `subscribers`: `integer` (format: int32) ( Required ) `subscribed`: `boolean` ( Required )

AllReactionsToItemRecord type


object with fields: `id`: `string` ( Required ) `reactions`: array of `CertainReactionToItemRecord` ( Required ) `emojiReactions`: array of `EmojiReactionRecord` ( Nullable and Optional , defaults to `null`)

ApiIcon type


object with fields: `icon`: `string` ( Required )

ApplicationPayload type

Name Type

Name	Type
`className`	`string` Possible values: `ListMenuExtensionsPayload` `ListCommandsPayload` `MessagePayload` `MenuActionPayload` `MessageActionPayload`

className

string

Possible values:

ListMenuExtensionsPayload
ListCommandsPayload
MessagePayload
MenuActionPayload
MessageActionPayload

ArticleChannelRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `channel`: `M2ChannelRecord` ( Required ) `channelContent`: `M2ChannelContentRecord` ( Required ) `reactions`: `AllReactionsToItemRecord` ( Required )

ArticleContentRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `content`: `string` ( Required )

ArticleDetailsRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `event`: `MeetingRecord` ( Nullable and Optional , defaults to `null`) `team`: `TD_Team` ( Nullable and Optional , defaults to `null`) `project`: `PR_Project` ( Nullable and Optional , defaults to `null`) `location`: `TD_Location` ( Nullable and Optional , defaults to `null`) `teams`: array of `TD_Team` ( Nullable and Optional , defaults to `null`) `locations`: array of `TD_Location` ( Nullable and Optional , defaults to `null`) `externalEntityInfo`: `ExternalEntityInfoRecord` ( Nullable and Optional , defaults to `null`)

object with fields:

id: string ( Required )
archived: boolean ( Required )
event: MeetingRecord ( Nullable and Optional , defaults to null)
team: TD_Team ( Nullable and Optional , defaults to null)
project: PR_Project ( Nullable and Optional , defaults to null)
location: TD_Location ( Nullable and Optional , defaults to null)
teams: array of TD_Team ( Nullable and Optional , defaults to null)
locations: array of TD_Location ( Nullable and Optional , defaults to null)
externalEntityInfo: ExternalEntityInfoRecord ( Nullable and Optional , defaults to null)

ArticleHitDetails type


object with fields: `ref`: `ArticleRecord` ( Required )

ArticleImportResult type


object with fields: `externalId`: `string` ( Nullable and Optional , defaults to `null`) `article`: `ArticleRecord` ( Nullable and Optional , defaults to `null`) `error`: `string` ( Nullable and Optional , defaults to `null`)

ArticleMarkdownImage type


object with fields: `alt`: `string` ( Required ) `src`: `string` ( Required )

ArticlePreviewRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `previewImages`: array of `ArticleMarkdownImage` ( Required ) `preview`: `string` ( Required ) `wordsNumber`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`) `cut`: `boolean` ( Nullable and Optional , defaults to `null`)

ArticleRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `title`: `string` ( Required ) `created`: `string` (format: date-time) ( Required ) `author`: `TD_MemberProfile` ( Required ) `aliases`: array of `BG_ArticleAlias` ( Required ) `archivedBy`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`) `archivedAt`: `string` (format: date-time) ( Nullable and Optional , defaults to `null`) `event`: `MeetingRecord` ( Nullable and Optional , defaults to `null`) `team`: `TD_Team` ( Nullable and Optional , defaults to `null`) `project`: `PR_Project` ( Nullable and Optional , defaults to `null`) `location`: `TD_Location` ( Nullable and Optional , defaults to `null`) `teams`: array of `TD_Team` ( Nullable and Optional , defaults to `null`) `locations`: array of `TD_Location` ( Nullable and Optional , defaults to `null`) `externalEntityInfo`: `ExternalEntityInfoRecord` ( Nullable and Optional , defaults to `null`) `previewImages`: array of `ArticleMarkdownImage` ( Required ) `preview`: `string` ( Required ) `wordsNumber`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`) `cut`: `boolean` ( Nullable and Optional , defaults to `null`) `content`: `string` ( Required ) `editable`: `boolean` ( Required ) `channel`: `M2ChannelRecord` ( Required ) `channelContent`: `M2ChannelContentRecord` ( Required ) `reactions`: `AllReactionsToItemRecord` ( Required )

object with fields:

id: string ( Required )
archived: boolean ( Required )
title: string ( Required )
created: string (format: date-time) ( Required )
author: TD_MemberProfile ( Required )
aliases: array of BG_ArticleAlias ( Required )
archivedBy: TD_MemberProfile ( Nullable and Optional , defaults to null)
archivedAt: string (format: date-time) ( Nullable and Optional , defaults to null)
event: MeetingRecord ( Nullable and Optional , defaults to null)
team: TD_Team ( Nullable and Optional , defaults to null)
project: PR_Project ( Nullable and Optional , defaults to null)
location: TD_Location ( Nullable and Optional , defaults to null)
teams: array of TD_Team ( Nullable and Optional , defaults to null)
locations: array of TD_Location ( Nullable and Optional , defaults to null)
externalEntityInfo: ExternalEntityInfoRecord ( Nullable and Optional , defaults to null)
previewImages: array of ArticleMarkdownImage ( Required )
preview: string ( Required )
wordsNumber: integer (format: int32) ( Nullable and Optional , defaults to null)
cut: boolean ( Nullable and Optional , defaults to null)
content: string ( Required )
editable: boolean ( Required )
channel: M2ChannelRecord ( Required )
channelContent: M2ChannelContentRecord ( Required )
reactions: AllReactionsToItemRecord ( Required )

AssignedPerson type


object with fields: `profile`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`) `role`: `string` ( Nullable and Optional , defaults to `null`)

Attachment type

Name Type

Name	Type
`className`	`string` Possible values: `VideoAttachment` `ImageAttachment` `FileAttachment` `DeletedAttachment` `UnfurlAttachment` `ProfileLinkPreview`

className

string

Possible values:

VideoAttachment
ImageAttachment
FileAttachment
DeletedAttachment
UnfurlAttachment
ProfileLinkPreview

AttachmentIn type

Name Type

Name	Type
`className`	`string` Possible values: `VideoAttachment` `ImageAttachment` `FileAttachment`

className

string

Possible values:

VideoAttachment
ImageAttachment
FileAttachment

AttachmentInfo type


object with fields: `details`: `Attachment` ( Nullable and Optional , defaults to `null`)

AuthModuleUsage type


object with fields: `authModule`: `ES_AuthModule` ( Required ) `profiles`: `integer` (format: int32) ( Required )

AutomationJobExecutionUnfurlDetails type


object with fields: `jobExecutionId`: `string` ( Required ) `projectRef`: `PR_Project` ( Required ) `repoName`: `string` ( Required )

AutomationJobUnfurlDetails type


object with fields: `jobId`: `string` ( Required ) `jobName`: `string` ( Required ) `projectRef`: `PR_Project` ( Required ) `repoName`: `string` ( Required ) `jobExecutionDisplayStatusFilter`: `ExecutionDisplayStatus` ( Nullable and Optional , defaults to `null`) `jobTriggerFilter`: `JobTriggerType` ( Nullable and Optional , defaults to `null`) `branch`: `Branch` ( Nullable and Optional , defaults to `null`)

object with fields:

jobId: string ( Required )
jobName: string ( Required )
projectRef: PR_Project ( Required )
repoName: string ( Required )
jobExecutionDisplayStatusFilter: ExecutionDisplayStatus ( Nullable and Optional , defaults to null)
jobTriggerFilter: JobTriggerType ( Nullable and Optional , defaults to null)
branch: Branch ( Nullable and Optional , defaults to null)

AvatarCropSquare type


object with fields: `x`: `integer` (format: int32) ( Required ) `y`: `integer` (format: int32) ( Required ) `length`: `integer` (format: int32) ( Required )

BG_ArticleAlias type


object with fields: `alias`: `string` ( Required ) `created`: `string` (format: date-time) ( Required )

BG_ArticleId type


object with fields: `id`: `string` ( Required )

BG_Stats type


object with fields: `totalBlogs`: `integer` (format: int32) ( Required ) `teams`: array of object with fields: `first`: `TD_Team` ( Required ) `second`: `integer` (format: int32) ( Required ) ( Required ) `projects`: array of object with fields: `first`: `PR_Project` ( Required ) `second`: `integer` (format: int32) ( Required ) ( Nullable and Optional , defaults to `null`) `locations`: array of object with fields: `first`: `TD_Location` ( Required ) `second`: `integer` (format: int32) ( Required ) ( Required )

object with fields:

totalBlogs: integer (format: int32) ( Required )
teams: array of object with fields:
- first: TD_Team ( Required )
- second: integer (format: int32) ( Required )
( Required )
projects: array of object with fields:
- first: PR_Project ( Required )
- second: integer (format: int32) ( Required )
( Nullable and Optional , defaults to null)
locations: array of object with fields:
- first: TD_Location ( Required )
- second: integer (format: int32) ( Required )
( Required )

BaseMenuActionContext type


object with fields: `menuId`: `string` ( Required )

BillingFeedChannel type


object with fields: `notificationDefaults`: `ChannelSpecificDefaults` ( Nullable and Optional , defaults to `null`)

BillingReport type


object with fields: `since`: `string` (format: full-date) ( Required ) `till`: `string` (format: full-date) ( Required ) `plans`: array of `PurchasedBillingPlan` ( Required ) `activeUsers`: array of `integer` (format: int64) ( Required ) `applications`: array of `integer` (format: int64) ( Required ) `chatMessages`: array of `integer` (format: int64) ( Required ) `ciCredits`: array of `integer` (format: int64) ( Required ) `trafficTotal`: array of `integer` (format: int64) ( Required ) `trafficFiles`: array of `integer` (format: int64) ( Required ) `trafficGit`: array of `integer` (format: int64) ( Required ) `trafficPackages`: array of `integer` (format: int64) ( Required ) `storageTotal`: array of `integer` (format: int64) ( Required ) `storageFiles`: array of `integer` (format: int64) ( Required ) `storageGit`: array of `integer` (format: int64) ( Required ) `storagePackages`: array of `integer` (format: int64) ( Required ) `storageAutomation`: array of `integer` (format: int64) ( Required ) `earliestBillingDate`: `string` (format: full-date) ( Required )

object with fields:

since: string (format: full-date) ( Required )
till: string (format: full-date) ( Required )
plans: array of PurchasedBillingPlan ( Required )
activeUsers: array of integer (format: int64) ( Required )
applications: array of integer (format: int64) ( Required )
chatMessages: array of integer (format: int64) ( Required )
ciCredits: array of integer (format: int64) ( Required )
trafficTotal: array of integer (format: int64) ( Required )
trafficFiles: array of integer (format: int64) ( Required )
trafficGit: array of integer (format: int64) ( Required )
trafficPackages: array of integer (format: int64) ( Required )
storageTotal: array of integer (format: int64) ( Required )
storageFiles: array of integer (format: int64) ( Required )
storageGit: array of integer (format: int64) ( Required )
storagePackages: array of integer (format: int64) ( Required )
storageAutomation: array of integer (format: int64) ( Required )
earliestBillingDate: string (format: full-date) ( Required )

BirthdayEvent type


object with fields: `profile`: `TD_MemberWithTeam` ( Required ) `birthday`: `string` (format: full-date) ( Required )

BlogCalendarEvent type


object with fields: `starts`: `string` (format: date-time) ( Nullable and Optional , defaults to `null`) `ends`: `string` (format: date-time) ( Nullable and Optional , defaults to `null`) `timezone`: `ATimeZone` ( Nullable and Optional , defaults to `null`) `rooms`: array of `string` ( Nullable and Optional , defaults to `null`) `allDay`: `boolean` ( Nullable and Optional , defaults to `null`)

object with fields:

starts: string (format: date-time) ( Nullable and Optional , defaults to null)
ends: string (format: date-time) ( Nullable and Optional , defaults to null)
timezone: ATimeZone ( Nullable and Optional , defaults to null)
rooms: array of string ( Nullable and Optional , defaults to null)
allDay: boolean ( Nullable and Optional , defaults to null)

BlogPublicationDetails type


object with fields: `teamId`: `TD_Team` ( Nullable and Optional , defaults to `null`) `teams`: array of `TD_Team` ( Nullable and Optional , defaults to `null`) `locationId`: `TD_Location` ( Nullable and Optional , defaults to `null`) `locations`: array of `TD_Location` ( Nullable and Optional , defaults to `null`) `event`: `CalendarEvent` ( Nullable and Optional , defaults to `null`) `article`: `ArticleRecord` ( Nullable and Optional , defaults to `null`)

object with fields:

teamId: TD_Team ( Nullable and Optional , defaults to null)
teams: array of TD_Team ( Nullable and Optional , defaults to null)
locationId: TD_Location ( Nullable and Optional , defaults to null)
locations: array of TD_Location ( Nullable and Optional , defaults to null)
event: CalendarEvent ( Nullable and Optional , defaults to null)
article: ArticleRecord ( Nullable and Optional , defaults to null)

BoardColumn type


object with fields: `name`: `string` ( Required ) `statuses`: array of `IssueStatus` ( Required )

BoardColumns type


object with fields: `columns`: array of `BoardColumn` ( Required )

BoardInfo type


object with fields: `owners`: `BoardOwners` ( Required ) `columns`: `BoardColumns` ( Required ) `description`: `string` ( Nullable and Optional , defaults to `null`)

BoardMemberOwners type


object with fields: `members`: array of `TD_MemberProfile` ( Required )

BoardOwners type


object with fields: `members`: `BoardMemberOwners` ( Required ) `teams`: `BoardTeamOwners` ( Required )

BoardRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `name`: `string` ( Required ) `board`: `BoardRecord` ( Required ) `data`: `BoardWidgetData` ( Nullable and Optional , defaults to `null`) `info`: `BoardInfo` ( Required )

BoardTeamOwners type


object with fields: `teams`: array of `TD_Team` ( Required )

BoardWidgetData type


object with fields: `max`: `integer` (format: int32) ( Required ) `perColumns`: array of `integer` (format: int32) ( Required )

BookHitDetails type


object with fields: `ref`: `KB_Book` ( Required ) `projectRef`: `PR_Project` ( Nullable and Optional , defaults to `null`) `authorRef`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`)

BooleanCFType type


No properties

BooleanCFValue type


object with fields: `value`: `boolean` ( Nullable and Optional , defaults to `null`)

Branch type


object with fields: `branchName`: `string` ( Required )

BranchInfo type


object with fields: `head`: `string` ( Required ) `ref`: `string` ( Required )

CAutomationTaskPrincipalDetails type


object with fields: `project`: `PR_Project` ( Required ) `name`: `string` ( Required ) `id`: `string` ( Required )

CBuiltInServicePrincipalDetails type


object with fields: `name`: `string` ( Required )

CExternalServicePrincipalDetails type


object with fields: `service`: `ES_Service` ( Required )

CFConstraint type

Name Type

className

string

Possible values:

StringCFConstraint
IntCFConstraint
PercentageCFConstraint
DateCFConstraint

CFEnumValuesModification type


object with fields: `valuesToAdd`: array of `EnumValueData` ( Required ) `valuesToUpdate`: array of `EnumValueData` ( Required ) `valuesToDelete`: array of `string` ( Required )

CFType type

Name Type

className

string

Possible values:

StringCFType
EnumListCFType
OpenEnumListCFType
IntCFType
DateCFType
ProfileCFType
PercentageCFType
StringListCFType
ProfileListCFType
IntListCFType
EnumCFType
BooleanCFType
UrlCFType
OpenEnumCFType

CFValue type

Name Type

className

string

Possible values:

DateCFValue
IntCFValue
PercentageCFValue
UrlCFValue
ProfileListCFValue
IntListCFValue
StringCFValue
BooleanCFValue
OpenEnumCFValue
StringListCFValue
OpenEnumListCFValue
EnumCFValue
ProfileCFValue
EnumListCFValue

CPrincipal type


object with fields: `name`: `string` ( Required ) `details`: `CPrincipalDetails` ( Nullable and Optional , defaults to `null`)

CPrincipalDetails type

Name Type

className

string

Possible values:

CAutomationTaskPrincipalDetails
CUserWithEmailPrincipalDetails
CExternalServicePrincipalDetails
CUserPrincipalDetails
CBuiltInServicePrincipalDetails

CUserPrincipalDetails type


object with fields: `user`: `TD_MemberProfile` ( Required )

CUserWithEmailPrincipalDetails type


object with fields: `name`: `string` ( Required ) `email`: `string` ( Required )

CalendarEvent type

object with fields:

calendarEvent: boolean ( Nullable and Optional , defaults to null)
starts: string (format: date-time) ( Nullable and Optional , defaults to null)
ends: string (format: date-time) ( Nullable and Optional , defaults to null)
timezone: ATimeZone ( Nullable and Optional , defaults to null)
rooms: array of TD_Location ( Nullable and Optional , defaults to null)
allDay: boolean ( Nullable and Optional , defaults to null)

CalendarEventSpec type

object with fields:

start: string (format: date-time) ( Required )
end: string (format: date-time) ( Required )
recurrenceRule: RecurrenceRule ( Nullable and Optional , defaults to null)
allDay: boolean ( Required )
timezone: ATimeZone ( Required )
parentId: string ( Nullable and Optional , defaults to null)
initialMeetingStart: string (format: date-time) ( Nullable and Optional , defaults to null)
busyStatus: BusyStatus ( Nullable and Optional , defaults to null)
nextChainId: string ( Nullable and Optional , defaults to null)

CertainReactionToItemRecord type


object with fields: `id`: `string` ( Required ) `itemId`: `string` ( Required ) `reaction`: `ReactionTypeRecord` ( Required ) `count`: `integer` (format: int32) ( Required ) `meReacted`: `boolean` ( Required ) `principals`: array of `CPrincipal` ( Required ) `order`: `integer` (format: int64) ( Nullable and Optional , defaults to `null`)

CertificateInfo type

object with fields:

certificateType: string ( Required )
version: integer (format: int32) ( Required )
serialNumber: string ( Required )
issuedBy: string ( Required )
issuedTo: string ( Required )
validFrom: string (format: date-time) ( Required )
validTo: string (format: date-time) ( Required )
algorithm: string ( Required )
fingerprint: Fingerprint ( Required )

ChannelAttachmentMenuActionContext type


object with fields: `menuId`: `string` ( Required ) `channelId`: `string` ( Required )

ChannelItemRecord type

object with fields:

text: string ( Required )
details: M2ItemContentDetails ( Nullable and Optional , defaults to null)
author: CPrincipal ( Required )
created: string (format: date-time) ( Required )
time: integer (format: int64) ( Required )
reactions: AllReactionsToItemRecord ( Nullable and Optional , defaults to null)
thread: M2ChannelRecord ( Nullable and Optional , defaults to null)
projectedItem: ChannelItemRecord ( Nullable and Optional , defaults to null)
attachments: array of AttachmentInfo ( Nullable and Optional , defaults to null)
attachmentsInfos: array of AttachmentInfo ( Nullable and Optional , defaults to null)
pending: boolean ( Nullable and Optional , defaults to null)
id: string ( Required )
archived: boolean ( Required )
edited: string (format: date-time) ( Nullable and Optional , defaults to null)
pinned: boolean ( Nullable and Optional , defaults to null)
suggestedParticipants: array of CPrincipal ( Nullable and Optional , defaults to null)
issues: array of Issue ( Required )

ChannelItemSnapshot type

object with fields:

id: string ( Required )
channelId: string ( Nullable and Optional , defaults to null)
text: string ( Required )
details: M2ItemContentDetails ( Nullable and Optional , defaults to null)
author: CPrincipal ( Required )
created: string (format: date-time) ( Required )
time: integer (format: int64) ( Required )
attachments: array of AttachmentInfo ( Nullable and Optional , defaults to null)

ChannelMessageMenuActionContext type


object with fields: `menuId`: `string` ( Required ) `channelId`: `string` ( Nullable and Optional , defaults to `null`) `messageId`: `string` ( Required )

ChannelParticipant type


object with fields: `principal`: `CPrincipal` ( Required ) `messageCount`: `integer` (format: int32) ( Required ) `pendingMessageCount`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`)

ChannelSpecificDefaults type


object with fields: `filter`: `NotificationFilter` ( Required ) `push`: `boolean` ( Required ) `email`: `M2EmailNotificationType` ( Required ) `threadsSubscribed`: `boolean` ( Nullable and Optional , defaults to `null`)

ChatChannel type

Name Type

className

string

Possible values:

ChatChannel.FromId
ChatChannel.FromName

ChatChannel.FromId type


object with fields: `id`: `string` ( Required )

ChatChannel.FromName type


object with fields: `name`: `string` ( Required )

ChatMessage type

Name Type

className

string

Possible values:

ChatMessage.Text
ChatMessage.Block

ChatMessage.Block type


object with fields: `style`: `MessageStyle` ( Nullable and Optional , defaults to `null`) `outline`: `MessageOutline` ( Nullable and Optional , defaults to `null`) `sections`: array of `MessageSectionElement` ( Required ) `messageData`: `string` ( Nullable and Optional , defaults to `null`)

ChatMessage.Text type


object with fields: `text`: `string` ( Required )

ChatModification type

Name Type

className

string

Possible values:

NewMessage
EditMessage
DeleteMessage
PublishMessage

Checklist type

object with fields:

id: string ( Required )
archived: boolean ( Required )
projectId: string ( Nullable and Optional , defaults to null)
project: PR_Project ( Nullable and Optional , defaults to null)
owner: TD_MemberProfile ( Nullable and Optional , defaults to null)
name: string ( Required )
root: PlanItem ( Nullable and Optional , defaults to null)
rootTag: PlanningTag ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
totalItemsCount: integer (format: int32) ( Required )
doneItemsCount: integer (format: int32) ( Required )
updatedTime: string (format: date-time) ( Nullable and Optional , defaults to null)

ClientInfo type

object with fields:

os: ClientOS ( Nullable and Optional , defaults to null)
osVersion: string ( Nullable and Optional , defaults to null)
browser: ClientBrowser ( Nullable and Optional , defaults to null)
browserVersion: string ( Nullable and Optional , defaults to null)
device: string ( Nullable and Optional , defaults to null)
version: string ( Nullable and Optional , defaults to null)

CodeDiscussionAddedFeedEvent type


object with fields: `codeDiscussion`: `CodeDiscussionRecord` ( Required ) `codeReview`: `CodeReviewRecord` ( Required )

CodeDiscussionAnchor type

object with fields:

project: ProjectKey ( Required )
repository: string ( Required )
revision: string ( Required )
filename: string ( Nullable and Optional , defaults to null)
line: integer (format: int32) ( Nullable and Optional , defaults to null)
oldLine: integer (format: int32) ( Nullable and Optional , defaults to null)
interpolatedLineState: InterpolatedLineState ( Nullable and Optional , defaults to null)

CodeDiscussionRecord type

object with fields:

id: string ( Required )
projectId: string ( Required )
anchor: CodeDiscussionAnchor ( Required )
created: string (format: date-time) ( Required )
channel: M2ChannelRecord ( Required )
resolved: boolean ( Required )
snippet: CodeDiscussionSnippet ( Nullable and Optional , defaults to null)
pending: boolean ( Nullable and Optional , defaults to null)
review: CodeReviewRecord ( Nullable and Optional , defaults to null)
feedItemId: string ( Nullable and Optional , defaults to null)
reviews: array of CodeReviewRecord ( Nullable and Optional , defaults to null)
archived: boolean ( Required )

CodeDiscussionSnippet type

Name Type

className

string

Possible values:

CodeDiscussionSnippet.PlainSnippet
CodeDiscussionSnippet.InlineDiffSnippet

CodeDiscussionSnippet.InlineDiffSnippet type


object with fields: `lines`: array of `InlineDiffLine` ( Required )

CodeDiscussionSnippet.PlainSnippet type


object with fields: `lines`: array of `CodeLine` ( Required )

CodeLine type


object with fields: `text`: `string` ( Required ) `index`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`) `offset`: `integer` (format: int32) ( Required ) `syntax`: array of `SyntaxMarkup` ( Nullable and Optional , defaults to `null`)

CodeReviewDetailedInfo type


object with fields: `shortInfo`: `CodeReviewRecord` ( Required ) `commits`: array of `RevisionsInReview` ( Required ) `discussionCounter`: `CodeReviewDiscussionCounter` ( Required ) `branches`: array of `TrackedBranchesInReview` ( Required )

CodeReviewDiscussionAddedFeedEvent type


object with fields: `discussion`: `CodeReviewDiscussionRecord` ( Required )

CodeReviewDiscussionCounter type


object with fields: `id`: `string` ( Required ) `discussionCounter`: `Counter` ( Required )

CodeReviewDiscussionRecord type


object with fields: `id`: `string` ( Required ) `review`: `CodeReviewRecord` ( Required ) `created`: `string` (format: date-time) ( Required ) `channel`: `M2ChannelRecord` ( Required ) `resolved`: `boolean` ( Required )

CodeReviewParticipant type

object with fields:

user: TD_MemberProfile ( Required )
role: CodeReviewParticipantRole ( Required )
state: ReviewerState ( Nullable and Optional , defaults to null)
theirTurn: boolean ( Nullable and Optional , defaults to null)
qualityGateSlots: array of CodeReviewParticipantQualityGateSlot ( Nullable and Optional , defaults to null)
addedAt: string (format: date-time) ( Nullable and Optional , defaults to null)

CodeReviewParticipantQualityGateSlot type


object with fields: `rule`: array of `string` ( Required ) `index`: `integer` (format: int32) ( Required )

CodeReviewParticipantRecord type


object with fields: `id`: `string` ( Required ) `projectId`: `string` ( Required ) `role`: `CodeReviewParticipantRole` ( Required ) `profile`: `TD_MemberProfile` ( Required ) `reviewerState`: `ReviewerState` ( Nullable and Optional , defaults to `null`) `theirTurn`: `boolean` ( Nullable and Optional , defaults to `null`) `archived`: `boolean` ( Required )

CodeReviewParticipants type


object with fields: `id`: `string` ( Required ) `participants`: array of `CodeReviewParticipant` ( Nullable and Optional , defaults to `null`) `reviewers`: array of `CodeReviewParticipantRecord` ( Required ) `authors`: array of `CodeReviewParticipantRecord` ( Required ) `watchers`: array of `CodeReviewParticipantRecord` ( Required )

CodeReviewPendingMessageCounter type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required )

CodeReviewRecord type

Name Type

className

string

Possible values:

CommitSetReviewRecord
MergeRequestRecord

CodeReviewWithCount type


object with fields: `review`: `CodeReviewRecord` ( Required ) `messagesCount`: `integer` (format: int32) ( Required ) `authors`: array of `GitCommitterProfile` ( Required ) `participants`: `CodeReviewParticipants` ( Required )

CodeSnippetAnchor type

object with fields:

projectKey: ProjectKey ( Required )
repository: string ( Required )
revision: string ( Required )
filename: string ( Required )
lineIndex: integer (format: int32) ( Nullable and Optional , defaults to null)
lineStart: integer (format: int32) ( Nullable and Optional , defaults to null)
lineEnd: integer (format: int32) ( Nullable and Optional , defaults to null)

CommandDetail type


object with fields: `name`: `string` ( Required ) `description`: `string` ( Required )

Commands type


object with fields: `commands`: array of `CommandDetail` ( Required )

CommitSetReviewRecord type

object with fields:

id: string ( Required )
project: ProjectKey ( Required )
projectId: string ( Required )
number: integer (format: int32) ( Required )
title: string ( Required )
state: CodeReviewState ( Required )
canBeReopened: boolean ( Nullable and Optional , defaults to null)
createdAt: integer (format: int64) ( Required )
createdBy: TD_MemberProfile ( Nullable and Optional , defaults to null)
turnBased: boolean ( Nullable and Optional , defaults to null)
feedChannel: M2ChannelRecord ( Nullable and Optional , defaults to null)
discussionCounter: Counter ( Required )
participants: array of CodeReviewParticipant ( Nullable and Optional , defaults to null)
reviewers: array of CodeReviewParticipantRecord ( Required )
authors: array of CodeReviewParticipantRecord ( Required )
watchers: array of CodeReviewParticipantRecord ( Required )

ContainerHelmChart type

object with fields:

name: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
tags: array of string ( Nullable and Optional , defaults to null)
projectUrl: string ( Nullable and Optional , defaults to null)
sourceUrl: string ( Nullable and Optional , defaults to null)
version: string ( Nullable and Optional , defaults to null)
apiVersion: string ( Nullable and Optional , defaults to null)
appVersion: string ( Nullable and Optional , defaults to null)
dependencies: array of ContainerHelmChartDependency ( Required )
type: string ( Nullable and Optional , defaults to null)

ContainerHelmChartDependency type


object with fields: `name`: `string` ( Required ) `version`: `string` ( Required ) `repository`: `string` ( Nullable and Optional , defaults to `null`) `condition`: `string` ( Nullable and Optional , defaults to `null`) `tags`: array of `string` ( Nullable and Optional , defaults to `null`)

ContainerImage type

object with fields:

name: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
tags: array of string ( Nullable and Optional , defaults to null)
projectUrl: string ( Nullable and Optional , defaults to null)
sourceUrl: string ( Nullable and Optional , defaults to null)
version: string ( Nullable and Optional , defaults to null)
platform: ContainerImagePlatform ( Nullable and Optional , defaults to null)
history: array of ContainerImageLayer ( Required )
children: array of ContainerManifest ( Required )
config: ContainerImageConfig ( Nullable and Optional , defaults to null)
annotation: ContainerImageAnnotation ( Nullable and Optional , defaults to null)

ContainerImageAnnotation type

object with fields:

created: integer (format: int64) ( Nullable and Optional , defaults to null)
buildName: string ( Nullable and Optional , defaults to null)
buildUrl: string ( Nullable and Optional , defaults to null)
revision: string ( Nullable and Optional , defaults to null)
vendor: string ( Nullable and Optional , defaults to null)
documentationUrl: string ( Nullable and Optional , defaults to null)
licenses: string ( Nullable and Optional , defaults to null)

ContainerImageConfig type

object with fields:

userName: string ( Nullable and Optional , defaults to null)
ports: array of string ( Nullable and Optional , defaults to null)
volumes: array of string ( Nullable and Optional , defaults to null)
env: array of string ( Nullable and Optional , defaults to null)
workingDir: string ( Nullable and Optional , defaults to null)
entryPoint: string ( Nullable and Optional , defaults to null)
cmd: string ( Nullable and Optional , defaults to null)
labels: array of string ( Nullable and Optional , defaults to null)

ContainerImageLayer type


object with fields: `id`: `string` ( Required ) `created`: `integer` (format: int64) ( Nullable and Optional , defaults to `null`) `statement`: `string` ( Required ) `command`: `string` ( Required ) `size`: `integer` (format: int64) ( Nullable and Optional , defaults to `null`)

ContainerImagePlatform type


object with fields: `os`: `string` ( Required ) `osVersion`: `string` ( Nullable and Optional , defaults to `null`) `arch`: `string` ( Nullable and Optional , defaults to `null`)

ContainerManifest type

object with fields:

name: string ( Required )
digest: string ( Required )
tags: array of string ( Required )
created: integer (format: int64) ( Required )
schemaVersion: integer (format: int32) ( Required )
mediaType: string ( Required )
manifestType: string ( Required )
totalSize: integer (format: int64) ( Required )
image: ContainerImage ( Nullable and Optional , defaults to null)
chart: ContainerHelmChart ( Nullable and Optional , defaults to null)

ContainerPackageType type


object with fields: `id`: `string` ( Required )

ContainerPackageVersionDetails type

object with fields:

type: PackageType ( Required )
repository: string ( Required )
name: string ( Required )
version: string ( Required )
tags: array of string ( Nullable and Optional , defaults to null)
created: integer (format: int64) ( Required )
accessed: integer (format: int64) ( Nullable and Optional , defaults to null)
downloads: integer (format: int64) ( Required )
diskSize: integer (format: int64) ( Required )
author: CPrincipal ( Nullable and Optional , defaults to null)
authors: array of CPrincipal ( Nullable and Optional , defaults to null)
origin: PackageOrigin ( Nullable and Optional , defaults to null)
metadata: key-value object of string keys and values of string ( Nullable and Optional , defaults to null)
schemaVersion: integer (format: int32) ( Required )
mediaType: string ( Required )
manifestType: string ( Required )
image: ContainerImage ( Nullable and Optional , defaults to null)
chart: ContainerHelmChart ( Nullable and Optional , defaults to null)

Counter type


object with fields: `resolved`: `integer` (format: int32) ( Required ) `unresolved`: `integer` (format: int32) ( Required )

Currency type


object with fields: `code`: `string` ( Required ) `sign`: `string` ( Nullable and Optional , defaults to `null`) `signAsPrefix`: `boolean` ( Required )

CustomField type

object with fields:

extendedType: ExtendedType ( Required )
id: string ( Required )
name: string ( Required )
description: string ( Nullable and Optional , defaults to null)
key: string ( Nullable and Optional , defaults to null)
type: CFType ( Required )
constraint: CFConstraint ( Nullable and Optional , defaults to null)
required: boolean ( Required )
private: boolean ( Required )
access: AccessType ( Nullable and Optional , defaults to null)
defaultValue: CFValue ( Required )
order: integer (format: int32) ( Required )
scope: ExtendedTypeScope ( Nullable and Optional , defaults to null)
archived: boolean ( Required )

CustomFieldValue type


object with fields: `field`: `CustomField` ( Required ) `value`: `CFValue` ( Required )

CustomFieldsRecord type


object with fields: `id`: `string` ( Required ) `values`: array of `CustomFieldValue` ( Required )

DR_Draft type

object with fields:

id: string ( Required )
title: string ( Required )
modified: string (format: date-time) ( Required )
created: string (format: date-time) ( Nullable and Optional , defaults to null)
modifiedBy: CPrincipal ( Nullable and Optional , defaults to null)
shared: boolean ( Required )
deleted: boolean ( Nullable and Optional , defaults to null)
publicationDetails2: PublicationDetails ( Nullable and Optional , defaults to null)
author: TD_MemberProfile ( Nullable and Optional , defaults to null)
publishedFlag: boolean ( Required )
published: boolean ( Nullable and Optional , defaults to null)
folder: DocumentFolderRecord ( Nullable and Optional , defaults to null)
accessOrdinal: integer (format: int32) ( Required )
editors: array of TD_MemberProfile ( Required )
editorsTeams: array of TD_Team ( Required )
document: TextDocument ( Required )

DR_DraftHeader type

object with fields:

id: string ( Required )
title: string ( Required )
author: TD_MemberProfile ( Required )
modified: string (format: date-time) ( Required )
created: string (format: date-time) ( Nullable and Optional , defaults to null)
modifiedBy: CPrincipal ( Nullable and Optional , defaults to null)
shared: boolean ( Required )
publicationDetails2: PublicationDetails ( Nullable and Optional , defaults to null)
deleted: boolean ( Nullable and Optional , defaults to null)
folder: DocumentFolderRecord ( Nullable and Optional , defaults to null)

DTO_FullRightWithoutType type


object with fields: `code`: `string` ( Required ) `title`: `string` ( Required ) `description`: `string` ( Nullable and Optional , defaults to `null`) `grantedForUsers`: `boolean` ( Required ) `featureFlag`: `FeatureFlag` ( Nullable and Optional , defaults to `null`)

DTO_Meeting type

object with fields:

id: string ( Required )
archived: boolean ( Required )
summary: string ( Required )
description: string ( Nullable and Optional , defaults to null)
locations: array of TD_Location ( Required )
profiles: array of TD_MemberProfile ( Required )
teams: array of TD_Team ( Required )
occurrenceRule: CalendarEventSpec ( Required )
origin: MeetingOrigin ( Required )
conferenceLink: string ( Nullable and Optional , defaults to null)
visibility: MeetingVisibility ( Required )
modificationPreference: MeetingModificationPreference ( Required )
joiningPreference: MeetingJoiningPreference ( Nullable and Optional , defaults to null)
organizer: MeetingOrganizer ( Nullable and Optional , defaults to null)
etag: integer (format: int64) ( Required )
privateDataSubstituted: boolean ( Required )
canModify: boolean ( Required )
canDelete: boolean ( Required )
canJoin: boolean ( Required )
externalParticipants: array of string ( Required )
linkToExternalSource: string ( Nullable and Optional , defaults to null)
eventAttachments: array of MeetingAttachment ( Nullable and Optional , defaults to null)

DTO_Right type


object with fields: `typeCode`: `string` ( Required ) `code`: `string` ( Required )

DTO_RightType type


object with fields: `typeCode`: `string` ( Required ) `title`: `string` ( Required )

DTO_RightType_Right type


object with fields: `rightType`: `DTO_RightType` ( Required ) `rights`: array of `DTO_FullRightWithoutType` ( Required )

DTO_RightsDeps type


object with fields: `code`: `string` ( Required ) `deps`: array of `string` ( Required )

DTO_RightsGroup type


object with fields: `title`: `string` ( Required ) `priority`: `integer` (format: int32) ( Required ) `rights`: array of `DTO_Right` ( Required )

DTO_RightsWithHierarchy type


object with fields: `rights`: array of `DTO_RightType_Right` ( Required ) `rightsGroups`: array of `DTO_RightsGroup` ( Required ) `deps`: array of `DTO_RightsDeps` ( Required )

DateCFConstraint type


object with fields: `min`: `string` (format: full-date) ( Nullable and Optional , defaults to `null`) `max`: `string` (format: full-date) ( Nullable and Optional , defaults to `null`) `message`: `string` ( Nullable and Optional , defaults to `null`)

DateCFType type


No properties

DateCFValue type


object with fields: `value`: `string` (format: full-date) ( Nullable and Optional , defaults to `null`)

DateTimeViewParams type


object with fields: `format`: `UnfurlDateTimeFormat` ( Nullable and Optional , defaults to `null`) `style`: `UnfurlDateTimeStyle` ( Nullable and Optional , defaults to `null`) `template`: `string` ( Nullable and Optional , defaults to `null`)

DeleteMessage type


object with fields: `id`: `string` ( Required )

DeletedAttachment type


object with fields: `deletedIdentity`: `string` ( Required )

Diff type


object with fields: `added`: array of `string` ( Required ) `removed`: array of `string` ( Required ) `removeAll`: `boolean` ( Required )

DiffContext type


object with fields: `left`: `DiffSide` ( Nullable and Optional , defaults to `null`) `right`: `DiffSide` ( Required )

DiffSide type

Name Type

className

string

Possible values:

DiffSide.Empty
DiffSide.NonEmpty

DiffSide.Empty type


object with fields: `revision`: `string` ( Required )

DiffSide.NonEmpty type


object with fields: `revision`: `string` ( Required ) `path`: `string` ( Required )

DocumentFolderPublicationItem type


object with fields: `folderId`: `string` ( Required )

DocumentFolderRecord type

object with fields:

id: string ( Required )
archived: boolean ( Required )
name: string ( Required )
parent: DocumentFolderRecord ( Nullable and Optional , defaults to null)
subfolders: array of DocumentFolderRecord ( Required )
documents: array of DR_DraftHeader ( Required )
owner: TD_MemberProfile ( Required )
alias: string ( Required )
created: string (format: date-time) ( Nullable and Optional , defaults to null)
createdBy: CPrincipal ( Nullable and Optional , defaults to null)
updated: string (format: date-time) ( Nullable and Optional , defaults to null)
updatedBy: CPrincipal ( Nullable and Optional , defaults to null)

DocumentPublicationItem type


object with fields: `documentId`: `string` ( Required ) `documentType`: `DraftDocumentType` ( Required )

ES_App type

object with fields:

id: string ( Required )
owner: TD_MemberProfile ( Nullable and Optional , defaults to null)
clientId: string ( Required )
name: string ( Required )
clientCredentialsFlowEnabled: boolean ( Required )
codeFlowEnabled: boolean ( Required )
codeFlowRedirectURIs: string ( Nullable and Optional , defaults to null)
implicitFlowEnabled: boolean ( Required )
implicitFlowRedirectURIs: string ( Nullable and Optional , defaults to null)
endpointURI: string ( Nullable and Optional , defaults to null)
hasVerificationToken: boolean ( Required )
hasSigningKey: boolean ( Required )
archived: boolean ( Required )
lastClientCredentialsAccess: AccessRecord ( Nullable and Optional , defaults to null)

ES_ApplicationPassword type


object with fields: `id`: `string` ( Required ) `profile`: `TD_MemberProfile` ( Required ) `name`: `string` ( Required ) `scope`: `string` ( Required ) `created`: `string` (format: date-time) ( Required ) `lastAccess`: `AccessRecord` ( Nullable and Optional , defaults to `null`)

ES_ApprovedScope type


object with fields: `id`: `string` ( Required ) `scope`: `string` ( Required ) `offlineAllowed`: `boolean` ( Required )

ES_AuthModule type


object with fields: `id`: `string` ( Required ) `key`: `string` ( Required ) `name`: `string` ( Required ) `ordinal`: `integer` (format: int32) ( Required ) `enabled`: `boolean` ( Required ) `iconDataURI`: `string` ( Nullable and Optional , defaults to `null`) `settings`: `ES_AuthModuleSettings` ( Required )

ES_AuthModuleSettings type

Name Type

className

string

Possible values:

ES_SamlAuthModuleSettings
ES_AzureAuthModuleSettings
ES_GoogleAuthModuleSettings
ES_GithubAuthModuleSettings
ES_HubAuthModuleSettings
ES_OIDCAuthModuleSettings
ES_BuiltinAuthModuleSettings
ES_LdapAuthModuleSettings
ES_HiddenAuthModuleSettings

ES_AuthenticationSession type


object with fields: `id`: `string` ( Required ) `profile`: `TD_MemberProfile` ( Required ) `created`: `string` (format: date-time) ( Required ) `expires`: `string` (format: date-time) ( Required ) `lastAccess`: `AccessRecord` ( Nullable and Optional , defaults to `null`) `current`: `boolean` ( Required )

ES_AzureAuthModuleSettings type


object with fields: `tenantId`: `string` ( Required ) `clientId`: `string` ( Required ) `clientSecret`: `string` ( Required ) `registerNewUsers`: `boolean` ( Required ) `emailVerified`: `boolean` ( Required )

ES_BuiltinAuthModuleSettings type


object with fields: `passwordStrengthPolicy`: `PasswordStrength` ( Required ) `domains`: array of `string` ( Nullable and Optional , defaults to `null`)

ES_BuiltinProfileLoginDetails type


object with fields: `passwordChangeRequest`: `string` ( Nullable and Optional , defaults to `null`)

ES_ContainerRegistrySettings type


object with fields: `immutableTags`: `boolean` ( Required )

ES_DefaultProfileLoginDetails type

object with fields:

login: string ( Nullable and Optional , defaults to null)
firstName: string ( Nullable and Optional , defaults to null)
lastName: string ( Nullable and Optional , defaults to null)
email: string ( Nullable and Optional , defaults to null)
emailVerified: boolean ( Required )
avatarUrl: string ( Nullable and Optional , defaults to null)

ES_ExternalPasswordAuthModuleSettings type

Name Type

className

string

Possible values:

ES_LdapAuthModuleSettings

ES_FederatedAuthModuleSettings type

Name Type

className

string

Possible values:

ES_SamlAuthModuleSettings
ES_AzureAuthModuleSettings
ES_GoogleAuthModuleSettings
ES_GithubAuthModuleSettings
ES_HubAuthModuleSettings
ES_OIDCAuthModuleSettings

ES_GithubAuthModuleSettings type


object with fields: `githubUrl`: `string` ( Required ) `clientId`: `string` ( Required ) `clientSecret`: `string` ( Required ) `registerNewUsers`: `boolean` ( Required ) `organizations`: array of `string` ( Required )

ES_GithubProfileLoginDetails type

object with fields:

login: string ( Nullable and Optional , defaults to null)
firstName: string ( Nullable and Optional , defaults to null)
lastName: string ( Nullable and Optional , defaults to null)
email: string ( Nullable and Optional , defaults to null)
emailVerified: boolean ( Required )
avatarUrl: string ( Nullable and Optional , defaults to null)
organizations: array of string ( Nullable and Optional , defaults to null)

ES_GoogleAuthModuleSettings type


object with fields: `clientId`: `string` ( Required ) `clientSecret`: `string` ( Required ) `registerNewUsers`: `boolean` ( Required ) `domains`: array of `string` ( Required )

ES_HiddenAuthModuleSettings type


object with fields: `passwordModule`: `boolean` ( Nullable and Optional , defaults to `null`) `federatedModule`: `boolean` ( Nullable and Optional , defaults to `null`)

ES_HubAuthModuleSettings type


object with fields: `hubUrl`: `string` ( Required ) `clientId`: `string` ( Required ) `clientSecret`: `string` ( Required ) `registerNewUsers`: `boolean` ( Nullable and Optional , defaults to `null`) `orgAuthProviderName`: `string` ( Nullable and Optional , defaults to `null`) `groups`: array of `string` ( Nullable and Optional , defaults to `null`)

ES_HubProfileLoginDetails type

object with fields:

login: string ( Nullable and Optional , defaults to null)
hubAuthModuleLogin: string ( Nullable and Optional , defaults to null)
firstName: string ( Nullable and Optional , defaults to null)
lastName: string ( Nullable and Optional , defaults to null)
email: string ( Nullable and Optional , defaults to null)
emailVerified: boolean ( Required )
avatarUrl: string ( Nullable and Optional , defaults to null)

ES_LdapAttributeNames type


object with fields: `fullNameAttributeName`: `string` ( Nullable and Optional , defaults to `null`) `usernameAttributeName`: `string` ( Nullable and Optional , defaults to `null`) `emailAttributeName`: `string` ( Nullable and Optional , defaults to `null`) `groupsAttributeName`: `string` ( Nullable and Optional , defaults to `null`)

ES_LdapAuthModuleSettings type

object with fields:

type: LdapModuleType ( Required )
registerNewUsers: boolean ( Required )
serverUrl: string ( Required )
connectionTimeout: integer (format: int32) ( Required )
readTimeout: integer (format: int32) ( Required )
sslKeystore: SSLKeystore ( Nullable and Optional , defaults to null)
teamMappings: array of ES_TeamMapping ( Required )
referralIgnored: boolean ( Required )
filter: string ( Required )
bindUserDN: string ( Required )
bindUserPassword: string ( Required )
attributeNames: ES_LdapAttributeNames ( Required )

ES_MavenRepositorySettings type


object with fields: `enableSnapshots`: `boolean` ( Required )

ES_NpmRegistrySettings type


No properties

ES_NuGetFeedSettings type


No properties

ES_OAuth2AuthModuleSettings type

Name Type

className

string

Possible values:

ES_AzureAuthModuleSettings
ES_GoogleAuthModuleSettings
ES_GithubAuthModuleSettings
ES_HubAuthModuleSettings
ES_OIDCAuthModuleSettings

ES_OAuthConsent type


object with fields: `clientService`: `ES_Service` ( Required ) `approvedScopes`: array of `ES_ApprovedScope` ( Required ) `refreshTokens`: array of `ES_RefreshToken` ( Required )

ES_OIDCAuthModuleSettings type

object with fields:

clientId: string ( Required )
clientSecret: string ( Required )
registerNewUsers: boolean ( Required )
discoveryUrl: string ( Nullable and Optional , defaults to null)
issuer: string ( Required )
authorizationEndpoint: string ( Required )
tokenEndpoint: string ( Required )
tokenKeysEndpoint: string ( Required )
userInfoEndpoint: string ( Required )
domains: array of string ( Required )

ES_PackageRepositorySettings type

Name Type

className

string

Possible values:

ES_ContainerRegistrySettings
ES_MavenRepositorySettings
ES_NpmRegistrySettings
ES_NuGetFeedSettings

ES_PasswordAuthModuleSettings type

Name Type

className

string

Possible values:

ES_BuiltinAuthModuleSettings
ES_LdapAuthModuleSettings

ES_PermanentToken type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Required ) `profile`: `TD_MemberProfile` ( Required ) `scope`: `string` ( Required ) `created`: `string` (format: date-time) ( Required ) `lastAccess`: `AccessRecord` ( Nullable and Optional , defaults to `null`)

ES_ProfileLogin type


object with fields: `identifier`: `string` ( Required ) `authModule`: `ES_AuthModule` ( Required ) `details`: `ES_ProfileLoginDetails` ( Required ) `access`: `AccessRecord` ( Nullable and Optional , defaults to `null`)

ES_ProfileLoginDetails type

Name Type

className

string

Possible values:

ES_HubProfileLoginDetails
ES_GithubProfileLoginDetails
ES_BuiltinProfileLoginDetails
ES_DefaultProfileLoginDetails

ES_RefreshToken type


object with fields: `id`: `string` ( Required ) `scope`: `string` ( Required ) `lastAccess`: `AccessRecord` ( Nullable and Optional , defaults to `null`)

ES_SamlAttributeNames type

object with fields:

loginAttributeName: string ( Nullable and Optional , defaults to null)
firstNameAttributeName: string ( Nullable and Optional , defaults to null)
lastNameAttributeName: string ( Nullable and Optional , defaults to null)
fullNameAttributeName: string ( Nullable and Optional , defaults to null)
emailAttributeName: string ( Nullable and Optional , defaults to null)
emailVerified: boolean ( Required )

ES_SamlAuthModuleSettings type

object with fields:

idpUrl: string ( Required )
idpEntityId: string ( Required )
idpCertificateSHA256: string ( Required )
spEntityId: string ( Required )
sslKeystore: SSLKeystore ( Nullable and Optional , defaults to null)
registerNewUsers: boolean ( Required )
contactProfileId: string ( Nullable and Optional , defaults to null)
attributeNames: ES_SamlAttributeNames ( Required )

ES_Service type

object with fields:

id: string ( Required )
owner: TD_MemberProfile ( Nullable and Optional , defaults to null)
type: OAuthServiceType ( Required )
clientId: string ( Required )
name: string ( Required )
redirectURIs: string ( Required )
archived: boolean ( Required )
lastClientCredentialsAccess: AccessRecord ( Nullable and Optional , defaults to null)
endpointURI: string ( Nullable and Optional , defaults to null)
hasVerificationToken: boolean ( Nullable and Optional , defaults to null)
hasSigningKey: boolean ( Nullable and Optional , defaults to null)

ES_SshKey type


object with fields: `fingerprint`: `string` ( Required ) `comment`: `string` ( Required ) `createdAt`: `string` (format: date-time) ( Required ) `lastUsedAt`: `string` (format: date-time) ( Nullable and Optional , defaults to `null`)

ES_TeamMapping type


object with fields: `teamId`: `string` ( Required ) `externalGroupName`: `string` ( Required )

EditMessage type


object with fields: `text`: `string` ( Required ) `id`: `string` ( Required ) `attachments`: array of `Attachment` ( Nullable and Optional , defaults to `null`)

EmojiReactionRecord type


object with fields: `id`: `string` ( Required ) `itemId`: `string` ( Required ) `emoji`: `string` ( Required ) `count`: `integer` (format: int32) ( Required ) `meReacted`: `boolean` ( Required ) `order`: `integer` (format: int64) ( Required )

EmojiSearchMatchData type


object with fields: `emoji`: `string` ( Required ) `matched`: `string` ( Nullable and Optional , defaults to `null`) `matchType`: `EmojiSearchMatchType` ( Required )

EntityHit type


object with fields: `score`: `number` (format: double) ( Required ) `title`: `string` ( Required ) `snippets`: array of `MatchSnippet` ( Required ) `details`: `EntityHitDetails` ( Required )

EntityHitDetails type

Name Type

className

string

Possible values:

MessageHitDetails
ProfileHitDetails
BookHitDetails
KbArticleHitDetails
FolderHitDetails
ProjectHitDetails
TeamHitDetails
ArticleHitDetails

EntityType type


object with fields: `key`: `string` ( Required ) `displayName`: `string` ( Nullable and Optional , defaults to `null`) `groupKey`: `string` ( Required ) `groupName`: `string` ( Nullable and Optional , defaults to `null`)

EnumCFType type


object with fields: `values`: array of `EnumValueData` ( Required )

EnumCFValue type


object with fields: `value`: `EnumValueData` ( Nullable and Optional , defaults to `null`)

EnumListCFType type


object with fields: `values`: array of `EnumValueData` ( Required )

EnumListCFValue type


object with fields: `values`: array of `EnumValueData` ( Required )

EnumValueData type


object with fields: `id`: `string` ( Nullable and Optional , defaults to `null`) `value`: `string` ( Required ) `principal`: `CPrincipalDetails` ( Nullable and Optional , defaults to `null`)

EstimationDTO type


object with fields: `start`: `string` (format: date-time) ( Required ) `predictedDuration`: `integer` (format: int64) ( Required )

ExtendedType type


object with fields: `key`: `string` ( Required ) `displayName`: `string` ( Required ) `apiClassName`: `string` ( Nullable and Optional , defaults to `null`) `scopeType`: `ExtendedTypeScopeType` ( Required )

ExternalArticle type

object with fields:

title: string ( Required )
content: string ( Required )
authorId: string ( Required )
created: string (format: date-time) ( Required )
teams: array of string ( Nullable and Optional , defaults to null)
locations: array of string ( Nullable and Optional , defaults to null)
externalId: string ( Nullable and Optional , defaults to null)
externalUrl: string ( Nullable and Optional , defaults to null)

ExternalCheckDTO type

object with fields:

repository: string ( Required )
revision: string ( Required )
executionStatus: CommitExecutionStatus ( Required )
url: string ( Required )
externalServiceName: string ( Required )
taskName: string ( Required )
taskId: string ( Required )
timestamp: integer (format: int64) ( Required )
description: string ( Nullable and Optional , defaults to null)

ExternalEntityInfoRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `externalId`: `string` ( Nullable and Optional , defaults to `null`) `externalName`: `string` ( Nullable and Optional , defaults to `null`) `externalUrl`: `string` ( Nullable and Optional , defaults to `null`) `transaction`: `ImportTransactionRecord` ( Required )

ExternalIssue type

object with fields:

summary: string ( Required )
description: string ( Nullable and Optional , defaults to null)
status: string ( Required )
assignee: string ( Nullable and Optional , defaults to null)
externalId: string ( Required )
externalName: string ( Nullable and Optional , defaults to null)
externalUrl: string ( Nullable and Optional , defaults to null)

FailureConditionDTO type

Name Type

className

string

Possible values:

NonZeroExitCodeDTO
TestFailedDTO
OutOfMemoryDTO
TimeOutDTO

FeatureFlag type


object with fields: `name`: `string` ( Required ) `description`: `string` ( Required ) `status`: `FeatureFlagStatus` ( Required ) `owner`: `string` ( Required ) `introduced`: `string` (format: full-date) ( Nullable and Optional , defaults to `null`)

FeedEvent type

Name Type

className

string

Possible values:

MergeRequestBranchRestoredEvent
CodeDiscussionAddedFeedEvent
ReviewTitleChangedEvent
ReviewerChangedEvent
MergeRequestMergedEvent
MergeRequestBranchDeletedEvent
ReviewStateChangedEvent
ReviewBranchTrackEvent
ReviewCompletionStateChangedEvent
CodeReviewDiscussionAddedFeedEvent
ReviewRevisionsChangedEvent

FileAttachment type


object with fields: `id`: `string` ( Required ) `sizeBytes`: `integer` (format: int64) ( Required ) `filename`: `string` ( Required )

Fingerprint type


object with fields: `md5`: `string` ( Required ) `sha1`: `string` ( Required ) `sha256`: `string` ( Required ) `sha384`: `string` ( Required ) `sha512`: `string` ( Required )

FolderHitDetails type


object with fields: `ref`: `KB_Folder` ( Required ) `bookRef`: `KB_Book` ( Required ) `projectRef`: `PR_Project` ( Nullable and Optional , defaults to `null`) `authorRef`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`)

FolderPublicationItem type

Name Type

className

string

Possible values:

DocumentFolderPublicationItem

GitAuthorInfo type


object with fields: `name`: `string` ( Required ) `email`: `string` ( Required )

GitCommitInfo type

object with fields:

id: string ( Required )
message: string ( Required )
authorDate: integer (format: int64) ( Required )
commitDate: integer (format: int64) ( Required )
author: GitAuthorInfo ( Required )
committer: GitAuthorInfo ( Required )
authorProfile: TD_MemberProfile ( Nullable and Optional , defaults to null)
parents: array of string ( Required )
heads: array of string ( Required )

GitCommitWithGraph type


object with fields: `repositoryName`: `string` ( Required ) `commit`: `GitCommitInfo` ( Required ) `reviews`: array of `CodeReviewRecord` ( Required ) `layout`: `GitGraphLayoutLine` ( Nullable and Optional , defaults to `null`) `unreachable`: `boolean` ( Required )

GitCommitterProfile type


object with fields: `author`: `string` ( Required ) `email`: `string` ( Required ) `profile`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`)

GitGraphLayoutEdge type


object with fields: `from`: `integer` (format: int32) ( Required ) `to`: `integer` (format: int32) ( Required ) `type`: `GitGraphEdgeType` ( Required ) `style`: `GitGraphEdgeLineStyle` ( Required ) `hasArrow`: `boolean` ( Required ) `color`: `integer` (format: int32) ( Required )

GitGraphLayoutLine type


object with fields: `nodes`: array of `GitGraphLayoutNode` ( Required ) `edges`: array of `GitGraphLayoutEdge` ( Required )

GitGraphLayoutNode type


object with fields: `pos`: `integer` (format: int32) ( Required ) `color`: `integer` (format: int32) ( Required )

GlobalPermissionTarget type


No properties

HA_DefaultValue type

Name Type

className

string

Possible values:

HA_DefaultValue.Const.Primitive
HA_DefaultValue.Const.EnumEntry
HA_DefaultValue.Collection
HA_DefaultValue.Map
HA_DefaultValue.Reference

HA_DefaultValue.Collection type


object with fields: `elements`: array of `HA_DefaultValue` ( Required )

HA_DefaultValue.Const type

Name Type

className

string

Possible values:

HA_DefaultValue.Const.Primitive
HA_DefaultValue.Const.EnumEntry

HA_DefaultValue.Const.EnumEntry type


object with fields: `entryName`: `string` ( Required )

HA_DefaultValue.Const.Primitive type


object with fields: `expression`: `string` ( Required )

HA_DefaultValue.Map type


object with fields: `elements`: key-value object of string keys and values of `HA_DefaultValue` ( Required )

HA_DefaultValue.Reference type


object with fields: `paramName`: `string` ( Required )

HA_Deprecation type


object with fields: `message`: `string` ( Required ) `since`: `string` ( Required ) `forRemoval`: `boolean` ( Required )

HA_Dto type

object with fields:

id: string ( Required )
name: string ( Required )
fields: array of HA_DtoField ( Required )
hierarchyRole: HierarchyRole ( Required )
extends: HA_Dto ( Nullable and Optional , defaults to null)
implements: array of HA_Dto ( Required )
inheritors: array of HA_Dto ( Required )
deprecation: HA_Deprecation ( Nullable and Optional , defaults to null)
record: boolean ( Required )

HA_DtoField type


object with fields: `field`: `HA_Field` ( Required ) `extension`: `boolean` ( Required )

HA_Endpoint type

object with fields:

resource: HA_Resource ( Required )
method: HA_Method ( Required )
parameters: array of HA_Parameter ( Required )
requestBody: HA_Type.Object ( Nullable and Optional , defaults to null)
responseBody: HA_Type ( Nullable and Optional , defaults to null)
path: HA_Path ( Required )
displayName: string ( Required )
functionName: string ( Required )
doc: string ( Nullable and Optional , defaults to null)
deprecation: HA_Deprecation ( Nullable and Optional , defaults to null)
rights: array of HA_Right ( Nullable and Optional , defaults to null)

HA_Enum type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Required ) `values`: array of `string` ( Required ) `deprecation`: `HA_Deprecation` ( Nullable and Optional , defaults to `null`)

HA_Field type


object with fields: `name`: `string` ( Required ) `type`: `HA_Type` ( Required ) `defaultValue`: `HA_DefaultValue` ( Nullable and Optional , defaults to `null`) `optional`: `boolean` ( Required ) `deprecation`: `HA_Deprecation` ( Nullable and Optional , defaults to `null`)

HA_MenuId type


object with fields: `menuId`: `string` ( Required ) `context`: `HA_Dto` ( Required )

HA_Model type


object with fields: `dto`: array of `HA_Dto` ( Required ) `enums`: array of `HA_Enum` ( Required ) `urlParams`: array of `HA_UrlParameter` ( Required ) `resources`: array of `HA_Resource` ( Required ) `allResources`: array of `HA_Resource` ( Required ) `menuIds`: array of `HA_MenuId` ( Required )

HA_Parameter type


object with fields: `field`: `HA_Field` ( Required ) `path`: `boolean` ( Required )

HA_Path type


object with fields: `segments`: array of `HA_PathSegment` ( Required )

HA_PathSegment type

Name Type

className

string

Possible values:

HA_PathSegment.Var
HA_PathSegment.PrefixedVar
HA_PathSegment.Const

HA_PathSegment.Const type


object with fields: `value`: `string` ( Required )

HA_PathSegment.PrefixedVar type


object with fields: `prefix`: `string` ( Required ) `name`: `string` ( Required )

HA_PathSegment.Var type


object with fields: `name`: `string` ( Required )

HA_Resource type


object with fields: `id`: `string` ( Required ) `path`: `HA_Path` ( Required ) `displaySingular`: `string` ( Required ) `displayPlural`: `string` ( Required ) `parentResource`: `HA_Resource` ( Nullable and Optional , defaults to `null`) `endpoints`: array of `HA_Endpoint` ( Required ) `nestedResources`: array of `HA_Resource` ( Required )

HA_Right type


object with fields: `title`: `string` ( Required ) `description`: `string` ( Nullable and Optional , defaults to `null`)

HA_Type type

Name Type

className

string

Possible values:

HA_Type.Primitive
HA_Type.Array
HA_Type.Map
HA_Type.Object
HA_Type.Dto
HA_Type.Ref
HA_Type.Enum
HA_Type.UrlParam

HA_Type.Array type


object with fields: `elementType`: `HA_Type` ( Required ) `nullable`: `boolean` ( Required )

HA_Type.Dto type


object with fields: `dto`: `HA_Dto` ( Required ) `nullable`: `boolean` ( Required )

HA_Type.Enum type


object with fields: `enum`: `HA_Enum` ( Required ) `nullable`: `boolean` ( Required )

HA_Type.Map type


object with fields: `valueType`: `HA_Type` ( Required ) `nullable`: `boolean` ( Required )

HA_Type.Object type


object with fields: `fields`: array of `HA_Field` ( Required ) `kind`: `HA_Type.Object.Kind` ( Required ) `nullable`: `boolean` ( Required )

HA_Type.Primitive type


object with fields: `primitive`: `HA_Primitive` ( Required ) `nullable`: `boolean` ( Required )

HA_Type.Ref type


object with fields: `dto`: `HA_Dto` ( Required ) `nullable`: `boolean` ( Required )

HA_Type.UrlParam type


object with fields: `urlParam`: `HA_UrlParameter` ( Required ) `nullable`: `boolean` ( Required )

HA_UrlParameter type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Required ) `options`: array of `HA_UrlParameterOption` ( Required ) `deprecation`: `HA_Deprecation` ( Nullable and Optional , defaults to `null`)

HA_UrlParameterOption type

Name Type

className

string

Possible values:

HA_UrlParameterOption.Const
HA_UrlParameterOption.Var

HA_UrlParameterOption.Const type


object with fields: `value`: `string` ( Required ) `optionName`: `string` ( Required ) `deprecation`: `HA_Deprecation` ( Nullable and Optional , defaults to `null`)

HA_UrlParameterOption.Var type


object with fields: `parameter`: `HA_Field` ( Required ) `prefixRequired`: `boolean` ( Required ) `optionName`: `string` ( Required ) `deprecation`: `HA_Deprecation` ( Nullable and Optional , defaults to `null`)

HolidaysEvent type


object with fields: `profile`: `TD_MemberProfile` ( Required ) `holidays`: array of `PublicHoliday` ( Required )

ImageAttachment type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Nullable and Optional , defaults to `null`) `width`: `integer` (format: int32) ( Required ) `height`: `integer` (format: int32) ( Required ) `previewBytes`: `string` ( Nullable and Optional , defaults to `null`) `variants`: array of `ImageAttachmentVariant` ( Nullable and Optional , defaults to `null`)

ImageAttachmentMeta type


object with fields: `variants`: array of `ImageAttachmentVariantsMeta` ( Required )

ImageAttachmentVariant type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Nullable and Optional , defaults to `null`) `width`: `integer` (format: int32) ( Required ) `height`: `integer` (format: int32) ( Required )

ImageAttachmentVariantsMeta type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Required ) `width`: `integer` (format: int32) ( Required ) `height`: `integer` (format: int32) ( Required )

ImportMetadata type


object with fields: `importSource`: `string` ( Required )

ImportSource type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `importer`: `CPrincipal` ( Required ) `name`: `string` ( Required )

ImportTransactionRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `importer`: `CPrincipal` ( Required ) `externalSource`: `string` ( Required ) `imported`: `string` (format: date-time) ( Required )

ImportedEntityInfo type


object with fields: `source`: `ImportSource` ( Required ) `externalName`: `string` ( Nullable and Optional , defaults to `null`) `externalUrl`: `string` ( Nullable and Optional , defaults to `null`)

InlineDiffLine type

object with fields:

text: string ( Required )
type: DiffLineType ( Nullable and Optional , defaults to null)
oldLineNum: integer (format: int32) ( Nullable and Optional , defaults to null)
newLineNum: integer (format: int32) ( Nullable and Optional , defaults to null)
oldFileOffset: integer (format: int32) ( Required )
newFileOffset: integer (format: int32) ( Required )
syntax: array of SyntaxMarkup ( Nullable and Optional , defaults to null)
deletes: array of TextRange ( Nullable and Optional , defaults to null)
inserts: array of TextRange ( Nullable and Optional , defaults to null)

IntCFConstraint type


object with fields: `min`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`) `max`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`) `message`: `string` ( Nullable and Optional , defaults to `null`)

IntCFType type


No properties

IntCFValue type


object with fields: `value`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`)

IntListCFType type


No properties

IntListCFValue type


object with fields: `values`: array of `integer` (format: int32) ( Required )

Invitation type

object with fields:

id: string ( Required )
expiresAt: string (format: date-time) ( Required )
inviteeEmail: string ( Required )
inviteeEmailBlocked: boolean ( Required )
inviteeEmailBlockedReason: string ( Nullable and Optional , defaults to null)
inviteeFirstName: string ( Nullable and Optional , defaults to null)
inviteeLastName: string ( Nullable and Optional , defaults to null)
invitee: TD_MemberProfile ( Nullable and Optional , defaults to null)
inviter: CPrincipal ( Required )
team: TD_Team ( Nullable and Optional , defaults to null)
role: TD_Role ( Nullable and Optional , defaults to null)
revoked: boolean ( Nullable and Optional , defaults to null)

InvitationLink type

object with fields:

id: string ( Required )
name: string ( Required )
createdBy: CPrincipal ( Required )
createdAt: string (format: date-time) ( Required )
expiresAt: string (format: date-time) ( Nullable and Optional , defaults to null)
inviteeLimit: integer (format: int32) ( Required )
inviteeUsage: integer (format: int32) ( Required )
deleted: boolean ( Required )

Issue type

object with fields:

id: string ( Required )
archived: boolean ( Required )
projectId: string ( Required )
projectRef: PR_Project ( Nullable and Optional , defaults to null)
trackerRef: IssueTracker ( Nullable and Optional , defaults to null)
number: integer (format: int32) ( Required )
createdBy: CPrincipal ( Required )
creationTime: string (format: date-time) ( Required )
assignee: TD_MemberProfile ( Nullable and Optional , defaults to null)
status: IssueStatus ( Required )
dueDate: string (format: full-date) ( Nullable and Optional , defaults to null)
importInfo: ImportedEntityInfo ( Nullable and Optional , defaults to null)
externalEntityInfo: ExternalEntityInfoRecord ( Nullable and Optional , defaults to null)
tags: array of PlanningTag ( Required )
title: string ( Required )
sprints: array of SprintRecord ( Required )
description: string ( Nullable and Optional , defaults to null)
channel: M2ChannelRecord ( Required )
attachments: array of AttachmentInfo ( Required )
checklists: array of Checklist ( Required )

IssueAssigneeChangedDetails type


object with fields: `oldAssignee`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`) `newAssignee`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`)

IssueAttachmentsChangedDetails type


object with fields: `addedNames`: array of `string` ( Nullable and Optional , defaults to `null`) `removedNames`: array of `string` ( Nullable and Optional , defaults to `null`)

IssueChangedM2Details type

Name Type

className

string

Possible values:

IssueTitleChangedDetails
IssueMCExtension
IssueStatusChangedDetails
IssueChecklistsChangedDetails
IssueDueDateChangedDetails
IssueAttachmentsChangedDetails
IssueCreatedDetails
IssueDeletedDetails
IssueDescriptionChangedDetails
IssueAssigneeChangedDetails
IssueTagsChangedDetails

IssueChecklistsChangedDetails type


object with fields: `addedChecklists`: array of `Checklist` ( Nullable and Optional , defaults to `null`) `removedChecklists`: array of `Checklist` ( Nullable and Optional , defaults to `null`)

IssueCreatedDetails type


object with fields: `issue`: `Issue` ( Nullable and Optional , defaults to `null`) `originMessage`: `MessageLink` ( Nullable and Optional , defaults to `null`)

IssueDeletedDetails type


No properties

IssueDescriptionChangedDetails type


object with fields: `oldDescription`: `string` ( Nullable and Optional , defaults to `null`) `newDescription`: `string` ( Nullable and Optional , defaults to `null`)

IssueDueDateChangedDetails type


object with fields: `oldDueDate`: `string` (format: full-date) ( Nullable and Optional , defaults to `null`) `newDueDate`: `string` (format: full-date) ( Nullable and Optional , defaults to `null`)

IssueImportResult type

object with fields:

message: string ( Required )
created: array of IssueImportResultItem ( Nullable and Optional , defaults to null)
updated: array of IssueImportResultItem ( Nullable and Optional , defaults to null)
skipped: array of IssueImportResultItem ( Nullable and Optional , defaults to null)
missingAttributes: array of string ( Nullable and Optional , defaults to null)

IssueImportResultItem type


object with fields: `externalId`: `string` ( Nullable and Optional , defaults to `null`) `issue`: `Issue` ( Nullable and Optional , defaults to `null`) `error`: `string` ( Nullable and Optional , defaults to `null`)

IssueMCExtension type


No properties

IssueStatus type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `name`: `string` ( Required ) `resolved`: `boolean` ( Required ) `color`: `string` ( Required )

IssueStatusChangedDetails type


object with fields: `oldStatus`: `IssueStatus` ( Required ) `newStatus`: `IssueStatus` ( Required )

IssueStatusData type


object with fields: `existingId`: `string` ( Nullable and Optional , defaults to `null`) `name`: `string` ( Required ) `resolved`: `boolean` ( Required ) `color`: `string` ( Required ) `originalStatus`: `IssueStatus` ( Nullable and Optional , defaults to `null`)

IssueStatusWithUsages type


object with fields: `status`: `IssueStatus` ( Required ) `usages`: `integer` (format: int32) ( Required )

IssueTagsChangedDetails type


object with fields: `addedTags`: array of `PlanningTag` ( Nullable and Optional , defaults to `null`) `removedTags`: array of `PlanningTag` ( Nullable and Optional , defaults to `null`)

IssueTitleChangedDetails type


object with fields: `oldTitle`: `string` ( Required ) `newTitle`: `string` ( Required )

IssueTracker type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `name`: `string` ( Required )

JobDTO type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Required ) `repoName`: `string` ( Required ) `archive`: `boolean` ( Required )

JobExecutionDTO type

object with fields:

executionId: string ( Required )
executionNumber: integer (format: int64) ( Required )
jobId: string ( Required )
jobName: string ( Required )
branch: string ( Required )
status: ExecutionStatus ( Required )
triggeredTime: integer (format: int64) ( Required )
startedTime: integer (format: int64) ( Nullable and Optional , defaults to null)
finishedTime: integer (format: int64) ( Nullable and Optional , defaults to null)
changesFromExclude: string ( Required )
changesCount: integer (format: int32) ( Required )
predictedEndTime: EstimationDTO ( Nullable and Optional , defaults to null)
failureConditions: array of FailureConditionDTO ( Required )

JobSubscription type


object with fields: `id`: `string` ( Required ) `jobId`: `string` ( Required ) `project`: `PR_Project` ( Required ) `state`: `JobSubscriptionState` ( Required ) `archived`: `boolean` ( Required )

JobSubscriptionState type


object with fields: `type`: `JobSubscriptionType` ( Required ) `containsMyCommit`: `boolean` ( Required ) `runByMe`: `boolean` ( Required )

KB_Article type

object with fields:

id: string ( Required )
archived: boolean ( Required )
title: string ( Required )
book: KB_Book ( Required )
folder: KB_Folder ( Required )
item: PublicationItem ( Required )
created: string (format: date-time) ( Required )
createdBy: CPrincipal ( Nullable and Optional , defaults to null)
updated: string (format: date-time) ( Nullable and Optional , defaults to null)
updatedBy: CPrincipal ( Nullable and Optional , defaults to null)
alias: string ( Required )

KB_Book type

object with fields:

id: string ( Required )
archived: boolean ( Required )
name: string ( Required )
summary: string ( Required )
updated: integer (format: int64) ( Required )
updatedBy: CPrincipal ( Nullable and Optional , defaults to null)
alias: string ( Required )
contexts: array of KB_BookContext ( Required )
rootFolder: KB_Folder ( Required )
locations: array of TD_Location ( Required )
teams: array of TD_Team ( Required )

KB_BookContext type

Name Type

className

string

Possible values:

KbPersonalContext
KbGlobalContext
KbProjectContext

KB_Folder type

object with fields:

id: string ( Required )
archived: boolean ( Required )
name: string ( Required )
parent: KB_Folder ( Nullable and Optional , defaults to null)
subfolders: array of KB_Folder ( Required )
articles: array of KB_Article ( Required )
book: KB_Book ( Required )
cover: KB_Article ( Nullable and Optional , defaults to null)
alias: string ( Required )
created: string (format: date-time) ( Nullable and Optional , defaults to null)
createdBy: CPrincipal ( Nullable and Optional , defaults to null)
updated: string (format: date-time) ( Nullable and Optional , defaults to null)
updatedBy: CPrincipal ( Nullable and Optional , defaults to null)

KbArticleHitDetails type


object with fields: `id`: `string` ( Required ) `bookRef`: `KB_Book` ( Required ) `projectRef`: `PR_Project` ( Nullable and Optional , defaults to `null`) `authorRef`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`)

KbGlobalContext type


No properties

KbPersonalContext type


object with fields: `owner`: `TD_MemberProfile` ( Required )

KbProjectContext type


object with fields: `project`: `PR_Project` ( Required )

KbPublicationDetails type


object with fields: `book`: `KB_Book` ( Nullable and Optional , defaults to `null`) `folder`: `KB_Folder` ( Nullable and Optional , defaults to `null`) `articleId`: `KB_Article` ( Nullable and Optional , defaults to `null`)

KotlinPlatform type


object with fields: `name`: `string` ( Required ) `targets`: array of `string` ( Required )

LastChanges type


object with fields: `lastChanges`: array of `RevisionInfo` ( Required ) `totalChanges`: `integer` (format: int32) ( Required )

LaunchResult type

Name Type

className

string

Possible values:

LaunchResult.Success
LaunchResult.Error

LaunchResult.Error type


object with fields: `message`: `string` ( Required )

LaunchResult.Success type


object with fields: `executionId`: `string` ( Required )

LinkPreview type


No properties

ListCommandsPayload type


object with fields: `accessToken`: `string` ( Nullable and Optional , defaults to `null`) `verificationToken`: `string` ( Nullable and Optional , defaults to `null`) `userId`: `string` ( Nullable and Optional , defaults to `null`)

ListMenuExtensionsPayload type


object with fields: `accessToken`: `string` ( Nullable and Optional , defaults to `null`) `verificationToken`: `string` ( Nullable and Optional , defaults to `null`) `userId`: `string` ( Nullable and Optional , defaults to `null`)

LocationMenuActionContext type


object with fields: `menuId`: `string` ( Required ) `location`: `TD_Location` ( Required )

M2AbsenceItemApproveDeletedContent type


object with fields: `absence`: `AbsenceRecord` ( Required ) `by`: `TD_MemberProfile` ( Required ) `approve`: `boolean` ( Required )

M2AbsenceItemApprovedContent type


object with fields: `absence`: `AbsenceRecord` ( Required ) `by`: `TD_MemberProfile` ( Required ) `approve`: `boolean` ( Required )

M2AbsenceItemContent type


object with fields: `absence`: `AbsenceRecord` ( Required ) `by`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`)

M2AbsenceItemDeletedContent type


object with fields: `absence`: `AbsenceRecord` ( Required ) `by`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`)

M2AbsenceItemUpdatedContent type

object with fields:

absence: AbsenceRecord ( Required )
reason: object with fields:
- old: AbsenceReasonRecord ( Required )
- new: AbsenceReasonRecord ( Required )
( Nullable and Optional , defaults to null)
description: object with fields:
- old: string ( Required )
- new: string ( Required )
( Nullable and Optional , defaults to null)
since: object with fields:
- old: string (format: full-date) ( Required )
- new: string (format: full-date) ( Required )
( Nullable and Optional , defaults to null)
till: object with fields:
- old: string (format: full-date) ( Required )
- new: string (format: full-date) ( Required )
( Nullable and Optional , defaults to null)
by: TD_MemberProfile ( Nullable and Optional , defaults to null)

M2BlogItemContent type


object with fields: `article`: `ArticleRecord` ( Required ) `articleContent`: `ArticleContentRecord` ( Required ) `articleDetails`: `ArticleDetailsRecord` ( Required ) `articleChannel`: `ArticleChannelRecord` ( Required )

M2BlogItemContentDetails type

Name Type

className

string

Possible values:

M2BlogItemPreview
M2BlogItemContent

M2BlogItemPreview type


object with fields: `article`: `ArticleRecord` ( Required ) `articlePreview`: `ArticlePreviewRecord` ( Required ) `articleDetails`: `ArticleDetailsRecord` ( Required ) `articleChannel`: `ArticleChannelRecord` ( Required )

M2ChannelArchivedItemDetails type


No properties

M2ChannelAutomationJobFeedInfo type


object with fields: `jobSubscription`: `JobSubscription` ( Required ) `jobName`: `string` ( Required ) `repoName`: `string` ( Nullable and Optional , defaults to `null`) `notificationDefaults`: `ChannelSpecificDefaults` ( Required )

M2ChannelContact type


object with fields: `defaultName`: `string` ( Required ) `key`: `string` ( Required ) `ext`: `M2ChannelContactInfo` ( Nullable and Optional , defaults to `null`)

M2ChannelContactArticle type


object with fields: `article`: `ArticleRecord` ( Required ) `notificationDefaults`: `ChannelSpecificDefaults` ( Required )

M2ChannelContactInfo type

Name Type

className

string

Possible values:

M2ChannelContactThread
M2ChannelContentMention
M2ChannelContentLocation
M2ChannelContentMember
M2ChannelContentCodeDiscussion
M2ChannelContentCodeReviewFeed
M2ChannelIssueInfo
BillingFeedChannel
M2ChannelAutomationJobFeedInfo
M2SharedChannelContent
M2ChannelContactObsolete
SpaceNewsFeedChannel
M2ChannelContentTeam
M2PrivateConversationChannelContent
M2ChannelContentCodeReviewDiscussion
M2ChannelContentNamedPrivateChannel
M2ChannelContentApplication
M2ChannelContactArticle
M2ChannelContactQuickInfoDefault

M2ChannelContactObsolete type


object with fields: `cause`: `M2ObsoleteCause` ( Nullable and Optional , defaults to `null`)

M2ChannelContactQuickInfoDefault type


object with fields: `name`: `string` ( Required ) `key`: `string` ( Required )

M2ChannelContactThread type

object with fields:

parent: M2ChannelRecord ( Required )
text: string ( Nullable and Optional , defaults to null)
messageId: string ( Nullable and Optional , defaults to null)
author: TD_MemberProfile ( Nullable and Optional , defaults to null)
messageAuthor: CPrincipal ( Nullable and Optional , defaults to null)
attachments: string ( Nullable and Optional , defaults to null)

M2ChannelContentApplication type


object with fields: `service`: `ES_Service` ( Required ) `notificationDefaults`: `ChannelSpecificDefaults` ( Required )

M2ChannelContentArticle type


object with fields: `article`: `ArticleRecord` ( Required ) `articleContent`: `ArticleContentRecord` ( Required ) `details`: `ArticleDetailsRecord` ( Nullable and Optional , defaults to `null`) `channel`: `ArticleChannelRecord` ( Nullable and Optional , defaults to `null`)

M2ChannelContentCodeDiscussion type


object with fields: `codeDiscussionId`: `string` ( Required ) `notificationDefaults`: `ChannelSpecificDefaults` ( Required ) `codeDiscussion`: `CodeDiscussionRecord` ( Nullable and Optional , defaults to `null`)

M2ChannelContentCodeReviewDiscussion type


object with fields: `codeReviewDiscussion`: `string` ( Required ) `notificationDefaults`: `ChannelSpecificDefaults` ( Required )

M2ChannelContentCodeReviewFeed type

object with fields:

codeReviewId: string ( Required )
notificationDefaults: ChannelSpecificDefaults ( Required )
codeReview: CodeReviewRecord ( Nullable and Optional , defaults to null)
participants: CodeReviewParticipants ( Nullable and Optional , defaults to null)
pendingMessageCounter: CodeReviewPendingMessageCounter ( Nullable and Optional , defaults to null)
project: PR_Project ( Nullable and Optional , defaults to null)

M2ChannelContentInfo type

Name Type

className

string

Possible values:

M2ChannelContentMention
M2ChannelContentLocation
M2ChannelContentMember
M2ChannelContentCodeDiscussion
M2ChannelContentCodeReviewFeed
M2ChannelIssueInfo
BillingFeedChannel
M2ChannelAutomationJobFeedInfo
M2SharedChannelContent
M2ChannelContactObsolete
SpaceNewsFeedChannel
M2ChannelContentTeam
M2PrivateConversationChannelContent
M2ChannelContentThread
M2ChannelContentCodeReviewDiscussion
M2ChannelContentNamedPrivateChannel
M2ChannelContentArticle
M2ChannelContentMembership
M2ChannelContentApplication

M2ChannelContentLocation type


object with fields: `location`: `TD_Location` ( Required ) `notificationDefaults`: `ChannelSpecificDefaults` ( Required )

M2ChannelContentMember type


object with fields: `member`: `TD_MemberProfile` ( Required ) `notificationDefaults`: `ChannelSpecificDefaults` ( Required ) `memberAbsences`: `ProfileAbsencesRecord` ( Nullable and Optional , defaults to `null`) `memberTeams`: `ProfileMembershipRecord` ( Nullable and Optional , defaults to `null`)

M2ChannelContentMembership type


No properties

M2ChannelContentMention type


object with fields: `record`: `ChannelItemRecord` ( Required ) `parent`: `M2ChannelRecord` ( Required )

M2ChannelContentNamedPrivateChannel type


object with fields: `name`: `string` ( Required ) `notificationDefaults`: `ChannelSpecificDefaults` ( Nullable and Optional , defaults to `null`) `canHaveThreads`: `boolean` ( Required )

M2ChannelContentRecord type


object with fields: `id`: `string` ( Required ) `content`: `M2ChannelContentInfo` ( Nullable and Optional , defaults to `null`)

M2ChannelContentTeam type


object with fields: `team`: `TD_Team` ( Required ) `notificationDefaults`: `ChannelSpecificDefaults` ( Required )

M2ChannelContentThread type


object with fields: `record`: `ChannelItemRecord` ( Required ) `parent`: `M2ChannelRecord` ( Required )

M2ChannelCreatedItemDetails type


No properties

M2ChannelFeedIntroItemDetails type


No properties

M2ChannelIssueInfo type


object with fields: `projectKey`: `ProjectKey` ( Nullable and Optional , defaults to `null`) `issue`: `Issue` ( Required ) `notificationDefaults`: `ChannelSpecificDefaults` ( Required )

M2ChannelRecord type

object with fields:

id: string ( Required )
contact: M2ChannelContact ( Required )
totalMessages: integer (format: int32) ( Required )
lastMessage: MessageInfo ( Nullable and Optional , defaults to null)
authors: array of TD_MemberProfile ( Nullable and Optional , defaults to null)
commentAuthors: array of CPrincipal ( Nullable and Optional , defaults to null)
participants: array of ChannelParticipant ( Nullable and Optional , defaults to null)
channelArchived: boolean ( Nullable and Optional , defaults to null)
archived: boolean ( Required )
content: M2ChannelContentInfo ( Nullable and Optional , defaults to null)
channel: M2ChannelRecord ( Required )
messages: array of ChannelItemRecord ( Nullable and Optional , defaults to null)

M2ChannelRestoredItemDetails type


No properties

M2ChatReader type

object with fields:

id: string ( Required )
unreadCounter: integer (format: int32) ( Required )
readTime: string (format: date-time) ( Nullable and Optional , defaults to null)
hasUnread: boolean ( Nullable and Optional , defaults to null)
contact: M2ChannelContact ( Required )
lastMessage: MessageInfo ( Nullable and Optional , defaults to null)
totalMessages: integer (format: int32) ( Required )
authors: array of TD_MemberProfile ( Required )
archived: boolean ( Required )
goto: boolean ( Required )
pinned: boolean ( Nullable and Optional , defaults to null)
hidden: boolean ( Nullable and Optional , defaults to null)
pinnedPrevChannelId: string ( Nullable and Optional , defaults to null)
subscribedSince: string (format: date-time) ( Nullable and Optional , defaults to null)
subscribed: boolean ( Nullable and Optional , defaults to null)
parentChannelId: string ( Nullable and Optional , defaults to null)

M2DraftEditorAddedItemContent type


object with fields: `id`: `string` ( Required ) `title`: `string` ( Required )

M2DraftEditorTeamAddedItemContent type


object with fields: `id`: `string` ( Required ) `team`: `TD_Team` ( Required ) `title`: `string` ( Required )

M2ExternalStatusFailureItemContent type

object with fields:

projectId: string ( Nullable and Optional , defaults to null)
repository: string ( Required )
branch: string ( Required )
revisionInfo: RevisionAuthorInfo ( Nullable and Optional , defaults to null)
changesInfo: LastChanges ( Nullable and Optional , defaults to null)
url: string ( Required )
externalServiceName: string ( Required )
taskName: string ( Required )
timestamp: integer (format: int64) ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)

M2ExternalStatusSucceedItemContent type

object with fields:

projectId: string ( Nullable and Optional , defaults to null)
repository: string ( Required )
branch: string ( Required )
revisionInfo: RevisionAuthorInfo ( Nullable and Optional , defaults to null)
changesInfo: LastChanges ( Nullable and Optional , defaults to null)
url: string ( Required )
externalServiceName: string ( Required )
taskName: string ( Required )
timestamp: integer (format: int64) ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)

M2ItemContentDetails type

Name Type

className

string

Possible values:

M2AbsenceItemContent
M2DraftEditorTeamAddedItemContent
M2TextItemContent
M2ExternalStatusSucceedItemContent
MCMessageCommonDetails
M2MaintenanceActionContent
M2AbsenceItemUpdatedContent
M2MembershipContent
M2MembershipTerminatedContent
M2MembershipRequestedContent
M2MembershipCreatedContent
M2PackageCreatedDetails
M2PackageDeletedDetails
M2AbsenceItemApprovedContent
M2TaskExecutionFailureItemContent
M2BlogItemPreview
M2BlogItemContent
M2ChannelRestoredItemDetails
MCMessage
M2AbsenceItemApproveDeletedContent
MembersAddedItemDetails
TeamAddedItemDetails
M2TaskExecutionSucceedItemContent
StickerContentDetails
IssueTitleChangedDetails
IssueMCExtension
IssueStatusChangedDetails
IssueChecklistsChangedDetails
IssueDueDateChangedDetails
IssueAttachmentsChangedDetails
IssueCreatedDetails
IssueDeletedDetails
IssueDescriptionChangedDetails
IssueAssigneeChangedDetails
IssueTagsChangedDetails
MergeRequestBranchRestoredEvent
CodeDiscussionAddedFeedEvent
ReviewTitleChangedEvent
ReviewerChangedEvent
MergeRequestMergedEvent
MergeRequestBranchDeletedEvent
ReviewStateChangedEvent
ReviewBranchTrackEvent
ReviewCompletionStateChangedEvent
CodeReviewDiscussionAddedFeedEvent
ReviewRevisionsChangedEvent
M2AbsenceItemDeletedContent
M2ChannelCreatedItemDetails
M2UserLeftChannel
M2MemberContent
M2MemberLeavesContent
M2MemberJoinsContent
M2ChannelFeedIntroItemDetails
M2PollContent
M2ChannelArchivedItemDetails
M2ExternalStatusFailureItemContent
M2DraftEditorAddedItemContent

M2MaintenanceActionContent type


object with fields: `action`: `string` ( Required ) `success`: `boolean` ( Required ) `details`: `string` ( Required )

M2MemberContent type

Name Type

className

string

Possible values:

M2MemberContent
M2MemberLeavesContent
M2MemberJoinsContent

No properties

M2MemberJoinsContent type


object with fields: `member`: `TD_MemberProfile` ( Required )

M2MemberLeavesContent type


object with fields: `member`: `TD_MemberProfile` ( Required )

M2MembershipContent type

Name Type

className

string

Possible values:

M2MembershipContent
M2MembershipTerminatedContent
M2MembershipRequestedContent
M2MembershipCreatedContent

No properties

M2MembershipCreatedContent type


object with fields: `membership`: `TD_Membership` ( Required )

M2MembershipRequestedContent type


object with fields: `membership`: `TD_Membership` ( Required ) `leave`: `boolean` ( Required )

M2MembershipTerminatedContent type


object with fields: `membership`: `TD_Membership` ( Required )

M2PackageContentDetails type

Name Type

className

string

Possible values:

M2PackageCreatedDetails
M2PackageDeletedDetails

M2PackageCreatedDetails type


object with fields: `pkg`: `PackageVersionInfo` ( Required )

M2PackageDeletedDetails type


object with fields: `pkg`: `PackageVersionInfo` ( Required )

M2PollContent type


object with fields: `poll`: `PollRecord` ( Required )

M2PrivateConversationChannelContent type


object with fields: `channelId`: `string` ( Required ) `subject`: `string` ( Nullable and Optional , defaults to `null`) `members`: array of `TD_MemberProfile` ( Required ) `notificationDefaults`: `ChannelSpecificDefaults` ( Nullable and Optional , defaults to `null`)

M2SharedChannelContent type

object with fields:

name: string ( Required )
group: string ( Required )
access: M2.Access ( Required )
description: string ( Required )
iconId: string ( Nullable and Optional , defaults to null)
notificationDefaults: ChannelSpecificDefaults ( Required )
teams: array of TD_Team ( Nullable and Optional , defaults to null)
canEdit: boolean ( Nullable and Optional , defaults to null)

M2TaskExecutionFailureItemContent type

object with fields:

taskExecutionId: string ( Required )
taskExecutionName: string ( Required )
repoName: string ( Required )
branchName: string ( Required )
commit: string ( Required )
shortCommitMessage: string ( Required )
project: ProjectKey ( Required )
finishDateTime: integer (format: int64) ( Required )
triggerInfo: string ( Required )
details: string ( Required )

M2TaskExecutionSucceedItemContent type

object with fields:

taskExecutionId: string ( Required )
taskExecutionName: string ( Required )
repoName: string ( Required )
branchName: string ( Required )
commit: string ( Required )
shortCommitMessage: string ( Required )
project: ProjectKey ( Required )
finishDateTime: integer (format: int64) ( Required )
triggerInfo: string ( Required )
details: string ( Required )

M2TextItemContent type


object with fields: `markdown`: `boolean` ( Nullable and Optional , defaults to `null`)

M2UserLeftChannel type


No properties

MCAction type


object with fields: `id`: `string` ( Required ) `value`: `string` ( Required )

MCButton type


object with fields: `text`: `string` ( Required ) `style`: `string` ( Required ) `action`: `MCAction` ( Required ) `disabled`: `boolean` ( Nullable and Optional , defaults to `null`)

MCDivider type


No properties

MCElement type


object with fields: `defaultText`: `string` ( Required ) `details`: `MCElementDetails` ( Nullable and Optional , defaults to `null`)

MCElementDetails type

Name Type

className

string

Possible values:

MCOutline
MCFields
MCImage
MCDivider
MCTag
MCSection
MCText
MCButton
MCIcon
MCGroup

MCFields type


object with fields: `fields`: array of object with fields: `first`: `MCElement` ( Nullable and Optional , defaults to `null`) `second`: `MCElement` ( Nullable and Optional , defaults to `null`) ( Required )

MCGroup type


object with fields: `elements`: array of `MCElement` ( Required )

MCIcon type


object with fields: `name`: `string` ( Required ) `style`: `string` ( Required )

MCImage type


object with fields: `src`: `string` ( Required )

MCMessage type

object with fields:

style: string ( Required )
outline: MCOutline ( Nullable and Optional , defaults to null)
content: array of MCElement ( Required )
serviceId: string ( Nullable and Optional , defaults to null)
supplementaryData: string ( Nullable and Optional , defaults to null)
extension: M2ItemContentDetails ( Nullable and Optional , defaults to null)

MCMessageCommonDetails type


No properties

MCOutline type


object with fields: `icon`: `MCElement` ( Nullable and Optional , defaults to `null`) `text`: `MCText` ( Nullable and Optional , defaults to `null`)

MCSection type


object with fields: `header`: `MCText` ( Nullable and Optional , defaults to `null`) `elements`: array of `MCElement` ( Required ) `footer`: `MCText` ( Nullable and Optional , defaults to `null`)

MCTag type


object with fields: `text`: `string` ( Required ) `style`: `string` ( Required )

MCText type


object with fields: `content`: `string` ( Required ) `markdown`: `boolean` ( Required ) `accessory`: `MCElement` ( Nullable and Optional , defaults to `null`)

MatchSnippet type


object with fields: `propertyName`: `string` ( Required ) `snippet`: `string` ( Required )

MavenChecksum type


object with fields: `algorithm`: `string` ( Required ) `value`: `string` ( Required )

MavenPackageDependency type


object with fields: `scope`: `string` ( Required ) `group`: `string` ( Required ) `artifact`: `string` ( Required ) `version`: `string` ( Nullable and Optional , defaults to `null`)

MavenPackageFile type


object with fields: `name`: `string` ( Required ) `created`: `integer` (format: int64) ( Required ) `length`: `integer` (format: int64) ( Required ) `checksums`: array of `MavenChecksum` ( Required )

MavenPackageParent type


object with fields: `group`: `string` ( Required ) `artifact`: `string` ( Required ) `version`: `string` ( Required )

MavenPackageType type


object with fields: `id`: `string` ( Required )

MavenPackageVersionDetails type

object with fields:

type: PackageType ( Required )
repository: string ( Required )
name: string ( Required )
version: string ( Required )
tags: array of string ( Nullable and Optional , defaults to null)
created: integer (format: int64) ( Required )
accessed: integer (format: int64) ( Nullable and Optional , defaults to null)
downloads: integer (format: int64) ( Required )
diskSize: integer (format: int64) ( Required )
author: CPrincipal ( Nullable and Optional , defaults to null)
authors: array of CPrincipal ( Nullable and Optional , defaults to null)
origin: PackageOrigin ( Nullable and Optional , defaults to null)
metadata: key-value object of string keys and values of string ( Nullable and Optional , defaults to null)
packaging: string ( Nullable and Optional , defaults to null)
packageName: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
url: string ( Nullable and Optional , defaults to null)
licenses: array of string ( Required )
scmUrl: string ( Nullable and Optional , defaults to null)
dependencies: array of MavenPackageDependency ( Required )
kotlinPlatforms: array of KotlinPlatform ( Nullable and Optional , defaults to null)
parent: MavenPackageParent ( Nullable and Optional , defaults to null)
pathPrefix: string ( Nullable and Optional , defaults to null)
files: array of MavenPackageFile ( Required )

MdMarkup type


object with fields: `unfurl`: array of `Unfurl` ( Required )

MeCodeReviewParticipantRecord type

object with fields:

id: string ( Required )
role: CodeReviewParticipantRole ( Nullable and Optional , defaults to null)
theirTurn: boolean ( Nullable and Optional , defaults to null)
reviewerState: ReviewerState ( Nullable and Optional , defaults to null)
review: CodeReviewRecord ( Required )
participants: CodeReviewParticipants ( Required )
pendingCounter: CodeReviewPendingMessageCounter ( Required )
archived: boolean ( Required )

MediaAttachment type

Name Type

className

string

Possible values:

VideoAttachment
ImageAttachment

MeetingAttachment type


object with fields: `fileUrl`: `string` ( Nullable and Optional , defaults to `null`) `title`: `string` ( Nullable and Optional , defaults to `null`) `mimeType`: `string` ( Nullable and Optional , defaults to `null`) `fileId`: `string` ( Nullable and Optional , defaults to `null`) `source`: `string` ( Nullable and Optional , defaults to `null`)

MeetingOccurrenceTime type


object with fields: `start`: `string` (format: date-time) ( Required ) `end`: `string` (format: date-time) ( Required )

MeetingOrganizer type

Name Type

className

string

Possible values:

MeetingOrganizer.User
MeetingOrganizer.ExternalUser
MeetingOrganizer.Application
MeetingOrganizer.HiddenUser

MeetingOrganizer.Application type


object with fields: `appRef`: `ES_Service` ( Required )

MeetingOrganizer.ExternalUser type


object with fields: `email`: `string` ( Required )

MeetingOrganizer.HiddenUser type


No properties

MeetingOrganizer.User type


object with fields: `profileRef`: `TD_MemberProfile` ( Required )

MeetingRecord type

object with fields:

id: string ( Required )
archived: boolean ( Required )
starts: string (format: date-time) ( Required )
finishes: string (format: date-time) ( Required )
timezone: ATimeZone ( Nullable and Optional , defaults to null)
allDay: boolean ( Required )
rooms: array of TD_Location ( Required )
participants: array of Participant ( Required )
article: ArticleRecord ( Nullable and Optional , defaults to null)

MembersAddedItemDetails type


object with fields: `principals`: array of `CPrincipal` ( Required ) `othersDisplayNames`: array of `string` ( Required )

MembershipEvent type


object with fields: `profile`: `TD_MemberProfile` ( Required ) `membership`: array of `TD_Membership` ( Required )

MenuActionContext type

Name Type

className

string

Possible values:

LocationMenuActionContext
ProjectMenuActionContext
RepositoryMenuActionContext
ChannelMessageMenuActionContext
ChannelAttachmentMenuActionContext
TeamMenuActionContext
BaseMenuActionContext

MenuActionPayload type


object with fields: `extensionName`: `string` ( Required ) `context`: `MenuActionContext` ( Required ) `accessToken`: `string` ( Nullable and Optional , defaults to `null`) `verificationToken`: `string` ( Nullable and Optional , defaults to `null`) `userId`: `string` ( Required )

MenuExtensionDetail type


object with fields: `menuId`: `string` ( Required ) `name`: `string` ( Required ) `description`: `string` ( Nullable and Optional , defaults to `null`)

MenuExtensions type


object with fields: `extensions`: array of `MenuExtensionDetail` ( Required )

MergeRequestBranch type


object with fields: `displayName`: `string` ( Required ) `ref`: `string` ( Required ) `deleted`: `boolean` ( Required )

MergeRequestBranchDeletedEvent type


object with fields: `repository`: `string` ( Required ) `branch`: `string` ( Required ) `branchType`: `MergeRequestBranchType` ( Required )

MergeRequestBranchPair type


object with fields: `repository`: `string` ( Required ) `sourceBranch`: `string` ( Required ) `targetBranch`: `string` ( Required ) `sourceBranchRef`: `string` ( Required ) `sourceBranchInfo`: `MergeRequestBranch` ( Nullable and Optional , defaults to `null`) `targetBranchInfo`: `MergeRequestBranch` ( Nullable and Optional , defaults to `null`)

MergeRequestBranchRestoredEvent type


object with fields: `repository`: `string` ( Required ) `branch`: `string` ( Required ) `branchType`: `MergeRequestBranchType` ( Required )

MergeRequestMergedEvent type


object with fields: `repository`: `string` ( Required ) `sourceBranch`: `string` ( Required ) `targetBranch`: `string` ( Required )

MergeRequestRecord type

object with fields:

id: string ( Required )
project: ProjectKey ( Required )
projectId: string ( Required )
number: integer (format: int32) ( Required )
title: string ( Required )
state: CodeReviewState ( Required )
canBeReopened: boolean ( Nullable and Optional , defaults to null)
createdAt: integer (format: int64) ( Required )
createdBy: TD_MemberProfile ( Nullable and Optional , defaults to null)
turnBased: boolean ( Nullable and Optional , defaults to null)
feedChannel: M2ChannelRecord ( Nullable and Optional , defaults to null)
branchPairs: array of MergeRequestBranchPair ( Required )
discussionCounter: Counter ( Required )
participants: array of CodeReviewParticipant ( Nullable and Optional , defaults to null)
reviewers: array of CodeReviewParticipantRecord ( Required )
authors: array of CodeReviewParticipantRecord ( Required )
watchers: array of CodeReviewParticipantRecord ( Required )

MergeRequestReviewer type


object with fields: `profileId`: `string` ( Required ) `qualityGateSlot`: `CodeReviewParticipantQualityGateSlot` ( Nullable and Optional , defaults to `null`)

MessageAccessoryElement type

Name Type

className

string

Possible values:

MessageIcon
MessageTag
MessageImage

MessageAction type

Name Type

className

string

Possible values:

PostMessageAction

MessageActionPayload type


object with fields: `actionId`: `string` ( Required ) `actionValue`: `string` ( Required ) `message`: `MessageContext` ( Required ) `accessToken`: `string` ( Nullable and Optional , defaults to `null`) `verificationToken`: `string` ( Nullable and Optional , defaults to `null`) `userId`: `string` ( Required )

MessageButton type


object with fields: `text`: `string` ( Required ) `style`: `MessageButtonStyle` ( Required ) `action`: `MessageAction` ( Required ) `disabled`: `boolean` ( Nullable and Optional , defaults to `null`)

MessageContext type

object with fields:

messageId: string ( Required )
channelId: string ( Required )
messageData: string ( Nullable and Optional , defaults to null)
body: ChatMessage ( Nullable and Optional , defaults to null)
attachments: array of Attachment ( Nullable and Optional , defaults to null)
externalId: string ( Nullable and Optional , defaults to null)
createdTime: string ( Required )

MessageControlElement type

Name Type

className

string

Possible values:

MessageButton

MessageControlGroup type


object with fields: `elements`: array of `MessageControlElement` ( Required )

MessageDivider type


No properties

MessageElement type

Name Type

className

string

Possible values:

MessageDivider
MessageFields
MessageText
MessageControlGroup

MessageField type


object with fields: `first`: `string` ( Required ) `second`: `string` ( Required )

MessageFieldElement type

Name Type

className

string

Possible values:

MessageField

MessageFields type


object with fields: `fields`: array of `MessageFieldElement` ( Required )

MessageForImport type


object with fields: `authorPrincipalId`: `string` ( Required ) `text`: `string` ( Required ) `createdAtUtc`: `integer` (format: int64) ( Required ) `attachments`: array of `Attachment` ( Nullable and Optional , defaults to `null`)

MessageHitDetails type


object with fields: `ref`: `ChannelItemRecord` ( Required ) `channel`: `M2ChannelRecord` ( Required ) `readerRef`: `M2ChatReader` ( Required ) `threadStarter`: `boolean` ( Required ) `thread`: `string` ( Nullable and Optional , defaults to `null`)

MessageIcon type


object with fields: `icon`: `ApiIcon` ( Required ) `style`: `MessageStyle` ( Required )

MessageImage type


object with fields: `src`: `string` ( Required )

MessageInfo type


object with fields: `id`: `string` ( Required ) `text`: `string` ( Required ) `time`: `integer` (format: int64) ( Required ) `author`: `CPrincipal` ( Required ) `attachments`: `string` ( Nullable and Optional , defaults to `null`) `inThirdPerson`: `boolean` ( Nullable and Optional , defaults to `null`)

MessageLink type


object with fields: `channelKey`: `string` ( Required ) `channelId`: `string` ( Required ) `messageId`: `string` ( Required )

MessageOutline type


object with fields: `icon`: `ApiIcon` ( Nullable and Optional , defaults to `null`) `text`: `string` ( Required )

MessagePayload type


object with fields: `message`: `MessageContext` ( Required ) `accessToken`: `string` ( Nullable and Optional , defaults to `null`) `verificationToken`: `string` ( Nullable and Optional , defaults to `null`) `userId`: `string` ( Required )

MessageRecipient type

Name Type

className

string

Possible values:

MessageRecipient.Channel
MessageRecipient.Member
MessageRecipient.Issue
MessageRecipient.CodeReview

MessageRecipient.Channel type


object with fields: `channel`: `ChatChannel` ( Required )

MessageRecipient.CodeReview type


object with fields: `codeReview`: `string` ( Required )

MessageRecipient.Issue type


object with fields: `issue`: `string` ( Required )

MessageRecipient.Member type


object with fields: `member`: `ProfileIdentifier` ( Required )

MessageSection type


object with fields: `header`: `string` ( Nullable and Optional , defaults to `null`) `elements`: array of `MessageElement` ( Required ) `footer`: `string` ( Nullable and Optional , defaults to `null`)

MessageSectionElement type

Name Type

className

string

Possible values:

MessageDivider
MessageSection

MessageTag type


object with fields: `text`: `string` ( Required ) `style`: `MessageStyle` ( Required )

MessageText type


object with fields: `accessory`: `MessageAccessoryElement` ( Nullable and Optional , defaults to `null`) `content`: `string` ( Required )

MetricsEvent type


object with fields: `id`: `string` ( Required ) `time`: `integer` (format: int64) ( Required ) `props`: array of `MetricsProp` ( Nullable and Optional , defaults to `null`) `points`: array of `MetricsPoint` ( Nullable and Optional , defaults to `null`)

MetricsPoint type


object with fields: `key`: `string` ( Required ) `value`: `integer` (format: int64) ( Required )

MetricsProp type


object with fields: `key`: `string` ( Required ) `value`: `string` ( Required )

MetricsRequest type


object with fields: `client`: `ClientInfo` ( Required ) `events`: array of `MetricsEvent` ( Required )

NavBarMenuItem type


object with fields: `item`: `string` ( Required ) `enabled`: `boolean` ( Required )

NewMessage type


object with fields: `text`: `string` ( Required ) `temporaryId`: `string` ( Required ) `attachments`: array of `Attachment` ( Nullable and Optional , defaults to `null`) `pending`: `boolean` ( Required ) `draftTag`: `string` ( Nullable and Optional , defaults to `null`)

NonWorkingDays type


object with fields: `since`: `string` (format: full-date) ( Required ) `till`: `string` (format: full-date) ( Required ) `startsEarlier`: `boolean` ( Required ) `endsLater`: `boolean` ( Required )

NonWorkingDaysEvent type


object with fields: `profile`: `TD_MemberProfile` ( Required ) `days`: array of `NonWorkingDays` ( Required )

NonZeroExitCodeDTO type


No properties

NpmPackageDependency type


object with fields: `name`: `string` ( Required ) `version`: `string` ( Required ) `type`: `string` ( Nullable and Optional , defaults to `null`)

NpmPackageType type


object with fields: `id`: `string` ( Required )

NpmPackageVersionDetails type

object with fields:

type: PackageType ( Required )
repository: string ( Required )
name: string ( Required )
version: string ( Required )
tags: array of string ( Nullable and Optional , defaults to null)
created: integer (format: int64) ( Required )
accessed: integer (format: int64) ( Nullable and Optional , defaults to null)
downloads: integer (format: int64) ( Required )
diskSize: integer (format: int64) ( Required )
author: CPrincipal ( Nullable and Optional , defaults to null)
authors: array of CPrincipal ( Nullable and Optional , defaults to null)
origin: PackageOrigin ( Nullable and Optional , defaults to null)
metadata: key-value object of string keys and values of string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
dependencies: array of NpmPackageDependency ( Required )
keywords: array of string ( Required )
license: string ( Nullable and Optional , defaults to null)
projectUrl: string ( Nullable and Optional , defaults to null)
repositoryUrl: string ( Nullable and Optional , defaults to null)
repositoryRevision: string ( Nullable and Optional , defaults to null)
readme: string ( Nullable and Optional , defaults to null)

NuGetDependency type


object with fields: `id`: `string` ( Required ) `range`: `string` ( Required )

NuGetDependencyGroup type


object with fields: `targetFramework`: `string` ( Nullable and Optional , defaults to `null`) `dependencies`: array of `NuGetDependency` ( Nullable and Optional , defaults to `null`)

NuGetPackageType type


object with fields: `id`: `string` ( Required )

NuGetPackageVersionDetails type

object with fields:

type: PackageType ( Required )
repository: string ( Required )
name: string ( Required )
version: string ( Required )
tags: array of string ( Nullable and Optional , defaults to null)
created: integer (format: int64) ( Required )
accessed: integer (format: int64) ( Nullable and Optional , defaults to null)
downloads: integer (format: int64) ( Required )
diskSize: integer (format: int64) ( Required )
author: CPrincipal ( Nullable and Optional , defaults to null)
authors: array of CPrincipal ( Nullable and Optional , defaults to null)
origin: PackageOrigin ( Nullable and Optional , defaults to null)
metadata: key-value object of string keys and values of string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
projectUrl: string ( Nullable and Optional , defaults to null)
license: string ( Nullable and Optional , defaults to null)
licenseUrl: string ( Nullable and Optional , defaults to null)
icon: string ( Nullable and Optional , defaults to null)
title: string ( Nullable and Optional , defaults to null)
dependencies: array of NuGetDependencyGroup ( Required )

OIDCDiscovery type

Name Type

className

string

Possible values:

OIDCDiscovery.Success
OIDCDiscovery.Error

OIDCDiscovery.Error type


object with fields: `code`: `string` ( Required ) `description`: `string` ( Required )

OIDCDiscovery.Success type


object with fields: `issuer`: `string` ( Required ) `authorizationEndpoint`: `string` ( Required ) `deviceAuthorizationEndpoint`: `string` ( Required ) `tokenEndpoint`: `string` ( Required ) `userinfoEndpoint`: `string` ( Required ) `revocationEndpoint`: `string` ( Required ) `jwksUri`: `string` ( Required )

OpenEnumCFType type


No properties

OpenEnumCFValue type


object with fields: `value`: `EnumValueData` ( Nullable and Optional , defaults to `null`)

OpenEnumListCFType type


No properties

OpenEnumListCFValue type


object with fields: `values`: array of `EnumValueData` ( Required )

OutOfMemoryDTO type


No properties

Overdrafts type


object with fields: `storage`: `integer` (format: int32) ( Required ) `bandwidth`: `integer` (format: int32) ( Required ) `ciCredits`: `integer` (format: int32) ( Required )

PR_PrivateProject type


object with fields: `key`: `ProjectKey` ( Required ) `name`: `string` ( Required ) `accessAllowed`: `boolean` ( Required ) `admins`: array of `TD_MemberProfile` ( Required )

PR_Project type

object with fields:

id: string ( Required )
key: ProjectKey ( Required )
name: string ( Required )
private: boolean ( Required )
description: string ( Nullable and Optional , defaults to null)
icon: string ( Nullable and Optional , defaults to null)
latestRepositoryActivity: string (format: date-time) ( Nullable and Optional , defaults to null)
archived: boolean ( Required )
repos: array of PR_RepositoryInfo ( Required )
memberProfiles: array of TD_MemberProfile ( Required )
memberTeams: array of TD_Team ( Required )
adminProfiles: array of TD_MemberProfile ( Required )
adminTeams: array of TD_Team ( Required )
collaboratorsProfiles: array of TD_MemberProfile ( Required )
collaboratorsTeams: array of TD_Team ( Required )
tags: array of string ( Required )
packages: array of ProjectPackageRepository ( Required )
trackers: array of ProjectIssueTrackerItem ( Required )
type: ProjectTeamType ( Required )
teams: array of TD_Team ( Nullable and Optional , defaults to null)
members: array of ProjectTeamMemberRecord ( Nullable and Optional , defaults to null)
team: TD_Team ( Nullable and Optional , defaults to null)
boards: array of BoardRecord ( Required )

PR_RepositoryInfo type

object with fields:

id: string ( Nullable and Optional , defaults to null)
name: string ( Required )
description: string ( Required )
latestActivity: string (format: date-time) ( Nullable and Optional , defaults to null)
proxyPushNotification: string (format: date-time) ( Nullable and Optional , defaults to null)
state: RepositoryState ( Required )
initProgress: string ( Nullable and Optional , defaults to null)
readmeName: string ( Nullable and Optional , defaults to null)
monthlyActivity: RepositoryActivity ( Nullable and Optional , defaults to null)

PR_Tag type


object with fields: `name`: `string` ( Required ) `projectCount`: `integer` (format: int32) ( Required )

PackageData type


object with fields: `type`: `PackageType` ( Required ) `repository`: `string` ( Required ) `name`: `string` ( Required ) `versions`: `integer` (format: int64) ( Required ) `updated`: `integer` (format: int64) ( Required ) `lastVersion`: `string` ( Required )

PackageOrigin type

Name Type

className

string

Possible values:

PackageOrigin.Build
PackageOrigin.Url

PackageOrigin.Build type


object with fields: `name`: `string` ( Nullable and Optional , defaults to `null`) `url`: `string` ( Nullable and Optional , defaults to `null`)

PackageOrigin.Url type


object with fields: `url`: `string` ( Required )

PackageRepository type

object with fields:

id: string ( Required )
type: PackageType ( Required )
name: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
public: boolean ( Required )
settings: ES_PackageRepositorySettings ( Nullable and Optional , defaults to null)
archived: boolean ( Required )

PackageRepositoryMirror type

Name Type

className

string

Possible values:

PackageRepositoryMirror.Space
PackageRepositoryMirror.External

PackageRepositoryMirror.External type


object with fields: `id`: `string` ( Required ) `url`: `string` ( Required ) `credentials`: `PackageRepositoryCredentials` ( Required ) `secretId`: `string` ( Nullable and Optional , defaults to `null`) `secretValue`: `string` ( Nullable and Optional , defaults to `null`)

PackageRepositoryMirror.Space type


object with fields: `id`: `string` ( Required ) `repository`: `ProjectPackageRepository` ( Required )

PackageType type

Name Type

className

string

Possible values:

MavenPackageType
ContainerPackageType
NuGetPackageType
NpmPackageType

PackageVersionData type

object with fields:

type: PackageType ( Required )
repository: string ( Required )
name: string ( Required )
version: string ( Required )
tags: array of string ( Nullable and Optional , defaults to null)
created: integer (format: int64) ( Nullable and Optional , defaults to null)
updated: integer (format: int64) ( Nullable and Optional , defaults to null)
downloads: integer (format: int64) ( Nullable and Optional , defaults to null)

PackageVersionDetails type

Name Type

className

string

Possible values:

MavenPackageVersionDetails
ContainerPackageVersionDetails
NuGetPackageVersionDetails
NpmPackageVersionDetails

PackageVersionInfo type


object with fields: `type`: `PackageType` ( Required ) `repository`: `string` ( Required ) `name`: `string` ( Required ) `version`: `string` ( Required ) `tags`: array of `string` ( Nullable and Optional , defaults to `null`)

Participant type


object with fields: `user`: `TD_MemberProfile` ( Required ) `status`: `EventParticipationStatus` ( Required )

PercentageCFConstraint type


No properties

PercentageCFType type


No properties

PercentageCFValue type


object with fields: `value`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`)

PermissionTarget type

Name Type

className

string

Possible values:

GlobalPermissionTarget
ProjectPermissionTarget
ProfilePermissionTarget
TeamPermissionTarget

PlainParameterRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `bundleId`: `string` ( Required ) `key`: `string` ( Required ) `value`: `string` ( Required )

PlanItem type

object with fields:

id: string ( Required )
checklistId: string ( Required )
tag: PlanningTag ( Nullable and Optional , defaults to null)
simpleText: string ( Nullable and Optional , defaults to null)
simpleDone: boolean ( Nullable and Optional , defaults to null)
issue: Issue ( Nullable and Optional , defaults to null)
issueProblem: string ( Nullable and Optional , defaults to null)
canEditIssue: boolean ( Nullable and Optional , defaults to null)
hasChildren: boolean ( Required )
children: array of PlanItem ( Required )

PlanItemChildren type


object with fields: `id`: `string` ( Required ) `children`: array of `PlanItem` ( Required )

PlanningTag type


object with fields: `id`: `string` ( Required ) `projectId`: `string` ( Required ) `parent`: `PlanningTag` ( Nullable and Optional , defaults to `null`) `name`: `string` ( Required )

PollRecord type

object with fields:

id: string ( Required )
owner: TD_MemberProfile ( Required )
question: string ( Required )
meVote: boolean ( Required )
countPeople: integer (format: int32) ( Required )
anonymous: boolean ( Required )
closed: boolean ( Required )
extendable: boolean ( Required )
multiChoice: boolean ( Required )
ended: boolean ( Required )
expirationTime: string (format: date-time) ( Nullable and Optional , defaults to null)
votes: array of VoteGroup ( Required )

PostMessageAction type


object with fields: `actionId`: `string` ( Required ) `payload`: `string` ( Required )

PrincipalIn type

Name Type

className

string

Possible values:

PrincipalIn.Profile
PrincipalIn.Application

PrincipalIn.Application type


object with fields: `application`: `string` ( Required )

PrincipalIn.Profile type


object with fields: `profile`: `ProfileIdentifier` ( Required )

ProfileAbsencesRecord type


object with fields: `id`: `string` ( Required ) `absences`: array of `AbsenceRecord` ( Required )

ProfileCFType type


No properties

ProfileCFValue type


object with fields: `profile`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`)

ProfileHitDetails type


object with fields: `ref`: `TD_MemberProfile` ( Required ) `absencesRef`: `ProfileAbsencesRecord` ( Required ) `membershipRef`: `ProfileMembershipRecord` ( Required ) `locationsRef`: `ProfileLocationsRecord` ( Required )

ProfileLinkPreview type


object with fields: `profile`: `TD_MemberProfile` ( Required )

ProfileListCFType type


No properties

ProfileListCFValue type


object with fields: `profiles`: array of `TD_MemberProfile` ( Required )

ProfileLocationsRecord type


object with fields: `id`: `string` ( Required ) `locations`: array of `TD_MemberLocation` ( Required )

ProfileMembershipRecord type


object with fields: `id`: `string` ( Required ) `memberships`: array of `TD_Membership` ( Required )

ProfilePermissionTarget type


object with fields: `profile`: `ProfileIdentifier` ( Required )

ProjectHitDetails type


object with fields: `ref`: `PR_Project` ( Required )

ProjectIssueTrackerItem type


object with fields: `key`: `string` ( Required ) `tracker`: `IssueTracker` ( Required )

ProjectKey type


object with fields: `key`: `string` ( Required )

ProjectMenuActionContext type


object with fields: `menuId`: `string` ( Required ) `project`: `PR_Project` ( Required )

ProjectPackageRepository type


object with fields: `id`: `string` ( Required ) `project`: `PR_Project` ( Required ) `name`: `string` ( Required ) `description`: `string` ( Nullable and Optional , defaults to `null`) `repository`: `PackageRepository` ( Required ) `archived`: `boolean` ( Required ) `mirrors`: array of `PackageRepositoryMirror` ( Required )

ProjectPermissionTarget type


object with fields: `project`: `ProjectIdentifier` ( Required )

ProjectTeamMemberRecord type


object with fields: `id`: `string` ( Required ) `project`: `PR_Project` ( Required ) `profile`: `TD_MemberProfile` ( Required ) `position`: `TD_Role` ( Nullable and Optional , defaults to `null`) `since`: `string` (format: date-time) ( Required ) `archived`: `boolean` ( Required )

PublicHoliday type


object with fields: `id`: `string` ( Required ) `calendar`: `PublicHolidayCalendarRecord` ( Required ) `name`: `string` ( Required ) `date`: `string` (format: full-date) ( Required ) `workingDay`: `boolean` ( Required ) `halfDay`: `boolean` ( Nullable and Optional , defaults to `null`)

PublicHolidayCalendarRecord type

object with fields:

id: string ( Required )
archived: boolean ( Required )
name: string ( Required )
firstDate: string (format: full-date) ( Nullable and Optional , defaults to null)
lastDate: string (format: full-date) ( Nullable and Optional , defaults to null)
eventsCount: integer (format: int32) ( Required )
location: TD_Location ( Required )

PublicationDetails type

Name Type

className

string

Possible values:

KbPublicationDetails
BlogPublicationDetails

PublicationItem type

Name Type

className

string

Possible values:

DocumentFolderPublicationItem
PublicationItemStub
DocumentPublicationItem

PublicationItemStub type


No properties

PublishMessage type


object with fields: `id`: `string` ( Required )

PurchasedBillingPlan type

object with fields:

id: string ( Required )
jetSalesId: string ( Nullable and Optional , defaults to null)
plan: string ( Required )
billingPeriod: string ( Required )
since: string (format: full-date) ( Required )
till: string (format: full-date) ( Required )
currency: Currency ( Required )
addUserPrice: number (format: double) ( Required )
addStoragePrice: number (format: double) ( Required )
addBandwidthPrice: number (format: double) ( Required )
addCiCreditPrice: number (format: double) ( Required )
minActiveUsers: integer (format: int32) ( Required )
prepaidUsers: integer (format: int32) ( Required )
storagePerUser: integer (format: int32) ( Required )
storageOverall: integer (format: int32) ( Required )
bandwidthPerUser: integer (format: int32) ( Required )
bandwidthOverall: integer (format: int32) ( Required )
ciCredits: integer (format: int32) ( Required )
ciCreditsReserve: integer (format: int32) ( Required )
integrations: integer (format: int32) ( Required )
searchHistory: integer (format: int32) ( Required )
hardLimitAmount: number (format: double) ( Required )

QRCode type


object with fields: `width`: `integer` (format: int32) ( Required ) `base64Bitmap`: `string` ( Required )

ReactionData type


object with fields: `name`: `string` ( Required ) `symbol`: `string` ( Required ) `emoji`: `string` ( Required )

ReactionTypeRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `data`: `ReactionData` ( Required ) `provider`: `CPrincipal` ( Required ) `addedAt`: `string` (format: full-date) ( Required ) `order`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`)

RecurrenceRule type


object with fields: `freq`: `RecurrenceRuleFreq` ( Required ) `ends`: `RecurrenceRuleEnds` ( Required )

RecurrenceRuleEnds type

Name Type

className

string

Possible values:

RecurrenceRuleEnds.Never
RecurrenceRuleEnds.TotalCount
RecurrenceRuleEnds.OnDate

RecurrenceRuleEnds.Never type


No properties

RecurrenceRuleEnds.OnDate type


object with fields: `date`: `string` (format: full-date) ( Required )

RecurrenceRuleEnds.TotalCount type


object with fields: `count`: `integer` (format: int32) ( Required )

RecurrenceRuleFreq type

Name Type

className

string

Possible values:

RecurrenceRuleFreq.Daily
RecurrenceRuleFreq.Weekly
RecurrenceRuleFreq.MonthlyOnFirstWeekday
RecurrenceRuleFreq.MonthlyOnLastWeekday
RecurrenceRuleFreq.MonthlyOnDate
RecurrenceRuleFreq.MonthlyOnStartDate
RecurrenceRuleFreq.Yearly

RecurrenceRuleFreq.Daily type


object with fields: `interval`: `integer` (format: int32) ( Required )

RecurrenceRuleFreq.MonthlyOnDate type


object with fields: `day`: `integer` (format: int32) ( Required ) `interval`: `integer` (format: int32) ( Required )

RecurrenceRuleFreq.MonthlyOnFirstWeekday type


object with fields: `weekday`: `Weekday` ( Required ) `shift`: `integer` (format: int32) ( Required ) `interval`: `integer` (format: int32) ( Required )

RecurrenceRuleFreq.MonthlyOnLastWeekday type


object with fields: `weekday`: `Weekday` ( Required ) `interval`: `integer` (format: int32) ( Required )

RecurrenceRuleFreq.MonthlyOnStartDate type


object with fields: `interval`: `integer` (format: int32) ( Required )

RecurrenceRuleFreq.Weekly type


object with fields: `weekdays`: array of `Weekday` ( Required ) `interval`: `integer` (format: int32) ( Required )

RecurrenceRuleFreq.Yearly type


object with fields: `interval`: `integer` (format: int32) ( Required )

RepositoryActivity type


object with fields: `lastActivity`: array of object with fields: `first`: `string` (format: full-date) ( Required ) `second`: `integer` (format: int32) ( Required ) ( Required )

RepositoryCommitRecord type

object with fields:

id: string ( Required )
repositoryId: string ( Required )
repositoryName: string ( Required )
revision: string ( Required )
message: string ( Nullable and Optional , defaults to null)
date: string (format: date-time) ( Required )
authorName: string ( Nullable and Optional , defaults to null)
authorEmail: string ( Nullable and Optional , defaults to null)
committerName: string ( Nullable and Optional , defaults to null)
committerEmail: string ( Nullable and Optional , defaults to null)
authorProfile: TD_MemberProfile ( Nullable and Optional , defaults to null)

RepositoryInReview type


object with fields: `name`: `string` ( Required ) `deleted`: `boolean` ( Required )

RepositoryMenuActionContext type


object with fields: `menuId`: `string` ( Required ) `project`: `PR_Project` ( Required ) `repo`: `string` ( Required )

ResponsibilityRecord type


object with fields: `responsibilityId`: `string` ( Required ) `summary`: `string` ( Required ) `notes`: `string` ( Nullable and Optional , defaults to `null`) `assignedPeople`: array of `AssignedPerson` ( Required )

ReviewBranchTrackEvent type


object with fields: `repository`: `string` ( Required ) `branch`: `string` ( Required ) `track`: `boolean` ( Required )

ReviewCompletionStateChangedEvent type


object with fields: `state`: `ReviewerState` ( Required )

ReviewCounts type


object with fields: `opened`: `integer` (format: int32) ( Required ) `closed`: `integer` (format: int32) ( Required ) `authoredByMe`: `integer` (format: int32) ( Required ) `reviewedByMe`: `integer` (format: int32) ( Required ) `needsMyAttention`: `integer` (format: int32) ( Required ) `needsMyReview`: `integer` (format: int32) ( Required )

ReviewRevisionsChangedEvent type


object with fields: `commits`: array of `RepositoryCommitRecord` ( Required ) `changeType`: `ReviewRevisionsChangedType` ( Required ) `projectKey`: `string` ( Nullable and Optional , defaults to `null`) `review`: `CodeReviewRecord` ( Nullable and Optional , defaults to `null`)

ReviewStateChangedEvent type


object with fields: `state`: `CodeReviewState` ( Required ) `review`: `CodeReviewRecord` ( Nullable and Optional , defaults to `null`)

ReviewTitleChangedEvent type


object with fields: `oldTitle`: `string` ( Required ) `newTitle`: `string` ( Required )

ReviewerChangedEvent type


object with fields: `uid`: `TD_MemberProfile` ( Required ) `changeType`: `ReviewerChangedType` ( Required )

RevisionAuthor type


object with fields: `authorName`: `string` ( Required ) `profile`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`)

RevisionAuthorInfo type


object with fields: `revisionInfo`: `RevisionInfo` ( Required ) `author`: `RevisionAuthor` ( Required )

RevisionInReview type


object with fields: `repository`: `string` ( Required ) `commit`: `string` ( Required )

RevisionInfo type


object with fields: `revision`: `string` ( Required ) `date`: `integer` (format: int64) ( Required ) `message`: `string` ( Required )

RevisionsInReview type


object with fields: `repository`: `RepositoryInReview` ( Required ) `commits`: array of `GitCommitWithGraph` ( Required )

SSLKeystore type


object with fields: `name`: `string` ( Required ) `created`: `string` (format: full-date) ( Required )

SamlMetadataResponse type

Name Type

className

string

Possible values:

SamlMetadataResponse.Success
SamlMetadataResponse.Error

SamlMetadataResponse.Error type


object with fields: `messages`: array of `string` ( Required )

SamlMetadataResponse.Success type


object with fields: `metadata`: `string` ( Required )

SecretParameterRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `bundleId`: `string` ( Required ) `key`: `string` ( Required )

SettingsValue type

object with fields:

emailNotificationsEnabled: boolean ( Required )
firstDayOfWeek: Weekday ( Required )
themeName: string ( Nullable and Optional , defaults to null)
calendarView: string ( Nullable and Optional , defaults to null)
notificationEmail: TD_ProfileEmail ( Nullable and Optional , defaults to null)
draftType: DraftDocumentType ( Nullable and Optional , defaults to null)
todoFilters: boolean ( Nullable and Optional , defaults to null)

SpaceNewsFeedChannel type


object with fields: `notificationDefaults`: `ChannelSpecificDefaults` ( Nullable and Optional , defaults to `null`)

SprintRecord type

object with fields:

id: string ( Required )
archived: boolean ( Required )
board: BoardRecord ( Required )
name: string ( Required )
state: SprintState ( Required )
from: string (format: full-date) ( Required )
to: string (format: full-date) ( Required )
default: boolean ( Required )
description: string ( Nullable and Optional , defaults to null)

Sticker type

object with fields:

id: string ( Required )
symbol: string ( Nullable and Optional , defaults to null)
attachmentId: string ( Nullable and Optional , defaults to null)
width: integer (format: int32) ( Nullable and Optional , defaults to null)
height: integer (format: int32) ( Nullable and Optional , defaults to null)
variants: array of StickerVariant ( Nullable and Optional , defaults to null)
animated: boolean ( Nullable and Optional , defaults to null)
archived: boolean ( Required )

StickerContentDetails type


object with fields: `sticker`: `Sticker` ( Required ) `pack`: `StickerPackInfo` ( Nullable and Optional , defaults to `null`)

StickerPackInfo type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Required ) `favoriteByDefault`: `boolean` ( Required ) `archived`: `boolean` ( Required ) `private`: `boolean` ( Required ) `pack`: `StickerPackInfo` ( Required ) `addedAt`: `string` (format: date-time) ( Nullable and Optional , defaults to `null`) `stickers`: array of `Sticker` ( Required )

StickerVariant type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Nullable and Optional , defaults to `null`) `width`: `integer` (format: int32) ( Required ) `height`: `integer` (format: int32) ( Required )

StringCFConstraint type


object with fields: `min`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`) `max`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`) `pattern`: `string` ( Nullable and Optional , defaults to `null`) `message`: `string` ( Nullable and Optional , defaults to `null`)

StringCFType type


No properties

StringCFValue type


object with fields: `value`: `string` ( Nullable and Optional , defaults to `null`)

StringListCFType type


No properties

StringListCFValue type


object with fields: `values`: array of `string` ( Required )

SubjectResponsibilitiesTable type


object with fields: `subjectId`: `string` ( Required ) `name`: `string` ( Nullable and Optional , defaults to `null`) `reusedInProjects`: array of `string` ( Required ) `responsibilityRecords`: array of `ResponsibilityRecord` ( Required )

SupportProfileDTO type


object with fields: `profile`: `TD_MemberProfile` ( Required ) `adminPermissionsGranted`: `boolean` ( Required )

SyntaxMarkup type


object with fields: `type`: `SyntaxMarkupType` ( Nullable and Optional , defaults to `null`) `range`: `TextRange` ( Required )

TD_Language type


object with fields: `id`: `string` ( Required ) `code`: `string` ( Required ) `name`: `string` ( Required ) `nativeName`: `string` ( Required ) `firstNameTitle`: `string` ( Required ) `lastNameTitle`: `string` ( Required )

TD_Location type

object with fields:

id: string ( Required )
name: string ( Required )
timezone: ATimeZoneWithOffset ( Nullable and Optional , defaults to null)
tz: string ( Nullable and Optional , defaults to null)
workdays: array of integer (format: int32) ( Nullable and Optional , defaults to null)
phones: array of string ( Required )
emails: array of string ( Required )
equipment: array of string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
address: string ( Nullable and Optional , defaults to null)
parent: TD_Location ( Nullable and Optional , defaults to null)
type: string ( Required )
mapId: string ( Nullable and Optional , defaults to null)
capacity: integer (format: int32) ( Nullable and Optional , defaults to null)
channelId: string ( Nullable and Optional , defaults to null)
archived: boolean ( Required )

TD_LocationEquipmentType type


object with fields: `name`: `string` ( Required ) `archived`: `boolean` ( Required )

TD_LocationMap type


object with fields: `id`: `string` ( Required ) `picture`: `string` ( Required ) `created`: `string` (format: date-time) ( Required ) `width`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`) `height`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`)

TD_LocationMapPoint type

object with fields:

id: string ( Required )
mapId: string ( Nullable and Optional , defaults to null)
x: integer (format: int32) ( Required )
y: integer (format: int32) ( Required )
created: string (format: date-time) ( Required )
memberLocation: string ( Nullable and Optional , defaults to null)
deleted: boolean ( Nullable and Optional , defaults to null)

TD_LocationWithTimeZone type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Required ) `timezone`: `ATimeZoneWithOffset` ( Required )

TD_MemberInLocationMap type


object with fields: `profile`: `TD_MemberProfile` ( Required ) `memberLocation`: `TD_MemberLocation` ( Required ) `locationMapPoint`: `TD_LocationMapPoint` ( Nullable and Optional , defaults to `null`)

TD_MemberLocation type

object with fields:

id: string ( Required )
location: TD_Location ( Required )
locationMapPoints: array of TD_LocationMapPoint ( Nullable and Optional , defaults to null)
since: string (format: full-date) ( Nullable and Optional , defaults to null)
till: string (format: full-date) ( Nullable and Optional , defaults to null)
member: TD_MemberProfile ( Required )
archived: boolean ( Required )

TD_MemberProfile type

object with fields:

id: string ( Required )
username: string ( Required )
name: TD_ProfileName ( Required )
speaksEnglish: boolean ( Required )
smallAvatar: string ( Nullable and Optional , defaults to null)
avatar: string ( Nullable and Optional , defaults to null)
profilePicture: string ( Nullable and Optional , defaults to null)
languages: array of TD_ProfileLanguage ( Required )
archived: boolean ( Required )
notAMember: boolean ( Required )
joined: string (format: full-date) ( Nullable and Optional , defaults to null)
left: string (format: full-date) ( Nullable and Optional , defaults to null)
leftAt: string (format: date-time) ( Nullable and Optional , defaults to null)
membershipHistory: array of TD_Membership ( Required )
emails: array of TD_ProfileEmail ( Required )
phones: array of string ( Required )
messengers: array of string ( Required )
links: array of string ( Required )
about: string ( Nullable and Optional , defaults to null)
avatarCropSquare: AvatarCropSquare ( Nullable and Optional , defaults to null)
gender: Gender ( Nullable and Optional , defaults to null)
birthday: string (format: full-date) ( Nullable and Optional , defaults to null)
managers: array of TD_MemberProfile ( Required )
folder: DocumentFolderRecord ( Required )
absences: array of AbsenceRecord ( Required )
memberships: array of TD_Membership ( Required )
holidays: array of PublicHoliday ( Required )
logins: array of ES_ProfileLogin ( Required )
locations: array of TD_MemberLocation ( Required )
onboardingRequired: boolean ( Required )
showBannerOnLandingPage: boolean ( Nullable and Optional , defaults to null)
showBannerOnProjectPage: boolean ( Nullable and Optional , defaults to null)
showBannerOnTeamDirectoryHomePage: boolean ( Nullable and Optional , defaults to null)
customFields: key-value object of string keys and values of CFValue ( Required )

TD_MemberWithTeam type


object with fields: `profile`: `TD_MemberProfile` ( Required ) `teams`: array of `TD_Team` ( Required )

TD_Membership type

object with fields:

id: string ( Required )
member: TD_MemberProfile ( Nullable and Optional , defaults to null)
team: TD_Team ( Required )
role: TD_Role ( Required )
lead: boolean ( Required )
manager: TD_MemberProfile ( Nullable and Optional , defaults to null)
since: string (format: full-date) ( Nullable and Optional , defaults to null)
till: string (format: full-date) ( Nullable and Optional , defaults to null)
activeSince: string (format: date-time) ( Nullable and Optional , defaults to null)
activeTill: string (format: date-time) ( Nullable and Optional , defaults to null)
requiresApproval: boolean ( Required )
archived: boolean ( Required )
editFor: TD_Membership ( Nullable and Optional , defaults to null)
pendingEdit: TD_Membership ( Nullable and Optional , defaults to null)
approver: TD_MemberProfile ( Nullable and Optional , defaults to null)
customFields: key-value object of string keys and values of CFValue ( Required )

TD_MergedEvent type


object with fields: `events`: array of object with fields: `first`: `TD_Membership` ( Required ) `second`: `integer` (format: int32) ( Required ) ( Required ) `profile`: `TD_MemberProfile` ( Required )

TD_ProfileEmail type


object with fields: `id`: `string` ( Required ) `email`: `string` ( Required )

TD_ProfileLanguage type


object with fields: `name`: `TD_ProfileName` ( Nullable and Optional , defaults to `null`) `language`: `TD_Language` ( Required ) `languageCode`: `string` ( Nullable and Optional , defaults to `null`)

TD_ProfileName type


object with fields: `firstName`: `string` ( Required ) `lastName`: `string` ( Required )

TD_ProfileWorkingDays type


object with fields: `profile`: `TD_MemberProfile` ( Required ) `workingDays`: `TD_WorkingDays` ( Required )

TD_Role type


object with fields: `id`: `string` ( Required ) `name`: `string` ( Required ) `parent`: `TD_Role` ( Nullable and Optional , defaults to `null`) `archived`: `boolean` ( Required )

TD_Stats type

object with fields:

totalMembers: integer (format: int32) ( Required )
teams: array of object with fields:
- first: TD_Team ( Required )
- second: integer (format: int32) ( Required )
( Required )
roles: array of object with fields:
- first: TD_Role ( Required )
- second: integer (format: int32) ( Required )
( Required )
locations: array of object with fields:
- first: TD_Location ( Required )
- second: integer (format: int32) ( Required )
( Required )

TD_Team type

object with fields:

id: string ( Required )
name: string ( Required )
description: string ( Required )
parent: TD_Team ( Nullable and Optional , defaults to null)
emails: array of string ( Nullable and Optional , defaults to null)
channelId: string ( Nullable and Optional , defaults to null)
archived: boolean ( Required )
disbanded: boolean ( Nullable and Optional , defaults to null)
disbandedAt: string (format: full-date) ( Nullable and Optional , defaults to null)
externalId: string ( Nullable and Optional , defaults to null)
memberships: array of TD_Membership ( Required )
customFields: key-value object of string keys and values of CFValue ( Required )

TD_WorkingDays type


object with fields: `id`: `string` ( Required ) `dateStart`: `string` (format: full-date) ( Nullable and Optional , defaults to `null`) `dateEnd`: `string` (format: full-date) ( Nullable and Optional , defaults to `null`) `workingDaysSpec`: `WorkingDaysSpec` ( Required )

TeamAddedItemDetails type


object with fields: `team`: `TD_Team` ( Required )

TeamHitDetails type


object with fields: `ref`: `TD_Team` ( Required )

TeamMenuActionContext type


object with fields: `menuId`: `string` ( Required ) `team`: `TD_Team` ( Required )

TeamPermissionTarget type


object with fields: `team`: `string` ( Required )

TestFailedDTO type


No properties

TextDocument type


object with fields: `id`: `string` ( Required ) `resetCounter`: `integer` (format: int64) ( Required ) `version`: `integer` (format: int64) ( Nullable and Optional , defaults to `null`) `type`: `DraftDocumentType` ( Required ) `text`: `string` ( Required ) `model`: `string` ( Nullable and Optional , defaults to `null`)

TextRange type


object with fields: `start`: `integer` (format: int32) ( Required ) `length`: `integer` (format: int32) ( Required )

ThrottledLogin type


object with fields: `id`: `string` ( Required ) `login`: `string` ( Required ) `throttledUntil`: `string` (format: date-time) ( Required )

TimeInterval type


object with fields: `since`: `TimeOfDay` ( Required ) `till`: `TimeOfDay` ( Required )

TimeOfDay type


object with fields: `hours`: `integer` (format: int32) ( Required ) `minutes`: `integer` (format: int32) ( Required )

TimeOutDTO type


No properties

TodoContent type

object with fields:

originalText: string ( Required )
link: string ( Nullable and Optional , defaults to null)
kind: TodoItemContentKind ( Nullable and Optional , defaults to null)
principal: CPrincipal ( Nullable and Optional , defaults to null)
time: integer (format: int64) ( Nullable and Optional , defaults to null)
text: string ( Required )
extId: string ( Nullable and Optional , defaults to null)

TodoItemContent type

Name Type

className

string

Possible values:

TodoItemContentText
TodoItemContentMdText
TodoContent

TodoItemContentMdText type


object with fields: `text`: `string` ( Required ) `mdMarkup`: `MdMarkup` ( Required )

TodoItemContentText type


object with fields: `text`: `string` ( Required )

TodoItemRecord type


object with fields: `id`: `string` ( Required ) `archived`: `boolean` ( Required ) `created`: `string` (format: date-time) ( Required ) `updated`: `string` (format: date-time) ( Required ) `content`: `TodoItemContent` ( Required ) `_status`: `string` ( Required ) `dueDate`: `string` (format: full-date) ( Nullable and Optional , defaults to `null`)

TrackedBranchesInReview type


object with fields: `repository`: `string` ( Required ) `branches`: array of `BranchInfo` ( Required )

TrustedCertificate type


object with fields: `id`: `string` ( Required ) `alias`: `string` ( Required ) `data`: `string` ( Required ) `info`: `CertificateInfo` ( Required ) `archived`: `boolean` ( Required )

TwoFactorAuthenticationSecret type


object with fields: `secretKey`: `string` ( Required ) `qrCode`: `QRCode` ( Required ) `scratchCodes`: array of `integer` (format: int32) ( Required )

UA_JetBrainsUserAgreement type


object with fields: `content`: `string` ( Required ) `version`: `UA_Version` ( Required ) `updated`: `string` (format: date-time) ( Required )

UA_JetBrainsUserAgreementStatus type

Name Type

className

string

Possible values:

UA_JetBrainsUserAgreementStatus.NotAccepted
UA_JetBrainsUserAgreementStatus.Accepted

UA_JetBrainsUserAgreementStatus.Accepted type


object with fields: `profile`: `TD_MemberProfile` ( Required ) `version`: `UA_Version` ( Required ) `accepted`: `string` (format: date-time) ( Required )

UA_JetBrainsUserAgreementStatus.NotAccepted type


object with fields: `profile`: `TD_MemberProfile` ( Required )

UA_UserAgreement type


object with fields: `id`: `string` ( Required ) `content`: `string` ( Required ) `version`: `UA_Version` ( Required ) `updated`: `string` (format: date-time) ( Required )

UA_UserAgreementStatus type

Name Type

className

string

Possible values:

UA_UserAgreementStatus.NotAccepted
UA_UserAgreementStatus.Accepted

UA_UserAgreementStatus.Accepted type


object with fields: `profile`: `TD_MemberProfile` ( Required ) `userAgreement`: `UA_UserAgreement` ( Required ) `accepted`: `string` (format: date-time) ( Required )

UA_UserAgreementStatus.NotAccepted type


object with fields: `profile`: `TD_MemberProfile` ( Required )

UA_Version type


object with fields: `major`: `integer` (format: int32) ( Required ) `minor`: `integer` (format: int32) ( Required )

Unfurl type

object with fields:

title: string ( Required )
link: string ( Required )
text: string ( Required )
details: UnfurlDetails ( Nullable and Optional , defaults to null)
sitename: string ( Nullable and Optional , defaults to null)
image: string ( Nullable and Optional , defaults to null)
imageMime: string ( Nullable and Optional , defaults to null)
imageWidth: integer (format: int32) ( Nullable and Optional , defaults to null)
imageHeight: integer (format: int32) ( Nullable and Optional , defaults to null)
video: string ( Nullable and Optional , defaults to null)
videoIFrame: string ( Nullable and Optional , defaults to null)
videoMime: string ( Nullable and Optional , defaults to null)
videoHeight: integer (format: int32) ( Nullable and Optional , defaults to null)
videoWidth: integer (format: int32) ( Nullable and Optional , defaults to null)
favicon: string ( Nullable and Optional , defaults to null)

UnfurlAttachment type


object with fields: `unfurl`: `Unfurl` ( Required ) `id`: `string` ( Nullable and Optional , defaults to `null`)

UnfurlDetails type

Name Type

className

string

Possible values:

UnfurlDetailsDateTimeRange
UnfurlDetailsTeam
UnfurlDetailsChecklist
UnfurlDetailsDateTime
UnfurlDetailsIssueStatus
UnfurlDetailsSprint
AutomationJobExecutionUnfurlDetails
UnfurlDetailsArticle
UnfurlDetailsCodeSnippet
UnfurlDetailsIssueTag
UnfurlDetailsProfile
UnfurlDetailsLocation
UnfurlDetailsMeeting
UnfurlDetailsDraft
ChannelItemSnapshot
UnfurlDetailsMC
AutomationJobUnfurlDetails
UnfurlDetailsIssue

UnfurlDetailsArticle type


object with fields: `article`: `ArticleRecord` ( Required ) `content`: `ArticleContentRecord` ( Required ) `channel`: `ArticleChannelRecord` ( Required ) `details`: `ArticleDetailsRecord` ( Nullable and Optional , defaults to `null`)

UnfurlDetailsChecklist type


object with fields: `checklist`: `Checklist` ( Required )

UnfurlDetailsCodeSnippet type


object with fields: `anchor`: `CodeSnippetAnchor` ( Required ) `lines`: array of `CodeLine` ( Required )

UnfurlDetailsDateTime type


object with fields: `utcMilliseconds`: `integer` (format: int64) ( Required ) `params`: `DateTimeViewParams` ( Nullable and Optional , defaults to `null`)

UnfurlDetailsDateTimeRange type


object with fields: `since`: `integer` (format: int64) ( Required ) `till`: `integer` (format: int64) ( Required ) `params`: `DateTimeViewParams` ( Nullable and Optional , defaults to `null`)

UnfurlDetailsDraft type


object with fields: `draft`: `string` ( Required ) `title`: `string` ( Required )

UnfurlDetailsIssue type


object with fields: `issue`: `Issue` ( Required )

UnfurlDetailsIssueStatus type


object with fields: `status`: `IssueStatus` ( Required )

UnfurlDetailsIssueTag type


object with fields: `tag`: `PlanningTag` ( Required ) `strikeThrough`: `boolean` ( Required )

UnfurlDetailsLocation type


object with fields: `location`: `TD_Location` ( Required )

UnfurlDetailsMC type


object with fields: `message`: `MCMessage` ( Required ) `inlineUnfurls`: array of `AttachmentInfo` ( Nullable and Optional , defaults to `null`)

UnfurlDetailsMeeting type


object with fields: `meeting`: `DTO_Meeting` ( Required )

UnfurlDetailsProfile type


object with fields: `profile`: `TD_MemberProfile` ( Required )

UnfurlDetailsSprint type


object with fields: `project`: `PR_Project` ( Required ) `sprint`: `SprintRecord` ( Required )

UnfurlDetailsTeam type


object with fields: `team`: `TD_Team` ( Required )

UnfurlsBlockListEntry type


object with fields: `link`: `string` ( Required ) `prefix`: `boolean` ( Required ) `global`: `boolean` ( Required )

UrlCFType type


No properties

UrlCFValue type


object with fields: `href`: `string` ( Nullable and Optional , defaults to `null`)

VcsHostingPassword type


object with fields: `fingerprint`: `string` ( Required ) `lastUsed`: `string` (format: date-time) ( Nullable and Optional , defaults to `null`)

VideoAttachment type

object with fields:

id: string ( Required )
name: string ( Nullable and Optional , defaults to null)
width: integer (format: int32) ( Nullable and Optional , defaults to null)
height: integer (format: int32) ( Nullable and Optional , defaults to null)
sizeBytes: integer (format: int64) ( Required )
previewBytes: string ( Nullable and Optional , defaults to null)

VoteGroup type


object with fields: `variantName`: `string` ( Required ) `count`: `integer` (format: int32) ( Required ) `meVote`: `boolean` ( Required ) `lastUsers`: array of `TD_MemberProfile` ( Required ) `owner`: `TD_MemberProfile` ( Nullable and Optional , defaults to `null`)

WeekDayTimeInterval type


object with fields: `day`: `integer` (format: int32) ( Required ) `checked`: `boolean` ( Required ) `interval`: `TimeInterval` ( Required )

Workday type


object with fields: `weekday`: `string` ( Required ) `working`: `boolean` ( Required ) `hours`: `integer` (format: int32) ( Required ) `minutes`: `integer` (format: int32) ( Nullable and Optional , defaults to `null`)

WorkingDaysSpec type


object with fields: `days`: array of `Workday` ( Required ) `workingHours`: array of `WeekDayTimeInterval` ( Nullable and Optional , defaults to `null`) `notificationHours`: array of `WeekDayTimeInterval` ( Nullable and Optional , defaults to `null`)

ChatMessageIdentifier type

Possible values:

className: "ChatMessageIdentifier.InternalId"
id: string ( Required )
className: "ChatMessageIdentifier.ExternalId"
externalId: string ( Required )

ExtendedTypeScope type

Possible values:

className: "ExtendedTypeScope.Org"
className: "ExtendedTypeScope.Container"
containerId: string ( Required )

FTSQueryFilter type

Possible values:

className: "FTSQueryFilter.Channel"
channelId: string ( Required )
className: "FTSQueryFilter.Book"
bookId: string ( Required )
className: "FTSQueryFilter.Project"
projectId: string ( Required )

ImportExistsPolicy type

Possible values:

className: "ImportExistsPolicy.Skip"
className: "ImportExistsPolicy.Update"

ImportMissingPolicy type

Possible values:

className: "ImportMissingPolicy.Skip"
className: "ImportMissingPolicy.ReplaceWithDefault"

PackageRepositoryIdentifier type

Possible values:

className: "PackageRepositoryIdentifier.Id"
id: string ( Required )
className: "PackageRepositoryIdentifier.Key"
key: string ( Required )

ProfileIdentifier type

Possible values:

className: "ProfileIdentifier.Me"
className: "ProfileIdentifier.Id"
id: string ( Required )
className: "ProfileIdentifier.Username"
username: string ( Required )

ProjectIdentifier type

Possible values:

className: "ProjectIdentifier.Id"
id: string ( Required )
className: "ProjectIdentifier.Key"
key: string ( Required )

ReviewIdentifier type

Possible values:

className: "ReviewIdentifier.Id"
id: string ( Required )
className: "ReviewIdentifier.Key"
key: string ( Required )
className: "ReviewIdentifier.Number"
number: integer (format: int32) ( Required )

Enums

AbsenceListMode enum

Type : string

Possible values:

All
WithAccessibleReasonUnapproved
WithAccessibleReasonAll

AccessType enum

Type : string

Possible values:

PUBLIC
CONFIDENTIAL
RESTRICTED

BusyStatus enum

Type : string

Possible values:

Busy
Free

ChecklistSorting enum

Type : string

Possible values:

UPDATED
TITLE

ClientBrowser enum

Type : string

Possible values:

Other
Chrome
Firefox
Safari
Edge
Opera

ClientOS enum

Type : string

Possible values:

Other
Windows
MacOS
Linux
Android
iOS

CodeReviewParticipantRole enum

Type : string

Possible values:

Reviewer
Author
Watcher

CodeReviewState enum

Type : string

Possible values:

Opened
Closed
Deleted

CodeReviewStateFilter enum

Type : string

Possible values:

Opened
Closed
RequiresAuthorAttention
NeedsReview

ColumnSortOrder enum

Type : string

Possible values:

ASC
DESC

CommitExecutionStatus enum

Type : string

Possible values:

SCHEDULED
PENDING
READY_TO_START
FAILED_TO_START
RUNNING
FAILING
SUCCEEDED
TERMINATED
FAILED
HANGING

DiffLineType enum

Type : string

Possible values:

ADDED
DELETED
MODIFIED
CONFLICT_OLD
CONFLICT_NEW

DraftDocumentType enum

Type : string

Possible values:

WYSIWYG
MARKDOWN

EmojiSearchMatchType enum

Type : string

Possible values:

Name
OtherName
Emoticon
Unicode

EnumValueOrdering enum

Type : string

Possible values:

NAME_ASC
NAME_DESC

EventParticipationStatus enum

Type : string

Possible values:

GOING
NOT_GOING
NOT_SURE
WAITING_FOR_RESPONSE

ExecutionDisplayStatus enum

Type : string

Possible values:

Awaiting
Running
Stopped
Succeeded
Failed

ExecutionStatus enum

Type : string

Possible values:

SCHEDULED
PENDING
READY_TO_START
RUNNING
FINISHED
TERMINATED
FAILED

ExtendedTypeScopeType enum

Type : string

Possible values:

Org
Container

FeatureFlagStatus enum

Type : string

Possible values:

WIP
EXPERIMENTAL
INTERNAL

Gender enum

Type : string

Possible values:

Female
Male
Other
NotSpecified

GitGraphEdgeLineStyle enum

Type : string

Possible values:

SOLID
DASHED
DOTTED

GitGraphEdgeType enum

Type : string

Possible values:

UP
DOWN

HA_Method enum

Type : string

Possible values:

REST_CREATE
REST_QUERY
REST_GET
REST_UPDATE
REST_DELETE
HTTP_GET
HTTP_POST
HTTP_PATCH
HTTP_PUT
HTTP_DELETE

HA_Primitive enum

Type : string

Possible values:

Byte
Short
Int
Long
Float
Double
Boolean
String
Date
DateTime

HA_Type.Object.Kind enum

Type : string

Possible values:

PAIR
TRIPLE
BATCH
MOD
REQUEST_BODY

HierarchyRole enum

Type : string

Possible values:

SEALED
OPEN
FINAL
ABSTRACT
INTERFACE

InterpolatedLineState enum

Type : string

Possible values:

Normal
Deleted
Modified

IssuesSorting enum

Type : string

Possible values:

UPDATED
CREATED
TITLE
DUE

JobSubscriptionType enum

Type : string

Possible values:

ALL_FINISHED
FAILED

JobTriggerType enum

Type : string

Possible values:

MANUAL
GIT_PUSH
SCHEDULE
GIT_BRANCH_DELETED
CODE_REVIEW_OPENED
CODE_REVIEW_CLOSED

LdapModuleType enum

Type : string

Possible values:

AD
OPEN_LDAP

M2.Access enum

Type : string

Possible values:

Private
Public

M2EmailNotificationType enum

Type : string

Possible values:

INSTANT
DELAYED
NONE

M2ObsoleteCause enum

Type : string

Possible values:

PermissionsDenied

MeetingJoiningPreference enum

Type : string

Possible values:

NOBODY
EVERYONE

MeetingModificationPreference enum

Type : string

Possible values:

ORGANIZER
PARTICIPANTS
EVERYONE

MeetingOrigin enum

Type : string

Possible values:

User
GoogleCalendar

MeetingVisibility enum

Type : string

Possible values:

PARTICIPANTS
EVERYONE

MergeRequestBranchType enum

Type : string

Possible values:

SOURCE
TARGET

MessageButtonStyle enum

Type : string

Possible values:

PRIMARY
REGULAR
DANGER
SECONDARY

MessageStyle enum

Type : string

Possible values:

PRIMARY
SECONDARY
SUCCESS
ERROR
WARNING

NotificationFilter enum

Type : string

Possible values:

ALL_MESSAGES
MENTIONS
NOTHING
MUTE

OAuthServiceType enum

Type : string

Possible values:

Server
WebClient
Mobile
ServiceAccount

PackageRepositoryCredentials enum

Type : string

Possible values:

ANONYMOUS
PASSWORD
TOKEN
HEADER

PasswordStrength enum

Type : string

Possible values:

NO_POLICY
FAIR
GOOD
STRONG

ProfileOrder enum

Type : string

Possible values:

DEFAULT
FULL_NAME

ProjectTeamType enum

Type : string

Possible values:

LEGACY
MEMBERS
ATTACHED

RecurrentModification enum

Type : string

Possible values:

Me
SinceMe
All

RepositoryState enum

Type : string

Possible values:

READY
IN_PROGRESS
ERROR

ReviewRevisionsChangedType enum

Type : string

Possible values:

Created
Added
Removed

ReviewSorting enum

Type : string

Possible values:

CreatedAtAsc
CreatedAtDesc
LastUpdatedAsc
LastUpdatedDesc

ReviewType enum

Type : string

Possible values:

CommitSetReview
MergeRequest

ReviewerChangedType enum

Type : string

Possible values:

Joined
Left

ReviewerState enum

Type : string

Possible values:

Accepted
Rejected

SprintState enum

Type : string

Possible values:

CLOSED
CURRENT
PLANNED

SyntaxMarkupType enum

Type : string

Possible values:

KEYWORD
COMMENT
NUM_LITERAL
STRING_LITERAL
DECLARATION
PARAMETER_ASSIGNMENT
IDENTIFIER
IDENTIFIER_TYPE
IDENTIFIER_DECLARATION
ANNOTATION
PREPROCESSOR_ANNOTATION
PREPROCESSOR_MESSAGE
HIGHLIGHT
SKIP

TodoItemContentKind enum

Type : string

Possible values:

NONE
REGULAR
MESSAGE
ISSUE
BLOG
DOCUMENT

TwoFactorAuthenticationStatus enum

Type : string

Possible values:

NOT_SETUP
INACTIVE
ACTIVE

UnfurlDateTimeFormat enum

Type : string

Possible values:

RELATIVE_TO_NOW
FULL
TIME_ONLY
DATE_ONLY

UnfurlDateTimeStyle enum

Type : string

Possible values:

REGULAR
SECONDARY
STRIKETHROUGH
BOLD
CODE

Weekday enum

Type : string

Possible values:

SUNDAY
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY

Last modified: 18 August 2021