JetBrains Space Help

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

AbsenceApprovalWebhookEvent type

object with fields:

AbsenceCommonSubscriptionFilter type

object with fields:

AbsenceCommonSubscriptionFilterIn type

object with fields:

  • reasons: array of string Required

AbsenceEvent type

object with fields:

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

AbsenceWebhookEvent type

object with fields:

  • meta: KMetaMod Required

  • absence: AbsenceRecord Required

  • member: TD_MemberProfile Required

  • icon: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

  • reason: object with fields:

    ( 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)

  • location: object with fields:

    ( Nullable and Optional , defaults to null)

  • available: object with fields:

    • old: boolean Required

    • new: boolean Required

    ( Nullable and Optional , defaults to null)

AccessRecord type

object with fields:

  • time: string (format: date-time) Required

  • address: string Required

  • userAgent: string ( Nullable and Optional , defaults to null)

AdHocConnectedAppMetadata type

object with fields:

  • lastSentServerUrl: string ( Nullable and Optional , defaults to null)

  • connectionStatus: AppConnectionStatus ( 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:

ApiIcon type

object with fields:

  • icon: string Required

AppMessageDeliveryDTO type

object with fields:

  • id: string Required

  • messageType: AppMessageDeliveryType Required

  • webhook: WebhookRecord ( Nullable and Optional , defaults to null)

  • deliveryId: string ( Nullable and Optional , defaults to null)

  • successful: boolean Required

  • sentAt: string (format: date-time) Required

  • duration: string Required

  • method: string Required

  • url: string ( Nullable and Optional , defaults to null)

  • requestHeaders: array of HttpHeaderDTO ( Nullable and Optional , defaults to null)

  • requestBody: string ( Nullable and Optional , defaults to null)

  • responseStatusCode: integer (format: int32) ( Nullable and Optional , defaults to null)

  • responseHeaders: array of HttpHeaderDTO ( Nullable and Optional , defaults to null)

  • responseBody: string ( Nullable and Optional , defaults to null)

  • httpClientError: AppMessageDeliveryDTO.ClientErrorDTO ( Nullable and Optional , defaults to null)

AppMessageDeliveryDTO.ClientErrorDTO type

object with fields:

  • className: string Required

  • message: string ( Nullable and Optional , defaults to null)

  • causeClassName: string ( Nullable and Optional , defaults to null)

  • causeMessage: string ( Nullable and Optional , defaults to null)

AppPublicationCheckPayload type

No properties

ApplicationAuthorizationRequestedEvent type

object with fields:

ApplicationAuthorizedWebhookEvent type

object with fields:

ApplicationMetadata type

Name

Type

className

string

Possible values:

ApplicationPayload type

Name

Type

className

string

Possible values:

ApplicationSshKeyWebhookEvent type

object with fields:

  • meta: KMetaMod Required

  • application: ES_App Required

  • fingerprint: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

  • comment: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

ApplicationUnfurl type

object with fields:

ApplicationUnfurlContent type

Name

Type

className

string

Possible values:

ApplicationUnfurlContent.BlockMarkdown type

object with fields:

  • icon: ApiIcon ( Nullable and Optional , defaults to null)

  • title: string Required

  • markdown: string Required

ApplicationUnfurlContent.Image type

object with fields:

ApplicationUnfurlContent.InlineMarkdown type

object with fields:

  • markdown: string Required

ApplicationUnfurlContent.MC type

object with fields:

ApplicationUnfurlContentImageSource type

Name

Type

className

string

Possible values:

ApplicationUnfurlContentImageSource.Attachment type

object with fields:

  • id: string Required

ApplicationUnfurlContentImageSource.Url type

object with fields:

  • url: string Required

ApplicationUnfurlContext type

Name

Type

className

string

Possible values:

ApplicationUnfurlDomain type

object with fields:

  • domain: string Required

  • status: RightStatus Required

  • modificationAuthor: CPrincipal ( Nullable and Optional , defaults to null)

  • modificationTimestamp: string (format: date-time) ( Nullable and Optional , defaults to null)

ApplicationUnfurlPattern type

object with fields:

  • prefix: string Required

  • linkReplacement: string Required

  • status: RightStatus Required

  • modificationAuthor: CPrincipal ( Nullable and Optional , defaults to null)

  • modificationTimestamp: string (format: date-time) ( Nullable and Optional , defaults to null)

ApplicationUnfurlPatternRequest type

object with fields:

  • prefix: string Required

  • linkReplacement: string Required

ApplicationUnfurlQueueItem type

object with fields:

  • id: string Required

  • target: string Required

  • context: ApplicationUnfurlContext ( Nullable and Optional , defaults to null)

  • contextLinkForAuthor: string ( Nullable and Optional , defaults to null)

  • authorUserId: ProfileIdentifier ( Nullable and Optional , defaults to null)

  • etag: integer (format: int64) Required

ApplicationUnfurlQueueItemsCreatedEvent type

No properties

ApplicationUnfurlTarget type

Name

Type

className

string

Possible values:

ApplicationUnfurlTarget.Domain type

object with fields:

  • domain: string Required

ApplicationUnfurlTarget.Pattern type

object with fields:

  • pattern: string Required

ApplicationUnfurlTargetsRequestedEvent type

object with fields:

ApplicationWebhookEvent type

object with fields:

  • meta: KMetaMod Required

  • application: ES_App Required

  • name: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

  • owner: object with fields:

    ( Nullable and Optional , defaults to null)

  • archived: object with fields:

    • old: boolean Required

    • new: boolean Required

    ( Nullable and Optional , defaults to null)

  • endpointURI: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

  • clientIdChanged: boolean Required

  • clientSecretChanged: boolean Required

  • verificationTokenChanged: boolean Required

  • signingKeyChanged: boolean Required

ApplicationsSubscriptionFilter type

object with fields:

  • application: ES_App ( Nullable and Optional , defaults to null)

ApplicationsSubscriptionFilterIn type

object with fields:

  • application: string ( Nullable and Optional , defaults to null)

ArticleChannelRecord type

object with fields:

ArticleContentRecord type

object with fields:

  • id: string Required

  • archived: boolean Required

  • content: string Required

  • attachments: array of AttachmentInfo ( Nullable and Optional , defaults to null)

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)

  • 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)

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

  • previewAttachments: array of AttachmentInfo ( Nullable and Optional , defaults to null)

  • 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)

  • 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)

  • content: string Required

  • attachments: array of AttachmentInfo ( Nullable and Optional , defaults to null)

  • previewImages: array of ArticleMarkdownImage Required

  • preview: string Required

  • previewAttachments: array of AttachmentInfo ( Nullable and Optional , defaults to null)

  • wordsNumber: integer (format: int32) ( Nullable and Optional , defaults to null)

  • cut: boolean ( Nullable and Optional , defaults to null)

  • channel: M2ChannelRecord Required

  • channelContent: M2ChannelContentRecord ( Nullable and Optional , defaults to null)

  • reactions: AllReactionsToItemRecord Required

  • editable: boolean 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

className

string

Possible values:

AttachmentIn type

Name

Type

className

string

Possible values:

AttachmentInfo type

object with fields:

  • details: Attachment ( Nullable and Optional , defaults to null)

AuthModuleUsage type

object with fields:

AuthScope type

Name

Type

className

string

Possible values:

AutomationJobEvent type

object with fields:

  • meta: KMetaMod Required

  • executionId: string Required

  • project: PR_Project Required

  • repositoryName: string Required

  • jobName: string Required

  • executionNumber: integer (format: int64) Required

  • trigger: JobExecutionTrigger Required

  • triggerTime: string (format: date-time) Required

  • status: object with fields:

    ( Nullable and Optional , defaults to null)

  • failureReasons: object with fields:

    ( Nullable and Optional , defaults to null)

  • stoppedBy: object with fields:

    ( Nullable and Optional , defaults to null)

  • startTime: object with fields:

    • old: string (format: date-time) Required

    • new: string (format: date-time) Required

    ( Nullable and Optional , defaults to null)

  • endTime: object with fields:

    • old: string (format: date-time) Required

    • new: string (format: date-time) Required

    ( Nullable and Optional , defaults to null)

AutomationJobExecutionUnfurlDetails type

object with fields:

  • jobExecutionId: string Required

  • projectRef: PR_Project Required

  • repoName: string Required

AutomationJobSubscriptionFilter type

object with fields:

  • projects: array of PR_Project Required

  • repositoryName: string ( Nullable and Optional , defaults to null)

  • branchSpec: array of string ( Nullable and Optional , defaults to null)

  • jobs: array of string ( Nullable and Optional , defaults to null)

AutomationJobSubscriptionFilterIn type

object with fields:

  • projects: array of string ( Nullable and Optional , defaults to null)

  • repositoryName: string ( Nullable and Optional , defaults to null)

  • branchSpec: array of string ( Nullable and Optional , defaults to null)

  • jobs: array of string ( Nullable and Optional , defaults to null)

AutomationJobUnfurlDetails type

object with fields:

  • jobId: string Required

  • jobName: string Required

  • projectRef: PR_Project Required

  • repoName: string Required

  • jobExecutionDisplayStatusFilter: JobExecutionDisplayStatus ( Nullable and Optional , defaults to null)

  • jobTriggerFilter: JobTriggerType ( Nullable and Optional , defaults to null)

  • branch: Branch ( Nullable and Optional , defaults to null)

AutomationServiceMetadata type

object with fields:

AutonumberCFParameters type

object with fields:

  • prefix: string Required

  • suffix: string Required

AutonumberCFType type

No properties

AutonumberCFValue type

object with fields:

  • value: string ( 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_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:

    Required

BaseMenuActionContext type

object with fields:

  • menuId: string Required

BillingFeedChannel type

object with fields:

BillingReport type

object with fields:

  • plans: array of PurchasedBillingPlan Required

  • reportDays: array of BillingReportDay Required

  • bandwidthAllocation: integer (format: int64) ( Nullable and Optional , defaults to null)

  • ciAllocation: integer (format: int64) ( Nullable and Optional , defaults to null)

  • serverToday: string (format: full-date) Required

  • earliestBillingDate: string (format: full-date) Required

BillingReportDay type

object with fields:

  • date: string (format: full-date) Required

  • activeUsers: integer (format: int32) Required

  • userUsage: integer (format: int32) Required

  • userCost: number (format: double) Required

  • storageAllocationB: integer (format: int64) ( Nullable and Optional , defaults to null)

  • storageTotalUsage: integer (format: int64) Required

  • storageFilesUsage: integer (format: int64) Required

  • storageGitUsage: integer (format: int64) Required

  • storagePackagesUsage: integer (format: int64) Required

  • storageCost: number (format: double) Required

  • bandwidthTotalUsageDelta: integer (format: int64) Required

  • bandwidthTotalUsage: integer (format: int64) Required

  • bandwidthFilesUsageDelta: integer (format: int64) Required

  • bandwidthFilesUsage: integer (format: int64) Required

  • bandwidthGitUsageDelta: integer (format: int64) Required

  • bandwidthGitUsage: integer (format: int64) Required

  • bandwidthPackagesUsageDelta: integer (format: int64) Required

  • bandwidthPackagesUsage: integer (format: int64) Required

  • bandwidthAutomationExternalTrafficUsageDelta: integer (format: int64) Required

  • bandwidthAutomationExternalTrafficUsage: integer (format: int64) Required

  • bandwidthAutomationInternalUsageDelta: integer (format: int64) Required

  • bandwidthAutomationInternalUsage: integer (format: int64) Required

  • bandwidthCost: number (format: double) Required

  • ciUsageDelta: integer (format: int64) Required

  • ciUsage: integer (format: int64) Required

  • ciCost: number (format: double) Required

  • appUsage: integer (format: int64) Required

  • chatUsage: integer (format: int64) Required

  • totalCost: number (format: double) Required

BirthdayEvent type

object with fields:

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)

BlogCommonSubscriptionFilter type

object with fields:

BlogCommonSubscriptionFilterIn type

object with fields:

  • teams: array of string Required

  • locations: array of string Required

  • authors: array of string Required

BlogPublicationDetails type

object with fields:

  • teams: array of TD_Team ( 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)

BlogPublicationDetailsIn type

object with fields:

  • teams: array of string ( Nullable and Optional , defaults to null)

  • locations: array of string ( Nullable and Optional , defaults to null)

  • event: CalendarEventIn ( Nullable and Optional , defaults to null)

  • article: string ( Nullable and Optional , defaults to null)

BlogWebhookEvent type

object with fields:

  • meta: KMetaMod Required

  • article: ArticleRecord Required

  • action: string ( Nullable and Optional , defaults to null)

  • author: object with fields:

    ( Nullable and Optional , defaults to null)

  • created: object with fields:

    • old: string (format: date-time) Required

    • new: string (format: date-time) Required

    ( Nullable and Optional , defaults to null)

  • title: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

  • textChanged: boolean Required

  • unpublished: object with fields:

    • old: boolean Required

    • new: boolean Required

    ( Nullable and Optional , defaults to null)

  • teams: object with fields:

    ( Nullable and Optional , defaults to null)

  • locations: object with fields:

    ( Nullable and Optional , defaults to null)

  • externalEntityInfo: object with fields:

    • old: integer (format: int64) Required

    • new: integer (format: int64) Required

    ( Nullable and Optional , defaults to null)

BoardColumn type

object with fields:

BoardColumns type

object with fields:

BoardInfo type

object with fields:

BoardMemberOwners type

object with fields:

BoardOwners type

object with fields:

BoardRecord type

object with fields:

  • id: string Required

  • archived: boolean Required

  • name: string Required

  • info: BoardInfo Required

  • from: string (format: full-date) ( Nullable and Optional , defaults to null)

  • to: string (format: full-date) ( Nullable and Optional , defaults to null)

BoardTeamOwners type

object with fields:

BookContainerInfo type

object with fields:

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

CApplicationPrincipalDetails type

object with fields:

CAutomationTaskPrincipalDetails type

object with fields:

CBuiltInServicePrincipalDetails type

object with fields:

  • name: string Required

CFCommitIdentifier type

Name

Type

className

string

Possible values:

CFCommitIdentifier.CommitHash type

object with fields:

  • commitHash: string Required

CFCommitIdentifier.Full type

object with fields:

CFCommitInfoBase type

Name

Type

className

string

Possible values:

CFCommitInfoBase.CFCommitInfo type

object with fields:

CFCommitInfoBase.PermissionDenied type

object with fields:

  • commitHash: string Required

CFConstraint type

Name

Type

className

string

Possible values:

CFCreateParameters type

Name

Type

className

string

Possible values:

CFEnumValue type

object with fields:

  • id: string Required

  • value: string Required

  • principal: CPrincipalDetails ( Nullable and Optional , defaults to null)

CFEnumValueModification type

Name

Type

className

string

Possible values:

CFEnumValueModification.Create type

object with fields:

  • name: string Required

CFEnumValueModification.Remove type

object with fields:

CFEnumValueModification.Update type

object with fields:

CFEnumValuesModification type

object with fields:

CFInputValue type

Name

Type

className

string

Possible values:

CFParameters type

Name

Type

className

string

Possible values:

CFType type

Name

Type

className

string

Possible values:

CFUpdateParameters type

Name

Type

className

string

Possible values:

CFValue type

Name

Type

className

string

Possible values:

CPrincipal type

object with fields:

CPrincipalDetails type

Name

Type

className

string

Possible values:

CRight type

object with fields:

  • typeCode: string Required

  • code: string Required

  • title: string Required

  • description: string ( Nullable and Optional , defaults to null)

  • featureFlag: FeatureFlag ( Nullable and Optional , defaults to null)

CUserPrincipalDetails type

object with fields:

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)

CalendarEventIn 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 string ( 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)

CallSession type

object with fields:

  • id: string Required

  • archived: boolean Required

  • room: Room Required

  • description: string Required

  • start: string (format: date-time) Required

  • end: string (format: date-time) ( Nullable and Optional , defaults to null)

  • channel: M2ChannelRecord ( Nullable and Optional , defaults to null)

  • topology: ConnectionTopology ( Nullable and Optional , defaults to null)

  • resourcesPrepared: boolean Required

CallSessionUnfurlDetails type

object with fields:

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

ChangeClientSecretPayload type

object with fields:

  • newClientSecret: string Required

  • clientId: string Required

  • userId: string ( Nullable and Optional , defaults to null)

  • verificationToken: string ( Nullable and Optional , defaults to null)

ChangeInReview type

object with fields:

ChangeServerUrlPayload type

object with fields:

  • newServerUrl: string Required

  • clientId: string Required

  • userId: string ( Nullable and Optional , defaults to null)

  • verificationToken: string ( Nullable and Optional , defaults to null)

ChannelAttachmentMenuActionContext type

object with fields:

  • menuId: string Required

  • channelId: string Required

ChannelContactThread type

Name

Type

className

string

Possible values:

ChannelEvent type

object with fields:

  • meta: KMetaMod Required

  • channel: M2ChannelRecord Required

  • name: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

  • description: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

  • icon: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

  • restored: boolean ( Nullable and Optional , defaults to null)

  • archived: boolean ( Nullable and Optional , defaults to null)

ChannelInfoAttachment type

object with fields:

  • details: Attachment ( Nullable and Optional , defaults to null)

  • time: string (format: date-time) Required

  • messageId: string Required

  • channelId: string Required

  • contactKey: 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)

  • 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)

ChannelPermissionContext type

object with fields:

ChannelSpecificDefaults type

object with fields:

  • subscribed: boolean ( Nullable and Optional , defaults to null)

  • filter: NotificationFilter Required

  • push: boolean Required

  • email: M2EmailNotificationType Required

  • threadsSubscribed: boolean ( Nullable and Optional , defaults to null)

ChatHistoryRange type

object with fields:

ChatMessage type

Name

Type

className

string

Possible values:

ChatMessage.Block type

object with fields:

ChatMessage.Text type

object with fields:

  • text: string Required

ChatMessageUnfurlContext type

object with fields:

ChatModification type

Name

Type

className

string

Possible values:

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)

  • issue: Issue ( 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)

ChecklistBodyIn type

Name

Type

className

string

Possible values:

ChecklistDocumentBody type

object with fields:

  • checklist: Checklist Required

  • canConvertItemsToIssues: boolean Required

ChecklistDocumentBodyCreateIn type

object with fields:

  • projectId: string ( Nullable and Optional , defaults to null)

  • bodyIn: ChecklistBodyIn ( Nullable and Optional , defaults to null)

ChecklistDocumentBodyEditIn type

object with fields:

  • description: string ( Nullable and Optional , defaults to null)

  • owner: string ( Nullable and Optional , defaults to null)

  • tag: string ( Nullable and Optional , defaults to null)

  • topics: array of string ( Optional )

  • bodyIn: ChecklistBodyIn ( 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)

ClientSideActionContext type

Name

Type

className

string

Possible values:

CodeDiscussionAddedFeedEvent type

object with fields:

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

  • project: PR_Project ( Nullable and Optional , defaults to null)

  • anchor: CodeDiscussionAnchor Required

  • endAnchor: CodeDiscussionAnchor ( Nullable and Optional , defaults to null)

  • created: string (format: date-time) Required

  • channel: M2ChannelRecord Required

  • resolvable: boolean ( Nullable and Optional , defaults to null)

  • resolved: boolean Required

  • snippet: CodeDiscussionSnippet ( Nullable and Optional , defaults to null)

  • resolvedBy: CPrincipal ( 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.InlineDiffSnippet type

object with fields:

CodeDiscussionSnippet.PlainSnippet type

object with fields:

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:

CodeReviewDiscussionAddedFeedEvent type

object with fields:

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 ( Nullable and Optional , defaults to null)

  • resolved: boolean ( Nullable and Optional , defaults to null)

  • archived: boolean Required

CodeReviewParticipant type

object with fields:

CodeReviewParticipantCodeOwnerSlot type

object with fields:

  • rule: array of string ( Nullable and Optional , defaults to null)

  • pattern: string Required

CodeReviewParticipantQualityGateSlot type

object with fields:

  • rule: array of string Required

  • index: integer (format: int32) Required

CodeReviewParticipantRecord type

object with fields:

CodeReviewParticipantSlotBase type

Name

Type

className

string

Possible values:

CodeReviewParticipants type

object with fields:

CodeReviewPendingMessageCounter type

object with fields:

  • id: string Required

  • archived: boolean Required

CodeReviewRecord type

Name

Type

className

string

Possible values:

CodeReviewSubscriptionFilter type

object with fields:

  • project: PR_Project ( Nullable and Optional , defaults to null)

  • repository: string ( Nullable and Optional , defaults to null)

  • authors: array of TD_MemberProfile Required

  • participants: array of TD_MemberProfile Required

  • branchSpec: array of string Required

  • pathSpec: array of string Required

  • titleRegex: string Required

CodeReviewSubscriptionFilterIn type

object with fields:

  • project: string ( Nullable and Optional , defaults to null)

  • repository: string ( Nullable and Optional , defaults to null)

  • authors: array of string Required

  • participants: array of string Required

  • branchSpec: array of string Required

  • pathSpec: array of string Required

  • titleRegex: string Required

CodeReviewUnboundDiscussionCounter type

object with fields:

  • id: string Required

CodeReviewUnfurlContext type

object with fields:

  • reviewId: string Required

CodeReviewWebhookEvent type

object with fields:

  • projectKey: ProjectKey Required

  • repository: string Required

  • reviewId: string Required

  • title: string Required

  • isMergeRequest: boolean Required

CodeReviewWithCount type

object with fields:

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:

CommitInfo type

object with fields:

  • project: PR_Project Required

  • repository: string Required

  • commitId: string Required

  • message: string Required

  • commitDate: string (format: date-time) Required

  • authorName: string Required

  • authorEmail: string Required

  • authorProfile: TD_MemberProfile ( Nullable and Optional , defaults to null)

Name

Type

className

string

Possible values:

CommitMessageUnfurlContext type

object with fields:

CommitMessageUnfurlsRecord type

object with fields:

  • id: string Required

  • unfurls: array of Unfurl Required

CommitSetReviewRecord type

object with fields:

ComputePoolKey type

object with fields:

  • value: string Required

ConfigurePermissionsAction type

object with fields:

ContactCFParameters type

object with fields:

  • contactKind: TD_ContactKind ( Nullable and Optional , defaults to null)

ContactCFType type

No properties

ContactCFValue type

object with fields:

  • value: string ( Nullable and Optional , defaults to null)

ContactListCFType type

No properties

ContactListCFValue type

object with fields:

  • values: array of string 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

  • pinned: boolean Required

  • comment: string ( Nullable and Optional , defaults to null)

  • 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

  • hasCents: 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)

  • deleted: boolean ( Nullable and Optional , defaults to null)

  • parameters: CFParameters ( Nullable and Optional , defaults to null)

  • archived: boolean Required

CustomFieldData type

object with fields:

  • id: string Required

  • name: string Required

  • type: CustomFieldType Required

  • multivalued: boolean Required

  • parameters: CFParameters ( Nullable and Optional , defaults to null)

  • required: boolean Required

  • defaultValue: CFValue Required

  • constraint: CFConstraint ( Nullable and Optional , defaults to null)

  • description: string ( Nullable and Optional , defaults to null)

  • order: integer (format: int32) Required

  • archived: boolean Required

CustomFieldInputValue type

object with fields:

CustomFieldValue type

object with fields:

CustomFieldValueData type

object with fields:

CustomFieldValueUpdate type

object with fields:

CustomFieldsRecord type

object with fields:

CustomGenericSubscriptionIn type

object with fields:

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)

  • archivedBy: CPrincipal ( Nullable and Optional , defaults to null)

  • archivedAt: string (format: date-time) ( Nullable and Optional , defaults to null)

  • publicationDetails: PublicationDetails ( Nullable and Optional , defaults to null)

  • publicationDetails2: PublicationDetails ( Nullable and Optional , defaults to null)

  • author: TD_MemberProfile ( Nullable and Optional , defaults to null)

  • createdBy: CPrincipal ( Nullable and Optional , defaults to null)

  • published: boolean ( Nullable and Optional , defaults to null)

  • folder: DocumentFolderRecord ( Nullable and Optional , defaults to null)

  • folderRef: DocumentFolder ( Nullable and Optional , defaults to null)

  • containerInfo: DocumentContainerInfo Required

  • accessOrdinal: integer (format: int32) Required

  • editors: array of TD_MemberProfile Required

  • editorsTeams: array of TD_Team Required

  • documentBody: DocumentBody Required

  • bodyType: DocumentBodyType Required

DR_DraftHeader type

object with fields:

  • id: string Required

  • title: string Required

  • author: TD_MemberProfile Required

  • createdBy: CPrincipal ( Nullable and Optional , defaults to null)

  • 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

  • publicationDetails: PublicationDetails ( Nullable and Optional , defaults to null)

  • publicationDetails2: PublicationDetails ( Nullable and Optional , defaults to null)

  • deleted: boolean ( Nullable and Optional , defaults to null)

  • archivedBy: CPrincipal ( Nullable and Optional , defaults to null)

  • archivedAt: string (format: date-time) ( Nullable and Optional , defaults to null)

  • folder: DocumentFolderRecord ( Nullable and Optional , defaults to null)

  • folderRef: DocumentFolder ( Nullable and Optional , defaults to null)

  • containerInfo: DocumentContainerInfo Required

  • bodyType: DocumentBodyType Required

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)

  • conferenceData: EventConferenceData ( Nullable and Optional , defaults to null)

  • channelRef: M2ChannelRecord ( Nullable and Optional , defaults to null)

DTO_MeetingRSVP type

object with fields:

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:

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:

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)

DateTimeCFConstraint type

object with fields:

  • min: string (format: date-time) ( Nullable and Optional , defaults to null)

  • max: string (format: date-time) ( Nullable and Optional , defaults to null)

  • message: string ( Nullable and Optional , defaults to null)

DateTimeCFType type

No properties

DateTimeCFValue type

object with fields:

  • value: string (format: date-time) ( 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

DeletePersonalFeedAction type

object with fields:

  • feed: string Required

  • feedId: string ( Nullable and Optional , defaults to null)

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:

DiffSide type

Name

Type

className

string

Possible values:

DiffSide.Empty type

object with fields:

  • revision: string Required

DiffSide.NonEmpty type

object with fields:

  • revision: string Required

  • path: string Required

Document type

object with fields:

  • id: string Required

  • title: string Required

  • publicationDetails: PublicationDetails ( Nullable and Optional , defaults to null)

  • folderRef: DocumentFolder ( Nullable and Optional , defaults to null)

  • bodyType: DocumentBodyType Required

  • archived: boolean Required

  • archivedBy: CPrincipal ( Nullable and Optional , defaults to null)

  • archivedAt: string (format: date-time) ( Nullable and Optional , defaults to null)

  • createdBy: CPrincipal ( Nullable and Optional , defaults to null)

  • created: string (format: date-time) ( Nullable and Optional , defaults to null)

  • modifiedBy: CPrincipal ( Nullable and Optional , defaults to null)

  • modified: string (format: date-time) Required

  • documentBody: DocumentBody Required

DocumentBody type

Name

Type

className

string

Possible values:

DocumentBodyCreateIn type

Name

Type

className

string

Possible values:

DocumentBodyUpdateIn type

Name

Type

className

string

Possible values:

DocumentCFInputValue type

object with fields:

  • documentId: string ( Nullable and Optional , defaults to null)

DocumentCFParameters type

object with fields:

DocumentCFParametersInput type

object with fields:

DocumentCFScope type

Name

Type

className

string

Possible values:

DocumentCFScope.Project type

object with fields:

DocumentCFScopeInput type

Name

Type

className

string

Possible values:

DocumentCFScopeInput.Project type

object with fields:

  • projectId: string Required

DocumentCFType type

No properties

DocumentCFValue type

object with fields:

  • document: Document ( Nullable and Optional , defaults to null)

DocumentContainerInfo type

Name

Type

className

string

Possible values:

DocumentCustomSubscriptionFilter type

object with fields:

  • project: PR_Project ( Nullable and Optional , defaults to null)

  • books: array of KB_Book ( Nullable and Optional , defaults to null)

  • folders: array of KbFolderItem ( Nullable and Optional , defaults to null)

  • documents: array of KbDocumentItem Required

DocumentCustomSubscriptionFilterIn type

object with fields:

  • project: string ( Nullable and Optional , defaults to null)

  • books: array of string ( Nullable and Optional , defaults to null)

  • folders: array of string ( Nullable and Optional , defaults to null)

  • documents: array of string Required

DocumentEditorsChangedEvent type

object with fields:

DocumentFolder type

object with fields:

  • id: string Required

  • archived: boolean Required

  • parent: DocumentFolder ( Nullable and Optional , defaults to null)

  • name: string Required

  • created: string (format: date-time) Required

  • createdBy: CPrincipal ( Nullable and Optional , defaults to null)

  • updated: string (format: date-time) Required

  • updatedBy: CPrincipal ( Nullable and Optional , defaults to null)

DocumentFolderRecord type

object with fields:

DocumentFolderWithChildren type

object with fields:

DocumentHistoryUnfurlDetails type

object with fields:

  • document: string Required

  • title: string Required

  • version: string (format: date-time) ( Nullable and Optional , defaults to null)

  • base: string (format: date-time) ( Nullable and Optional , defaults to null)

  • preview: string (format: date-time) ( Nullable and Optional , defaults to null)

DocumentInContainer type

object with fields:

  • id: string Required

  • archived: boolean Required

  • containerLinkId: string Required

  • title: string Required

  • author: TD_MemberProfile ( Nullable and Optional , defaults to null)

  • createdBy: CPrincipal ( Nullable and Optional , defaults to null)

  • 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

  • publicationDetails: PublicationDetails ( Nullable and Optional , defaults to null)

  • publicationDetails2: PublicationDetails ( Nullable and Optional , defaults to null)

  • folderRef: DocumentFolder ( Nullable and Optional , defaults to null)

  • containerInfo: DocumentContainerInfo Required

  • bodyType: DocumentBodyType Required

  • deleted: boolean Required

  • archivedBy: CPrincipal ( Nullable and Optional , defaults to null)

  • archivedAt: string (format: date-time) ( Nullable and Optional , defaults to null)

  • published: boolean ( Nullable and Optional , defaults to null)

  • accessOrdinal: integer (format: int32) Required

  • documentBody: DocumentBody Required

DocumentListCFInputValue type

object with fields:

  • documents: array of string Required

DocumentListCFType type

No properties

DocumentListCFValue type

object with fields:

DocumentMetaWebhookEvent type

object with fields:

  • meta: KMetaMod Required

  • document: string Required

  • deleted: object with fields:

    • old: boolean Required

    • new: boolean Required

    ( Nullable and Optional , defaults to null)

  • published: object with fields:

    • old: boolean Required

    • new: boolean Required

    ( Nullable and Optional , defaults to null)

DocumentWebhookEvent type

object with fields:

  • meta: KMetaMod Required

  • document: string Required

  • changeAuthors: array of CPrincipal Required

  • version: string (format: date-time) Required

  • base: string (format: date-time) Required

DryCleanupResults type

Name

Type

className

string

Possible values:

DryCleanupResults.Failure type

object with fields:

  • error: string Required

DryCleanupResults.Results type

object with fields:

ES_App type

object with fields:

  • id: string Required

  • owner: TD_MemberProfile ( Nullable and Optional , defaults to null)

  • ownerApp: ES_App ( Nullable and Optional , defaults to null)

  • clientId: string Required

  • name: string Required

  • picture: string ( Nullable and Optional , defaults to null)

  • defaultExternalPicture: string ( Nullable and Optional , defaults to null)

  • createdAt: string (format: date-time) ( Nullable and Optional , defaults to null)

  • kind: string ( Nullable and Optional , defaults to null)

  • presentableName: string ( Nullable and Optional , defaults to null)

  • applicationType: ApplicationType ( Nullable and Optional , defaults to null)

  • clientCredentialsFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • codeFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • codeFlowRedirectURIs: string ( Nullable and Optional , defaults to null)

  • pkceRequired: boolean ( Nullable and Optional , defaults to null)

  • implicitFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • implicitFlowRedirectURIs: string ( 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)

  • hasPublicKeySignature: boolean ( Nullable and Optional , defaults to null)

  • endpointSslVerification: boolean ( Nullable and Optional , defaults to null)

  • basicAuthUsername: string ( Nullable and Optional , defaults to null)

  • hasBearerToken: boolean ( Nullable and Optional , defaults to null)

  • sslKeystoreAuth: string ( Nullable and Optional , defaults to null)

  • archived: boolean Required

  • patterns: array of ApplicationUnfurlPattern Required

  • domains: array of ApplicationUnfurlDomain Required

  • metadata: ApplicationMetadata ( Nullable and Optional , defaults to null)

  • settings: ES_AppSettings Required

ES_AppSettings type

object with fields:

  • clientCredentialsFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • codeFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • codeFlowRedirectURIs: string ( Nullable and Optional , defaults to null)

  • pkceRequired: boolean ( Nullable and Optional , defaults to null)

  • implicitFlowEnabled: boolean ( Nullable and Optional , defaults to null)

  • implicitFlowRedirectURIs: string ( Nullable and Optional , defaults to null)

  • endpoint: EndpointDTO Required

  • endpointAuth: EndpointAuthDTO Required

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_ApplicationPermanentToken type

object with fields:

  • id: string Required

  • name: string Required

  • application: ES_App Required

  • scope: string Required

  • created: string (format: date-time) Required

  • expires: string (format: date-time) ( Nullable and Optional , defaults to null)

  • 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_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

  • retentionPolicyParams: RetentionPolicyParams ( Nullable and Optional , defaults to null)

  • immutablePackageVersions: boolean ( Nullable and Optional , defaults to null)

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_FederatedAuthModuleSettings type

Name

Type

className

string

Possible values:

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

  • retentionPolicyParams: RetentionPolicyParams ( Nullable and Optional , defaults to null)

  • immutablePackageVersions: boolean ( Nullable and Optional , defaults to null)

ES_NpmRegistrySettings type

object with fields:

  • retentionPolicyParams: RetentionPolicyParams ( Nullable and Optional , defaults to null)

  • immutablePackageVersions: boolean ( Nullable and Optional , defaults to null)

ES_NuGetFeedSettings type

object with fields:

  • retentionPolicyParams: RetentionPolicyParams ( Nullable and Optional , defaults to null)

  • immutablePackageVersions: boolean ( Nullable and Optional , defaults to null)

ES_OAuth2AuthModuleSettings type

Name

Type

className

string

Possible values:

ES_OAuthConsent type

object with fields:

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_PasswordAuthModuleSettings type

Name

Type

className

string

Possible values:

ES_PersonalToken type

object with fields:

  • id: string Required

  • name: string Required

  • profile: TD_MemberProfile Required

  • scope: string Required

  • created: string (format: date-time) Required

  • expires: string (format: date-time) ( Nullable and Optional , defaults to null)

  • lastAccess: AccessRecord ( Nullable and Optional , defaults to null)

ES_ProfileLogin type

object with fields:

ES_ProfileLoginDetails type

Name

Type

className

string

Possible values:

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_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

EbsSnapshotApi type

object with fields:

  • snapshotId: string Required

  • snapshotName: string ( Nullable and Optional , defaults to null)

  • snapshotState: SnapshotState Required

  • execution: integer (format: int64) ( Nullable and Optional , defaults to null)

  • claimId: integer (format: int64) ( Nullable and Optional , defaults to null)

EbsVolumeApi type

object with fields:

  • volumeId: string Required

  • volumeName: string Required

  • az: string ( Nullable and Optional , defaults to null)

  • volumeState: VolumeState Required

  • execution: integer (format: int64) ( Nullable and Optional , defaults to null)

  • claimId: integer (format: int64) ( Nullable and Optional , defaults to null)

EcsTaskContainerInfo type

object with fields:

  • name: string Required

  • lastStatus: string ( Nullable and Optional , defaults to null)

  • exitCode: integer (format: int32) ( Nullable and Optional , defaults to null)

  • reason: string ( Nullable and Optional , defaults to null)

EcsTaskInfoApi type

object with fields:

  • taskArn: string Required

  • containers: array of EcsTaskContainerInfo Required

  • desiredStatus: DesiredStatus Required

  • lastStatus: DesiredStatus Required

  • startedAt: integer (format: int64) ( Nullable and Optional , defaults to null)

  • pullStartedAt: integer (format: int64) ( Nullable and Optional , defaults to null)

  • stoppedAt: integer (format: int64) ( Nullable and Optional , defaults to null)

  • execution: integer (format: int64) Required

EditMessage type

object with fields:

  • text: string Required

  • id: string Required

  • attachments: array of Attachment ( Nullable and Optional , defaults to null)

EmailBouncedEvent type

object with fields:

  • email: string Required

  • reason: string Required

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

EndpointAuthCreate type

Name

Type

className

string

Possible values:

EndpointAuthCreate.Basic type

object with fields:

  • username: string Required

  • password: string Required

EndpointAuthCreate.Bearer type

object with fields:

  • token: string Required

EndpointAuthCreate.PublicKeySignature type

No properties

EndpointAuthCreate.SigningKey type

No properties

EndpointAuthDTO type

object with fields:

EndpointAuthRead type

Name

Type

className

string

Possible values:

EndpointAuthRead.Basic type

object with fields:

  • username: string Required

EndpointAuthRead.Bearer type

No properties

EndpointAuthRead.PublicKeySignature type

No properties

EndpointAuthRead.SigningKey type

No properties

EndpointAuthRead.Unknown type

No properties

EndpointDTO type

object with fields:

  • url: string ( Nullable and Optional , defaults to null)

  • sslVerification: boolean Required

EnumCFInputParameters type

object with fields:

  • values: array of string Required

EnumCFInputValue type

object with fields:

EnumCFParameters type

object with fields:

EnumCFType type

object with fields:

EnumCFValue type

object with fields:

EnumListCFInputValue type

object with fields:

EnumListCFType type

object with fields:

EnumListCFValue type

object with fields:

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

EventConferenceData type

object with fields:

EventSubjectInfoDTO type

object with fields:

  • code: string Required

  • parentCode: string ( Nullable and Optional , defaults to null)

  • name: string Required

  • description: string Required

  • events: array of EventTypeInfoDTO Required

  • defaultFilters: array of SubscriptionFilter Required

  • featureFlag: string ( Nullable and Optional , defaults to null)

EventTypeInfoDTO type

object with fields:

  • code: string Required

  • name: string Required

  • description: string Required

  • rights: array of CRight Required

  • featureFlag: string ( Nullable and Optional , defaults to null)

  • sortOrder: integer (format: int32) 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)

ExternalLinkPattern type

object with fields:

  • id: string Required

  • archived: boolean Required

  • prefix: string Required

  • linkReplacement: string Required

FailureConditionDTO type

Name

Type

className

string

Possible values:

FeatureFlag type

object with fields:

  • name: string Required

  • description: string Required

  • status: FeatureFlagStatus Required

  • owner: string Required

  • since: FeatureFlagDate ( Nullable and Optional , defaults to null)

  • issueNumber: integer (format: int32) ( Nullable and Optional , defaults to null)

FeatureFlagDate type

object with fields:

  • year: integer (format: int32) Required

  • month: integer (format: int32) Required

  • day: integer (format: int32) Required

FeatureFlagWebhookEvent type

object with fields:

  • meta: KMetaMod Required

  • name: string Required

  • issueNumber: integer (format: int32) ( Nullable and Optional , defaults to null)

  • enabledForAll: object with fields:

    • old: boolean Required

    • new: boolean Required

    ( Nullable and Optional , defaults to null)

  • selfManageable: object with fields:

    • old: boolean Required

    • new: boolean Required

    ( Nullable and Optional , defaults to null)

  • addedTeams: array of TD_Team ( Nullable and Optional , defaults to null)

  • addedProfiles: array of TD_Team ( Nullable and Optional , defaults to null)

  • removedTeams: array of TD_MemberProfile ( Nullable and Optional , defaults to null)

  • removedProfiles: array of TD_MemberProfile ( Nullable and Optional , defaults to null)

FeedEvent type

Name

Type

className

string

Possible values:

FileAttachment type

object with fields:

  • id: string Required

  • sizeBytes: integer (format: int64) Required

  • filename: string Required

FileBodySource type

Name

Type

className

string

Possible values:

FileBodySource.Blob type

object with fields:

  • blobId: string Required

FileBodySource.Upload type

object with fields:

  • uploadId: string Required

FileDocumentBody type

Name

Type

className

string

Possible values:

FileDocumentBody.Blob type

object with fields:

  • versionId: string Required

  • mediaType: string Required

  • fileSize: integer (format: int64) Required

FileDocumentBody.Upload type

object with fields:

  • versionId: string Required

  • mediaType: string ( Nullable and Optional , defaults to null)

  • uploading: boolean Required

FileDocumentBodyCreateIn type

object with fields:

FileDocumentBodyUpdateIn type

object with fields:

Fingerprint type

object with fields:

  • md5: string Required

  • sha1: string Required

  • sha256: string Required

  • sha384: string Required

  • sha512: string Required

Fraction type

object with fields:

  • numerator: integer (format: int32) Required

  • denominator: integer (format: int32) Required

FractionCFType type

No properties

FractionCFValue type

object with fields:

  • value: Fraction ( Nullable and Optional , defaults to null)

GitAuthorInfo type

object with fields:

  • name: string Required

  • email: string Required

GitCommitChange type

object with fields:

  • changeType: GitCommitChangeType Required

  • old: GitFile ( Nullable and Optional , defaults to null)

  • new: GitFile ( Nullable and Optional , defaults to null)

  • revision: string Required

  • diffSize: GitDiffSize ( Nullable and Optional , defaults to null)

  • path: string ( Nullable and Optional , defaults to null)

GitCommitChanges type

object with fields:

GitCommitFileRequest type

object with fields:

GitCommitInfo type

object with fields:

  • id: string Required

  • message: string Required

  • authorDate: integer (format: int64) Required

  • commitDate: integer (format: int64) Required

  • author: GitAuthorInfo Required

  • authorProfile: TD_MemberProfile ( Nullable and Optional , defaults to null)

  • committer: GitAuthorInfo Required

  • committerProfile: TD_MemberProfile ( Nullable and Optional , defaults to null)

  • parents: array of string Required

  • heads: array of string Required

  • signature: GitCommitSignature ( Nullable and Optional , defaults to null)

GitCommitInfoWithChanges type

object with fields:

GitCommitResult type

object with fields:

  • fromHead: string ( Nullable and Optional , defaults to null)

  • toHead: string ( Nullable and Optional , defaults to null)

  • success: boolean Required

  • message: string Required

  • resultCommitId: string ( Nullable and Optional , defaults to null)

GitCommitSignature type

Name

Type

className

string

Possible values:

GitCommitSignature.NotVerified type

No properties

GitCommitSignature.Raw type

object with fields:

  • signature: string Required

  • signedDataB64: string Required

GitCommitSignature.RevokedKey type

object with fields:

  • description: string Required

  • revokeComment: string ( Nullable and Optional , defaults to null)

GitCommitSignature.Verified type

object with fields:

  • description: string Required

GitCommitWithGraph type

object with fields:

GitCommitterProfile type

object with fields:

  • author: string Required

  • email: string Required

  • profile: TD_MemberProfile ( Nullable and Optional , defaults to null)

GitDiffSize type

object with fields:

  • added: integer (format: int32) Required

  • deleted: integer (format: int32) Required

GitFile type

object with fields:

  • commit: string Required

  • path: string Required

  • blob: string Required

  • type: GitEntryType Required

GitFileContent type

Name

Type

className

string

Possible values:

GitFileContent.Base64 type

object with fields:

  • value: string Required

  • executable: boolean ( Nullable and Optional , defaults to null)

GitFileContent.Deleted type

No properties

GitFileContent.Text type

object with fields:

  • value: string Required

  • executable: boolean ( Nullable and Optional , defaults to null)

GitGraphLayoutEdge type

object with fields:

GitGraphLayoutLine type

object with fields:

GitGraphLayoutNode type

object with fields:

  • pos: integer (format: int32) Required

  • color: integer (format: int32) Required

GitMergeResultHttp type

object with fields:

  • status: GitMergeStatusHttp Required

  • resultCommitId: string ( Nullable and Optional , defaults to null)

GitMergedFile type

object with fields:

  • name: string Required

  • oldName: string ( Nullable and Optional , defaults to null)

  • baseId: string ( Nullable and Optional , defaults to null)

  • sourceId: string ( Nullable and Optional , defaults to null)

  • targetId: string ( Nullable and Optional , defaults to null)

  • diffSize: GitDiffSize ( Nullable and Optional , defaults to null)

  • entryType: GitEntryType Required

  • conflicting: boolean Required

GitRebaseResultHttp type

object with fields:

  • resultCommitIds: array of string Required

GlobalNotificationSettings type

object with fields:

  • emailNotificationsEnabled: boolean Required

  • notificationEmail: TD_ProfileEmail ( Nullable and Optional , defaults to null)

  • pushNotificationEnabled: boolean Required

  • desktopInactivityTimeout: integer (format: int32) ( Nullable and Optional , defaults to null)

  • multiClientEnabled: boolean Required

GlobalPermissionContext type

No properties

GlobalPermissionTarget type

No properties

GlobalScope type

No properties

GpgKeyData type

object with fields:

  • fingerprint: string Required

  • publicKey: string Required

  • userId: string Required

  • verified: boolean Required

  • comment: string Required

  • created: string (format: date-time) Required

  • added: string (format: date-time) Required

  • expires: string (format: date-time) ( Nullable and Optional , defaults to null)

  • revoked: boolean Required

  • revokeComment: string ( Nullable and Optional , defaults to null)

HA_DefaultValue type

Name

Type

className

string

Possible values:

HA_DefaultValue.Collection type

object with fields:

HA_DefaultValue.Const type

Name

Type

className

string

Possible values:

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:

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:

HA_DtoField type

object with fields:

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:

HA_Parameter type

object with fields:

HA_Path type

object with fields:

HA_PathSegment type

Name

Type

className

string

Possible values:

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.Array type

object with fields:

  • elementType: HA_Type Required

  • nullable: boolean Required

  • tags: array of string Required

HA_Type.Dto type

object with fields:

  • dto: HA_Dto Required

  • nullable: boolean Required

  • tags: array of string Required

HA_Type.Enum type

object with fields:

  • enum: HA_Enum Required

  • nullable: boolean Required

  • tags: array of string Required

HA_Type.Map type

object with fields:

  • valueType: HA_Type Required

  • nullable: boolean Required

  • tags: array of string Required

HA_Type.Object type

object with fields:

HA_Type.Primitive type

object with fields:

  • primitive: HA_Primitive Required

  • nullable: boolean Required

  • tags: array of string Required

HA_Type.Ref type

object with fields:

  • dto: HA_Dto Required

  • nullable: boolean Required

  • tags: array of string Required

HA_Type.UrlParam type

object with fields:

HA_UrlParameter type

object with fields:

HA_UrlParameterOption type

Name

Type

className

string

Possible values:

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

  • parameters: array of HA_Field Required

  • prefixRequired: boolean Required

  • optionName: string Required

  • deprecation: HA_Deprecation ( Nullable and Optional , defaults to null)

HolidaysEvent type

object with fields:

HttpHeaderDTO type

object with fields:

  • name: string Required

  • maskedValue: boolean Required

  • values: array of string 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:

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

ImportTransactionRecord type

object with fields:

  • id: string Required

  • archived: boolean Required

  • importer: CPrincipal Required

  • externalSource: string Required

  • imported: string (format: date-time) Required

InaccessibleContainerInfo type

No properties

InaccessibleDocumentBody type

object with fields:

InitPayload type

object with fields:

  • clientSecret: string Required

  • serverUrl: string Required

  • state: string ( Nullable and Optional , defaults to null)

  • clientId: string Required

  • userId: string Required

  • verificationToken: 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

IntelliJSharedIndexNamedUploadUrl type

object with fields:

IntelliJSharedIndexUploadUrl type

object with fields:

  • url: string Required

  • method: string Required

IntelliJSharedIndexUploadUrls type

object with fields:

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)

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

  • team: TD_Team ( Nullable and Optional , defaults to null)

  • position: TD_Role ( Nullable and Optional , defaults to null)

  • 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)

  • externalEntityInfo: ExternalEntityInfoRecord ( Nullable and Optional , defaults to null)

  • tags: array of PlanningTag Required

  • title: string Required

  • attachmentsCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • topics: array of Topic 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

  • customFields: key-value object of string keys and values of CFValue Required

IssueAssigneeChangedDetails type

object with fields:

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)

IssueCFInputValue type

object with fields:

IssueCFType type

No properties

IssueCFValue type

object with fields:

  • issue: Issue ( Nullable and Optional , defaults to null)

IssueChangedM2Details type

Name

Type

className

string

Possible values:

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)

IssueCodeChangesMCExtension type

No properties

IssueCommits type

object with fields:

  • id: string Required

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)

IssueListCFInputValue type

object with fields:

IssueListCFType type

No properties

IssueListCFValue type

object with fields:

IssueMCExtension type

No properties

IssueMentionedDetails type

object with fields:

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:

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:

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

IssueWebhookCustomFieldUpdate type

object with fields:

IssueWebhookEvent type

object with fields:

  • meta: KMetaMod Required

  • issue: Issue Required

  • title: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

  • description: object with fields:

    • old: string Required

    • new: string Required

    ( Nullable and Optional , defaults to null)

  • assignee: object with fields:

    ( Nullable and Optional , defaults to null)

  • status: object with fields:

    ( Nullable and Optional , defaults to null)

  • dueDate: object with fields:

    • old: string (format: full-date) Required

    • new: string (format: full-date) Required

    ( Nullable and Optional , defaults to null)

  • tagDelta: object with fields:

    ( Nullable and Optional , defaults to null)

  • topicDelta: object with fields:

    ( Nullable and Optional , defaults to null)

  • checklistDelta: object with fields:

    ( Nullable and Optional , defaults to null)

  • sprintDelta: object with fields:

    ( Nullable and Optional , defaults to null)

  • customFieldUpdate: IssueWebhookCustomFieldUpdate ( Nullable and Optional , defaults to null)

  • deleted: object with fields:

    • old: boolean Required

    • new: boolean Required

    ( Nullable and Optional , defaults to null)

JobDTO type

object with fields:

JobExecutionDTO type

object with fields:

  • executionId: string Required

  • executionNumber: integer (format: int64) Required

  • jobId: string Required

  • jobName: string Required

  • projectId: 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)

  • changesCount: integer (format: int32) Required

  • predictedEndTime: EstimationDTO ( Nullable and Optional , defaults to null)

  • failureConditions: array of FailureConditionDTO Required

JobExecutionTrigger type

Name

Type

className

string

Possible values:

JobExecutionTrigger.CodeReviewClosed type

object with fields:

  • reviewId: string Required

JobExecutionTrigger.CodeReviewOpened type

object with fields:

  • reviewId: string Required

JobExecutionTrigger.GitBranchDeleted type

object with fields:

  • branches: array of string Required

JobExecutionTrigger.GitPush type

object with fields:

  • commit: string Required

JobExecutionTrigger.Manual type

object with fields:

JobExecutionTrigger.Schedule type

No properties

JobSubscription type

object with fields:

JobSubscriptionState type

object with fields:

K8sContainerInfo type

object with fields:

  • taskId: string Required

  • graphExec: string Required

  • name: string Required

  • lastStatus: RuntimeStatus Required

  • exitCode: integer (format: int32) ( Nullable and Optional , defaults to null)

  • reason: string ( Nullable and Optional , defaults to null)

  • message: string ( Nullable and Optional , defaults to null)

  • startedAt: integer (format: int64) ( Nullable and Optional , defaults to null)

  • stoppedAt: integer (format: int64) ( Nullable and Optional , defaults to null)

K8sEventLabels type

object with fields:

  • startedBy: string ( Nullable and Optional , defaults to null)

  • stepExec: string Required

  • graphExec: string ( Nullable and Optional , defaults to null)

K8sJobInfo type

object with fields:

K8sLocationInfo type

object with fields:

  • cluster: string Required

  • namespace: string Required

  • taskId: string Required

K8sPodInfo type

object with fields:

  • taskId: string Required

  • graphExec: string Required

  • status: RuntimeStatus Required

  • message: string ( Nullable and Optional , defaults to null)

  • containers: array of K8sContainerInfo Required

KB_Article type

object with fields:

  • id: string Required

  • archived: boolean Required

  • title: string Required

  • book: KB_Book Required

  • folder: KB_Folder Required

  • documentId: string Required

  • document: DocumentInContainer ( Nullable and Optional , defaults to null)

  • documentRef: Document Required

  • created: string (format: date-time) Required

  • createdBy: CPrincipal ( Nullable and Optional , defaults to null)

  • updated: string (format: date-time) Required

  • 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

KB_BookContext type

Name

Type

className

string

Possible values:

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) Required

  • createdBy: CPrincipal ( Nullable and Optional , defaults to null)

  • updated: string (format: date-time) Required

  • updatedBy: CPrincipal ( Nullable and Optional , defaults to null)

KMetaMod type

object with fields:

  • principal: CPrincipal Required

  • timestamp: string (format: date-time) Required

  • method: string Required

KbDocumentContainerInfo type

object with fields:

KbDocumentItem type

object with fields:

  • book: KB_Book Required

  • articleId: string Required

  • id: string Required

  • name: string Required

  • path: array of string Required

  • containerLinkId: string ( Nullable and Optional , defaults to null)

KbFolderItem type

object with fields:

  • book: KB_Book Required

  • id: string Required

  • name: string Required

  • path: array of string Required

KbNoneContext type

No properties

KbPersonalContext type

object with fields:

KbProjectContext type

object with fields:

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.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:

  • clientId: string Required

  • userId: string ( Nullable and Optional , defaults to null)

  • verificationToken: string ( Nullable and Optional , defaults to null)

ListMenuExtensionsPayload type

object with fields:

  • clientId: string Required

  • userId: string ( Nullable and Optional , defaults to null)

  • verificationToken: string ( Nullable and Optional , defaults to null)