JetBrains Space
 
  1. Extend Space
  2. Space HTTP API
  3. API Reference

API Reference

Last modified: 06 September 2023

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:

  • meta: KMetaMod ( Required )

  • absence: AbsenceRecord ( Required )

  • member: TD_MemberProfile ( Required )

  • approved: object with fields:

    • old: boolean ( Required )

    • new: boolean ( Required )

    ( Required )

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 )

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

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

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)

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

  • uninstallationStatus: AppUninstallationStatus ( Nullable and Optional , defaults to null)

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

  • archived: boolean ( Required )

AllReactionsToItemRecord type

object with fields:

  • id: string ( Required )

  • emojiReactions: array of EmojiReactionRecord ( Nullable and Optional , defaults to null)

AnyOfCFFilter type

Name

Type

className

string

Possible values:

AnyOfFilter type

object with fields:

AnyOfFilterValue type

Name

Type

className

string

Possible values:

ApiIcon type

object with fields:

  • icon: string ( Required )

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

AppParameter type

object with fields:

  • key: string ( Required )

  • value: string ( Required )

AppPublicationCheckPayload type

No properties

AppUiEnabledState type

object with fields:

  • enabledByDefault: boolean ( Required )

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

AppUiExtContextData type

object with fields:

AppUiExtensionApi type

Name

Type

className

string

Possible values:

AppUiExtensionIn type

Name

Type

className

string

Possible values:

AppUserActionExecutionResult type

Name

Type

className

string

Possible values:

AppUserActionExecutionResult.AuthCodeFlowRequired type

object with fields:

AppUserActionExecutionResult.Failure type

object with fields:

  • message: string ( Required )

AppUserActionExecutionResult.Success type

object with fields:

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

ApplicationAuthorizationRequestedEvent type

object with fields:

ApplicationAuthorizedWebhookEvent type

object with fields:

ApplicationHomepageUiExtensionApi type

object with fields:

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

ApplicationHomepageUiExtensionIn type

object with fields:

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

    If specified, overrides the default URL for the application homepage iframe. The default URL is <application endpoint> /iframe/app-homepage

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

object with fields:

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

    Optional icon to appear in the header above the image

  • title: string ( Required )

    Header text

  • url: string ( Required )

    Image url.

    Space will download and store this image to your organization at the moment of link preview processing, so that further changes of the image available on that url won ' t affect the already generated link preview.

ApplicationUnfurlContent.Message type

object with fields:

  • style: MessageStyle ( Required )

    Default style for outline and sections

  • outline: MessageOutlineBase ( Nullable and Optional , defaults to null)

    Line of elements appearing above the main body of the message

  • sections: array of MessageSectionElement ( Required )

    List of sections of the message

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 )

    Prefix that is used in external IDs and that will be recognised by Space to generate links

  • linkReplacement: string ( Required )

    URL of the external resource ending with < ? > which is a variable for a number that follows the prefix.

    If the specified prefix should be a part of the URL, include it before < ? >.

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

    Prefix that is used in external IDs and that will be recognised by Space to generate links

  • linkReplacement: string ( Required )

    URL of the external resource ending with < ? > which is a variable for a number that follows the prefix.

    If the specified prefix should be a part of the URL, include it before < ? >.

ApplicationUnfurlQueueItem type

object with fields:

  • id: string ( Required )

  • target: string ( Required )

    External url that the preview is being provided for

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

    Describes the context in which this link appears in Space

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

    Space user that has posted the link

  • etag: integer (format: int64) ( Required )

    Monotonically increasing counter that should be used by the application to fetch unprocessed queue items only

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 )

ApplicationUnfurlTargetWebhookEvent type

object with fields:

ApplicationUninstalledPayload type

object with fields:

  • serverUrl: string ( Required )

  • clientId: string ( Required )

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

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

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)

ArticleAppUnfurlContext type

object with fields:

  • articleId: string ( Required )

ArticleChannelRecord type

object with fields:

ArticleContentRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • content: string ( Required )

    warning

    Deprecated since 2023-05-30: Use docContent property instead. It will be removed in a future version.

ArticleDetailsRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • event: MeetingRecord ( 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)

  • docContent: TextDocumentContent ( Required )

  • attachments: array of AttachmentInfo ( 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)

  • content: string ( Required )

    warning

    Deprecated since 2023-05-30: Use docContent property instead. It will be removed in a future version.

  • event: MeetingRecord ( 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)

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

AttachmentUnfurlDetails type

Name

Type

className

string

Possible values:

AuthCodeFlowPermissionsRequest type

object with fields:

  • scope: string ( Required )

  • purpose: string ( Required )

AuthConfig type

object with fields:

  • dontRememberMeTtl: integer (format: int32) ( Required )

  • adminRememberMeTtl: integer (format: int32) ( Required )

  • userRememberMeTtl: integer (format: int32) ( Required )

AuthModuleUsage type

object with fields:

  • authModule: ES_AuthModule ( Required )

  • profiles: integer (format: int32) ( Required )

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)

  • repositories: array of GitCheckout ( 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:

AutonumberCFFilter type

object with fields:

  • query: string ( Required )

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)

AvailableTrial type

object with fields:

  • tier: Tier ( Required )

  • durationDays: integer (format: int32) ( Required )

AvatarCropSquare type

object with fields:

  • x: integer (format: int32) ( Required )

  • y: integer (format: int32) ( Required )

  • length: integer (format: int32) ( Required )

AzureRegisterNewUserRule type

object with fields:

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:

    • first: TD_Location ( Required )

    • second: integer (format: int32) ( Required )

    ( Required )

BOMDiff type

object with fields:

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

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

BacklogType type

Name

Type

className

string

Possible values:

BacklogType.Manual type

object with fields:

  • neverUsed: boolean ( Required )

BacklogType.SearchBased type

object with fields:

BacklogTypeIn type

Name

Type

className

string

Possible values:

BacklogTypeIn.Manual type

No properties

BacklogTypeIn.SearchBased type

object with fields:

BatchInfo type

object with fields:

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

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

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

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

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

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

  • guestCost: number (format: double) ( Nullable and Optional , defaults to null)

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

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

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

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

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

  • profile: TD_MemberWithTeam ( Required )

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

BlockUnfurlDetails type

Name

Type

className

string

Possible values:

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 )

BlogEventMenuActionContext type

object with fields:

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

BoardBacklog type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • board: BoardRecord ( Required )

  • type: BacklogType ( Required )

BoardColumn type

object with fields:

  • name: string ( Required )

  • statuses: array of IssueStatus ( Required )

BoardColumns type

object with fields:

BoardInfo type

object with fields:

  • owners: BoardOwners ( Required )

  • columns: BoardColumns ( Required )

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

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

  • issueFields: array of BoardIssueField ( Required )

  • backlog: BoardBacklog ( Nullable and Optional , defaults to null)

BoardIssueField type

Name

Type

className

string

Possible values:

BoardIssueField.BuiltIn type

object with fields:

BoardIssueField.Custom type

object with fields:

BoardIssueInputField type

Name

Type

className

string

Possible values:

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)

BoardSprintFilterValue type

object with fields:

  • boardSprintIn: BoardSprintIn ( Nullable and Optional , defaults to null)

BoardSprintIn type

Name

Type

className

string

Possible values:

BoardSprintIn.Backlog type

object with fields:

  • id: string ( Required )

BoardSprintIn.Board type

object with fields:

  • id: string ( Required )

BoardSprintIn.Sprint type

object with fields:

  • id: string ( Required )

BoardTeamOwners type

object with fields:

  • teams: array of TD_Team ( Required )

BookContainerInfo type

object with fields:

  • book: KB_Book ( Nullable and Optional , defaults to null)

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

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

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

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

BooleanCFFilter type

object with fields:

BooleanCFType type

No properties

BooleanCFValue type

object with fields:

  • value: boolean ( Required )

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

BusinessEntityRelationEvent type

object with fields:

  • meta: KMetaMod ( Required )

  • relation: string ( Required )

  • entity: string ( Required )

  • member: TD_MemberProfile ( Required )

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

  • archived: object with fields:

    • old: boolean ( Required )

    • new: boolean ( Required )

    ( Nullable and Optional , defaults to null)

CApplicationPrincipalDetails type

object with fields:

CAutomationTaskPrincipalDetails type

object with fields:

  • project: PR_Project ( Required )

  • name: string ( Required )

  • id: string ( Required )

CBuiltInServicePrincipalDetails type

object with fields:

  • name: string ( Required )

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

CFCommitIdentifier type

Name

Type

className

string

Possible values:

CFCommitIdentifier.CommitHash type

object with fields:

  • commitHash: string ( Required )

CFCommitIdentifier.Full type

object with fields:

  • project: ProjectIdentifier ( Required )

  • repository: string ( Required )

  • commitHash: string ( Required )

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:

  • valuesToAdd: array of EnumValueData ( Required )

  • valuesToUpdate: array of EnumValueData ( Required )

  • valuesToDelete: array of string ( Required )

CFFilter type

Name

Type

className

string

Possible values:

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:

  • name: string ( Required )

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

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

CalendarInfo type

object with fields:

  • id: string ( Required )

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

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

  • freeBusyOnly: boolean ( Required )

  • readOnly: boolean ( Required )

  • exposeToCalDav: boolean ( Required )

  • exposeToGoogle: boolean ( Required )

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

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

  • archived: boolean ( Required )

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 )

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

  • initialSession: CallSession ( Nullable and Optional , defaults to null)

  • subSessions: array of CallSession ( Required )

  • participations: array of SessionParticipationRecord ( Required )

CallSessionUnfurlDetails type

object with fields:

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)

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

ChangeInReview type

object with fields:

  • repository: string ( Required )

  • change: GitCommitChange ( Required )

  • read: boolean ( Required )

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)

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

ChangeUnfurlViewType type

object with fields:

  • messageId: string ( Required )

  • unfurlLink: string ( Required )

  • viewTypes: array of UnfurlViewType ( 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)

ChannelFilterValue type

object with fields:

ChannelFilterValueDetails type

Name

Type

className

string

Possible values:

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)

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

  • mentions: array of EntityMention ( Nullable and Optional , defaults to null)

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

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

  • issues: array of Issue ( Required )

  • externalIssues: array of ExternalIssue ( Nullable and Optional , defaults to null)

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)

  • mentions: array of EntityMention ( Nullable and Optional , defaults to null)

  • projectedItem: ChannelItemSnapshot ( Nullable and Optional , defaults to null)

ChannelItemSyncRecord type

object with fields:

ChannelMessageMenuActionContext type

object with fields:

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:

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

ChatBotUiExtensionApi type

No properties

ChatBotUiExtensionIn type

No properties

ChatChannelSubscriptionFilter type

object with fields:

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

  • contact: ChatContactRecord ( Nullable and Optional , defaults to null)

ChatChannelSubscriptionFilterIn type

object with fields:

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

ChatContactDetails type

Name

Type

className

string

Possible values:

ChatContactDetails.App type

object with fields:

  • app: ES_App ( Required )

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

ChatContactDetails.Conversation type

object with fields:

  • users: array of TD_MemberProfile ( Required )

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

ChatContactDetails.Default type

object with fields:

  • type: string ( Required )

  • name: string ( Required )

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

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

  • fontIconColor: PrivateFeedColor ( Nullable and Optional , defaults to null)

  • access: M2.Access ( Nullable and Optional , defaults to null)

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

  • extra: ContactExtraTag ( Nullable and Optional , defaults to null)

ChatContactDetails.Profile type

object with fields:

ChatContactDetails.Thread type

object with fields:

  • parent: ChatContactRecord ( Required )

  • message: MessageInfo ( Required )

  • authors: array of CPrincipal ( Nullable and Optional , defaults to null)

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

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

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

ChatContactRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • key: string ( Required )

  • details: ChatContactDetails ( Required )

  • channelType: string ( Required )

  • lastMessage: MessageInfo ( Nullable and Optional , defaults to null)

  • unreadStatus: M2UnreadStatus ( Nullable and Optional , defaults to null)

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

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

  • pinned: boolean ( Required )

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

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

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

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

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

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

ChatMessage type

Name

Type

className

string

Possible values:

ChatMessage.Block type

object with fields:

ChatMessage.Text type

object with fields:

  • text: string ( Required )

ChatMessageCreatedEvent type

object with fields:

  • channelId: string ( Required )

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

  • message: ChannelItemRecord ( Required )

ChatMessageDeletedEvent type

object with fields:

  • channelId: string ( Required )

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

  • message: ChannelItemRecord ( Required )

ChatMessageEditableByMe type

No properties

ChatMessageIdentifier.ExternalId type

object with fields:

  • externalId: string ( Required )

ChatMessageMenuItemUiExtensionApi type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

  • visibilityFilters: array of ChatMessageMenuItemVisibilityFilterApi ( Required )

ChatMessageMenuItemUiExtensionIn type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

  • visibilityFilters: array of ChatMessageMenuItemVisibilityFilterIn ( Required )

ChatMessageMenuItemVisibilityFilterApi type

Name

Type

className

string

Possible values:

ChatMessageMenuItemVisibilityFilterIn type

Name

Type

className

string

Possible values:

ChatMessageReactionAddedEvent type

object with fields:

  • messageId: string ( Required )

  • channelId: string ( Required )

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

  • actor: CPrincipal ( Required )

  • emoji: string ( Required )

  • newCount: integer (format: int32) ( Required )

ChatMessageReactionRemovedEvent type

object with fields:

  • messageId: string ( Required )

  • channelId: string ( Required )

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

  • actor: CPrincipal ( Required )

  • emoji: string ( Required )

  • newCount: integer (format: int32) ( Required )

ChatMessageReactionSubscriptionFilter type

object with fields:

  • emojis: array of string ( Required )

ChatMessageReactionSubscriptionFilterIn type

object with fields:

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

ChatMessageUnfurlContext type

object with fields:

ChatMessageUpdatedEvent type

object with fields:

  • channelId: string ( Required )

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

  • message: ChannelItemRecord ( Required )

  • edited: object with fields:

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

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

    ( Nullable and Optional , defaults to null)

  • pinned: object with fields:

    • old: boolean ( Required )

    • new: boolean ( Required )

    ( Nullable and Optional , defaults to null)

ChatModification type

Name

Type

className

string

Possible values:

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

  • canConvertItemsToIssues: boolean ( Required )

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

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

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

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

ChecklistDocumentBodyCreateIn type

object with fields:

ChecklistDocumentBodyEditIn type

object with fields:

  • description: string ( Nullable and Optional )

  • owner: string ( Nullable and Optional )

  • tag: string ( Nullable and Optional )

  • topics: array of string ( Optional )

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

ChecklistDocumentHttpBody type

object with fields:

CheckoutRevisionDTO type

object with fields:

  • repoName: string ( Required )

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

  • branch: Branch ( Required )

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

  • ide: ClientIDE ( Nullable and Optional , defaults to null)

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

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

  • deviceType: ClientDeviceType ( 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 )

    warning

    Deprecated since 2020-01-18: Use project instead.

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

  • suggestedEdit: CodeDiscussionSuggestedEdit ( 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:

CodeDiscussionSuggestedEdit type

object with fields:

  • suggestionCommitId: string ( Required )

  • status: CodeDiscussionSuggestedEditState ( Nullable and Optional , defaults to null)

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

  • filePath: string ( Required )

  • hasConflicts: boolean ( Required )

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

  • startLineIndex: integer (format: int32) ( Required )

  • endLineIndexInclusive: integer (format: int32) ( Required )

CodeDiscussionSuggestedEditRequest type

object with fields:

  • path: string ( Required )

  • commitId: string ( Required )

  • startLineIndex: integer (format: int32) ( Required )

  • endLineIndexInclusive: integer (format: int32) ( Required )

  • suggestedContent: string ( Required )

CodeLine type

object with fields:

  • text: string ( Required )

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

  • offset: integer (format: int32) ( Required )

  • syntax: array of SyntaxMarkup ( Nullable and Optional , defaults to null)

CodeReviewCommitsUpdatedWebhookEvent type

object with fields:

CodeReviewDescription type

object with fields:

  • text: string ( Required )

  • unfurls: array of Attachment ( Required )

CodeReviewDetailedInfo type

object with fields:

CodeReviewDiscussion type

Name

Type

className

string

Possible values:

CodeReviewDiscussion.Bound type

object with fields:

CodeReviewDiscussion.Unbound type

object with fields:

CodeReviewDiscussionAddedFeedEvent type

object with fields:

CodeReviewDiscussionCounter type

object with fields:

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 )

CodeReviewDiscussionWebhookEvent type

object with fields:

  • meta: KMetaMod ( Nullable and Optional , defaults to null)

  • review: CodeReviewRecord ( Required )

  • discussion: CodeReviewDiscussion ( Required )

  • resolved: object with fields:

    • old: boolean ( Required )

    • new: boolean ( Required )

    ( Nullable and Optional , defaults to null)

CodeReviewEditableByMe type

No properties

CodeReviewLinkedExternalIssuesChanged type

object with fields:

CodeReviewMenuActionContext type

object with fields:

CodeReviewMenuItemUiExtensionApi type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

  • visibilityFilters: array of CodeReviewMenuItemVisibilityFilterApi ( Required )

CodeReviewMenuItemUiExtensionIn type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

  • visibilityFilters: array of CodeReviewMenuItemVisibilityFilterIn ( Required )

CodeReviewMenuItemVisibilityFilterApi type

Name

Type

className

string

Possible values:

CodeReviewMenuItemVisibilityFilterIn type

Name

Type

className

string

Possible values:

CodeReviewParticipant type

object with fields:

  • user: TD_MemberProfile ( Required )

  • role: CodeReviewParticipantRole ( Required )

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

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

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

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

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

  • qualityGateSlots: array of CodeReviewParticipantQualityGateSlot ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2023-02: To be removed. It will be removed in a future version.

  • codeOwnerSlots: array of CodeReviewParticipantCodeOwnerSlot ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2023-02: To be removed. It will be removed in a future version.

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

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:

  • id: string ( Required )

  • projectId: string ( Required )

  • role: CodeReviewParticipantRole ( Required )

  • profile: TD_MemberProfile ( Required )

  • reviewerState: ReviewerState ( Nullable and Optional , defaults to null)

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

  • archived: boolean ( Required )

CodeReviewParticipantSlotBase type

Name

Type

className

string

Possible values:

CodeReviewParticipantWebhookEvent type

object with fields:

  • meta: KMetaMod ( Nullable and Optional , defaults to null)

  • review: CodeReviewRecord ( Required )

  • isMergeRequest: boolean ( Required )

  • participant: TD_MemberProfile ( Required )

  • reviewerState: object with fields:

    ( Nullable and Optional , defaults to null)

  • theirTurn: object with fields:

    • old: boolean ( Required )

    • new: boolean ( Required )

    ( Nullable and Optional , defaults to null)

CodeReviewParticipants type

object with fields:

  • id: string ( Required )

  • participants: array of CodeReviewParticipant ( Nullable and Optional , defaults to null)

  • reviewers: array of CodeReviewParticipantRecord ( Required )

    warning

    Deprecated since 2020-11-03: Use participants. It will be removed in a future version.

  • authors: array of CodeReviewParticipantRecord ( Required )

    warning

    Deprecated since 2020-11-03: Use participants. It will be removed in a future version.

  • watchers: array of CodeReviewParticipantRecord ( Required )

    warning

    Deprecated since 2020-11-03: Use participants. It will be removed in a future version.

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 )

CodeReviewUnboundDiscussionRecord type

object with fields:

  • id: string ( Required )

  • review: CodeReviewRecord ( Required )

  • item: ChannelItemRecord ( Required )

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

  • pending: boolean ( Required )

  • archived: boolean ( Required )

CodeReviewUnfurlContext type

object with fields:

CodeReviewUpdatedWebhookEvent type

object with fields:

  • meta: KMetaMod ( Required )

  • review: CodeReviewRecord ( Nullable and Optional , defaults to null)

  • titleMod: object with fields:

    • old: string ( Required )

    • new: string ( Required )

    ( Nullable and Optional , defaults to null)

  • descriptionMod: object with fields:

    • old: string ( Required )

    • new: string ( Required )

    ( Nullable and Optional , defaults to null)

  • targetBranchMod: object with fields:

    • old: string ( Required )

    • new: string ( Required )

    ( Nullable and Optional , defaults to null)

CodeReviewWebhookEvent type

object with fields:

  • meta: KMetaMod ( Nullable and Optional , defaults to null)

  • review: CodeReviewRecord ( Nullable and Optional , defaults to null)

  • projectKey: ProjectKey ( Required )

    warning

    Deprecated since 2023.01.11: Use review.project instead.

  • repository: string ( Required )

  • reviewId: string ( Required )

    warning

    Deprecated since 2023.01.11: Use review.id instead.

  • title: string ( Required )

    warning

    Deprecated since 2023.01.11: Use review.title instead.

  • isMergeRequest: boolean ( Required )

    warning

    Deprecated since 2023.01.11: Use `review is MergeRequestRecord` instead.

CodeReviewWithCount type

object with fields:

  • review: CodeReviewRecord ( Required )

  • messagesCount: integer (format: int32) ( Required )

    warning

    Deprecated since 2023-05-08: Use review.discussionCounter instead. It will be removed in a future version.

  • authors: array of GitCommitterProfile ( Required )

  • participants: CodeReviewParticipants ( Required )

CodeScopeRange type

object with fields:

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

  • startLine: integer (format: int32) ( Required )

  • linesCount: integer (format: int32) ( Required )

CodeSnippetAnchor type

object with fields:

  • projectKey: ProjectKey ( Required )

  • repository: string ( Required )

  • revision: string ( Required )

  • filename: string ( Required )

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

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

CodeSuggestedEditHeadContentDetails type

object with fields:

  • codeDiscussion: CodeDiscussionRecord ( Required )

  • accepted: boolean ( 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)

CommitLinkedExternalIssuesChanged type

object with fields:

  • project: PR_Project ( Required )

  • repositoryId: string ( Required )

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

  • commitId: string ( Required )

  • commit: GitCommitInfo ( Nullable and Optional , defaults to null)

  • changes: GitCommitChanges ( Nullable and Optional , defaults to null)

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

  • issues: array of ExternalIssueIdOut ( Required )

Name

Type

className

string

Possible values:

CommitMessageUnfurlContext type

object with fields:

  • projectId: string ( Required )

  • repo: string ( Required )

  • commitId: string ( Required )

CommitMessageUnfurlsRecord type

object with fields:

  • id: string ( Required )

  • unfurls: array of Unfurl ( Required )

CommitSetReviewRecord type

object with fields:

  • id: string ( Required )

  • project: ProjectKey ( Required )

  • projectId: string ( Required )

  • number: integer (format: int32) ( Required )

  • title: string ( Required )

  • state: CodeReviewState ( Required )

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

  • createdAt: integer (format: int64) ( Required )

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

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

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

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

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

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

  • discussionCounter: DiscussionCounter ( Required )

  • participants: array of CodeReviewParticipant ( Nullable and Optional , defaults to null)

  • reviewers: array of CodeReviewParticipantRecord ( Required )

    warning

    Deprecated since 2020-11-03: Use participants. It will be removed in a future version.

  • authors: array of CodeReviewParticipantRecord ( Required )

    warning

    Deprecated since 2020-11-03: Use participants. It will be removed in a future version.

  • watchers: array of CodeReviewParticipantRecord ( Required )

    warning

    Deprecated since 2020-11-03: Use participants. It will be removed in a future version.

  • commits: array of ReviewCommit ( Required )

  • issueIds: array of string ( Required )

  • externalIssues: array of ExternalIssueIdOut ( Nullable and Optional , defaults to null)

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

  • unfurls: array of Attachment ( Required )

CommonProjectFeaturePinnedItem type

object with fields:

CommonProjectFeaturePins type

object with fields:

ComposerPackageDependency type

object with fields:

  • name: string ( Required )

  • version: string ( Required )

  • type: string ( Required )

ComposerPackageType type

object with fields:

  • id: string ( Required )

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

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

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

  • dependencies: array of ComposerPackageDependency ( Required )

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

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

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

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

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

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

ComputePoolKey type

object with fields:

  • value: string ( Required )

ConfigurePermissionsAction type

object with fields:

ContactCFFilter type

object with fields:

  • query: string ( Required )

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)

ContactExtraTag type

object with fields:

  • primary: string ( Required )

  • secondary: string ( Required )

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

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

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

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

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

  • projectKey: ProjectKey ( Nullable and Optional , defaults to null)

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

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

  • assignee: CPrincipal ( 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)

  • subject: PackageVersionRef ( Nullable and Optional , defaults to null)

ContextMenuItemUiExtensionApi type

Name

Type

className

string

Possible values:

ContextMenuItemUiExtensionIn type

Name

Type

className

string

Possible values:

CratesPackageDependency type

object with fields:

  • name: string ( Required )

  • versionReq: string ( Required )

  • features: array of string ( Required )

  • optional: boolean ( Required )

  • defaultFeatures: boolean ( Required )

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

  • kind: string ( Required )

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

CratesPackageType type

object with fields:

  • id: string ( Required )

CratesPackageVersionDetails type

object with fields:

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

  • dependencies: array of CratesPackageDependency ( Required )

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

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

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

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

  • keywords: array of string ( Required )

  • categories: array of string ( Required )

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

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

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

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

CreateExternalIssueProjectResult type

object with fields:

CreateExternalIssueRequestPayload type

object with fields:

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

  • spaceUserId: string ( Required )

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

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

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

  • clientId: string ( Required )

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

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

Currency type

object with fields:

  • code: string ( Required )

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

  • signAsPrefix: boolean ( Required )

  • hasCents: boolean ( Required )

CustomActionPayload type

object with fields:

  • actionId: string ( Required )

  • clientId: string ( Required )

  • userId: string ( Required )

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

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

CustomBoardIssueInputField type

object with fields:

CustomEmojiAddedEvent type

object with fields:

  • emoji: string ( Required )

  • owner: CPrincipal ( Required )

  • attachmentId: string ( Required )

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

CustomEmojiDeletedEvent type

object with fields:

  • emoji: string ( Required )

  • owner: CPrincipal ( Required )

CustomEmojiInfo type

object with fields:

  • name: string ( Required )

  • provider: CPrincipal ( Required )

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

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

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

CustomEmojiUpdatedEvent type

object with fields:

  • emoji: string ( Required )

  • owner: CPrincipal ( Required )

  • attachmentId: object with fields:

    • old: string ( Required )

    • new: string ( Required )

    ( Nullable and Optional , defaults to null)

  • uploadedAt: object with fields:

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

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

    ( Nullable and Optional , defaults to null)

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)

    warning

    Deprecated since 2020-09-28: Use name instead. It will be removed in a future version.

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

  • fieldId: string ( Required )

  • value: CFInputValue ( Required )

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:

  • subjectCode: string ( Required )

  • filters: array of SubscriptionFilterIn ( Required )

  • eventTypeCodes: array of string ( Required )

CustomHttpHeaderDTO type

object with fields:

  • name: string ( Required )

  • value: string ( Required )

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

DTO_FullRightWithoutType type

object with fields:

  • code: string ( Required )

  • title: string ( Required )

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

  • grantedForUsers: boolean ( Required )

  • featureFlag: FeatureFlagInfo ( 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)

    warning

    Deprecated since 2021-12-21: Use conferenceData instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-12-21: Use externalSource instead. It will be removed in a future version.

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

  • externalSource: EventExternalSource ( Nullable and Optional , defaults to null)

  • calendar: CalendarInfo ( Nullable and Optional , defaults to null)

  • canLeaveOrRsvp: boolean ( 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:

DartPackageDependency type

object with fields:

  • name: string ( Required )

  • version: string ( Required )

DartPackageType type

object with fields:

  • id: string ( Required )

DartPackageVersionDetails type

object with fields:

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

  • description: string ( Required )

  • homePage: string ( Required )

  • repositoryUrl: string ( Required )

  • issueTracker: string ( Required )

  • documentation: string ( Required )

  • license: string ( Required )

  • readme: string ( Required )

  • changelog: string ( Required )

  • dependencies: array of DartPackageDependency ( Nullable and Optional , defaults to null)

  • devDependencies: array of DartPackageDependency ( Nullable and Optional , defaults to null)

  • dependencyOverrides: array of DartPackageDependency ( Nullable and Optional , defaults to null)

  • environment: array of DartPackageDependency ( Nullable and Optional , defaults to null)

DashboardItemData type

object with fields:

  • name: string ( Required )

  • isEnabled: boolean ( Required )

DashboardPreferencesRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • data: array of array of DashboardItemData ( Nullable and Optional , defaults to null)

  • type: DashboardContainerType ( Nullable and Optional , defaults to null)

DataProducerOptions type

object with fields:

  • sfuOptions: SFUDataProducerOptions ( Required )

  • closed: boolean ( Required )

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

  • routerId: string ( Required )

DateCFConstraint type

object with fields:

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

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

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

DateCFFilter type

object with fields:

  • minValue: DateCFValue ( Nullable and Optional , defaults to null)

  • maxValue: DateCFValue ( 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)

DateFilterValue type

object with fields:

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

DateRangeFilter type

object with fields:

DateRangeIn type

Name

Type

className

string

Possible values:

DateRangeIn.Range type

object with fields:

DateRangeIn.SpecialValue type

object with fields:

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)

DateTimeCFFilter type

object with fields:

DateTimeCFType type

No properties

DateTimeCFValue type

object with fields:

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

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

DeleteAllAutomationLegacyChannelsAction type

No properties

DeleteAutomationLegacyChannelAction type

object with fields:

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 )

DeployTargetAuditLogEntry type

object with fields:

DeployTargetChangedMCExtension type

No properties

DeployTargetFieldMod type

object with fields:

  • fieldName: string ( Required )

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

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

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

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

object with fields:

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

  • url: string ( Required )

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

DeployTargetRecord type

object with fields:

  • id: string ( Required )

  • projectId: string ( Required )

  • name: string ( Required )

  • key: string ( Required )

  • description: string ( Required )

  • createdAt: string ( Required )

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

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

  • channel: M2ChannelRecord ( Required )

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

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

  • archived: boolean ( Required )

  • users: array of TD_MemberProfile ( Required )

  • teams: array of TD_Team ( Required )

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

  • channelId: string ( Required )

  • repositories: array of DeployTargetRepositoryDTO ( Required )

  • manualControl: boolean ( Required )

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

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

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

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

  • links: array of DeployTargetLink ( Required )

  • current: DeploymentInfo ( Nullable and Optional , defaults to null)

  • next: DeploymentInfo ( Nullable and Optional , defaults to null)

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

DeployTargetRepositoryDTO type

object with fields:

  • repositoryName: string ( Required )

  • missing: boolean ( Required )

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

DeployTargetsSearchExpression type

object with fields:

DeployTargetsSearchFilter type

Name

Type

className

string

Possible values:

DeployTargetsSearchFilter.Archived type

object with fields:

  • exclusive: boolean ( Required )

DeployTargetsSearchFilter.ByCustomField type

object with fields:

  • cfId: string ( Required )

  • cff: CFFilter ( Required )

  • negated: boolean ( Required )

DeployTargetsSearchFilter.ByDescription type

object with fields:

  • searchText: string ( Required )

object with fields:

  • searchText: string ( Required )

object with fields:

  • searchText: string ( Required )

DeployTargetsSearchFilter.ByMaintainers type

object with fields:

DeployTargetsSearchFilter.ByMatchingText type

object with fields:

  • searchText: string ( Required )

DeployTargetsSearchFilter.ByName type

object with fields:

  • searchText: string ( Required )

DeployTargetsSearchFilter.ByProjects type

object with fields:

  • projects: array of string ( Required )

  • negated: boolean ( Required )

DeployTargetsSearchFilter.Maintainer type

Name

Type

className

string

Possible values:

DeployTargetsSearchFilter.Maintainer.NoMaintainers type

No properties

DeployTargetsSearchFilter.Maintainer.Team type

object with fields:

  • id: string ( Required )

DeployTargetsSearchFilter.Maintainer.User type

object with fields:

  • id: string ( Required )

DeploymentCFFilter type

object with fields:

DeploymentCFInputValue type

object with fields:

DeploymentCFType type

No properties

DeploymentCFValue type

object with fields:

DeploymentCommitRefDetails type

object with fields:

  • repositoryName: string ( Required )

  • branch: string ( Required )

  • commit: string ( Required )

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

  • head: boolean ( Required )

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

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

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

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

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

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

  • rollback: boolean ( Required )

  • missing: boolean ( Required )

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

DeploymentCommitReference type

object with fields:

  • repositoryName: string ( Required )

  • branch: string ( Required )

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

DeploymentData type

object with fields:

  • id: string ( Required )

  • version: string ( Required )

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

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

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

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

  • targetKey: string ( Required )

  • status: DeploymentStatus ( Required )

  • syncStatus: DeploymentSyncStatus ( Required )

  • externalLink: ExternalLink ( Nullable and Optional , defaults to null)

  • commitRefs: array of DeploymentCommitRefDetails ( Required )

DeploymentInfo type

Name

Type

className

string

Possible values:

DeploymentM2ChannelInfo type

object with fields:

DeploymentM2DetailsNoThread type

No properties

DeploymentM2DetailsWithThread type

object with fields:

DeploymentRecord type

object with fields:

  • id: string ( Required )

  • version: string ( Required )

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

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

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

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

  • status: DeploymentStatus ( Required )

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

  • channel: M2ChannelRecord ( Required )

  • target: DeployTargetRecord ( Required )

  • targetKey: string ( Required )

  • syncStatus: DeploymentSyncStatus ( Required )

  • commitRefs: array of DeploymentCommitRefDetails ( Required )

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

  • externalLink: ExternalLink ( Nullable and Optional , defaults to null)

  • archived: boolean ( Required )

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

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

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

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

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

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

DeploymentTargetM2ChannelInfo type

object with fields:

DeploymentWebhookEvent type

object with fields:

  • meta: KMetaMod ( Required )

  • projectKey: string ( Required )

  • targetId: string ( Required )

  • deploymentId: string ( Required )

  • statusMod: object with fields:

    ( Nullable and Optional , defaults to null)

DeploymentsSubscriptionFilter type

object with fields:

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

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

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

DeploymentsSubscriptionFilterIn type

object with fields:

  • project: string ( Required )

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

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

DevConfigurationAccessSettingsDTO type

object with fields:

DevConfigurationAccessTypeDTO type

Name

Type

className

string

Possible values:

DevConfigurationAccessTypeDTO_Private type

object with fields:

DevConfigurationAccessTypeDTO_Project type

No properties

DevConfigurationHotPool type

object with fields:

  • enabled: boolean ( Required )

  • hibernateInstances: boolean ( Required )

  • size: integer (format: int32) ( Required )

  • cronSchedule: string ( Required )

  • timezone: string ( Required )

DevConfigurationParticipantDTO type

Name

Type

className

string

Possible values:

DevConfigurationParticipantDTO_Team type

object with fields:

DevConfigurationParticipantDTO_User type

object with fields:

DevConfigurationWarmup type

object with fields:

  • indexing: boolean ( Required )

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

  • triggers: array of DevConfigurationWarmupTriggers ( Required )

DevConfigurationWarmupTriggers type

Name

Type

className

string

Possible values:

DevConfigurationWarmupTriggers.Cron type

object with fields:

  • expression: string ( Required )

Diff type

object with fields:

  • added: array of string ( Required )

  • removed: array of string ( Required )

  • removeAll: boolean ( Required )

DiffContext type

object with fields:

  • left: DiffSide ( Nullable and Optional , defaults to null)

  • right: DiffSide ( Required )

DiffSide type

Name

Type

className

string

Possible values:

DiffSide.Empty type

object with fields:

  • revision: string ( Required )

DiffSide.NonEmpty type

object with fields:

  • revision: string ( Required )

  • path: string ( Required )

DiscussionCounter type

object with fields:

  • resolved: integer (format: int32) ( Required )

  • unresolved: integer (format: int32) ( Required )

  • unresolvedSuggestedEdits: integer (format: int32) ( Required )

  • acceptedSuggestedEdits: integer (format: int32) ( Required )

  • rejectedSuggestedEdits: integer (format: int32) ( Required )

Document type

object with fields:

  • id: string ( Required )

  • title: string ( Required )

  • alias: string ( Required )

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

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

  • bodyType: DocumentBodyType ( Nullable and Optional , defaults to null)

  • bodyInfo: DocumentBodyInfo ( Nullable and Optional , defaults to null)

  • 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: DocumentBodyInfo ( Required )

    warning

    Deprecated since 2023-05-30: Use body property instead. It will be removed in a future version.

  • body: DocumentHttpBody ( Nullable and Optional , defaults to null)

DocumentAccess type

object with fields:

DocumentAccessRecipient type

object with fields:

DocumentAccessRecipientIdentifier type

object with fields:

DocumentAppUnfurlContext type

object with fields:

  • documentId: string ( Required )

DocumentBodyCreateIn type

Name

Type

className

string

Possible values:

DocumentBodyInfo type

Name

Type

className

string

Possible values:

DocumentBodyUpdateIn type

Name

Type

className

string

Possible values:

DocumentCFFilter type

object with fields:

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)

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

  • documents: array of Document ( Required )

DocumentCustomSubscriptionFilterIn type

object with fields:

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

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

  • documents: array of string ( Required )

DocumentEditableByMe type

No properties

DocumentEditorsChangedEvent type

object with fields:

  • meta: KMetaMod ( Required )

  • document: string ( Required )

DocumentFolder type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

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

  • name: string ( Required )

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

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

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

DocumentFolderCustomSubscriptionFilter type

object with fields:

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

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

DocumentFolderCustomSubscriptionFilterIn type

object with fields:

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

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

DocumentFolderEditableByMe type

No properties

DocumentFolderItem type

Name

Type

className

string

Possible values:

DocumentFolderItem.DocumentItem type

object with fields:

DocumentFolderItem.FolderItem type

object with fields:

DocumentFolderMenuActionContext type

object with fields:

DocumentFolderMenuItemUiExtensionApi type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

  • visibilityFilters: array of DocumentFolderMenuItemVisibilityFilterApi ( Required )

DocumentFolderMenuItemUiExtensionIn type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

  • visibilityFilters: array of DocumentFolderMenuItemVisibilityFilterIn ( Required )

DocumentFolderMenuItemVisibilityFilterApi type

Name

Type

className

string

Possible values:

DocumentFolderMenuItemVisibilityFilterIn type

Name

Type

className

string

Possible values:

DocumentFolderMetaWebhookEvent type

object with fields:

  • meta: KMetaMod ( Required )

  • folder: string ( Required )

  • archived: object with fields:

    • old: boolean ( Required )

    • new: boolean ( Required )

    ( Nullable and Optional , defaults to null)

DocumentFolderOwnAccessChangedEvent type

object with fields:

  • meta: KMetaMod ( Required )

  • folder: string ( Required )

DocumentFolderWithChildren type

object with fields:

DocumentHistoryUnfurlDetails type

object with fields:

  • document: string ( Required )

  • title: string ( Required )

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

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

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

DocumentHttpBody type

Name

Type

className

string

Possible values:

DocumentListCFInputValue type

object with fields:

  • documents: array of string ( Required )

DocumentListCFType type

No properties

DocumentListCFValue type

object with fields:

  • documents: array of Document ( Required )

DocumentMenuActionContext type

object with fields:

  • documentId: string ( Required )

  • projectIdentifier: ProjectIdentifier ( Nullable and Optional , defaults to null)

DocumentMenuItemUiExtensionApi type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

  • visibilityFilters: array of DocumentMenuItemVisibilityFilterApi ( Required )

DocumentMenuItemUiExtensionIn type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

  • visibilityFilters: array of DocumentMenuItemVisibilityFilterIn ( Required )

DocumentMenuItemVisibilityFilterApi type

Name

Type

className

string

Possible values:

DocumentMenuItemVisibilityFilterIn type

Name

Type

className

string

Possible values:

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 )

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

  • changeAuthors: array of CPrincipal ( Required )

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

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

DocumentsSearchHighlights type

object with fields:

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

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

DryCleanupResults type

Name

Type

className

string

Possible values:

DryCleanupResults.Failure type

object with fields:

  • error: string ( Required )

DryCleanupResults.Results type

object with fields:

  • totalSize: integer (format: int64) ( Required )

  • totalCount: integer (format: int32) ( Required )

  • packageVersions: array of PackageVersionRef ( Required )

DryRunResult type

object with fields:

  • teams: array of TD_Team ( Required )

  • projects: array of PR_Project ( Required )

  • locations: array of TD_Location ( Required )

  • records: array of string ( Required )

DslEvaluationConfig type

object with fields:

  • experimentalOptIns: array of string ( Required )

  • runtimeInfo: DslRuntimeInfo ( Required )

DslRuntimeInfo type

object with fields:

  • mavenRepoUrl: string ( Required )

  • mavenCoordinates: MavenCoordinates ( Required )

ES_App type

object with fields:

  • id: string ( Required )

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

    User that created/installed the application. null if the application was created/installed by another application, See ownerApp.

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

    Application that created/installed the application. null if the application was created/installed by a user, See owner.

  • clientId: string ( Required )

  • name: string ( Required )

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

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

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

    warning

    Deprecated since 2021-08-20: Use settings instead. It will be removed in a future version.

  • archived: boolean ( Required )

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

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

  • settings: ES_AppSettings ( Required )

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

  • patterns: array of ApplicationUnfurlPattern ( Required )

  • contexts: array of AppUiExtContextData ( Required )

  • domains: array of ApplicationUnfurlDomain ( 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)

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

  • endpointAuth: EndpointAuthDTO ( Nullable and Optional , defaults to null)

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

ES_ApplicationPassword type

object with fields:

  • id: string ( Required )

  • profile: TD_MemberProfile ( Required )

  • name: string ( Required )

  • scope: XScopeApi ( 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 )

  • apiScope: XScopeApi ( 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: XScopeApi ( 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 )

  • registerNewUserRules: array of AzureRegisterNewUserRule ( Nullable and Optional , defaults to null)

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

object with fields:

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

  • immutablePackageVersions: boolean ( 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_CratesRegistrySettings type

object with fields:

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

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

ES_DartRepositorySettings type

object with fields:

  • 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_FileRepositorySettings type

object with fields:

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

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

ES_GithubAuthModuleSettings type

object with fields:

  • githubUrl: string ( Required )

  • clientId: string ( Required )

  • clientSecret: string ( Required )

  • registerNewUsers: boolean ( Required )

  • organizations: array of string ( Required )

  • registerNewUserRules: array of GithubRegisterNewUserRule ( Nullable and Optional , defaults to null)

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)

  • allEmails: array of object with fields:

    • first: string ( Required )

    • second: boolean ( Required )

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

  • registerNewUserRules: array of GoogleRegisterNewUserRule ( Nullable and Optional , defaults to null)

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)

  • registerNewUserRules: array of HubRegisterNewUserRule ( 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 )

  • registerNewUserRules: array of LdapRegisterNewUserRule ( Nullable and Optional , defaults to null)

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)

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

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

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

ES_OAuth2AuthModuleSettings type

Name

Type

className

string

Possible values:

ES_OAuthApp type

Name

Type

className

string

Possible values:

ES_OAuthConsent type

object with fields:

ES_OAuthInternalApp type

object with fields:

  • name: string ( Required )

  • clientId: string ( Required )

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

  • registerNewUserRules: array of OidcRegisterNewUserRule ( Nullable and Optional , defaults to null)

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 )

  • apiScope: XScopeApi ( 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_PythonPackageIndexSettings type

object with fields:

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

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

ES_RefreshToken type

object with fields:

  • id: string ( Required )

  • scope: XScopeApi ( 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 )

  • registerNewUserRules: array of SamlRegisterNewUserRule ( 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)

EditMessage type

object with fields:

  • text: string ( Required )

  • id: string ( Required )

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

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

EmailBouncedEvent type

object with fields:

  • email: string ( Required )

  • reason: string ( Required )

EmojiReaction type

object with fields:

  • emoji: string ( Required )

  • count: integer (format: int32) ( Required )

  • meReacted: boolean ( 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

EndpointAuthCreateDTO type

object with fields:

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

EndpointAuthUpdateDTO type

object with fields:

  • appLevelAuth: EndpointAppLevelAuthUpdateType ( Optional )

  • basicAuthUsername: string ( Optional )

  • basicAuthPassword: string ( Optional )

  • bearerAuthToken: string ( Optional )

  • hasVerificationToken: boolean ( Optional )

  • sslKeystoreAuth: string ( Nullable and Optional )

EndpointCreateDTO type

object with fields:

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

  • sslVerification: boolean ( Required )

EndpointDTO type

object with fields:

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

  • sslVerification: boolean ( Required )

EntityMention type

object with fields:

  • position: integer (format: int32) ( Required )

  • length: integer (format: int32) ( Required )

  • link: string ( Required )

EnumCFFilter type

object with fields:

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)

EnvVar type

object with fields:

  • type: EnvVarType ( Required )

  • key: string ( Required )

  • value: string ( Required )

EventConferenceData type

object with fields:

EventExternalSource type

object with fields:

  • sourceName: string ( Required )

  • externalId: string ( Required )

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

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

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

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 )

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

ExtendedType type

object with fields:

  • key: string ( Required )

  • displayName: string ( Required )

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

  • scopeType: ExtendedTypeScopeType ( Required )

ExtendedTypeKey type

object with fields:

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 )

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

  • timestamp: integer (format: int64) ( Required )

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

object with fields:

  • id: string ( Required )

  • url: string ( Required )

ExternalCollaboratorType type

No properties

ExternalEndpointUpdateDTO type

object with fields:

  • url: string ( Nullable and Optional )

  • sslVerification: boolean ( Optional )

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:

  • id: string ( Required )

  • archived: boolean ( Required )

  • issueId: string ( Required )

  • issuePrefix: string ( Required )

  • url: string ( Required )

  • status: IssueStatus ( Nullable and Optional , defaults to null)

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

  • fields: array of ExternalIssueField ( Nullable and Optional , defaults to null)

  • codeReviewIds: array of string ( Required )

ExternalIssueDataIn type

object with fields:

  • issueId: string ( Required )

  • url: string ( Required )

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

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

  • fields: array of ExternalIssueField ( Nullable and Optional , defaults to null)

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

ExternalIssueEvent type

Name

Type

className

string

Possible values:

ExternalIssueEventQueueItem type

object with fields:

  • event: ExternalIssueEvent ( Required )

    An actionable event from Space about issue from external issue tracker

  • etag: integer (format: int64) ( Required )

    Monotonically increasing counter that should be used by the application to fetch unprocessed queue items only

ExternalIssueEventQueueItemsBatch type

object with fields:

ExternalIssueField type

object with fields:

  • name: string ( Required )

  • value: string ( Required )

ExternalIssueId type

object with fields:

  • id: string ( Required )

  • externalTrackerProjectId: string ( Required )

ExternalIssueIdOut type

object with fields:

  • prefix: string ( Required )

  • id: string ( Required )

ExternalIssueLinkedCodeReviewsChanged type

object with fields:

  • issuePrefix: string ( Required )

  • issueId: string ( Required )

  • reviews: array of CodeReviewRecord ( Required )

ExternalIssueLinkedCommit type

object with fields:

ExternalIssueLinkedCommitsChanged type

object with fields:

ExternalIssueLinkedCommitsForRepo type

object with fields:

  • project: PR_Project ( Required )

  • repositoryId: string ( Required )

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

  • commits: array of ExternalIssueLinkedCommit ( Required )

ExternalIssueStatusIn type

object with fields:

  • name: string ( Required )

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

ExternalIssueTrackerProjectApi type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • issuePrefix: string ( Required )

  • linkReplacement: string ( Required )

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

  • spaceProjectLinks: array of ExternalIssueTrackerProjectLink ( Required )

ExternalIssueTrackerProjectIn type

object with fields:

  • name: string ( Required )

  • issuePrefix: string ( Required )

  • linkReplacement: string ( Required )

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

object with fields:

  • spaceProject: PR_Project ( Required )

  • targetStatusForMergeRequestMerge: IssueStatus ( Nullable and Optional , defaults to null)

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

ExternalIssueTrackerUiExtensionApi type

object with fields:

  • domain: string ( Required )

  • trackerName: string ( Required )

  • canCreateIssues: boolean ( Required )

ExternalIssueTrackerUiExtensionIn type

object with fields:

  • domain: string ( Required )

  • trackerName: string ( Required )

  • canCreateIssues: boolean ( Required )

object with fields:

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

  • url: string ( Required )

ExternalLinkPattern type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • prefix: string ( Required )

    Prefix that is used in the external IDs and that will be recognised by Space to generate links

  • linkReplacement: string ( Required )

    URL of the external resource ending with < ? > which is a variable for a number that follows the prefix

FailureConditionDTO type

Name

Type

className

string

Possible values:

FeatureFlagDate type

object with fields:

  • year: integer (format: int32) ( Required )

  • month: integer (format: int32) ( Required )

  • day: integer (format: int32) ( Required )

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

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 )

FileBOM type

object with fields:

  • name: string ( Required )

FileData type

object with fields:

  • type: PackageType ( Required )

  • repository: string ( Required )

  • name: string ( Required )

  • path: string ( Required )

  • fileType: FileDataType ( Required )

  • created: integer (format: int64) ( Required )

  • size: integer (format: int64) ( Required )

FileDetails type

object with fields:

  • type: PackageType ( Required )

  • repository: string ( Required )

  • name: string ( Required )

  • created: integer (format: int64) ( Required )

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

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

  • downloads: integer (format: int64) ( Required )

  • diskSize: integer (format: int64) ( Required )

  • authors: array of CPrincipal ( Nullable and Optional , defaults to null)

  • origin: PackageOrigin ( Nullable and Optional , defaults to null)

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

  • path: string ( Required )

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

  • metadata: key-value object of string keys and values of string ( Nullable and Optional , defaults to null)

FileDocumentBody type

object with fields:

  • versionId: string ( Required )

  • contentType: string ( Required )

  • fileSize: integer (format: int64) ( Required )

FileDocumentBodyCreateIn type

object with fields:

  • blobId: string ( Required )

FileDocumentBodyInfo type

object with fields:

  • fileDocument: FileDocumentRecord ( Nullable and Optional , defaults to null)

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

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

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

FileDocumentBodyUpdateIn type

object with fields:

  • blobId: string ( Required )

FileDocumentHttpBody type

object with fields:

  • contentType: string ( Required )

  • fileSize: integer (format: int64) ( Required )

FileDocumentRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • body: FileDocumentBody ( Required )

FileSetInReview type

object with fields:

  • repository: string ( Required )

  • commit: string ( Required )

  • paths: array of string ( Required )

FileType type

object with fields:

  • id: string ( Required )

Fingerprint type

object with fields:

  • md5: string ( Required )

  • sha1: string ( Required )

  • sha256: string ( Required )

  • sha384: string ( Required )

  • sha512: string ( Required )

FolderAccess type

object with fields:

  • permissions: array of FolderAccessRecipient ( Nullable and Optional , defaults to null)

  • restricted: boolean ( Required )

FolderAccessRecipient type

object with fields:

FolderAccessRecipientIdentifier type

object with fields:

FollowedColleagueSettingsDTO type

object with fields:

FollowedEntityDTO type

Name

Type

className

string

Possible values:

FollowedEntityDTO.Project type

object with fields:

  • enabled: boolean ( Required )

  • projectId: string ( Required )

  • teams: array of FollowedEntityDTO.Team ( Nullable and Optional , defaults to null)

FollowedEntityDTO.Team type

object with fields:

  • enabled: boolean ( Required )

  • teamId: string ( Required )

FollowedMembersSettings type

object with fields:

  • enabled: boolean ( Required )

  • members: array of string ( Required )

Fraction type

object with fields:

  • numerator: integer (format: int32) ( Required )

  • denominator: integer (format: int32) ( Required )

FractionCFFilter type

object with fields:

FractionCFType type

No properties

FractionCFValue type

object with fields:

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

FullWebhookDTO type

object with fields:

GenericIssueId type

Name

Type

className

string

Possible values:

GetMessagesResponse type

object with fields:

  • messages: array of ChannelItemRecord ( Required )

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

  • orgLimitReached: boolean ( Required )

GettingStartedUiExtensionApi type

object with fields:

  • gettingStartedUrl: string ( Required )

  • gettingStartedTitle: string ( Required )

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

GettingStartedUiExtensionIn type

object with fields:

  • gettingStartedUrl: string ( Required )

  • gettingStartedTitle: string ( Required )

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

GitAuthorInfo type

object with fields:

  • name: string ( Required )

  • email: string ( Required )

GitCheckout type

object with fields:

  • isDefault: boolean ( Required )

  • name: string ( Required )

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

  • ref: string ( Required )

  • commit: string ( Required )

GitCherryPickResult type

object with fields:

  • success: boolean ( Required )

  • message: string ( Required )

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

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)

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

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

GitCommitChanges type

object with fields:

  • changes: array of GitCommitChange ( Required )

  • overflow: boolean ( Required )

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)

  • committerIsSpace: boolean ( 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.ExpiredKey type

object with fields:

  • description: string ( Required )

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:

  • repositoryName: string ( Required )

  • commit: GitCommitInfo ( Required )

  • commitMessageUnfurls: array of Unfurl ( Required )

  • reviews: array of CodeReviewRecord ( Required )

  • issueIds: array of string ( Required )

  • linkedIssues: array of GenericIssueId ( Nullable and Optional , defaults to null)

  • deployments: array of object with fields:

    • first: string ( Required )

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

    ( Required )

  • layout: GitGraphLayoutLine ( Nullable and Optional , defaults to null)

  • unreachable: boolean ( Required )

GitCommitterProfile type

object with fields:

  • author: string ( Required )

  • email: string ( Required )

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

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 )

  • properties: GitFileProperties ( Nullable and Optional , defaults to null)

GitFileAttribute type

object with fields:

GitFileChange type

object with fields:

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)

GitFileProperties type

object with fields:

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

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

  • attributes: array of GitFileAttribute ( Required )

GitGraphLayoutEdge type

object with fields:

  • from: integer (format: int32) ( Required )

  • to: integer (format: int32) ( Required )

  • type: GitGraphEdgeType ( Required )

  • style: GitGraphEdgeLineStyle ( Required )

  • hasArrow: boolean ( Required )

  • color: integer (format: int32) ( Required )

GitGraphLayoutLine type

object with fields:

GitGraphLayoutNode type

object with fields:

  • pos: integer (format: int32) ( Required )

  • color: integer (format: int32) ( Required )

GitMergeBranchResult type

object with fields:

  • status: GitMergeStatus ( Required )

  • message: string ( Required )

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

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 )

  • properties: GitFileProperties ( Nullable and Optional , defaults to null)

GitRebaseResult type

object with fields:

  • success: boolean ( Required )

  • message: string ( Required )

  • resultCommitIds: array of string ( Required )

GitRebaseResultHttp type

object with fields:

  • resultCommitIds: array of string ( Required )

GitRepositorySettings type

object with fields:

GitRepositorySettings.Bundle type

object with fields:

  • enable: boolean ( Required )

GitRepositorySettings.MirrorSettings type

object with fields:

  • url: string ( Required )

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

  • detachHEAD: boolean ( Required )

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

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

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

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

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

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

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

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

  • fetchPeriodically: boolean ( Required )

  • fetchBeforeGitCall: boolean ( Required )

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

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

GitRepositorySettings.PreReceiveHook type

object with fields:

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

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

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

GitRepositorySettings.ProtectedBranch type

object with fields:

  • pattern: array of string ( Required )

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

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

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

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

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

  • qualityGate: GitRepositorySettings.QualityGate ( Nullable and Optional , defaults to null)

  • safeMerge: GitRepositorySettings.SafeMerge ( Nullable and Optional , defaults to null)

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

GitRepositorySettings.PushRestrictions type

object with fields:

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

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

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

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

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

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

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

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

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

GitRepositorySettings.QualityGate type

object with fields:

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

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

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

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

  • approvals: array of GitRepositorySettings.QualityGateApproval ( Nullable and Optional , defaults to null)

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

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

GitRepositorySettings.QualityGateApproval type

object with fields:

  • minApprovals: integer (format: int32) ( Required )

  • approvedBy: array of string ( Required )

GitRepositorySettings.SafeMerge type

object with fields:

  • configOid: string ( Required )

GitRepositorySettings.SubtreeSetting type

object with fields:

  • localBranch: string ( Required )

  • localPath: string ( Required )

  • remoteRepo: string ( Required )

  • remoteBranch: string ( Required )

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

GithubRegisterNewUserRule type

object with fields:

  • userType: RegisterNewUserType ( Required )

  • allowed: boolean ( Required )

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

GlobalRole type

Name

Type

className

string

Possible values:

GlobalRole.GlobalAdmin type

No properties

GlobalRole.GlobalMember type

No properties

GlobalRole.Guest type

No properties

GlobalRole.LightGuest type

No properties

GlobalScope type

No properties

GoogleIntegrationDisconnectedEvent type

object with fields:

GoogleRegisterNewUserRule type

object with fields:

  • userType: RegisterNewUserType ( Required )

  • allowed: boolean ( Required )

  • restrictedByDomains: array of string ( Required )

GpgKeyData type

object with fields:

  • fingerprint: string ( Required )

  • publicKey: string ( Required )

  • userIds: array of GpgKeyData.KeyUserId ( 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 )

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

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

GpgKeyData.KeyUserId type

object with fields:

  • id: string ( Required )

  • verified: boolean ( Required )

GuestType type

Name

Type

className

string

Possible values:

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:

  • elements: key-value object of string keys and values of HA_DefaultValue ( Required )

HA_DefaultValue.Reference type

object with fields:

  • paramName: string ( Required )

HA_Deprecation type

object with fields:

  • message: string ( Required )

  • since: string ( Required )

  • forRemoval: boolean ( Required )

HA_Description type

object with fields:

  • text: string ( Required )

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

HA_Dto type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • fields: array of HA_DtoField ( Required )

  • hierarchyRole: HierarchyRole ( Required )

    warning

    Deprecated since 20-07-2021: Use hierarchyRole2.

  • hierarchyRole2: HierarchyRole2 ( Required )

  • extends: HA_Dto ( Nullable and Optional , defaults to null)

  • implements: array of HA_Dto ( Required )

  • inheritors: array of HA_Dto ( Required )

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

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

  • experimental: HA_Experimental ( Nullable and Optional , defaults to null)

  • record: boolean ( Required )

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

  • errorsField: HA_Field ( Nullable and Optional , defaults to null)

HA_DtoField type

object with fields:

  • field: HA_Field ( Required )

  • extension: boolean ( Required )

HA_Endpoint type

object with fields:

  • resource: HA_Resource ( Required )

  • method: HA_Method ( Required )

  • parameters: array of HA_Parameter ( Required )

  • requestBody: HA_Type.Object ( Nullable and Optional , defaults to null)

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

  • path: HA_Path ( Required )

  • displayName: string ( Required )

  • functionName: string ( Required )

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

    warning

    Deprecated since 2022-03-25: Use description instead. It will be removed in a future version.

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

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

  • experimental: HA_Experimental ( Nullable and Optional , defaults to null)

  • rights: array of HA_Right ( Nullable and Optional , defaults to null)

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

  • experimental: HA_Experimental ( Nullable and Optional , defaults to null)

HA_Experimental type

object with fields:

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

HA_FeatureFlag type

object with fields:

  • name: string ( Required )

  • displayName: string ( Required )

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 )

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

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

  • experimental: HA_Experimental ( Nullable and Optional , defaults to null)

HA_InlineError type

Name

Type

className

string

Possible values:

HA_InlineError.InaccessibleFields type

object with fields:

  • fields: array of string ( Required )

  • message: string ( Required )

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:

  • field: HA_Field ( Required )

  • path: boolean ( Required )

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:

  • rightUniqueCode: string ( Required )

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

  • fields: array of HA_Field ( Required )

  • kind: HA_Type.Object.Kind ( Required )

  • nullable: boolean ( Required )

  • tags: array of string ( Required )

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:

  • urlParam: HA_UrlParameter ( Required )

  • nullable: boolean ( Required )

  • tags: array of string ( Required )

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 )

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

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

  • experimental: HA_Experimental ( Nullable and Optional , defaults to null)

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

HA_UrlParameterOption.Var type

object with fields:

  • parameter: HA_Field ( Required )

    warning

    Deprecated since 2021-08-17: Use 'parameters'.

  • parameters: array of HA_Field ( Required )

  • prefixRequired: boolean ( Required )

  • optionName: string ( Required )

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

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

  • experimental: HA_Experimental ( Nullable and Optional , defaults to null)

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

HolidaysEvent type

object with fields:

HubRegisterNewUserRule type

object with fields:

  • userType: RegisterNewUserType ( Required )

  • allowed: boolean ( Required )

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

  • restrictedByGroups: array of string ( Required )

IdeNames type

object with fields:

  • backendFullName: string ( Required )

  • backendShortName: string ( Required )

  • clientFullName: string ( Required )

  • clientShortName: string ( Required )

  • usesSeparateClientProduct: boolean ( Required )

IdeType type

object with fields:

  • id: string ( Required )

  • toolboxId: string ( Required )

  • names: IdeNames ( Required )

  • description: string ( Required )

  • defaultWarmupProfile: string ( Required )

IdeVersionDetails type

object with fields:

  • ideName: string ( Required )

  • version: string ( Required )

  • versionDisplayName: string ( Required )

  • build: string ( Required )

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

  • quality: IdeVersionQuality ( Required )

IdeVersionQuality type

object with fields:

  • name: string ( Required )

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

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

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

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

ImportMessage type

Name

Type

className

string

Possible values:

ImportMessage.Create type

object with fields:

ImportMessage.Delete type

object with fields:

ImportMessage.Update type

object with fields:

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

object with fields:

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

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

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

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

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

InlineDiff type

object with fields:

  • type: GitFileType ( Required )

  • lines: array of InlineDiffLine ( Required )

  • hasFilteredFragments: boolean ( Required )

  • lineEndingDiff: LineEndingDiff ( Nullable and Optional , defaults to null)

  • bomDiff: BOMDiff ( Nullable and Optional , defaults to null)

  • scopes: array of CodeScopeRange ( 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)

InlineUnfurlDetails type

Name

Type

className

string

Possible values:

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)

IntCFFilter type

object with fields:

  • minValue: IntCFValue ( Nullable and Optional , defaults to null)

  • maxValue: IntCFValue ( Nullable and Optional , defaults to null)

IntCFType type

No properties

IntCFValue type

object with fields:

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

IntListCFType type

No properties

IntListCFValue type

object with fields:

  • values: array of integer (format: int32) ( Required )

Invitation type

object with fields:

  • id: string ( Required )

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

  • inviteeEmail: string ( Required )

  • inviteeEmailBlocked: boolean ( Required )

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

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

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

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

  • inviter: CPrincipal ( Required )

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

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

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

  • projectRole: ProjectTeamRole ( Nullable and Optional , defaults to null)

  • globalRole: GlobalRole ( 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)

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

  • globalRole: GlobalRole ( Nullable and Optional , defaults to null)

  • projectRole: ProjectTeamRole ( Required )

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

  • deleted: boolean ( Required )

Issue type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

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

  • projectRef: PR_Project ( Required )

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

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

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

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

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

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

  • parents: array of Issue ( Required )

  • subItemsList: Checklist ( Required )

  • checklists: array of Checklist ( Required )

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

  • channel: M2ChannelRecord ( Required )

  • attachments: array of AttachmentInfo ( Required )

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

  • rtDescription: RtContent ( Nullable and Optional , defaults to null)

  • backlogs: array of BoardBacklog ( Required )

  • sprints: array of SprintRecord ( Required )

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

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

IssueCFFilter type

object with fields:

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:

IssueChannelFilterValueDetails type

object with fields:

  • projectId: string ( Required )

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

IssueCodeReviewLinkRemoved type

object with fields:

  • review: CodeReviewRecord ( Required )

  • issuePrefix: string ( Required )

  • issueId: string ( Required )

IssueCommitLinkRemoved type

object with fields:

  • project: PR_Project ( Required )

  • repositoryId: string ( Required )

  • commitId: string ( Required )

  • issuePrefix: string ( Required )

  • issueId: string ( Required )

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)

IssueEditableByMe type

No properties

IssueFieldFilter type

Name

Type

className

string

Possible values:

IssueFieldFilter.ByCustomField type

object with fields:

IssueFieldFilter.BySystemField type

object with fields:

IssueFieldOrder type

Name

Type

className

string

Possible values:

IssueFieldOrder.Custom type

object with fields:

IssueFieldOrder.System type

object with fields:

IssueFieldOrderIn type

Name

Type

className

string

Possible values:

IssueFieldOrderIn.Custom type

object with fields:

IssueFieldOrderIn.System type

object with fields:

IssueFieldVisibility type

object with fields:

  • field: IssueSystemFieldEnum ( Nullable and Optional , defaults to null)

  • visible: boolean ( Required )

IssueFilterValue type

object with fields:

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)

IssueImportTransactionWebhookEvent type

object with fields:

IssueLinkedToCodeReview type

object with fields:

  • review: CodeReviewRecord ( Required )

  • issuePrefix: string ( Required )

  • issueId: string ( Required )

IssueLinkedToCommit type

object with fields:

  • project: PR_Project ( Required )

  • repositoryId: string ( Required )

  • repositoryName: string ( Required )

  • commit: GitCommitInfo ( Required )

  • commitChanges: GitCommitChanges ( Nullable and Optional , defaults to null)

  • commitUrl: string ( Required )

  • issuePrefix: string ( Required )

  • issueId: string ( Required )

IssueListCFInputValue type

object with fields:

IssueListCFType type

No properties

IssueListCFValue type

object with fields:

  • issues: array of Issue ( Required )

IssueMCExtension type

No properties

IssueMentionedDetails type

object with fields:

IssueMenuActionContext type

object with fields:

IssueMenuItemUiExtensionApi type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

  • visibilityFilters: array of IssueMenuItemVisibilityFilterApi ( Required )

IssueMenuItemUiExtensionIn type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

  • visibilityFilters: array of IssueMenuItemVisibilityFilterIn ( Required )

IssueMenuItemVisibilityFilterApi type

Name

Type

className

string

Possible values:

IssueMenuItemVisibilityFilterIn type

Name

Type

className

string

Possible values:

IssueSearchExpression type

Name

Type

className

string

Possible values:

IssueSearchExpression.And type

object with fields:

IssueSearchExpression.FieldFilter type

object with fields:

IssueSearchExpression.Not type

object with fields:

IssueSearchExpression.Or 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)

IssueStatusFilterValue type

object with fields:

  • name: string ( Required )

  • color: string ( Required )

IssueStatusIn type

Name

Type

className

string

Possible values:

IssueStatusIn.Id type

object with fields:

  • id: string ( Required )

IssueStatusIn.Name type

object with fields:

  • name: string ( Required )

IssueStatusIn.Resolved type

object with fields:

IssueStatusWithUsages type

object with fields:

  • status: IssueStatus ( Required )

  • usages: integer (format: int32) ( Required )

IssueTagsChangedDetails type

object with fields:

  • addedTags: array of PlanningTag ( Nullable and Optional , defaults to null)

  • removedTags: array of PlanningTag ( Nullable and Optional , defaults to null)

IssueTitleChangedDetails type

object with fields:

  • oldTitle: string ( Required )

  • newTitle: string ( Required )

IssueTracker type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • name: string ( Required )

  • systemIssueFieldVisibilities: array of IssueFieldVisibility ( Required )

  • fields: array of IssueFieldOrder ( Required )

IssueUnfurlContext type

object with fields:

  • issueId: string ( Required )

IssueWebhookCustomFieldUpdate type

object with fields:

  • customField: CustomField ( Required )

  • mod: object with fields:

    ( Nullable and Optional , defaults to null)

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:

    • old: array of Topic ( Required )

    • new: array of Topic ( Required )

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

IssuesWidgetSettingsDTO type

object with fields:

  • selectedFilterId: string ( Required )

JobDTO type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • repoName: string ( Required )

  • repository: RepositoryInProject ( Required )

  • archive: boolean ( Required )

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 )

  • failureConditions: array of FailureConditionDTO ( Required )

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

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

object with fields:

JobExecutionTrigger.Schedule type

No properties

JobParameter type

object with fields:

  • name: string ( Required )

  • value: string ( Required )

JobSubscription type

object with fields:

  • id: string ( Required )

  • jobId: string ( Required )

  • project: PR_Project ( Required )

  • state: JobSubscriptionState ( Required )

  • archived: boolean ( Required )

JobSubscriptionState type

object with fields:

  • type: JobSubscriptionType ( Required )

  • containsMyCommit: boolean ( Required )

  • runByMe: boolean ( Required )

KB_Article type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • title: string ( Required )

  • book: KB_Book ( Required )

  • folder: KB_Folder ( Required )

  • documentId: string ( Required )

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

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

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

KbNoneContext type

No properties

KbProjectContext type

object with fields:

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 )

LdapRegisterNewUserRule type

object with fields:

LightGuestType type

No properties

LineEndingDiff type

object with fields:

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)

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

LocalCodeDiscussionAnchorIn type

object with fields:

  • revision: string ( Required )

  • filename: string ( Required )

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

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

LocationCFFilter type

object with fields:

LocationCFInputValue type

object with fields:

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

LocationCFType type

No properties

LocationCFValue type

object with fields:

  • location: TD_Location ( Nullable and Optional , defaults to null)

LocationEvent type

object with fields:

M2AbsenceItemApproveDeletedContent type

object with fields:

M2AbsenceItemApprovedContent type

object with fields:

M2AbsenceItemContent type

object with fields:

M2AbsenceItemDeletedContent type

object with fields:

M2AbsenceItemUpdatedContent type

object with fields:

  • absence: AbsenceRecord ( Required )

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

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

M2BlogItemContent type

object with fields:

M2BlogItemContentDetails type

Name

Type

className

string

Possible values:

M2BlogItemPreview type

object with fields:

M2ChannelAIAssistanceInfo type

object with fields:

  • sessionId: string ( Required )

  • sessionName: string ( Required )

  • llmProvider: string ( Required )

M2ChannelArchivedItemDetails type

No properties

M2ChannelAutomationJobFeedInfo type

object with fields:

  • jobSubscription: JobSubscription ( Required )

  • jobName: string ( Required )

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

  • notificationDefaults: ChannelSpecificDefaults ( Required )

M2ChannelContact type

object with fields:

  • defaultName: string ( Required )

  • key: string ( Required )

  • ext: M2ChannelContactInfo ( Nullable and Optional , defaults to null)

M2ChannelContactArticle type

object with fields:

M2ChannelContactCallDiscussion type

object with fields:

M2ChannelContactInfo type

Name

Type

className

string

Possible values:

M2ChannelContactObsolete type

object with fields:

M2ChannelContactThread type

object with fields:

  • parent: M2ChannelRecord ( Required )

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

  • messageId: string ( Required )

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

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

M2ChannelContentApplication type

object with fields:

M2ChannelContentArticle type

object with fields:

M2ChannelContentCallDiscussion type

object with fields:

M2ChannelContentCodeDiscussion type

object with fields:

M2ChannelContentCodeDiscussionInReview type

object with fields:

M2ChannelContentCodeReviewDiscussion type

object with fields:

M2ChannelContentCodeReviewFeed type

object with fields:

M2ChannelContentInfo type

Name

Type

className

string

Possible values:

M2ChannelContentMember type

object with fields:

M2ChannelContentNamedPrivateChannel type

object with fields:

  • name: string ( Required )

  • notificationDefaults: ChannelSpecificDefaults ( Nullable and Optional , defaults to null)

  • canHaveThreads: boolean ( Required )

  • color: PrivateFeedColor ( Nullable and Optional , defaults to null)

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

M2ChannelContentRecord type

object with fields:

M2ChannelContentThread type

object with fields:

M2ChannelCreatedItemDetails type

No properties

M2ChannelFeedIntroItemDetails type

No properties

M2ChannelIssueInfo type

object with fields:

M2ChannelRdWsTimelineInfo type

object with fields:

  • notificationDefaults: ChannelSpecificDefaults ( Required )

  • workspaceId: string ( Required )

  • workspaceName: string ( Required )

M2ChannelRecord type

object with fields:

  • id: string ( Required )

  • contact: M2ChannelContact ( Required )

  • totalMessages: integer (format: int32) ( Required )

  • lastMessage: MessageInfo ( Nullable and Optional , defaults to null)

  • participants: array of ChannelParticipant ( Nullable and Optional , defaults to null)

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

  • archived: boolean ( Required )

  • pinnedMessages: array of ChannelItemRecord ( Nullable and Optional , defaults to null)

  • content: M2ChannelContentInfo ( Nullable and Optional , defaults to null)

M2ChannelRestoredItemDetails type

No properties

M2DraftEditorAddedItemContent type

object with fields:

  • id: string ( Required )

  • title: string ( Required )

M2DraftEditorTeamAddedItemContent type

object with fields:

  • id: string ( Required )

  • team: TD_Team ( Required )

  • title: string ( Required )

M2ExternalStatusFailureItemContent type

object with fields:

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

  • repository: string ( Required )

  • branch: string ( Required )

  • revisionInfo: RevisionAuthorInfo ( Nullable and Optional , defaults to null)

  • changesInfo: LastChanges ( Nullable and Optional , defaults to null)

  • url: string ( Required )

  • externalServiceName: string ( Required )

  • taskName: string ( Required )

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

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

M2ExternalStatusSucceedItemContent type

object with fields:

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

  • repository: string ( Required )

  • branch: string ( Required )

  • revisionInfo: RevisionAuthorInfo ( Nullable and Optional , defaults to null)

  • changesInfo: LastChanges ( Nullable and Optional , defaults to null)

  • url: string ( Required )

  • externalServiceName: string ( Required )

  • taskName: string ( Required )

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

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

M2ItemContentDetails type

Name

Type

className

string

Possible values:

M2LiveTypedContent type

object with fields:

  • session: string ( Required )

  • message: string ( Required )

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

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

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

M2MaintenanceActionContent type

object with fields:

  • action: string ( Required )

  • success: boolean ( Required )

  • details: string ( Required )

M2MemberContent type

Name

Type

className

string

Possible values:

No properties

M2MemberJoinsContent type

object with fields:

M2MemberLeavesContent type

object with fields:

M2MembershipContent type

Name

Type

className

string

Possible values:

No properties

M2MembershipCreatedContent type

object with fields:

M2MembershipRequestedContent type

object with fields:

  • membership: TD_Membership ( Required )

  • leave: boolean ( Required )

M2MembershipTerminatedContent type

object with fields:

M2PackageContentDetails type

Name

Type

className

string

Possible values:

M2PackageCreatedDetails type

object with fields:

M2PackageDeletedDetails type

object with fields:

M2PollContent type

object with fields:

M2PrivateConversationChannelContent type

object with fields:

  • channelId: string ( Required )

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

  • members: array of TD_MemberProfile ( Required )

  • notificationDefaults: ChannelSpecificDefaults ( Nullable and Optional , defaults to null)

M2SharedChannelContent type

object with fields:

  • name: string ( Required )

  • group: string ( Required )

  • access: M2.Access ( Required )

  • description: string ( Required )

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

  • notificationDefaults: ChannelSpecificDefaults ( Required )

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

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

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

M2TaskExecutionFailureItemContent type

object with fields:

  • taskExecutionId: string ( Required )

  • taskExecutionName: string ( Required )

  • repoName: string ( Required )

  • branchName: string ( Required )

  • commit: string ( Required )

  • shortCommitMessage: string ( Required )

  • project: ProjectKey ( Required )

  • finishDateTime: integer (format: int64) ( Required )

  • triggerInfo: string ( Required )

  • details: string ( Required )

M2TaskExecutionSucceedItemContent type

object with fields:

  • taskExecutionId: string ( Required )

  • taskExecutionName: string ( Required )

  • repoName: string ( Required )

  • branchName: string ( Required )

  • commit: string ( Required )

  • shortCommitMessage: string ( Required )

  • project: ProjectKey ( Required )

  • finishDateTime: integer (format: int64) ( Required )

  • triggerInfo: string ( Required )

  • details: string ( Required )

M2TextItemContent type

object with fields:

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

  • mentions: array of EntityMention ( Nullable and Optional , defaults to null)

M2UnreadStatus type

object with fields:

  • unread: boolean ( Required )

  • counter: integer (format: int32) ( Required )

  • id: string ( Required )

M2UserLeftChannel type

No properties

MCAction type

object with fields:

  • id: string ( Required )

  • value: string ( Required )

  • clientSideAction: MCClientSideAction ( Nullable and Optional , defaults to null)

MCButton type

object with fields:

  • text: string ( Required )

  • style: MessageButtonStyle ( Nullable and Optional , defaults to null)

  • action: MCAction ( Required )

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

MCClientSideAction type

object with fields:

MCDivider type

No properties

MCElement type

object with fields:

  • defaultText: string ( Required )

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

MCElementDetails type

Name

Type

className

string

Possible values:

MCFields type

object with fields:

  • fields: array of object with fields:

    • first: MCElement ( Nullable and Optional , defaults to null)

    • second: MCElement ( Nullable and Optional , defaults to null)

    ( Required )

MCGroup type

object with fields:

MCIcon type

object with fields:

  • name: string ( Required )

  • style: MessageStyle ( Nullable and Optional , defaults to null)

MCImage type

object with fields:

  • src: string ( Required )

MCInlineElement type

object with fields:

MCInlineElementDetails type

Name

Type

className

string

Possible values:

MCInlineGroup type

object with fields:

MCInlineText type

object with fields:

  • content: string ( Required )

  • markdown: boolean ( Required )

  • style: MessageStyle ( Nullable and Optional , defaults to null)

MCMessage type

object with fields:

MCMessageCommonDetails type

No properties

MCOutline type

Name

Type

className

string

Possible values:

MCOutlineLegacy type

object with fields:

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

  • text: MCText ( Nullable and Optional , defaults to null)

MCOutlineV2 type

object with fields:

MCParagraph type

object with fields:

  • accessory: MCElement ( Nullable and Optional , defaults to null)

  • elements: array of MCElement ( Required )

MCSection type

object with fields:

  • elements: array of MCElement ( Required )

  • style: MessageStyle ( Nullable and Optional , defaults to null)

  • header: MCText ( Nullable and Optional , defaults to null)

  • footer: MCText ( Nullable and Optional , defaults to null)

MCTag type

object with fields:

  • text: string ( Required )

  • style: MessageStyle ( Nullable and Optional , defaults to null)

MCText type

object with fields:

  • content: string ( Required )

  • markdown: boolean ( Required )

  • accessory: MCElement ( Nullable and Optional , defaults to null)

  • style: MessageStyle ( Nullable and Optional , defaults to null)

  • size: MessageTextSize ( Nullable and Optional , defaults to null)

MCTextOrInline type

No properties

MCTimestamp type

object with fields:

  • ts: integer (format: int64) ( Required )

  • style: MessageStyle ( Nullable and Optional , defaults to null)

  • format: MessageTimestampFormat ( Nullable and Optional , defaults to null)

  • strikethrough: boolean ( Required )

MarketplaceAppMetadata type

object with fields:

  • marketplaceAppId: string ( Required )

  • lastSentServerUrl: string ( Required )

  • connectionStatus: AppConnectionStatus ( Required )

  • uninstallationStatus: AppUninstallationStatus ( Nullable and Optional , defaults to null)

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

MavenChecksum type

object with fields:

  • algorithm: string ( Required )

  • value: string ( Required )

MavenCoordinates type

object with fields:

  • groupId: string ( Required )

  • artifactId: string ( Required )

  • version: string ( Required )

MavenPackageDependency type

object with fields:

  • scope: string ( Required )

  • group: string ( Required )

  • artifact: string ( Required )

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

MavenPackageFile type

object with fields:

  • name: string ( Required )

  • created: integer (format: int64) ( Required )

  • length: integer (format: int64) ( Required )

  • checksums: array of MavenChecksum ( Required )

MavenPackageParent type

object with fields:

  • group: string ( Required )

  • artifact: string ( Required )

  • version: string ( Required )

MavenPackageType type

object with fields:

  • id: string ( Required )

MavenPackageVersionDetails type

object with fields:

  • type: PackageType ( Required )

  • repository: string ( Required )

  • name: string ( Required )

  • version: string ( Required )

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

  • created: integer (format: int64) ( Required )

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

  • downloads: integer (format: int64) ( Required )

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

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

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

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

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

  • licenses: array of string ( Required )

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

  • dependencies: array of MavenPackageDependency ( Required )

  • kotlinPlatforms: array of KotlinPlatform ( Nullable and Optional , defaults to null)

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

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

  • files: array of MavenPackageFile ( Required )

MavenRepositoryConnectionSettings type

object with fields:

MdMarkup type

object with fields:

  • unfurl: array of Unfurl ( Required )

MdTextDocumentContent type

object with fields:

  • markdown: string ( Required )

MeCodeReviewParticipantRecord type

object with fields:

  • id: string ( Required )

  • role: CodeReviewParticipantRole ( Nullable and Optional , defaults to null)

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

  • reviewerState: ReviewerState ( Nullable and Optional , defaults to null)

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

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

  • review: CodeReviewRecord ( Required )

  • participants: CodeReviewParticipants ( Required )

  • pendingCounter: CodeReviewPendingMessageCounter ( Required )

  • archived: boolean ( Required )

MediaAttachment type

Name

Type

className

string

Possible values:

MeetingAttachment type

object with fields:

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

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

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

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

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

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

MeetingMenuActionContext type

object with fields:

  • meetingId: string ( Required )

MeetingMenuItemUiExtensionApi type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

MeetingMenuItemUiExtensionIn type

object with fields:

  • displayName: string ( Required )

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

  • menuItemUniqueCode: string ( Required )

MeetingModWebhookEvent type

object with fields:

MeetingOccurrenceTime type

object with fields:

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

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

MeetingOrganizer type

Name

Type

className

string

Possible values:

MeetingOrganizer.Application type

object with fields:

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

MeetingOrganizer.ExternalUser type

object with fields:

  • email: string ( Required )

MeetingOrganizer.HiddenUser type

No properties

MeetingOrganizer.User type

object with fields:

MeetingRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

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

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

  • timezone: ATimeZone ( Nullable and Optional , defaults to null)

  • allDay: boolean ( Required )

  • rooms: array of TD_Location ( Required )

  • participants: array of Participant ( Required )

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

MeetingWithOccurrenceTime type

object with fields:

MeetingsCommonSubscriptionFilter type

object with fields:

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

  • participants: array of TD_MemberProfile ( 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)

MeetingsCommonSubscriptionFilterIn type

object with fields:

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

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

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

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

MemberCommonSubscriptionFilter type

object with fields:

MemberCommonSubscriptionFilterIn type

object with fields:

  • teams: array of string ( Required )

  • locations: array of string ( Required )

  • profiles: array of ProfileIdentifier ( Nullable and Optional , defaults to null)

MembersAddedItemDetails type

object with fields:

  • principals: array of CPrincipal ( Required )

  • othersDisplayNames: array of string ( Required )

MembershipEvent type

object with fields:

MembershipMCExtension type

No properties

Name

Type

className

string

Possible values:

object with fields:

  • menuItemUniqueCode: string ( Required )

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

  • clientId: string ( Required )

  • userId: string ( Required )

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

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

Name

Type

className

string

Possible values:

Name

Type

className

string

Possible values:

MergeRequestBranch type

object with fields:

  • displayName: string ( Required )

  • ref: string ( Required )

  • deleted: boolean ( Required )

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

MergeRequestBranchDeletedEvent type

object with fields:

MergeRequestBranchPair type

object with fields:

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

  • repository: string ( Required )

  • sourceBranch: string ( Required )

  • targetBranch: string ( Required )

  • sourceBranchRef: string ( Required )

  • sourceBranchInfo: MergeRequestBranch ( Nullable and Optional , defaults to null)

  • targetBranchInfo: MergeRequestBranch ( Nullable and Optional , defaults to null)

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

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

MergeRequestBranchRestoredEvent type

object with fields:

MergeRequestMergedEvent type

object with fields:

  • repository: string ( Required )

  • sourceBranch: string ( Required )

  • targetBranch: string ( Required )

MergeRequestRecord type

object with fields:

  • id: string ( Required )

  • project: ProjectKey ( Required )

  • projectId: string ( Required )

  • number: integer (format: int32) ( Required )

  • title: string ( Required )

  • state: CodeReviewState ( Required )

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

  • createdAt: integer (format: int64) ( Required )

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

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

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

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

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

  • branchPairs: array of MergeRequestBranchPair ( Required )

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

  • externalLink: ExternalCodeReviewLink ( Nullable and Optional , defaults to null)

  • discussionCounter: DiscussionCounter ( Required )

  • participants: array of CodeReviewParticipant ( Nullable and Optional , defaults to null)

  • reviewers: array of CodeReviewParticipantRecord ( Required )

    warning

    Deprecated since 2020-11-03: Use participants. It will be removed in a future version.

  • authors: array of CodeReviewParticipantRecord ( Required )

    warning

    Deprecated since 2020-11-03: Use participants. It will be removed in a future version.

  • watchers: array of CodeReviewParticipantRecord ( Required )

    warning

    Deprecated since 2020-11-03: Use participants. It will be removed in a future version.

  • commits: array of ReviewCommit ( Required )

  • issueIds: array of string ( Required )

  • externalIssues: array of ExternalIssueIdOut ( Nullable and Optional , defaults to null)

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

  • unfurls: array of Attachment ( Required )

MergeSelectOptions type

object with fields:

MessageAccessoryElement type

Name

Type

className

string

Possible values:

MessageAction type

Name

Type

className

string

Possible values:

MessageActionPayload type

object with fields:

  • actionId: string ( Required )

  • actionValue: string ( Required )

  • message: MessageContext ( Required )

  • clientId: string ( Required )

  • userId: string ( Required )

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

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

MessageBlockElement type

Name

Type

className

string

Possible values:

MessageButton type

object with fields:

  • text: string ( Required )

  • style: MessageButtonStyle ( Required )

  • action: MessageAction ( Required )

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

MessageContext type

object with fields:

  • messageId: string ( Required )

  • channelId: string ( Required )

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

  • body: ChatMessage ( Nullable and Optional , defaults to null)

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

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

  • createdTime: string ( Required )

MessageControlElement type

Name

Type

className

string

Possible values:

MessageControlGroup type

object with fields:

MessageDivider type

No properties

MessageField type

object with fields:

  • first: string ( Required )

  • second: string ( Required )

MessageFieldElement type

Name

Type

className

string

Possible values:

  • MessageField

  • MessageFieldV2

    warning

    Experimental . This part of API is not supported yet on mobile clients. Messages using it will be replaced with stubs on iOS and Android.

MessageFieldV2 type

object with fields:

(Experimental)

warning

Experimental . This part of API is not supported yet on mobile clients. Messages using it will be replaced with stubs on iOS and Android.

MessageFields type

object with fields:

MessageForImport type

object with fields:

  • authorPrincipalId: string ( Required )

  • text: string ( Required )

  • createdAtUtc: integer (format: int64) ( Required )

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

MessageIcon type

object with fields:

MessageImage type

object with fields:

  • src: string ( Required )

MessageInfo type

object with fields:

  • id: string ( Required )

  • text: string ( Required )

  • time: integer (format: int64) ( Required )

  • author: CPrincipal ( Required )

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

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

MessageInlineElement type

Name

Type

className

string

Possible values:

MessageInlineGroup type

object with fields:

(Experimental)

warning

Experimental . This part of API is not supported yet on mobile clients. Messages using it will be replaced with stubs on iOS and Android.

MessageInlineText type

object with fields:

  • text: string ( Required )

  • style: MessageStyle ( Nullable and Optional , defaults to null)

object with fields:

  • channelKey: string ( Required )

  • channelId: string ( Required )

  • messageId: string ( Required )

MessageOutline type

object with fields:

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

  • text: string ( Required )

MessageOutlineBase type

Name

Type

className

string

Possible values:

  • MessageOutline

    Outline containing inline markdown text with an optional icon

  • MessageOutlineElements

    warning

    Experimental . This part of API is not supported yet on mobile clients. Messages using it will be replaced with stubs on iOS and Android.

    New outline containing a number of various inline elements

MessageOutlineElements type

object with fields:

(Experimental)

warning

Experimental . This part of API is not supported yet on mobile clients. Messages using it will be replaced with stubs on iOS and Android.

MessagePayload type

object with fields:

  • message: MessageContext ( Required )

  • clientId: string ( Required )

  • userId: string ( Required )

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

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

MessageSection type

object with fields:

  • elements: array of MessageBlockElement ( Required )

    Block elements that constitute the section

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

    Header text is displayed with a large font size at the top of the section

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

    Footer text is displayed with a small font size and in a dimmed color at the bottom of the section

  • style: MessageStyle ( Nullable and Optional , defaults to null)

    warning

    Experimental . This parameter is not supported yet on mobile clients and will be ignored on iOS and Android.

    Section style determines the color of the left-hand side bar

  • textSize: MessageTextSize ( Nullable and Optional , defaults to null)

    warning

    Experimental . This parameter is not supported yet on mobile clients and will be ignored on iOS and Android.

    Default text size for all the elements within the section ( excluding header and footer )

MessageSectionElement type

Name

Type

className

string

Possible values:

MessageTag type

object with fields:

  • text: string ( Required )

  • style: MessageStyle ( Nullable and Optional , defaults to null)

MessageText type

object with fields:

MessageTimestamp type

object with fields:

  • ts: integer (format: int64) ( Required )

  • style: MessageStyle ( Nullable and Optional , defaults to null)

  • format: MessageTimestampFormat ( Nullable and Optional , defaults to null)

  • strikethrough: boolean ( Required )

MetricsEvent type

object with fields:

  • id: string ( Required )

  • time: integer (format: int64) ( Required )

  • props: array of MetricsProp ( Nullable and Optional , defaults to null)

  • points: array of MetricsPoint ( Nullable and Optional , defaults to null)

MetricsPoint type

object with fields:

  • key: string ( Required )

  • value: integer (format: int64) ( Required )

MetricsProp type

object with fields:

  • key: string ( Required )

  • value: string ( Required )

MetricsRequest type

object with fields:

object with fields:

  • item: string ( Required )

  • enabled: boolean ( Required )

object with fields:

  • url: string ( Required )

  • withBackUrl: boolean ( Required )

  • openInNewTab: boolean ( Required )

object with fields:

  • url: string ( Required )

  • withBackUrl: boolean ( Required )

  • openInNewTab: boolean ( Required )

NewExternalIssueEventPayload type

object with fields:

  • clientId: string ( Required )

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

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

NewMergeRequestFromIssueActionContext type

object with fields:

NewMessage type

object with fields:

  • text: string ( Required )

  • temporaryId: string ( Required )

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

  • pending: boolean ( Required )

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

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

NewUnfurlQueueItemsPayload type

object with fields:

  • clientId: string ( Required )

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

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

NexusStagingProfile type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

NonWorkingDays type

object with fields:

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

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

  • startsEarlier: boolean ( Required )

  • endsLater: boolean ( Required )

NonWorkingDaysEvent type

object with fields:

NonZeroExitCodeDTO type

No properties

NotSet type

No properties

NpmPackageDependency type

object with fields:

  • name: string ( Required )

  • version: string ( Required )

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

NpmPackageType type

object with fields:

  • id: string ( Required )

NpmPackageVersionDetails type

object with fields:

  • type: PackageType ( Required )

  • repository: string ( Required )

  • name: string ( Required )

  • version: string ( Required )

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

  • created: integer (format: int64) ( Required )

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

  • downloads: integer (format: int64) ( Required )

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

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

  • dependencies: array of NpmPackageDependency ( Required )

  • keywords: array of string ( Required )

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

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

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

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

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

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

NuGetDependency type

object with fields:

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

  • id: string ( Required )

  • range: string ( Required )

NuGetPackageType type

object with fields:

  • id: string ( Required )

NuGetPackageVersionDetails type

object with fields:

  • type: PackageType ( Required )

  • repository: string ( Required )

  • name: string ( Required )

  • version: string ( Required )

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

  • created: integer (format: int64) ( Required )

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

  • downloads: integer (format: int64) ( Required )

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

  • verbatimVersion: string ( Required )

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

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

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

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

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

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

  • dependencies: array of NuGetDependency ( Required )

OIDCDiscovery type

object with fields:

  • issuer: string ( Required )

  • authorizationEndpoint: string ( Required )

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

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

  • jwksUri: string ( Required )

OidcRegisterNewUserRule type

object with fields:

  • userType: RegisterNewUserType ( Required )

  • allowed: boolean ( Required )

  • restrictedByDomains: array of string ( Required )

OpenEnumCFCreateParameters type

object with fields:

  • values: array of string ( Required )

OpenEnumCFInputValue type

object with fields:

OpenEnumCFType type

No properties

OpenEnumCFUpdateParameters type

object with fields:

OpenEnumCFValue type

object with fields:

OpenEnumListCFInputValue type

object with fields:

OpenEnumListCFType type

No properties

OpenEnumListCFValue type

object with fields:

OpenPersonalFeedSettingsAction type

object with fields:

  • tab: string ( Required )

  • feed: string ( Required )

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

OrgDomainDTO type

object with fields:

  • domain: string ( Required )

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

  • orgUrl: string ( Required )

OrgThrottlingStatus type

object with fields:

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

OrganizationForUpdateDTO type

object with fields:

  • name: string ( Optional )

  • slogan: string ( Nullable and Optional )

  • logoId: string ( Nullable and Optional )

  • logoSmall: string ( Nullable and Optional )

  • logo: string ( Nullable and Optional )

  • onboardingRequired: boolean ( Optional )

  • userAgreementAccepted: boolean ( Optional )

  • timezone: ATimeZone ( Nullable and Optional )

  • license: string ( Nullable and Optional )

  • orgSize: OrgSizeDTO ( Nullable and Optional )

  • orgIndustry: OrgIndustryDTO ( Nullable and Optional )

  • sendAnonymousDataAgreementAccepted: boolean ( Optional )

  • marketplaceEnabled: boolean ( Optional )

OrganizationRecord type

object with fields:

  • id: string ( Required )

  • orgId: string ( Required )

  • name: string ( Required )

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

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

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

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

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

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

  • timezone: ATimeZone ( Nullable and Optional , defaults to null)

  • orgSize: OrgSizeDTO ( Nullable and Optional , defaults to null)

  • orgIndustry: OrgIndustryDTO ( Nullable and Optional , defaults to null)

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

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

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

    warning

    Deprecated since 2021-10-13: Slack integration is no longer supported. It will be removed in a future version.

OutOfMemoryDTO type

No properties

Overdrafts type

object with fields:

  • storage: integer (format: int32) ( Required )

  • bandwidth: integer (format: int32) ( Required )

  • ciCredits: integer (format: int32) ( Required )

PR_PrivateProject type

object with fields:

  • key: ProjectKey ( Required )

  • name: string ( Required )

  • accessAllowed: boolean ( Required )

  • admins: array of TD_MemberProfile ( Required )

PR_Project type

object with fields:

  • id: string ( Required )

  • key: ProjectKey ( Required )

  • name: string ( Required )

  • private: boolean ( Required )

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

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

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

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

  • archived: boolean ( Required )

  • trackers: array of ProjectIssueTrackerItem ( Required )

  • enable: boolean ( Required )

  • hoursInDay: integer (format: int32) ( Required )

  • daysInWeek: integer (format: int32) ( Required )

  • format: DurationTextFormat ( Required )

  • packages: array of ProjectPackageRepository ( Required )

  • type: ProjectTeamType ( Required )

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

  • members: array of ProjectTeamMemberRecord ( Nullable and Optional , defaults to null)

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

  • guestProfiles: array of TD_MemberProfile ( Required )

  • personalFeaturePins: array of ToggleableProjectFeaturePins ( Nullable and Optional , defaults to null)

  • collaboratorsProfiles: array of TD_MemberProfile ( Required )

  • collaboratorsTeams: array of TD_Team ( Required )

  • features: array of ProjectFeatureState ( Nullable and Optional , defaults to null)

  • featuresUsage: array of ProjectFeatureUsage ( Nullable and Optional , defaults to null)

  • repos: array of PR_RepositoryInfo ( Required )

  • boards: array of BoardRecord ( Required )

  • featurePins: array of CommonProjectFeaturePins ( Nullable and Optional , defaults to null)

  • memberProfiles: array of TD_MemberProfile ( Required )

  • memberTeams: array of TD_Team ( Required )

  • adminProfiles: array of TD_MemberProfile ( Required )

  • adminTeams: array of TD_Team ( Required )

  • tags: array of string ( Required )

PR_RepositoryInfo type

object with fields:

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

  • name: string ( Required )

  • description: string ( Required )

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

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

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

  • state: RepositoryState ( Required )

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

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

  • monthlyActivity: RepositoryActivity ( Nullable and Optional , defaults to null)

  • defaultBranch: BranchInfo ( Nullable and Optional , defaults to null)

PR_Tag type

object with fields:

  • name: string ( Required )

  • projectCount: integer (format: int32) ( Required )

PackageData type

object with fields:

  • type: PackageType ( Required )

  • repository: string ( Required )

  • name: string ( Required )

  • versions: integer (format: int64) ( Required )

  • updated: integer (format: int64) ( Required )

  • lastVersion: string ( Required )

PackageMetadata type

object with fields:

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

PackageOrigin type

Name

Type

className

string

Possible values:

PackageOrigin.Build type

object with fields:

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

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

PackageOrigin.Url type

object with fields:

  • url: string ( Required )

PackageRepository type

object with fields:

  • id: string ( Required )

  • type: PackageType ( Required )

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

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

  • public: boolean ( Required )

  • cleanupEnabled: boolean ( Required )

  • settings: ES_PackageRepositorySettings ( Nullable and Optional , defaults to null)

  • mode: PackageRepositoryMode ( Required )

  • archived: boolean ( Required )

PackageRepositoryConnection type

Name

Type

className

string

Possible values:

PackageRepositoryConnection.Remote type

object with fields:

  • id: string ( Required )

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

  • enabled: boolean ( Required )

  • rememberDownloaded: boolean ( Required )

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

  • url: string ( Required )

  • credentials: PackageRepositoryCredentials ( Required )

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

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

  • settings: PackageRepositoryConnectionSettings ( Nullable and Optional , defaults to null)

PackageRepositoryConnection.Space type

object with fields:

  • id: string ( Required )

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

  • enabled: boolean ( Required )

  • rememberDownloaded: boolean ( Required )

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

  • repository: ProjectPackageRepository ( Required )

PackageRepositoryConnectionSettings type

Name

Type

className

string

Possible values:

PackageRepositoryPermissionContext type

object with fields:

PackageType type

Name

Type

className

string

Possible values:

PackageVersionData type

object with fields:

  • type: PackageType ( Required )

  • repository: string ( Required )

  • name: string ( Required )

  • version: string ( Required )

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

  • pinned: boolean ( Required )

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

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

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

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

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

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

PackageVersionDetails type

Name

Type

className

string

Possible values:

PackageVersionInfo type

object with fields:

  • type: PackageType ( Required )

  • repository: string ( Required )

  • name: string ( Required )

  • version: string ( Required )

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

PackageVersionRef type

object with fields:

  • name: string ( Required )

  • version: string ( Required )

PackagesAccess type

object with fields:

  • permissions: array of PackagesAccessRecipient ( Nullable and Optional , defaults to null)

  • restricted: boolean ( Required )

PackagesAccessRecipient type

object with fields:

PackagesAccessRecipientIdentifier type

object with fields:

PackagesExecutionResult type

Name

Type

className

string

Possible values:

PackagesExecutionResult.Failure type

object with fields:

  • error: string ( Required )

PackagesExecutionResult.Success type

No properties

PackagesPublishing type

object with fields:

  • publishingId: string ( Required )

  • source: PublishingSource ( Required )

  • created: integer (format: int64) ( Required )

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

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

  • successful: boolean ( Required )

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

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

PackagesSubscriptionFilter type

object with fields:

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

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

  • namePattern: array of string ( Required )

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

PackagesSubscriptionFilterIn type

object with fields:

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

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

  • namePattern: array of string ( Required )

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

PageUiExtensionApi type

Name

Type

className

string

Possible values:

PageUiExtensionIn type

Name

Type

className

string

Possible values:

ParameterLastUsageDTO type

object with fields:

  • jobExecutionId: string ( Required )

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

  • jobName: string ( Required )

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

Participant type

object with fields:

ParticipantOnProject type

object with fields:

ParticipantStateData type

object with fields:

  • audioEnabled: boolean ( Required )

  • videoEnabled: boolean ( Required )

  • screenShared: boolean ( Required )

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

ParticipantTeamOnProject type

object with fields:

PercentageCFConstraint type

No properties

PercentageCFFilter type

object with fields:

PercentageCFType type

No properties

PercentageCFValue type

object with fields:

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

PermissionContextApi type

Name

Type

className

string

Possible values:

PermissionTarget type

Name

Type

className

string

Possible values:

PermissionsRecipient type

Name

Type

className

string

Possible values:

PermissionsRecipient.Profile type

object with fields:

PermissionsRecipient.Team type

object with fields:

PersonalDocumentContainerInfo type

object with fields:

  • owner: TD_MemberProfile ( Required )

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

PersonalSubscriptionEvent type

object with fields:

  • eventCode: string ( Required )

  • name: string ( Required )

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

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

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

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

PersonalSubscriptionSettings type

object with fields:

PersonalSubscriptionSubjectSettings type

object with fields:

  • subjectCode: string ( Required )

  • enabled: boolean ( Required )

PersonalSubscriptionTarget type

object with fields:

  • subjectCode: string ( Required )

  • targetCode: string ( Required )

  • description: string ( Required )

  • events: array of PersonalSubscriptionEvent ( Required )

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

PingWebhookEvent type

object with fields:

  • webhookName: string ( Required )

PlainParameterRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • bundleId: string ( Required )

  • key: string ( Required )

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

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

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

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

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

  • value: string ( Required )

PlanItem type

object with fields:

  • id: string ( Required )

  • checklistId: string ( Required )

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

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

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

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

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

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

  • hasChildren: boolean ( Required )

  • archived: boolean ( Required )

  • topics: array of Topic ( Required )

  • children: array of PlanItem ( Required )

PlanItemChildren type

object with fields:

  • id: string ( Required )

  • children: array of PlanItem ( Required )

  • archived: boolean ( Required )

PlanningTag type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • projectId: string ( Required )

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

  • name: string ( Required )

PlanningTagFilterValue type

object with fields:

PlanningTagIn type

Name

Type

className

string

Possible values:

PlanningTagIn.Id type

object with fields:

  • id: string ( Required )

PlanningTagIn.Name type

object with fields:

  • path: array of string ( Required )

PollRecord type

object with fields:

  • id: string ( Required )

  • owner: TD_MemberProfile ( Required )

  • question: string ( Required )

  • meVote: boolean ( Required )

  • countPeople: integer (format: int32) ( Required )

  • anonymous: boolean ( Required )

  • closed: boolean ( Required )

  • extendable: boolean ( Required )

  • multiChoice: boolean ( Required )

  • ended: boolean ( Required )

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

  • votes: array of VoteGroup ( Required )

PostMessageAction type

object with fields:

  • actionId: string ( Required )

  • payload: string ( Required )

PostUnfurlContentResult type

Name

Type

className

string

Possible values:

PostUnfurlContentResult.EntityNotFound type

object with fields:

  • queueItemId: string ( Required )

PostUnfurlContentResult.NotApproved type

object with fields:

  • queueItemId: string ( Required )

PostUnfurlContentResult.QueueItemNotFound type

object with fields:

  • queueItemId: string ( Required )

PostUnfurlContentResult.Success type

object with fields:

  • queueItemId: string ( Required )

PostponeWorkspaceDeletionChannelAction type

object with fields:

  • workspaceId: string ( Required )

PostponedChannelItem type

object with fields:

  • id: string ( Required )

  • channelId: string ( Required )

  • message: string ( Required )

  • attachments: array of AttachmentInfo ( Required )

  • etag: integer (format: int64) ( Required )

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

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

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

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

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

  • archived: boolean ( Required )

PreferredIdeVersion type

Name

Type

className

string

Possible values:

PreferredIdeVersion.Fixed type

object with fields:

PreferredIdeVersion.LatestOfQuality type

object with fields:

PrincipalFilterValue type

object with fields:

  • principalIn: PrincipalIn ( Nullable and Optional , defaults to null)

PrivateChannelPermissionContext type

object with fields:

  • channelId: string ( Required )

PrivateFeed type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • icon: string ( Required )

  • color: PrivateFeedColor ( Required )

PrivateProjectPermissionContext type

object with fields:

  • projectId: string ( Required )

ProducerOptions type

object with fields:

  • sfuOptions: SFUProducerOptions ( Required )

  • userConnectionId: integer (format: int64) ( Required )

  • routerId: string ( Required )

  • source: MediaSource ( Required )

Profile2FARequirement type

object with fields:

  • roleId: string ( Required )

  • roleCode: string ( Required )

  • roleName: string ( Required )

ProfileCFFilter type

object with fields:

ProfileCFInputValue type

object with fields:

ProfileCFType type

No properties

ProfileCFValue type

object with fields:

ProfileEvent type

object with fields:

ProfileLinkPreview type

object with fields:

ProfileListCFInputValue type

object with fields:

ProfileListCFType type

No properties

ProfileListCFValue type

object with fields:

ProfileMembershipRecord type

object with fields:

  • id: string ( Required )

  • memberships: array of TD_Membership ( Required )

  • unapprovedMemberships: array of TD_Membership ( Nullable and Optional , defaults to null)

ProfileOrganizationEvent type

object with fields:

  • meta: KMetaMod ( Required )

  • member: TD_MemberProfile ( Required )

  • joinedOrganization: boolean ( Required )

  • leftOrganization: boolean ( Required )

ProfilePermissionTarget type

object with fields:

ProjectAdminRoleApi type

No properties

ProjectCFFilter type

object with fields:

ProjectCFInputValue type

object with fields:

ProjectCFType type

No properties

ProjectCFValue type

object with fields:

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

ProjectCommonSubscriptionFilter type

object with fields:

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

ProjectCommonSubscriptionFilterIn type

object with fields:

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

ProjectCustomRoleApi type

object with fields:

  • role: string ( Required )

ProjectEvent type

object with fields:

ProjectExternalRoleApi type

No properties

ProjectFeaturePinnedItem type

object with fields:

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

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

ProjectFeaturePinsIn type

object with fields:

ProjectFeatureState type

object with fields:

ProjectFeatureUsage type

object with fields:

  • feature: ProjectFeature ( Required )

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

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

ProjectIssueTrackerItem type

object with fields:

ProjectKey type

object with fields:

  • key: string ( Required )

ProjectMemberRoleApi type

No properties

ProjectPackageRepository type

object with fields:

  • id: string ( Required )

  • project: PR_Project ( Required )

  • name: string ( Required )

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

  • repository: PackageRepository ( Required )

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

  • archived: boolean ( Required )

  • connections: array of PackageRepositoryConnection ( Required )

ProjectPermissionContext type

object with fields:

ProjectPermissionTarget type

object with fields:

ProjectReposRecord type

object with fields:

ProjectRoleApi type

Name

Type

className

string

Possible values:

ProjectScope type

object with fields:

ProjectTeamMemberRecord type

object with fields:

  • id: string ( Required )

  • project: PR_Project ( Required )

  • profile: TD_MemberProfile ( Required )

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

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

  • archived: boolean ( Required )

ProjectTeamRole type

Name

Type

className

string

Possible values:

ProjectTeamRole.Admin type

No properties

ProjectTeamRole.Collaborator type

No properties

(Deprecated)

warning

Deprecated since 2023-07-01: Project collaborators are no longer supported. It will be removed in a future version.

ProjectTeamRole.Member type

No properties

ProvideExternalIssueData type

object with fields:

  • issuePrefix: string ( Required )

  • issueId: string ( Required )

PublicHoliday type

object with fields:

  • id: string ( Required )

  • calendar: PublicHolidayCalendarRecord ( Required )

  • name: string ( Required )

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

  • workingDay: boolean ( Required )

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

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

PublicHolidayCalendarRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • name: string ( Required )

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

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

  • eventsCount: integer (format: int32) ( Required )

  • location: TD_Location ( Required )

PublicationDetails type

Name

Type

className

string

Possible values:

PublicationDetailsIn type

Name

Type

className

string

Possible values:

PublishMessage type

object with fields:

  • id: string ( Required )

PublishingSource type

Name

Type

className

string

Possible values:

PublishingSource.Packages type

object with fields:

PurchasedBillingPlan type

object with fields:

  • id: string ( Required )

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

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

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

  • plan: string ( Required )

  • billingPeriod: string ( Required )

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

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

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

  • currency: Currency ( Required )

  • addUserPrice: number (format: double) ( Required )

  • addStoragePrice: number (format: double) ( Required )

  • addBandwidthPrice: number (format: double) ( Required )

  • addCiCreditPrice: number (format: double) ( Required )

  • minActiveUsers: integer (format: int32) ( Required )

  • prepaidUsers: integer (format: int32) ( Required )

  • storagePerUser: integer (format: int32) ( Required )

  • storageOverall: integer (format: int32) ( Required )

  • bandwidthPerUser: integer (format: int32) ( Required )

  • bandwidthOverall: integer (format: int32) ( Required )

  • ciCredits: integer (format: int32) ( Required )

  • ciCreditsReserve: integer (format: int32) ( Required )

  • ciCreditsRateForExternalWorker: number (format: double) ( Nullable and Optional , defaults to null)

  • integrations: integer (format: int32) ( Required )

  • searchHistory: integer (format: int32) ( Required )

  • balance: number (format: double) ( Required )

  • hardLimitAmount: number (format: double) ( Required )

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

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

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

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

PythonChecksum type

object with fields:

  • algorithm: string ( Required )

  • value: string ( Required )

PythonPackageFile type

object with fields:

  • name: string ( Required )

  • created: integer (format: int64) ( Required )

  • length: integer (format: int64) ( Required )

  • checksums: array of PythonChecksum ( Required )

PythonPackageType type

object with fields:

  • id: string ( Required )

PythonPackageUrl type

object with fields:

  • title: string ( Required )

  • href: string ( Required )

PythonPackageVersionDetails type

object with fields:

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

  • notNormalizedName: string ( Required )

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

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

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

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

  • keywords: array of string ( Required )

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

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

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

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

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

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

  • classifiers: array of string ( Required )

  • projectUrls: array of PythonPackageUrl ( Required )

  • requiresDist: array of string ( Required )

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

  • files: array of PythonPackageFile ( Required )

QRCode type

object with fields:

  • width: integer (format: int32) ( Required )

  • base64Bitmap: string ( Required )

RangeCFFilter type

Name

Type

className

string

Possible values:

RangeFilter type

object with fields:

RangeFilterValue type

Name

Type

className

string

Possible values:

RdConfigurationSource type

Name

Type

className

string

Possible values:

RdDevConfiguration type

object with fields:

RdDevConfigurationIde type

object with fields:

  • ideType: IdeType ( Required )

  • version: PreferredIdeVersion ( Nullable and Optional , defaults to null)

  • vmOptions: array of string ( Required )

RdDevContainer type

object with fields:

RdDevContainerImage type

Name

Type

className

string

Possible values:

RdDevContainerImage.Default type

No properties

RdDevContainerImage.FromRegistry type

object with fields:

  • image: string ( Required )

RdFromDevConfiguration type

object with fields:

RdFromDevfile type

object with fields:

  • path: string ( Required )

  • configurationRevision: string ( Required )

RdGatewayConnectionInfo type

object with fields:

  • originalLink: string ( Required )

  • relayLink: string ( Required )

  • relayAuthData: string ( Required )

  • version: string ( Required )

RdInstanceType type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • vcpus: integer (format: int32) ( Required )

  • memMb: integer (format: int32) ( Required )

  • volumeGb: integer (format: int32) ( Required )

  • enabled: boolean ( Required )

RdRepoConnection type

object with fields:

  • id: string ( Required )

  • projectId: string ( Required )

  • name: string ( Required )

  • sshUrl: string ( Required )

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

  • archived: boolean ( Required )

RdRepository type

Name

Type

className

string

Possible values:

RdRepository.DeletedRepository type

object with fields:

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

  • status: RdRepositoryStatus ( Nullable and Optional , defaults to null)

RdRepository.ExternalRepository type

object with fields:

  • name: string ( Required )

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

  • status: RdRepositoryStatus ( Nullable and Optional , defaults to null)

RdRepository.SpaceRepository type

object with fields:

  • name: string ( Required )

  • status: RdRepositoryStatus ( Nullable and Optional , defaults to null)

RdRepositoryStatus type

Name

Type

className

string

Possible values:

RdWarmupEvent type

object with fields:

RdWarmupRepositoryStatus type

object with fields:

  • commit: string ( Required )

  • branch: string ( Required )

RdWarmupSubscriptionFilter type

object with fields:

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

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

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

RdWarmupSubscriptionFilterIn type

object with fields:

  • project: string ( Required )

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

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

RdWarmupVcsData type

object with fields:

RdWorkspaceRepositoryStatus type

object with fields:

  • commit: string ( Required )

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

  • containsNotPushedChanges: boolean ( Required )

RdWorkspaceResources type

object with fields:

  • milliCpus: integer (format: int32) ( Required )

  • memoryMb: integer (format: int32) ( Required )

  • volumeGb: integer (format: int32) ( Required )

RdWorkspaceVcsData type

object with fields:

  • repositories: array of RdRepository ( Required )

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

  • repoName: string ( Required )

  • branchName: string ( Required )

  • revision: string ( Required )

  • containsNotPushedChanges: boolean ( Required )

RdWorkspaceWithoutRefs type

object with fields:

  • id: string ( Required )

  • ideType: IdeType ( Required )

  • name: string ( Required )

  • state: RdWorkspaceState ( Required )

  • projectId: string ( Required )

  • number: integer (format: int32) ( Required )

  • externalId: string ( Required )

  • vcsData: RdWorkspaceVcsData ( Nullable and Optional , defaults to null)

  • resources: RdWorkspaceResources ( Required )

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

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

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

Rd_WarmupExec type

object with fields:

  • id: string ( Required )

  • projectId: string ( Required )

  • vcsData: RdWarmupVcsData ( Required )

  • status: WarmupExecutionStatus ( Required )

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

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

  • ideType: IdeType ( Required )

  • ideBuild: string ( Required )

  • ideVersion: string ( Required )

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

  • computeTaskId: string ( Required )

  • trigger: WarmupExecutionTrigger ( Required )

  • configurationSource: RdConfigurationSource ( Required )

  • archived: boolean ( Required )

RecurrenceRule type

object with fields:

RecurrenceRuleEnds type

Name

Type

className

string

Possible values:

RecurrenceRuleEnds.Never type

No properties

RecurrenceRuleEnds.OnDate type

object with fields:

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

RecurrenceRuleEnds.TotalCount type

object with fields:

  • count: integer (format: int32) ( Required )

RecurrenceRuleFreq type

Name

Type

className

string

Possible values:

RecurrenceRuleFreq.Daily type

object with fields:

  • interval: integer (format: int32) ( Required )

RecurrenceRuleFreq.MonthlyOnDate type

object with fields:

  • day: integer (format: int32) ( Required )

  • interval: integer (format: int32) ( Required )

RecurrenceRuleFreq.MonthlyOnFirstWeekday type

object with fields:

  • weekday: Weekday ( Required )

  • shift: integer (format: int32) ( Required )

  • interval: integer (format: int32) ( Required )

RecurrenceRuleFreq.MonthlyOnLastWeekday type

object with fields:

  • weekday: Weekday ( Required )

  • interval: integer (format: int32) ( Required )

RecurrenceRuleFreq.MonthlyOnStartDate type

object with fields:

  • interval: integer (format: int32) ( Required )

RecurrenceRuleFreq.Weekly type

object with fields:

  • weekdays: array of Weekday ( Required )

  • interval: integer (format: int32) ( Required )

RecurrenceRuleFreq.Yearly type

object with fields:

  • interval: integer (format: int32) ( Required )

RefreshTokenPayload type

object with fields:

  • refreshToken: string ( Required )

  • scope: string ( Required )

  • clientId: string ( Required )

  • userId: string ( Required )

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

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

RemoteRepository type

object with fields:

  • url: string ( Required )

  • auth: RemoteRepositoryAuth ( Nullable and Optional , defaults to null)

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

RemoteRepositoryAuth type

Name

Type

className

string

Possible values:

RemoteRepositoryAuth.Basic type

object with fields:

  • username: string ( Required )

  • password: string ( Required )

RemoteRepositoryAuth.SSH type

object with fields:

  • privateKey: string ( Required )

  • passphrase: string ( Required )

RemoteRepositoryAuth.Token type

object with fields:

  • token: string ( Required )

ReplyMessageAttachment type

Name

Type

className

string

Possible values:

ReplyMessageAttachment.Reply type

object with fields:

  • messageId: string ( Required )

ReplyMessageAttachment.ReplyWithSnapshot type

object with fields:

RepoChanges type

object with fields:

RepoCommitsSubscriptionFilter type

object with fields:

RepoCommitsSubscriptionFilterIn type

object with fields:

RepoCommitsSubscriptionFilterSpec type

object with fields:

  • authors: array of string ( Required )

  • committers: array of string ( Required )

  • branchSpec: array of string ( Required )

  • pathSpec: string ( Required )

  • messageRegex: string ( Required )

RepoConnectionWithBranch type

object with fields:

  • connection: RdRepoConnection ( Required )

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

RepoHeadsChange type

object with fields:

  • name: string ( Required )

  • oldId: string ( Required )

  • newId: string ( Required )

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

RepoHeadsSubscriptionFilter type

object with fields:

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

  • repository: string ( Required )

RepoHeadsSubscriptionFilterIn type

object with fields:

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

  • repository: string ( Required )

RepositoryActivity type

object with fields:

  • lastActivity: array of object with fields:

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

    • second: integer (format: int32) ( Required )

    ( Required )

RepositoryCommitRecord type

object with fields:

  • id: string ( Required )

  • repositoryId: string ( Required )

  • repositoryName: string ( Required )

  • revision: string ( Required )

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

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

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

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

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

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

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

RepositoryDetails type

object with fields:

  • projectKey: string ( Required )

  • repository: string ( Required )

  • starred: boolean ( Required )

    if the repository is marked as favorite

RepositoryInProject type

object with fields:

  • name: string ( Required )

  • isDeleted: boolean ( Required )

RepositoryInReview type

object with fields:

  • name: string ( Required )

  • deleted: boolean ( Required )

RepositoryMirrorOptions type

object with fields:

  • syncPeriodically: boolean ( Required )

  • syncOnFetch: boolean ( Required )

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

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

RepositoryUrls type

object with fields:

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

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

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

object with fields:

  • mention: string ( Required )

  • link: string ( Required )

ResponsibilityRecord type

object with fields:

  • responsibilityId: string ( Required )

  • summary: string ( Required )

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

  • assignedPeople: array of AssignedPerson ( Required )

RetentionPolicyParams type

object with fields:

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

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

  • retainDownloadedOnce: boolean ( Required )

ReviewBranchTrackEvent type

object with fields:

  • repository: string ( Required )

  • branch: string ( Required )

  • track: boolean ( Required )

ReviewCommit type

object with fields:

  • repositoryId: string ( Required )

  • commitId: string ( Required )

ReviewCommitIn type

object with fields:

  • repository: string ( Required )

  • commit: string ( Required )

ReviewCompletionStateChangedEvent type

object with fields:

ReviewCreatedEvent type

object with fields:

  • projectKey: string ( Required )

  • reviewId: string ( Required )

  • reviewNumber: integer (format: int32) ( Required )

  • reviewType: ReviewType ( Required )

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

  • descriptionEditedByProfileIds: array of TD_MemberProfile ( Required )

  • commits: array of UnfurlDetailsCommit ( Nullable and Optional , defaults to null)

ReviewRevisionsChangedEvent type

object with fields:

ReviewStateChangedEvent type

object with fields:

ReviewTitleChangedEvent type

object with fields:

  • oldTitle: string ( Required )

  • newTitle: string ( Required )

ReviewerChangedEvent type

object with fields:

ReviewerParam type

object with fields:

  • profileId: string ( Required )

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

  • qualityGateSlot: CodeReviewParticipantSlotBase ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2022-02: Use isCodeOwner to specify that this reviewer reviews only their owned files. It will be removed in a future version.

ReviewsWidgetSettingsDTO type

object with fields:

  • selectedFilterId: string ( Required )

RevisionAuthor type

object with fields:

  • authorName: string ( Required )

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

RevisionAuthorInfo type

object with fields:

RevisionInfo type

object with fields:

  • revision: string ( Required )

  • date: integer (format: int64) ( Required )

  • message: string ( Required )

RevisionsInReview type

object with fields:

RightDTO type

object with fields:

  • rightCode: PermissionIdentifier ( Required )

  • name: string ( Required )

  • group: string ( Required )

  • description: string ( Required )

  • targetName: string ( Required )

  • editable: boolean ( Required )

  • status: RightStatus ( Required )

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

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

  • dependencies: array of string ( Required )

RightDescriptorDTO type

object with fields:

  • rightCode: PermissionIdentifier ( Required )

  • name: string ( Required )

  • group: string ( Required )

  • description: string ( Required )

  • targetName: string ( Required )

  • dependencies: array of string ( Required )

RightUpdateDTO type

object with fields:

RoleDTO type

object with fields:

  • roleId: string ( Required )

  • type: PermissionRoleType ( Required )

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

  • name: string ( Required )

  • description: string ( Required )

  • membersEditable: boolean ( Required )

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

Room type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • name: string ( Required )

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

  • origin: RoomOrigin ( Nullable and Optional , defaults to null)

RtBlockNode type

Name

Type

className

string

Possible values:

RtBlockNodeWithChildren type

Name

Type

className

string

Possible values:

RtBlockUnfurl type

object with fields:

  • href: string ( Required )

  • title: string ( Required )

RtBlockquote type

object with fields:

RtBoldMark type

No properties

RtBreak type

object with fields:

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

    warning

    Deprecated since 2023-03-28: Obsolete: there is no difference between soft and hard break. Hard breaks are enforced by a new paragraph, so from the Rt point of view all breaks are soft.. It will be removed in a future version.

  • marks: array of RtDocumentMark ( Required )

RtBulletList type

object with fields:

RtCode type

object with fields:

RtCodeBlockContentNode type

Name

Type

className

string

Possible values:

RtCodeMark type

No properties

RtContent type

object with fields:

RtDocument type

object with fields:

  • children: array of RtBlockNode ( Required )

  • version: string ( Required )

RtDocumentMark type

Name

Type

className

string

Possible values:

RtEmoji type

object with fields:

  • emojiName: string ( Required )

  • marks: array of RtDocumentMark ( Required )

RtFirstListItemContentNode type

Name

Type

className

string

Possible values:

RtHeading type

object with fields:

RtHeadingContentNode type

Name

Type

className

string

Possible values:

RtHorizontalRule type

No properties

RtImage type

object with fields:

  • src: string ( Required )

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

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

  • marks: array of RtDocumentMark ( Required )

  • attrs: RtImageAttrs ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2023-03-28: Use RtImage fields instead. It will be removed in a future version.

RtImageAttrs type

object with fields:

  • src: string ( Required )

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

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

(Deprecated)

warning

Deprecated since 2023-03-28: Use RtImage fields instead. It will be removed in a future version.

RtInlineNode type

Name

Type

className

string

Possible values:

RtInlineNodeWithMarks type

Name

Type

className

string

Possible values:

RtItalicMark type

No properties

RtLinkAttrs type

object with fields:

  • href: string ( Required )

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

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

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

(Deprecated)

warning

Deprecated since 2023-03-28: Use RtLinkMark fields instead. It will be removed in a future version.

RtLinkDetails type

Name

Type

className

string

Possible values:

RtLinkMark type

object with fields:

  • href: string ( Required )

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

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

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

  • attrs: RtLinkAttrs ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2023-03-28: Use RtLinkMark fields instead. It will be removed in a future version.

RtListItem type

object with fields:

RtMention type

object with fields:

(Deprecated)

warning

Deprecated since 2023-03-28: Use RtLinkMark.mention instead. It will be removed in a future version.

RtMentionAttrs type

Name

Type

className

string

Possible values:

  • RtTeamMentionAttrs

    warning

    Deprecated since 2023-03-28: Use RtLinkMark.mention instead. It will be removed in a future version.

  • RtPredefinedMentionAttrs

    warning

    Deprecated since 2023-03-28: Use RtLinkMark.mention instead. It will be removed in a future version.

  • RtProfileMentionAttrs

    warning

    Deprecated since 2023-03-28: Use RtLinkMark.mention instead. It will be removed in a future version.

RtOrderedList type

object with fields:

  • startNumber: integer (format: int32) ( Required )

  • children: array of RtListItem ( Required )

RtParagraph type

object with fields:

RtPredefinedMentionAttrs type

object with fields:

  • type: string ( Required )

(Deprecated)

warning

Deprecated since 2023-03-28: Use RtLinkMark.mention instead. It will be removed in a future version.

RtPredefinedMentionLinkDetails type

object with fields:

  • value: string ( Required )

RtProfileLinkDetails type

object with fields:

  • id: string ( Required )

  • userName: string ( Required )

RtProfileMentionAttrs type

object with fields:

  • id: string ( Required )

  • userName: string ( Required )

  • href: string ( Required )

(Deprecated)

warning

Deprecated since 2023-03-28: Use RtLinkMark.mention instead. It will be removed in a future version.

RtStrikeThroughMark type

No properties

RtTable type

object with fields:

RtTableCell type

object with fields:

  • children: array of RtBlockNode ( Required )

  • rowspan: integer (format: int32) ( Required )

  • colspan: integer (format: int32) ( Required )

  • colwidth: array of integer (format: int32) ( Nullable and Optional , defaults to null)

  • attrs: RtTableCellAttrs ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2023-03-28: Use RtTableRowContent fields instead. It will be removed in a future version.

RtTableCellAttrs type

object with fields:

  • rowspan: integer (format: int32) ( Required )

  • colspan: integer (format: int32) ( Required )

  • colwidth: array of number (format: double) ( Nullable and Optional , defaults to null)

(Deprecated)

warning

Deprecated since 2023-03-28: Use RtTableRowContent fields instead. It will be removed in a future version.

RtTableHeader type

object with fields:

  • children: array of RtBlockNode ( Required )

  • rowspan: integer (format: int32) ( Required )

  • colspan: integer (format: int32) ( Required )

  • colwidth: array of integer (format: int32) ( Nullable and Optional , defaults to null)

  • attrs: RtTableCellAttrs ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2023-03-28: Use RtTableRowContent fields instead. It will be removed in a future version.

RtTableRow type

object with fields:

RtTableRowContent type

Name

Type

className

string

Possible values:

RtTeamLinkDetails type

object with fields:

  • id: string ( Required )

RtTeamMentionAttrs type

object with fields:

  • id: string ( Required )

  • teamName: string ( Required )

  • href: string ( Required )

(Deprecated)

warning

Deprecated since 2023-03-28: Use RtLinkMark.mention instead. It will be removed in a future version.

RtText type

object with fields:

RtTextDocumentContent type

object with fields:

RtUnfurl type

object with fields:

  • href: string ( Required )

  • title: string ( Required )

  • marks: array of RtDocumentMark ( Required )

  • attrs: RtUnfurlAttrs ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2023-03-28: Use RtUnfurl fields instead. It will be removed in a future version.

RtUnfurlAttrs type

object with fields:

  • href: string ( Required )

  • title: string ( Required )

(Deprecated)

warning

Deprecated since 2023-03-28: Use RtUnfurl fields instead. It will be removed in a future version.

SFUDataProducerOptions type

object with fields:

  • id: string ( Required )

SFUProducerOptions type

object with fields:

SFUProducerParameters type

object with fields:

  • mediaKind: SFUMediaKind ( Required )

  • rtpParameters: string ( Required )

  • paused: boolean ( Required )

  • closed: boolean ( Required )

SPackageRepositoryAccessWebhookEvent type

object with fields:

  • projectKey: ProjectKey ( Required )

  • repository: string ( Required )

  • repositoryType: PackageType ( Required )

SPackageRepositoryWebhookEvent type

object with fields:

SRepoCommitsWebhookEvent type

object with fields:

SRepoHeadsWebhookEvent type

object with fields:

SSLKeystore type

object with fields:

  • name: string ( Required )

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

SSLKeystoreEndpointAuth type

object with fields:

  • sslKeystore: string ( Required )

SafeMerge type

object with fields:

SafeMergeCheck type

Name

Type

className

string

Possible values:

SafeMergeCheck.External type

object with fields:

  • taskId: string ( Required )

SafeMergeCheck.Job type

object with fields:

  • executionId: string ( Required )

SafeMergeMessage type

object with fields:

SamlMetadataResponse type

Name

Type

className

string

Possible values:

SamlMetadataResponse.Error type

object with fields:

  • messages: array of string ( Required )

SamlMetadataResponse.Success type

object with fields:

  • metadata: string ( Required )

SamlRegisterNewUserRule type

object with fields:

SavedMessage type

object with fields:

SavedMessageLabel type

object with fields:

  • name: string ( Required )

  • color: string ( Required )

  • id: string ( Required )

  • archived: boolean ( Required )

SecretParameterRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • bundleId: string ( Required )

  • key: string ( Required )

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

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

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

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

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

SessionParticipationRecord type

object with fields:

  • id: string ( Required )

  • connectionId: integer (format: int64) ( Required )

  • sessionId: string ( Required )

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

  • state: ParticipationState ( Required )

  • participant: TD_CallParticipant ( Nullable and Optional , defaults to null)

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

  • producers: array of ProducerOptions ( Required )

  • dataProducers: array of DataProducerOptions ( Required )

  • version: integer (format: int64) ( Required )

  • data: ParticipantStateData ( Required )

SettingsValue type

object with fields:

  • emailNotificationsEnabled: boolean ( Required )

  • firstDayOfWeek: Weekday ( Required )

  • darkTheme: DarkTheme ( Nullable and Optional , defaults to null)

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

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

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

  • draftType: DraftDocumentType ( Nullable and Optional , defaults to null)

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

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

SpaceIssueId type

object with fields:

  • id: string ( Required )

SpaceNewsFeedChannel type

object with fields:

  • notificationDefaults: ChannelSpecificDefaults ( Nullable and Optional , defaults to null)

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

SprintLaunch type

Name

Type

className

string

Possible values:

SprintLaunch.Immediate type

object with fields:

  • moveUnresolvedIssues: boolean ( Required )

  • notifySubscribers: boolean ( Required )

SprintLaunch.Manual type

No properties

SprintLaunch.Scheduled type

object with fields:

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

  • moveUnresolvedIssues: boolean ( Required )

  • notifySubscribers: boolean ( Required )

SprintRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • board: BoardRecord ( Required )

  • name: string ( Required )

  • state: SprintState ( Required )

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

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

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

  • launch: SprintLaunch ( Required )

SshKeyData type

object with fields:

  • fingerprint: string ( Required )

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

  • publicKey: string ( Required )

  • comment: string ( Required )

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

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

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

Sticker type

object with fields:

  • id: string ( Required )

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

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

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

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

  • variants: array of StickerVariant ( Nullable and Optional , defaults to null)

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

  • archived: boolean ( Required )

StickerContentDetails type

object with fields:

StickerPackInfo type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • favoriteByDefault: boolean ( Required )

  • archived: boolean ( Required )

  • private: boolean ( Required )

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

  • stickers: array of Sticker ( Required )

StickerVariant type

object with fields:

  • id: string ( Required )

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

  • width: integer (format: int32) ( Required )

  • height: integer (format: int32) ( Required )

StringCFConstraint type

object with fields:

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

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

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

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

StringCFFilter type

object with fields:

  • query: string ( Required )

StringCFType type

No properties

StringCFValue type

object with fields:

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

StringListCFType type

No properties

StringListCFValue type

object with fields:

  • values: array of string ( Required )

SubjectResponsibilitiesTable type

object with fields:

  • subjectId: string ( Required )

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

  • reusedInProjects: array of string ( Required )

  • responsibilityRecords: array of ResponsibilityRecord ( Required )

Subscription type

object with fields:

  • subjectCode: string ( Required )

  • filters: array of SubscriptionFilter ( Required )

  • eventTypeCodes: array of string ( Required )

SubscriptionDTO type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • enabled: boolean ( Required )

  • subscription: Subscription ( Required )

  • privateFeed: PrivateFeed ( Nullable and Optional , defaults to null)

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

  • requestedAuthentication: SubscriptionRequestedAuthorizations ( Nullable and Optional , defaults to null)

SubscriptionDefinition type

object with fields:

SubscriptionFilter type

Name

Type

className

string

Possible values:

SubscriptionFilterIn type

Name

Type

className

string

Possible values:

SubscriptionMetadata type

object with fields:

  • channel: M2ChannelRecord ( Required )

  • subscription: string ( Required )

  • subscriptionName: string ( Required )

SubscriptionRequestedAuthorizations type

object with fields:

  • rights: array of DTO_Right ( Required )

  • rightCodes: array of string ( Required )

  • permissionContext: PermissionContextApi ( Nullable and Optional , defaults to null)

  • projects: array of PR_Project ( Required )

SupportProfileDTO type

object with fields:

  • profile: TD_MemberProfile ( Required )

  • adminPermissionsGranted: boolean ( Required )

SymbolDefinitionLocation type

object with fields:

  • path: string ( Required )

  • range: TextRange ( Required )

SyntaxMarkup type

object with fields:

SystemFieldSearchFilter type

Name

Type

className

string

Possible values:

TD_CallParticipant type

Name

Type

className

string

Possible values:

TD_CallParticipant.App type

object with fields:

TD_CallParticipant.Team type

object with fields:

TD_CallParticipant.User type

object with fields:

TD_ContactKind type

Name

Type

className

string

Possible values:

TD_ContactKind.Email type

No properties

No properties

TD_ContactKind.Messenger type

object with fields:

  • messenger: string ( Required )

TD_ContactKind.PhoneNumber type

object with fields:

  • type: string ( Required )

TD_Language type

object with fields:

  • id: string ( Required )

  • code: string ( Required )

  • name: string ( Required )

  • nativeName: string ( Required )

  • firstNameTitle: string ( Required )

  • lastNameTitle: string ( Required )

TD_Location type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • timezone: ATimeZoneWithOffset ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2019.0.1: use tz field that contains no specific offset for a timezone. Field timezone is always null. It will be removed in a future version.

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

  • workdays: array of integer (format: int32) ( Nullable and Optional , defaults to null)

  • phones: array of string ( Required )

  • emails: array of string ( Required )

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

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

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

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

  • type: string ( Required )

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

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

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

  • archived: boolean ( Required )

  • equipment2: array of TD_LocationEquipmentTypeRecord ( Nullable and Optional , defaults to null)

TD_LocationEquipmentType type

object with fields:

  • name: string ( Required )

  • archived: boolean ( Required )

TD_LocationEquipmentTypeRecord type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • archived: boolean ( Required )

TD_LocationMap type

object with fields:

  • id: string ( Required )

  • picture: string ( Required )

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

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

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

TD_LocationMapPoint type

object with fields:

  • id: string ( Required )

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

  • x: integer (format: int32) ( Required )

  • y: integer (format: int32) ( Required )

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

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

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

TD_LocationWithTimeZone type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • timezone: ATimeZoneWithOffset ( Required )

  • type: LocationType ( Nullable and Optional , defaults to null)

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

TD_MemberInLocationMap type

object with fields:

TD_MemberLocation type

object with fields:

  • id: string ( Required )

  • location: TD_Location ( Required )

  • locationMapPoints: array of TD_LocationMapPoint ( Nullable and Optional , defaults to null)

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

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

  • member: TD_MemberProfile ( Required )

  • archived: boolean ( Required )

TD_MemberProfile type

object with fields:

  • id: string ( Required )

  • username: string ( Required )

  • name: TD_ProfileName ( Required )

  • speaksEnglish: boolean ( Required )

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

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

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

  • languages: array of TD_ProfileLanguage ( Required )

  • archived: boolean ( Required )

    Whether the user account has been deactivated. See also leftAt.

    Read more

  • notAMember: boolean ( Required )

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

    warning

    Deprecated since 2023-08-30: use `accessSuspended` instead. It will be removed in a future version.

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

    warning

    Deprecated since 2023-08-30: use `accessSuspendedAt` instead. It will be removed in a future version.

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

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

    Date at which the user account has been deactivated

    Read more

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

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

  • locations: array of TD_MemberLocation ( Required )

  • status: TwoFactorAuthenticationStatus ( Required )

  • emails: array of TD_ProfileEmail ( Required )

  • phones: array of string ( Required )

  • messengers: array of string ( Required )

  • links: array of string ( Required )

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

    warning

    Deprecated since 2023-08-30: Use `leftAt` instead.

    Date at which the user account has been deactivated

    Read more

  • managers: array of TD_MemberProfile ( Required )

  • absences: array of AbsenceRecord ( Required )

  • folderWithChildren: DocumentFolderWithChildren ( Required )

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

  • membershipHistory: array of TD_Membership ( Required )

  • logins: array of ES_ProfileLogin ( Required )

  • onboardingRequired: boolean ( Required )

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

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

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

  • memberships: array of TD_Membership ( Required )

  • unapprovedMemberships: array of TD_Membership ( Nullable and Optional , defaults to null)

  • topics: array of Topic ( Required )

  • locationHistory: array of TD_MemberLocation ( Required )

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

    Whether user account has been suspended

    Read more

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

    Date at which the user account has been suspended

    Read more

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

  • avatarCropSquare: AvatarCropSquare ( Nullable and Optional , defaults to null)

  • gender: Gender ( Nullable and Optional , defaults to null)

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

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

TD_MemberWithTeam type

object with fields:

TD_Membership type

object with fields:

  • id: string ( Required )

  • member: TD_MemberProfile ( Required )

  • team: TD_Team ( Required )

  • role: TD_Role ( Required )

  • lead: boolean ( Required )

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

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

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

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

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

  • requiresApproval: boolean ( Required )

  • archived: boolean ( Required )

  • editFor: TD_Membership ( Nullable and Optional , defaults to null)

  • pendingEdit: TD_Membership ( Nullable and Optional , defaults to null)

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

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

TD_MergedEvent type

object with fields:

  • events: array of object with fields:

    • first: TD_Membership ( Required )

    • second: integer (format: int32) ( Required )

    ( Required )

  • profile: TD_MemberProfile ( Required )

TD_ProfileEmail type

object with fields:

  • id: string ( Required )

  • email: string ( Required )

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

TD_ProfileLanguage type

object with fields:

  • name: TD_ProfileName ( Nullable and Optional , defaults to null)

  • language: TD_Language ( Required )

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

TD_ProfileName type

object with fields:

  • firstName: string ( Required )

  • lastName: string ( Required )

TD_ProfileWorkingDays type

object with fields:

TD_Role type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

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

  • archived: boolean ( Required )

TD_Stats type

object with fields:

  • totalMembers: integer (format: int32) ( Required )

  • teams: array of object with fields:

    • first: TD_Team ( Required )

    • second: integer (format: int32) ( Required )

    ( Required )

  • roles: array of object with fields:

    • first: TD_Role ( Required )

    • second: integer (format: int32) ( Required )

    ( Required )

  • locations: array of object with fields:

    • first: TD_Location ( Required )

    • second: integer (format: int32) ( Required )

    ( Required )

TD_Team type

object with fields:

  • id: string ( Required )

  • name: string ( Required )

  • description: string ( Required )

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

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

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

  • archived: boolean ( Required )

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

  • disbandedAt: string (format: full-date) ( Nullable and Optional , defaults to null)

  • externalId: string ( Nullable and Optional , defaults to null)

  • defaultManager: TD_MemberProfile ( Nullable and Optional , defaults to null)

  • memberships: array of TD_Membership ( Required )

  • customFields: key-value object of string keys and values of CFValue ( Required )

TD_WorkingDays type

object with fields:

  • id: string ( Required )

  • dateStart: string (format: full-date) ( Nullable and Optional , defaults to null)

  • dateEnd: string (format: full-date) ( Nullable and Optional , defaults to null)

  • workingDaysSpec: WorkingDaysSpec ( Required )

TabIndentedLinesBodyIn type

object with fields:

  • text: string ( Required )

TableIdFilterValue type

object with fields:

  • id: string ( Nullable and Optional , defaults to null)

TargetCFFilter type

object with fields:

TargetCFInputValue type

object with fields:

TargetCFType type

No properties

TargetCFValue type

object with fields:

TargetStatusForLinkedIssue type

object with fields:

  • issueId: string ( Required )

  • issueStatusId: string ( Nullable and Optional , defaults to null)

  • isExternalIssue: boolean ( Nullable and Optional , defaults to null)

TeamAddedItemDetails type

object with fields:

TeamCFFilter type

object with fields:

TeamCFInputValue type

object with fields:

  • team: string ( Nullable and Optional , defaults to null)

TeamCFType type

No properties

TeamCFValue type

object with fields:

  • team: TD_Team ( Nullable and Optional , defaults to null)

TeamEvent type

object with fields:

TeamMembershipEvent type

object with fields:

  • meta: KMetaMod ( Required )

  • membership: TD_Membership ( Required )

  • team: object with fields:

    ( Nullable and Optional , defaults to null)

  • role: object with fields:

    ( Nullable and Optional , defaults to null)

  • lead: object with fields:

    • old: boolean ( Required )

    • new: boolean ( Required )

    ( Nullable and Optional , defaults to null)

  • manager: object with fields:

    ( Nullable and Optional , defaults to null)

  • since: object with fields:

    • old: string (format: date-time) ( Required )

    • new: string (format: date-time) ( Required )

    ( Nullable and Optional , defaults to null)

  • till: object with fields:

    • old: string (format: date-time) ( Required )

    • new: string (format: date-time) ( Required )

    ( Nullable and Optional , defaults to null)

  • deleted: object with fields:

    • old: boolean ( Required )

    • new: boolean ( Required )

    ( Nullable and Optional , defaults to null)

  • approvedBy: object with fields:

    ( Nullable and Optional , defaults to null)

TeamPermissionTarget type

object with fields:

  • team: string ( Required )

TestConnectionResult type

object with fields:

  • success: boolean ( Required )

  • reason: string ( Nullable and Optional , defaults to null)

  • dangerBranches: array of string ( Required )

TestFailedDTO type

No properties

TextDocument type

object with fields:

  • id: string ( Required )

  • resetCounter: integer (format: int64) ( Required )

  • version: integer (format: int64) ( Nullable and Optional , defaults to null)

  • type: DraftDocumentType ( Required )

  • text: string ( Required )

  • model: string ( Nullable and Optional , defaults to null)

  • attachments: array of AttachmentInfo ( Nullable and Optional , defaults to null)

  • mentions: array of ResolvedMentionLink ( Nullable and Optional , defaults to null)

TextDocumentBodyConvertTypeIn type

object with fields:

TextDocumentBodyCreateInBase type

Name

Type

className

string

Possible values:

TextDocumentBodyCreateTypedIn type

object with fields:

TextDocumentBodyInfo type

object with fields:

  • textDocument: TextDocumentRecord ( Nullable and Optional , defaults to null)

  • textDocumentId: string ( Nullable and Optional , defaults to null)

  • textType: DraftDocumentType ( Nullable and Optional , defaults to null)

TextDocumentBodyUpdateIn type

object with fields:

TextDocumentBodyUpdateInBase type

Name

Type

className

string

Possible values:

TextDocumentContent type

Name

Type

className

string

Possible values:

TextDocumentHttpBody type

object with fields:

TextDocumentRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • type: DraftDocumentType ( Required )

  • attachments: array of AttachmentInfo ( Nullable and Optional , defaults to null)

  • mentions: array of ResolvedMentionLink ( Nullable and Optional , defaults to null)

TextQueryCFFilter type

Name

Type

className

string

Possible values:

TextQueryFilter type

object with fields:

  • query: string ( Required )

TextRange type

object with fields:

  • start: integer (format: int32) ( Required )

  • length: integer (format: int32) ( Required )

ThrottledLogin type

object with fields:

  • login: string ( Required )

  • throttledUntil: string (format: date-time) ( Required )

TierEntityUsage type

object with fields:

  • usage: integer (format: int32) ( Required )

  • limit: integer (format: int32) ( Required )

TierFeatureLimits type

object with fields:

  • tier: Tier ( Required )

  • storageLimit: integer (format: int64) ( Nullable and Optional , defaults to null)

  • trueTier: Tier ( Nullable and Optional , defaults to null)

  • hasCardVerifiedAdmin: boolean ( Nullable and Optional , defaults to null)

  • applications: TierEntityUsage ( Required )

  • searchHistoryLimit: integer (format: int32) ( Required )

  • availableTrials: array of AvailableTrial ( Nullable and Optional , defaults to null)

TimeInterval type

object with fields:

TimeOfDay type

object with fields:

  • hours: integer (format: int32) ( Required )

  • minutes: integer (format: int32) ( Required )

  • seconds: integer (format: int32) ( Nullable and Optional , defaults to null)

TimeOutDTO type

No properties

TimeTrackingItem type

object with fields:

  • id: string ( Required )

  • user: TD_MemberProfile ( Required )

  • project: PR_Project ( Required )

  • date: string (format: full-date) ( Required )

  • duration: string (format: duration) ( Required )

  • description: string ( Nullable and Optional , defaults to null)

  • subjectType: TimeTrackingSubjectType ( Required )

  • subject: string ( Required )

TodayBillingReport type

object with fields:

  • plan: PurchasedBillingPlan ( Required )

  • activeUsers: integer (format: int32) ( Required )

  • userUsage: integer (format: int32) ( Required )

  • userCost: number (format: double) ( Required )

  • activeGuests: integer (format: int32) ( Nullable and Optional , defaults to null)

  • paidActiveGuests: integer (format: int32) ( Nullable and Optional , defaults to null)

  • freeActiveGuests: integer (format: int32) ( Nullable and Optional , defaults to null)

  • guestCost: number (format: double) ( Nullable and Optional , defaults to null)

  • activeMembers: integer (format: int32) ( Nullable and Optional , defaults to null)

  • activeLegacyExternalCollaborators: integer (format: int32) ( Nullable and Optional , defaults to null)

  • activeExternalCollaborators: integer (format: int32) ( Nullable and Optional , defaults to null)

  • storageAllocationB: integer (format: int64) ( Nullable and Optional , defaults to null)

  • storageTotalUsage: integer (format: int64) ( Required )

  • storageCost: number (format: double) ( Required )

  • bandwidthTotalUsage: integer (format: int64) ( Required )

  • bandwidthCost: number (format: double) ( 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 )

TodoContent type

object with fields:

  • originalText: string ( Required )

  • link: string ( Nullable and Optional , defaults to null)

  • kind: TodoItemContentKind ( Nullable and Optional , defaults to null)

  • principal: CPrincipal ( Nullable and Optional , defaults to null)

  • time: integer (format: int64) ( Nullable and Optional , defaults to null)

  • text: string ( Required )

  • extId: string ( Nullable and Optional , defaults to null)

  • unfurls: array of Unfurl ( Nullable and Optional , defaults to null)

TodoItemContent type

Name

Type

className

string

Possible values:

TodoItemContentMdText type

object with fields:

  • text: string ( Required )

  • mdMarkup: MdMarkup ( Required )

TodoItemContentText type

object with fields:

  • text: string ( Required )

TodoItemRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • created: string (format: date-time) ( Required )

  • updated: string (format: date-time) ( Required )

  • content: TodoItemContent ( Required )

  • _status: string ( Required )

  • dueDate: string (format: full-date) ( Nullable and Optional , defaults to null)

  • dueTime: string (format: date-time) ( Nullable and Optional , defaults to null)

  • notificationRequired: boolean ( Nullable and Optional , defaults to null)

TodoItemUnfurlContext type

object with fields:

  • userId: string ( Required )

  • todoItemId: string ( Required )

ToggleableProjectFeaturePinnedItem type

object with fields:

ToggleableProjectFeaturePins type

object with fields:

TopLevelPageUiExtensionApi type

object with fields:

  • displayName: string ( Required )

  • description: string ( Nullable and Optional , defaults to null)

  • uniqueCode: string ( Required )

  • iframeUrl: string ( Nullable and Optional , defaults to null)

TopLevelPageUiExtensionIn type

object with fields:

  • displayName: string ( Required )

  • description: string ( Nullable and Optional , defaults to null)

    Optional description that explains the purpose of the web page

  • uniqueCode: string ( Required )

    Value identifying the top level page extension within your application. Only letters ( a-z, A-Z ) and digits ( 0-9 ) are allowed.

  • iframeUrl: string ( Nullable and Optional , defaults to null)

    If specified, overrides the default URL for the iframe. The default URL is <application endpoint> /iframe/top-level-page/ <unique code>

Topic type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • name: string ( Required )

  • parent: Topic ( Nullable and Optional , defaults to null)

  • project: PR_Project ( Nullable and Optional , defaults to null)

  • responsible: array of TD_MemberProfile ( Required )

TrackedBranchesInReview type

object with fields:

  • repository: string ( Required )

  • branches: array of BranchInfo ( Required )

TrackerIssueFieldOrder type

object with fields:

  • id: string ( Required )

  • fields: array of IssueFieldOrder ( Required )

  • archived: boolean ( Required )

TrackerIssueFieldVisibility type

object with fields:

  • id: string ( Required )

  • systemIssueFieldVisibilities: array of IssueFieldVisibility ( Required )

  • archived: boolean ( Required )

TrustedCertificate type

object with fields:

  • id: string ( Required )

  • alias: string ( Required )

  • data: string ( Required )

  • info: CertificateInfo ( Required )

  • archived: boolean ( Required )

TwoFactorAuthenticationRequirement type

Name

Type

className

string

Possible values:

TwoFactorAuthenticationRequirement.NotRequired type

No properties

TwoFactorAuthenticationRequirement.Required type

No properties

TwoFactorAuthenticationSecret type

object with fields:

  • secretKey: string ( Required )

  • qrCode: QRCode ( Required )

  • scratchCodes: array of integer (format: int32) ( Required )

TypographySettings type

object with fields:

  • fontLigaturesInRegularText: boolean ( Nullable and Optional , defaults to null)

  • fontLigaturesInCodeSnippets: boolean ( Nullable and Optional , defaults to null)

  • limitLineLengthInChatMessages: boolean ( Nullable and Optional , defaults to null)

UA_JetBrainsUserAgreement type

object with fields:

  • content: string ( Required )

  • version: UA_Version ( Required )

  • updated: string (format: date-time) ( Required )

UA_JetBrainsUserAgreementStatus type

Name

Type

className

string

Possible values:

UA_JetBrainsUserAgreementStatus.Accepted type

object with fields:

UA_JetBrainsUserAgreementStatus.NotAccepted type

object with fields:

UA_UserAgreement type

object with fields:

  • id: string ( Required )

  • content: string ( Required )

  • version: UA_Version ( Required )

  • updated: string (format: date-time) ( Required )

UA_UserAgreementStatus type

Name

Type

className

string

Possible values:

UA_UserAgreementStatus.Accepted type

object with fields:

UA_UserAgreementStatus.NotAccepted type

object with fields:

UA_Version type

object with fields:

  • major: integer (format: int32) ( Required )

  • minor: integer (format: int32) ( Required )

Unfurl type

object with fields:

  • title: string ( Required )

  • link: string ( Required )

  • text: string ( Required )

  • details: UnfurlDetails ( Nullable and Optional , defaults to null)

  • sitename: string ( Nullable and Optional , defaults to null)

  • image: string ( Nullable and Optional , defaults to null)

  • imageMime: string ( Nullable and Optional , defaults to null)

  • imageWidth: integer (format: int32) ( Nullable and Optional , defaults to null)

  • imageHeight: integer (format: int32) ( Nullable and Optional , defaults to null)

  • video: string ( Nullable and Optional , defaults to null)

  • videoIFrame: string ( Nullable and Optional , defaults to null)

  • videoMime: string ( Nullable and Optional , defaults to null)

  • videoHeight: integer (format: int32) ( Nullable and Optional , defaults to null)

  • videoWidth: integer (format: int32) ( Nullable and Optional , defaults to null)

  • favicon: string ( Nullable and Optional , defaults to null)

  • alwaysInline: boolean ( Nullable and Optional , defaults to null)

  • onlyForCustomLinks: boolean ( Nullable and Optional , defaults to null)

  • viewTypes: array of UnfurlViewType ( Nullable and Optional , defaults to null)

UnfurlActionPayload type

object with fields:

  • actionId: string ( Required )

  • actionValue: string ( Required )

  • link: string ( Required )

  • context: ApplicationUnfurlContext ( Required )

  • clientId: string ( Required )

  • userId: string ( Required )

  • verificationToken: string ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

UnfurlAttachment type

object with fields:

  • unfurl: Unfurl ( Required )

  • id: string ( Required )

  • onlyVisibleToYou: boolean ( Nullable and Optional , defaults to null)

UnfurlDeployTargetDetails type

object with fields:

  • targetRef: DeployTargetRecord ( Required )

  • targetName: string ( Nullable and Optional , defaults to null)

  • showLinkIcon: boolean ( Nullable and Optional , defaults to null)

  • skipDetailsRender: boolean ( Nullable and Optional , defaults to null)

UnfurlDeploymentDetails type

object with fields:

  • deploymentRef: DeploymentRecord ( Required )

  • showLinkIcon: boolean ( Nullable and Optional , defaults to null)

  • showDetails: boolean ( Nullable and Optional , defaults to null)

  • showStatus: boolean ( Nullable and Optional , defaults to null)

UnfurlDetails type

Name

Type

className

string

Possible values:

UnfurlDetailsApplication type

object with fields:

UnfurlDetailsArticle type

object with fields:

UnfurlDetailsChat type

object with fields:

  • channel: string ( Required )

  • title: string ( Required )

object with fields:

  • contactKey: string ( Required )

  • title: string ( Required )

UnfurlDetailsChecklist type

object with fields:

UnfurlDetailsCodeDiffSnippet type

object with fields:

  • header: MCMessage ( Required )

  • headerAttachments: array of AttachmentInfo ( Required )

  • lines: array of InlineDiffLine ( Required )

  • selectedLineIndex: integer (format: int32) ( Required )

  • selectedLinesCount: integer (format: int32) ( Required )

  • sourceBranch: string ( Nullable and Optional , defaults to null)

  • targetBranch: string ( Nullable and Optional , defaults to null)

UnfurlDetailsCodeReview type

object with fields:

  • review: CodeReviewRecord ( Required )

  • withIcon: boolean ( Nullable and Optional , defaults to null)

  • withBranchPair: boolean ( Required )

  • defaultBranchInRepo: string ( Nullable and Optional , defaults to null)

  • hideIfCannotResolve: boolean ( Nullable and Optional , defaults to null)

  • reviewState: CodeReviewState ( Nullable and Optional , defaults to null)

  • isMerged: boolean ( Nullable and Optional , defaults to null)

UnfurlDetailsCodeSnippet type

object with fields:

UnfurlDetailsCommit type

object with fields:

  • project: PR_Project ( Required )

  • repository: string ( Required )

  • repositoryId: string ( Nullable and Optional , defaults to null)

  • commitId: string ( Required )

  • message: string ( Required )

  • messageUnfurls: CommitMessageUnfurlsRecord ( Nullable and Optional , defaults to null)

  • commitDate: string (format: date-time) ( Required )

  • authorDate: string (format: date-time) ( Nullable and Optional , defaults to null)

  • author: GitAuthorInfo ( Required )

  • authorProfile: TD_MemberProfile ( Nullable and Optional , defaults to null)

  • hideAuthorAndDate: boolean ( Nullable and Optional , defaults to null)

  • withBranchTags: boolean ( Nullable and Optional , defaults to null)

  • reviewId: string ( Nullable and Optional , defaults to null)

UnfurlDetailsCommitsInCodeReview type

object with fields:

UnfurlDetailsDateTime type

object with fields:

  • utcMilliseconds: integer (format: int64) ( Required )

  • params: DateTimeViewParams ( Nullable and Optional , defaults to null)

UnfurlDetailsDateTimeRange type

object with fields:

  • since: integer (format: int64) ( Required )

  • till: integer (format: int64) ( Required )

  • params: DateTimeViewParams ( Nullable and Optional , defaults to null)

UnfurlDetailsDraft type

object with fields:

  • draft: string ( Required )

  • title: string ( Required )

  • document: Document ( Nullable and Optional , defaults to null)

  • strikeThrough: boolean ( Nullable and Optional , defaults to null)

UnfurlDetailsExternalIssue type

object with fields:

UnfurlDetailsExternalIssueId type

object with fields:

  • id: ExternalIssueId ( Required )

  • marketplaceAppId: string ( Nullable and Optional , defaults to null)

UnfurlDetailsFolder type

object with fields:

  • name: string ( Required )

  • root: boolean ( Required )

  • folder: DocumentFolder ( Nullable and Optional , defaults to null)

UnfurlDetailsImage type

object with fields:

  • icon: string ( Nullable and Optional , defaults to null)

  • title: string ( Required )

  • image: ImageAttachment ( Required )

UnfurlDetailsIssue type

object with fields:

  • issue: Issue ( Required )

  • strikeThrough: boolean ( Nullable and Optional , defaults to null)

  • compact: boolean ( Nullable and Optional , defaults to null)

UnfurlDetailsIssueId type

object with fields:

  • projectId: string ( Required )

  • issueId: string ( Required )

UnfurlDetailsIssueImportTransaction type

object with fields:

UnfurlDetailsIssueStatus type

object with fields:

UnfurlDetailsIssueTag type

object with fields:

  • tag: PlanningTag ( Required )

  • strikeThrough: boolean ( Required )

  • textSize: MessageTextSize ( Nullable and Optional , defaults to null)

UnfurlDetailsIssueTopic type

object with fields:

  • topic: Topic ( Required )

  • strikeThrough: boolean ( Required )

UnfurlDetailsLocation type

object with fields:

  • location: TD_Location ( Required )

  • strikeThrough: boolean ( Nullable and Optional , defaults to null)

UnfurlDetailsMC type

object with fields:

UnfurlDetailsMeeting type

object with fields:

  • meeting: DTO_Meeting ( Required )

  • compact: boolean ( Nullable and Optional , defaults to null)

UnfurlDetailsNewIssueAction type

object with fields:

  • title: string ( Required )

  • project: PR_Project ( Required )

UnfurlDetailsPackageDetails type

object with fields:

  • repoRef: ProjectPackageRepository ( Required )

  • packageName: string ( Nullable and Optional , defaults to null)

  • version: string ( Nullable and Optional , defaults to null)

UnfurlDetailsProfile type

object with fields:

  • profile: TD_MemberProfile ( Required )

  • strikeThrough: boolean ( Nullable and Optional , defaults to null)

UnfurlDetailsProject type

object with fields:

  • project: PR_Project ( Required )

  • strikeThrough: boolean ( Nullable and Optional , defaults to null)

UnfurlDetailsRepositoryBranch type

object with fields:

  • project: PR_Project ( Required )

  • repository: string ( Required )

  • branchHead: string ( Required )

  • deleted: boolean ( Required )

  • isDefault: boolean ( Nullable and Optional , defaults to null)

UnfurlDetailsReviewDescriptionDiff type

object with fields:

  • snapshotId: string ( Required )

  • baseSnapshotId: string ( Required )

UnfurlDetailsRole type

object with fields:

UnfurlDetailsShortCommit type

object with fields:

  • project: PR_Project ( Required )

  • repository: string ( Required )

  • commitId: string ( Required )

  • message: string ( Required )

  • strikeThrough: boolean ( Required )

UnfurlDetailsSnapshotDiff type

object with fields:

  • snapshotId: string ( Required )

  • baseSnapshotId: string ( Required )

UnfurlDetailsSprint type

object with fields:

  • project: PR_Project ( Required )

  • sprint: SprintRecord ( Required )

  • removed: boolean ( Nullable and Optional , defaults to null)

UnfurlDetailsTeam type

object with fields:

  • team: TD_Team ( Required )

  • strikeThrough: boolean ( Nullable and Optional , defaults to null)

UnfurlDetailsTextDiff type

object with fields:

  • textBefore: string ( Required )

  • textAfter: string ( Required )

UnfurlsBlockListEntry type

object with fields:

  • link: string ( Required )

  • prefix: boolean ( Required )

  • global: boolean ( Required )

UpdateDocumentAccessIn type

object with fields:

UpdateErrorDTO type

object with fields:

  • message: string ( Nullable and Optional , defaults to null)

  • errorType: WorkerError ( Required )

UpdateFolderAccessIn type

object with fields:

UpdateIssueStatusOnMergeRequestMerge type

object with fields:

  • review: MergeRequestRecord ( Required )

  • newStatus: string ( Nullable and Optional , defaults to null)

  • issuePrefix: string ( Required )

  • issueId: string ( Required )

UpdatePackageRepositoryAccessIn type

object with fields:

UrlCFType type

No properties

UrlCFValue type

object with fields:

  • href: string ( Nullable and Optional , defaults to null)

VaultConnectionRecord type

object with fields:

  • id: string ( Required )

  • projectId: string ( Required )

  • url: string ( Required )

  • name: string ( Nullable and Optional , defaults to null)

  • namespace: string ( Nullable and Optional , defaults to null)

  • vaultNamespace: string ( Nullable and Optional , defaults to null)

  • appRoleEndpointPath: string ( Required )

  • appRoleId: string ( Required )

  • createdAt: string (format: date-time) ( Required )

  • createdBy: CPrincipal ( Required )

  • updatedAt: string (format: date-time) ( Required )

  • updatedBy: CPrincipal ( Required )

  • deleted: boolean ( Required )

VcsCFScope type

Name

Type

className

string

Possible values:

VcsCFScope.Project type

object with fields:

VcsCFScopeInput type

Name

Type

className

string

Possible values:

VcsCFScopeInput.Project type

object with fields:

  • projectId: string ( Required )

VcsCommitCFFilter type

object with fields:

  • query: string ( Required )

VcsCommitCFInputValue type

object with fields:

VcsCommitCFParameters type

object with fields:

VcsCommitCFParametersInput type

object with fields:

VcsCommitCFType type

No properties

VcsCommitCFValue type

object with fields:

VcsCommitListCFInputValue type

object with fields:

VcsCommitListCFType type

No properties

VcsCommitListCFValue type

object with fields:

VideoAttachment type

object with fields:

  • id: string ( Required )

  • name: string ( Nullable and Optional , defaults to null)

  • width: integer (format: int32) ( Nullable and Optional , defaults to null)

  • height: integer (format: int32) ( Nullable and Optional , defaults to null)

  • sizeBytes: integer (format: int64) ( Required )

VideoCallChannelItemContent type

object with fields:

VoteGroup type

object with fields:

  • variantName: string ( Required )

  • count: integer (format: int32) ( Required )

  • meVote: boolean ( Required )

  • lastUsers: array of TD_MemberProfile ( Required )

  • owner: TD_MemberProfile ( Nullable and Optional , defaults to null)

WarmupExecutionTrigger type

Name

Type

className

string

Possible values:

WarmupExecutionTrigger.Legacy type

No properties

WarmupExecutionTrigger.Manual type

object with fields:

WarmupExecutionTrigger.Scheduled type

object with fields:

  • cronExpressions: array of string ( Required )

WarmupExecutionTrigger.VCS type

No properties

WebhookDeliveryStatusDTO type

Name

Type

className

string

Possible values:

WebhookDeliveryStatusDTO.ExpectedHttpClientError type

object with fields:

WebhookDeliveryStatusDTO.FailedDelivery type

object with fields:

  • deliveryId: string ( Required )

  • responseCode: integer (format: int32) ( Required )

  • message: string ( Required )

  • sentTime: string (format: date-time) ( Required )

WebhookDeliveryStatusDTO.InternalError type

object with fields:

  • deliveryId: string ( Required )

  • sentTime: string (format: date-time) ( Required )

WebhookDeliveryStatusDTO.Successful type

object with fields:

  • deliveryId: string ( Required )

  • responseCode: integer (format: int32) ( Required )

  • sentTime: string (format: date-time) ( Required )

WebhookEvent type

Name

Type

className

string

Possible values:

WebhookRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • app: ES_App ( Required )

  • subscriptions: array of SubscriptionDTO ( Required )

  • name: string ( Required )

  • description: string ( Nullable and Optional , defaults to null)

  • useAppEndpoint: boolean ( Required )

  • endpoint: EndpointDTO ( Required )

  • useAppEndpointAuth: boolean ( Required )

  • endpointAuth: EndpointAuthDTO ( Required )

  • enabled: boolean ( Required )

  • acceptedHttpResponseCodes: array of integer (format: int32) ( Required )

  • doRetries: boolean ( Required )

  • payloadFields: string ( Nullable and Optional , defaults to null)

  • payloadTemplate: string ( Nullable and Optional , defaults to null)

WebhookRequestPayload type

object with fields:

  • verificationToken: string ( Nullable and Optional , defaults to null)

    warning

    Deprecated since 2022-11-16: Verification token is only sent for old applications that have the Verification Token authentication set up. New applications cannot use this authentication.. It will be removed in a future version.

  • clientId: string ( Required )

  • webhookId: string ( Required )

  • payload: WebhookEvent ( Required )

WeekDayLocation type

object with fields:

  • day: integer (format: int32) ( Required )

  • remote: boolean ( Required )

WeekDayTimeInterval type

object with fields:

  • day: integer (format: int32) ( Required )

  • checked: boolean ( Required )

  • interval: TimeInterval ( Required )

WidgetSettingsDTO type

Name

Type

className

string

Possible values:

WidgetSettingsRecord type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

  • data: WidgetSettingsDTO ( Nullable and Optional , defaults to null)

  • widgetId: string ( Required )

Workday type

object with fields:

  • weekday: string ( Required )

  • working: boolean ( Required )

  • hours: integer (format: int32) ( Required )

  • minutes: integer (format: int32) ( Nullable and Optional , defaults to null)

WorkerComputePoolDTO type

object with fields:

WorkerDTO type

object with fields:

WorkerInfoDTO type

object with fields:

  • osType: WorkerOSType ( Nullable and Optional , defaults to null)

  • osName: string ( Nullable and Optional , defaults to null)

  • osArch: string ( Nullable and Optional , defaults to null)

  • osVersion: string ( Nullable and Optional , defaults to null)

  • hostname: string ( Nullable and Optional , defaults to null)

WorkerPermanentTokenInfoDTO type

object with fields:

  • created: string (format: date-time) ( Required )

WorkerStatsDTO type

object with fields:

  • volumeFreeSpace: string ( Nullable and Optional , defaults to null)

  • diskPressure: boolean ( Required )

  • cpuLimit: string ( Nullable and Optional , defaults to null)

  • memoryLimit: string ( Nullable and Optional , defaults to null)

WorkerStepsStatsDTO type

object with fields:

  • activity: array of object with fields:

    • first: string (format: full-date) ( Required )

    • second: integer (format: int32) ( Required )

    ( Required )

WorkerTagDTO type

object with fields:

  • name: string ( Required )

WorkerVersionDTO type

object with fields:

  • workerVersion: string ( Nullable and Optional , defaults to null)

  • updateError: UpdateErrorDTO ( Nullable and Optional , defaults to null)

WorkingDaysSpec type

object with fields:

  • days: array of Workday ( Required )

    warning

    Deprecated since 2020-11-10: Use workingHours and notificationHours instead.

  • workingHours: array of WeekDayTimeInterval ( Nullable and Optional , defaults to null)

  • notificationHours: array of WeekDayTimeInterval ( Nullable and Optional , defaults to null)

  • timezone: ATimeZone ( Nullable and Optional , defaults to null)

  • boundWeekdays: array of integer (format: int32) ( Nullable and Optional , defaults to null)

  • locations: array of WeekDayLocation ( Nullable and Optional , defaults to null)

XScopeApi type

Name

Type

className

string

Possible values:

XScopeApi.All type

No properties

XScopeApi.None type

No properties

XScopeApi.Scope type

object with fields:

XScopeGrantApi type

object with fields:

AbsenceIdentifier type

Possible values:

  • className: "AbsenceIdentifier.Id"

    id: string ( Required )

ApplicationIdentifier type

Possible values:

  • className: "ApplicationIdentifier.ClientId"

    Specifies application by the client id that it uses to authenticate in Space

    Read more

    clientId: string ( Required )

  • className: "ApplicationIdentifier.Id"

    Specifies application by the identifier that can be fetched via Get all applications method

    id: string ( Required )

  • className: "ApplicationIdentifier.Me"

    Specifies application that corresponds to the caller of this API method.

    Applicable only for calls made by Space applications.

BoardIdentifier type

Possible values:

  • className: "BoardIdentifier.Id"

    id: string ( Required )

CFEntityIdentifier type

Possible values:

CFEntityTypeIdentifier type

Possible values:

  • className: "CFAbsenceEntityType"

  • className: "CFDeployTargetEntityType"

  • className: "CFIssueTrackerEntityType"

    issueTracker: IssueTrackerIdentifier ( Required )

  • className: "CFMembershipEntityType"

  • className: "CFProfileEntityType"

  • className: "CFTeamEntityType"

CFEnumValueIdentifier type

Possible values:

  • className: "CFEnumValueIdentifier.Id"

    id: string ( Required )

  • className: "CFEnumValueIdentifier.Name"

    name: string ( Required )

CFIdentifier type

Possible values:

  • className: "CFIdentifier.Id"

    id: string ( Required )

  • className: "CFIdentifier.Name"

    name: string ( Required )

CalendarIdentifier type

Possible values:

  • className: "CalendarIdentifier.Id"

    id: string ( Required )

  • className: "CalendarIdentifier.PersonalCalendar"

ChannelIdentifier type

Possible values:

  • className: "ChannelIdentifier.Application"

    application: ApplicationIdentifier ( Required )

  • className: "ChannelIdentifier.Article"

    article: string ( Required )

  • className: "ChannelIdentifier.Channel"

    channel: ChatChannel ( Required )

  • className: "ChannelIdentifier.ContactKey"

    contactKey: string ( Required )

  • className: "ChannelIdentifier.Id"

    id: string ( Required )

  • className: "ChannelIdentifier.Issue"

    issue: IssueIdentifier ( Required )

  • className: "ChannelIdentifier.Profile"

    member: ProfileIdentifier ( Required )

  • className: "ChannelIdentifier.Review"

    codeReview: ReviewIdentifier ( Required )

  • className: "ChannelIdentifier.Thread"

    message: string ( Required )

ChatChannel type

Possible values:

  • className: "ChatChannel.FromId"

    id: string ( Required )

  • className: "ChatChannel.FromName"

    name: string ( Required )

ChatMessageIdentifier type

Possible values:

  • className: "ChatMessageIdentifier.ExternalId"

    externalId: string ( Required )

  • className: "ChatMessageIdentifier.InternalId"

    id: string ( Required )

ChecklistIdentifier type

Possible values:

  • className: "ChecklistIdentifier.Id"

    id: string ( Required )

ComputePoolIdentifier type

Possible values:

  • className: "ComputePoolIdentifier.Id"

    id: string ( Required )

  • className: "ComputePoolIdentifier.Key"

    value: string ( Required )

DashboardIdentifier type

Possible values:

  • className: "DashboardIdentifier.Id"

    id: string ( Required )

  • className: "DashboardIdentifier.Personal"

    profile: ProfileIdentifier ( Required )

  • className: "DashboardIdentifier.Project"

    project: ProjectIdentifier ( Required )

    profile: ProfileIdentifier ( Required )

DeploymentIdentifier type

Possible values:

  • className: "DeploymentIdentifier.Id"

    id: string ( Required )

  • className: "DeploymentIdentifier.Status"

    status: DeploymentIdentifierStatus ( Required )

  • className: "DeploymentIdentifier.Version"

    version: string ( Required )

DocumentSharingAccessType type

Possible values:

  • className: "DocumentSharingAccessType.Editor"

  • className: "DocumentSharingAccessType.Manager"

  • className: "DocumentSharingAccessType.Viewer"

ExtendedTypeScope type

Possible values:

  • className: "ExtendedTypeScope.Container"

    containerId: string ( Required )

  • className: "ExtendedTypeScope.Org"

FolderIdentifier type

Possible values:

  • className: "FolderIdentifier.Id"

    id: string ( Required )

  • className: "FolderIdentifier.Root"

  • className: "FolderIdentifier.SharedWithMe"

FolderSharingAccessType type

Possible values:

  • className: "FolderSharingAccessType.Editor"

  • className: "FolderSharingAccessType.Manager"

  • className: "FolderSharingAccessType.Viewer"

GlobalTargetIdentifier type

Possible values:

  • className: "GlobalTargetIdentifier.Composite"

    project: ProjectIdentifier ( Required )

    target: TargetIdentifier ( Required )

  • className: "GlobalTargetIdentifier.Number"

    number: string ( Required )

ImportExistsPolicy type

Possible values:

  • className: "ImportExistsPolicy.Skip"

  • className: "ImportExistsPolicy.Update"

ImportMissingPolicy type

Possible values:

  • className: "ImportMissingPolicy.ReplaceWithDefault"

  • className: "ImportMissingPolicy.Skip"

IssueIdentifier type

Possible values:

  • className: "IssueIdentifier.ExternalId"

    Identifies issue in Space that was earlier imported from an external system by external id provided during the import.

    project: ProjectIdentifier ( Required )

    externalId: string ( Required )

  • className: "IssueIdentifier.Id"

    id: string ( Required )

  • className: "IssueIdentifier.Key"

    key: string ( Required )

IssueTrackerIdentifier type

Possible values:

  • className: "IssueTrackerIdentifier.DefaultProjectTracker"

    project: ProjectIdentifier ( Required )

  • className: "IssueTrackerIdentifier.Id"

    id: string ( Required )

MessageRecipient type

Possible values:

  • className: "MessageRecipient.Channel"

    channel: ChatChannel ( Required )

  • className: "MessageRecipient.CodeReview"

    codeReview: string ( Required )

  • className: "MessageRecipient.Issue"

    issue: string ( Required )

  • className: "MessageRecipient.Member"

    member: ProfileIdentifier ( Required )

PackageRepositoryIdentifier type

Possible values:

  • className: "PackageRepositoryIdentifier.Id"

    id: string ( Required )

  • className: "PackageRepositoryIdentifier.Key"

    key: string ( Required )

  • className: "PackageRepositoryIdentifier.TypeAndName"

    type: string ( Required )

    name: string ( Required )

PackagesSharingAccessType type

Possible values:

  • className: "PackagesSharingAccessType.Manager"

  • className: "PackagesSharingAccessType.Viewer"

  • className: "PackagesSharingAccessType.Writer"

PermissionContextIdentifier type

Possible values:

  • className: "ChannelPermissionContextIdentifier"

    channel: string ( Required )

  • className: "GlobalPermissionContextIdentifier"

  • className: "PackageRepositoryPermissionContextIdentifier"

    packageRepository: string ( Required )

  • className: "ProjectPermissionContextIdentifier"

    project: ProjectIdentifier ( Required )

PermissionIdentifier type

Possible values:

  • className: "PermissionIdentifier.AddCustomEmoji"

  • className: "PermissionIdentifier.AddMembers"

  • className: "PermissionIdentifier.AddMembersOrTeamsToParticipantList"

  • className: "PermissionIdentifier.AddMessageReactions"

  • className: "PermissionIdentifier.AddNewChannels"

  • className: "PermissionIdentifier.AddNewExternalUser"

  • className: "PermissionIdentifier.AddParticipantsToCodeReviewDiscussionsAndThreads"

  • className: "PermissionIdentifier.AddParticipantsToIssueCommentThreads"

  • className: "PermissionIdentifier.AddReactionsToArticleComments"

  • className: "PermissionIdentifier.AddReactionsToCommentsInCodeReviews"

  • className: "PermissionIdentifier.AddReactionsToDirectMessages"

  • className: "PermissionIdentifier.AddReactionsToIssueComments"

  • className: "PermissionIdentifier.AddTeams"

  • className: "PermissionIdentifier.AdminPackageRepositories"

  • className: "PermissionIdentifier.AdminVisionProject"

  • className: "PermissionIdentifier.ApproveAbsences"

  • className: "PermissionIdentifier.ArchiveAndRestoreDocuments"

  • className: "PermissionIdentifier.AttachWorkersToAutomationComputePools"

  • className: "PermissionIdentifier.AuthorizeDomainsAndPatternsForAppPoweredPreviews"

  • className: "PermissionIdentifier.BaseRightForAllBonusAppUsers"

  • className: "PermissionIdentifier.BrowseChannels"

  • className: "PermissionIdentifier.ChangeBackgroundImagesForOrganization"

  • className: "PermissionIdentifier.ConnectToFleetWorkspaces"

  • className: "PermissionIdentifier.CreateApplications"

  • className: "PermissionIdentifier.CreateBoards"

    Create issue boards

  • className: "PermissionIdentifier.CreateCodeReviews"

  • className: "PermissionIdentifier.CreateDevConfigurations"

  • className: "PermissionIdentifier.CreateDevEnvironments"

    Allows to create dev environments and manage their lifecycle

  • className: "PermissionIdentifier.CreateDocuments"

  • className: "PermissionIdentifier.CreateFolders"

  • className: "PermissionIdentifier.CreateIssues"

    Create issues in a project

  • className: "PermissionIdentifier.CreateOrganizationAutomationWorkers"

  • className: "PermissionIdentifier.CreatePackageRepositories"

  • className: "PermissionIdentifier.CreatePermanentTokensForYourself"

  • className: "PermissionIdentifier.CreateProjectAutomationWorkers"

  • className: "PermissionIdentifier.CreateProjectSecrets"

  • className: "PermissionIdentifier.CreateProjects"

  • className: "PermissionIdentifier.CreateSuggestedEdit"

  • className: "PermissionIdentifier.DelegateGlobalPermissions"

  • className: "PermissionIdentifier.DeleteApplications"

  • className: "PermissionIdentifier.DeleteDocumentsForever"

  • className: "PermissionIdentifier.DeleteHostingSites"

    Allow delete hosted site with all site ' s history

  • className: "PermissionIdentifier.DeleteMemberProfile"

  • className: "PermissionIdentifier.DeletePackageRepositoriesContent"

  • className: "PermissionIdentifier.DeleteProjectParameters"

  • className: "PermissionIdentifier.DeleteProjectSecrets"

  • className: "PermissionIdentifier.DeleteVaultConnections"

    Delete Vault connections

  • className: "PermissionIdentifier.EditBonusEvents"

  • className: "PermissionIdentifier.EditBonusQuestionnaires"

  • className: "PermissionIdentifier.EditCodeReviews"

  • className: "PermissionIdentifier.EditDevEnvironmentsSettings"

    Allows to edit the organization ' s dev environments settings ( like default IDE version )

  • className: "PermissionIdentifier.EditDocuments"

  • className: "PermissionIdentifier.EditFolderContent"

  • className: "PermissionIdentifier.EditLocations"

  • className: "PermissionIdentifier.EditMemberVacationPeriods"

  • className: "PermissionIdentifier.EditTeamMembershipHistory"

  • className: "PermissionIdentifier.GrantAccessRightsToOtherMembersForBonusApp"

  • className: "PermissionIdentifier.GrantPermissionsToOtherMembers"

  • className: "PermissionIdentifier.ImportArticles"

  • className: "PermissionIdentifier.ImportIssues"

    Import issues

  • className: "PermissionIdentifier.ImportMessages"

  • className: "PermissionIdentifier.ImportMessagesObsolete"

  • className: "PermissionIdentifier.JoinDevEnvironmentsFromHotPool"

    Allows to join dev environments from hot pool and become their owner

  • className: "PermissionIdentifier.ListApplicationCommands"

  • className: "PermissionIdentifier.ListHostingSites"

    Allow get list of hosted sites

  • className: "PermissionIdentifier.ListRestrictedProjects"

  • className: "PermissionIdentifier.ManageAbsenceTypes"

  • className: "PermissionIdentifier.ManageAnySpentTime"

    Add, update and delete spent time items for any user

  • className: "PermissionIdentifier.ManageAuthenticationModules"

  • className: "PermissionIdentifier.ManageAuthenticationSessions"

  • className: "PermissionIdentifier.ManageAutomationComputePools"

  • className: "PermissionIdentifier.ManageAutomationComputePoolsInProjects"

  • className: "PermissionIdentifier.ManageAutomationDiagnosticData"

  • className: "PermissionIdentifier.ManageAutomationJobs"

  • className: "PermissionIdentifier.ManageAutomationWorkers"

  • className: "PermissionIdentifier.ManageBoards"

    Update issue board settings and delete issue boards

  • className: "PermissionIdentifier.ManageBusinessEntities"

  • className: "PermissionIdentifier.ManageChannels"

  • className: "PermissionIdentifier.ManageChecklists"

    Add, edit or remove checklists, as well as manage planning tags

  • className: "PermissionIdentifier.ManageCustomFields"

  • className: "PermissionIdentifier.ManageCustomFieldsForTargets"

  • className: "PermissionIdentifier.ManageDevEnvironmentsOfAllProjectMembers"

    Allows to manage the lifecycle of dev environments that the user doesn ' t own ( users can always manage their own environments )

  • className: "PermissionIdentifier.ManageDocuments"

  • className: "PermissionIdentifier.ManageDocumentsObsolete"

  • className: "PermissionIdentifier.ManageEmoji"

  • className: "PermissionIdentifier.ManageEmployeesSalaries"

  • className: "PermissionIdentifier.ManageExternalEntityLinkPatterns"

  • className: "PermissionIdentifier.ManageFeatureFlags"

  • className: "PermissionIdentifier.ManageFolders"

  • className: "PermissionIdentifier.ManageGitRepositories"

  • className: "PermissionIdentifier.ManageHistoricalAbsences"

  • className: "PermissionIdentifier.ManageHostingSite"

    Allow delete, undelete hosted site, add aliases and so on

  • className: "PermissionIdentifier.ManageIssueAssignment"

    Add issues to and remove issues from issue boards

  • className: "PermissionIdentifier.ManageIssueSettings"

    Manage settings of the issue tracker

  • className: "PermissionIdentifier.ManageLinkPreviewBlocklist"

  • className: "PermissionIdentifier.ManageLoggingLevel"

  • className: "PermissionIdentifier.ManageMaintenanceData"

  • className: "PermissionIdentifier.ManageMeetingConferenceRooms"

  • className: "PermissionIdentifier.ManageMeetings"

  • className: "PermissionIdentifier.ManageOnboardingHints"

  • className: "PermissionIdentifier.ManageOwnSpentTime"

    Add, update and delete own spent time items

  • className: "PermissionIdentifier.ManagePermanentTokens"

  • className: "PermissionIdentifier.ManagePersonalTables"

  • className: "PermissionIdentifier.ManageProjectPermissionScheme"

  • className: "PermissionIdentifier.ManageProjectSidebarPins"

  • className: "PermissionIdentifier.ManageSalaryEventsForDirectReports"

  • className: "PermissionIdentifier.ManageStickers"

  • className: "PermissionIdentifier.ManageTables"

    Manage tables in a project

  • className: "PermissionIdentifier.ManageTags"

    Add, edit or remove planning tags

  • className: "PermissionIdentifier.ManageThrottledLogins"

  • className: "PermissionIdentifier.ManageTopics"

  • className: "PermissionIdentifier.ManageTwoFactorAuthenticationAndApplicationPasswords"

  • className: "PermissionIdentifier.ManageVacations"

  • className: "PermissionIdentifier.ManageWarmUpAutomaticTriggers"

  • className: "PermissionIdentifier.ModerateSuggestions"

  • className: "PermissionIdentifier.ModifyDeploymentTargets"

    Modify deployment targets in a project

  • className: "PermissionIdentifier.ModifyDeployments"

    Modify deployments in a project

  • className: "PermissionIdentifier.ModifyProjectParameters"

  • className: "PermissionIdentifier.ModifyVaultConnections"

    Create or edit Vault connections

  • className: "PermissionIdentifier.MoveIssues"

    Move issues into other projects

  • className: "PermissionIdentifier.PinOrUnpinDirectMessages"

  • className: "PermissionIdentifier.PinOrUnpinIssueComments"

  • className: "PermissionIdentifier.PinOrUnpinMessages"

  • className: "PermissionIdentifier.PostCommentsToArticles"

  • className: "PermissionIdentifier.PostCommentsToCodeReviews"

  • className: "PermissionIdentifier.PostCommentsToIssues"

  • className: "PermissionIdentifier.PostContentForOtherMembers"

  • className: "PermissionIdentifier.PostMessages"

  • className: "PermissionIdentifier.PostMessagesInThreads"

  • className: "PermissionIdentifier.ProvideExternalInlineUnfurls"

  • className: "PermissionIdentifier.ProvideExternalUnfurlsAsAttachments"

  • className: "PermissionIdentifier.PublishArticles"

  • className: "PermissionIdentifier.PublishSitesOrApplications"

    Allow publish static web sites or applications

  • className: "PermissionIdentifier.PublishVisionProject"

  • className: "PermissionIdentifier.ReadGitRepositories"

  • className: "PermissionIdentifier.ReadPackageRepositories"

  • className: "PermissionIdentifier.ReadVisionProject"

  • className: "PermissionIdentifier.RemoveMembersOrTeamsFromParticipantList"

  • className: "PermissionIdentifier.ReportCodeIssuesForRepository"

  • className: "PermissionIdentifier.ReportExternalStatusChecks"

  • className: "PermissionIdentifier.RestoreIssues"

    Restore issues that were created by other users

  • className: "PermissionIdentifier.SendDirectMessages"

  • className: "PermissionIdentifier.SetUpTwoFactorAuthenticationForYourselfAndCreateApplicationPasswords"

  • className: "PermissionIdentifier.StartAutomationJobs"

  • className: "PermissionIdentifier.StartNewConversations"

  • className: "PermissionIdentifier.StopAutomationJobs"

  • className: "PermissionIdentifier.SubmitAnswerToBonusQuestionnaires"

  • className: "PermissionIdentifier.TrackApplicationState"

  • className: "PermissionIdentifier.UnpublishArticles"

  • className: "PermissionIdentifier.UpdateAbsences"

  • className: "PermissionIdentifier.UpdateApplications"

  • className: "PermissionIdentifier.UpdateChannelInfo"

  • className: "PermissionIdentifier.UpdateChannelSubscriptions"

  • className: "PermissionIdentifier.UpdateEmployeesSalary"

  • className: "PermissionIdentifier.UpdateIssues"

    Update issues that were created by other users

  • className: "PermissionIdentifier.UpdateLanguages"

  • className: "PermissionIdentifier.UpdateLocations"

  • className: "PermissionIdentifier.UpdateMeetingRsvpStatus"

  • className: "PermissionIdentifier.UpdateMeetings"

  • className: "PermissionIdentifier.UpdateMemberBusinessEntities"

  • className: "PermissionIdentifier.UpdateMemberProfiles"

  • className: "PermissionIdentifier.UpdateMemberProfilesAndEditLocations"

  • className: "PermissionIdentifier.UpdateNotificationSettings"

  • className: "PermissionIdentifier.UpdateOrganizationDetails"

  • className: "PermissionIdentifier.UpdateOverdrafts"

  • className: "PermissionIdentifier.UpdatePersonalTables"

  • className: "PermissionIdentifier.UpdatePositions"

  • className: "PermissionIdentifier.UpdateProjectSecrets"

  • className: "PermissionIdentifier.UpdateProjectTables"

  • className: "PermissionIdentifier.UpdateReactions"

  • className: "PermissionIdentifier.UpdateResponsibilities"

  • className: "PermissionIdentifier.UpdateTeams"

  • className: "PermissionIdentifier.UpdateToDos"

  • className: "PermissionIdentifier.UpdateWorkingHours"

  • className: "PermissionIdentifier.UseCalls"

  • className: "PermissionIdentifier.UseProjectSecrets"

  • className: "PermissionIdentifier.ViewAbsenceApprovals"

  • className: "PermissionIdentifier.ViewAbsenceReasons"

  • className: "PermissionIdentifier.ViewAbsenceTypes"

  • className: "PermissionIdentifier.ViewAbsences"

  • className: "PermissionIdentifier.ViewAllExternalUsers"

  • className: "PermissionIdentifier.ViewAndRemoveApplicationConsents"

  • className: "PermissionIdentifier.ViewAnswersToBonusQuestionnaires"

  • className: "PermissionIdentifier.ViewApplicationLogs"

    Allow to view application logs

  • className: "PermissionIdentifier.ViewApplicationSecrets"

  • className: "PermissionIdentifier.ViewApplications"

  • className: "PermissionIdentifier.ViewArticleComments"

  • className: "PermissionIdentifier.ViewArticles"

  • className: "PermissionIdentifier.ViewAtelierReport"

  • className: "PermissionIdentifier.ViewAutomationComputePools"

  • className: "PermissionIdentifier.ViewAutomationDiagnosticData"

  • className: "PermissionIdentifier.ViewAutomationJobs"

  • className: "PermissionIdentifier.ViewAutomationWorkers"

  • className: "PermissionIdentifier.ViewBoards"

    View issue boards

  • className: "PermissionIdentifier.ViewBonusEvents"

  • className: "PermissionIdentifier.ViewBonusQuestionnaires"

  • className: "PermissionIdentifier.ViewBouncedEmailAddresses"

  • className: "PermissionIdentifier.ViewBusinessEntities"

  • className: "PermissionIdentifier.ViewChannelInfo"

  • className: "PermissionIdentifier.ViewChannelParticipants"

  • className: "PermissionIdentifier.ViewCodeReviewChannelParticipants"

  • className: "PermissionIdentifier.ViewCodeReviewComments"

  • className: "PermissionIdentifier.ViewCodeReviews"

  • className: "PermissionIdentifier.ViewConfidentialCustomFields"

  • className: "PermissionIdentifier.ViewCustomEmoji"

  • className: "PermissionIdentifier.ViewDeployments"

    View deployments in a project

  • className: "PermissionIdentifier.ViewDevEnvironmentDiagnosticData"

  • className: "PermissionIdentifier.ViewDevEnvironmentsDebugData"

    Allows to view debug data

  • className: "PermissionIdentifier.ViewDevEnvironmentsOfAllProjectMembers"

    Allows to view dev environments that the user doesn ' t own ( users can always view their own environments )

  • className: "PermissionIdentifier.ViewDevEnvironmentsSettings"

    Allows to view the organization ' s dev environments settings ( like default IDE version )

  • className: "PermissionIdentifier.ViewDirectMessages"

  • className: "PermissionIdentifier.ViewDocuments"

  • className: "PermissionIdentifier.ViewEmployeesSalary"

  • className: "PermissionIdentifier.ViewExternalEntityLinkPatterns"

  • className: "PermissionIdentifier.ViewFolderContent"

  • className: "PermissionIdentifier.ViewFolderMetadata"

  • className: "PermissionIdentifier.ViewFolderMetadataObsolete"

  • className: "PermissionIdentifier.ViewGoogleIntegrationStatus"

  • className: "PermissionIdentifier.ViewIssues"

    View issues in a project

  • className: "PermissionIdentifier.ViewKeysOfProjectSecrets"

  • className: "PermissionIdentifier.ViewLanguages"

  • className: "PermissionIdentifier.ViewListOfBonusEvents"

  • className: "PermissionIdentifier.ViewLocationMapPoints"

  • className: "PermissionIdentifier.ViewLocations"

  • className: "PermissionIdentifier.ViewMaintenanceData"

  • className: "PermissionIdentifier.ViewMarketplaceApplications"

  • className: "PermissionIdentifier.ViewMeetings"

  • className: "PermissionIdentifier.ViewMemberBusinessEntities"

  • className: "PermissionIdentifier.ViewMemberLocations"

  • className: "PermissionIdentifier.ViewMemberProfileBasicInfo"

  • className: "PermissionIdentifier.ViewMemberProfiles"

  • className: "PermissionIdentifier.ViewMemberVacationPeriods"

  • className: "PermissionIdentifier.ViewMembershipRatioReport"

  • className: "PermissionIdentifier.ViewMemberships"

  • className: "PermissionIdentifier.ViewMessageReactions"

  • className: "PermissionIdentifier.ViewMessages"

  • className: "PermissionIdentifier.ViewNotificationSettings"

  • className: "PermissionIdentifier.ViewOrganizationDetails"

  • className: "PermissionIdentifier.ViewOrganizationInfo"

  • className: "PermissionIdentifier.ViewParticipantsInArticleCommentsThreads"

  • className: "PermissionIdentifier.ViewParticipantsInIssueCommentThreads"

  • className: "PermissionIdentifier.ViewPermissionsGrantedToOtherMembers"

  • className: "PermissionIdentifier.ViewPersonalTables"

  • className: "PermissionIdentifier.ViewPositions"

  • className: "PermissionIdentifier.ViewProjectDetails"

  • className: "PermissionIdentifier.ViewProjectParameters"

  • className: "PermissionIdentifier.ViewReactionsToArticleComments"

  • className: "PermissionIdentifier.ViewReactionsToCommentsInCodeReviews"

  • className: "PermissionIdentifier.ViewReactionsToDirectMessages"

  • className: "PermissionIdentifier.ViewReactionsToIssueComments"

  • className: "PermissionIdentifier.ViewResponsibilities"

  • className: "PermissionIdentifier.ViewRestrictedCustomFields"

  • className: "PermissionIdentifier.ViewSpentTime"

    View spent time in the project

  • className: "PermissionIdentifier.ViewTables"

    View tables in a project

  • className: "PermissionIdentifier.ViewTeams"

  • className: "PermissionIdentifier.ViewToDos"

  • className: "PermissionIdentifier.ViewUsageData"

  • className: "PermissionIdentifier.ViewVaultConnections"

    View Vault connections

  • className: "PermissionIdentifier.ViewWorkingHours"

  • className: "PermissionIdentifier.WriteGitRepositories"

  • className: "PermissionIdentifier.WritePackageRepositories"

  • className: "PermissionIdentifier.WritePackageRepositoriesObsolete"

  • className: "PermissionIdentifier.WriteVisionProject"

PermissionsRecipientIdentifier type

Possible values:

  • className: "PermissionsRecipientIdentifier.Profile"

    profileId: string ( Required )

  • className: "PermissionsRecipientIdentifier.Team"

    teamId: string ( Required )

PlanItemIdentifier type

Possible values:

  • className: "PlanItemIdentifier.Id"

    id: string ( Required )

PrincipalIn type

Possible values:

  • className: "PrincipalIn.Application"

    application: ApplicationIdentifier ( Required )

  • className: "PrincipalIn.BuiltIn"

    builtIn: string ( Required )

  • className: "PrincipalIn.Profile"

    profile: ProfileIdentifier ( Required )

ProfileIdentifier type

Possible values:

  • className: "ProfileIdentifier.ExternalId"

    externalId: string ( Required )

  • className: "ProfileIdentifier.Id"

    id: string ( Required )

  • className: "ProfileIdentifier.Me"

  • className: "ProfileIdentifier.Username"

    username: string ( Required )

ProjectIdentifier type

Possible values:

  • className: "ProjectIdentifier.Id"

    id: string ( Required )

  • className: "ProjectIdentifier.Key"

    key: string ( Required )

ProjectRoleIn type

Possible values:

  • className: "ProjectAdministratorRoleIn"

  • className: "ProjectCustomRoleIn"

    role: string ( Required )

  • className: "ProjectExternalRoleIn"

  • className: "ProjectMemberRoleIn"

ReactionItemIdentifier type

Possible values:

  • className: "ReactionItemIdentifier.ArticleReaction"

    article: string ( Required )

  • className: "ReactionItemIdentifier.ChatMessageReaction"

    channel: ChannelIdentifier ( Required )

    message: ChatMessageIdentifier ( Required )

ReviewIdentifier type

Possible values:

  • className: "ReviewIdentifier.Id"

    id: string ( Required )

  • className: "ReviewIdentifier.Key"

    key: string ( Required )

  • className: "ReviewIdentifier.Number"

    number: integer (format: int32) ( Required )

SprintIdentifier type

Possible values:

  • className: "SprintIdentifier.Current"

    board: BoardIdentifier ( Required )

  • className: "SprintIdentifier.Id"

    id: string ( Required )

SyncBatchInfo type

Possible values:

  • className: "SyncBatchInfo.SinceEtag"

    etag: string ( Required )

    batchSize: integer (format: int32) ( Required )

TargetIdentifier type

Possible values:

  • className: "TargetIdentifier.Id"

    id: string ( Required )

  • className: "TargetIdentifier.Key"

    key: string ( Required )

  • className: "TargetIdentifier.Number"

    number: integer (format: int32) ( Required )

TeamIdentifier type

Possible values:

  • className: "TeamIdentifier.ExternalId"

    externalId: string ( Required )

  • className: "TeamIdentifier.Id"

    id: string ( Required )

  • className: "TeamIdentifier.Name"

    name: string ( Required )

TeamMembershipIdentifier type

Possible values:

  • className: "TeamMembershipIdentifier.Id"

    id: string ( Required )

TimeTrackingSubjectIdentifier type

Possible values:

  • className: "TimeTrackingSubjectIdentifier.Issue"

    issue: IssueIdentifier ( Required )

WidgetSettingsIdentifier type

Possible values:

  • className: "WidgetSettingsIdentifier.Id"

    id: string ( Required )

  • className: "WidgetSettingsIdentifier.Plain"

    profile: ProfileIdentifier ( Required )

    dashboard: DashboardIdentifier ( Required )

    widget: string ( Required )

WorkerScopeFilter type

Possible values:

  • className: "WorkerScopeFilter.OrganizationOnly"

  • className: "WorkerScopeFilter.Project"

    project: ProjectIdentifier ( Required )

WorkerSortOrder type

Possible values:

  • className: "WorkerSortOrder.AccessTime"

    time: SortOrderType ( Required )

  • className: "WorkerSortOrder.Name"

    name: SortOrderType ( Required )

WorkspaceIdentifier type

Possible values:

  • className: "WorkspaceIdentifier.ByProject"

    project: ProjectIdentifier ( Required )

    number: integer (format: int32) ( Required )

  • className: "WorkspaceIdentifier.ExternalId"

    externalId: string ( Required )

  • className: "WorkspaceIdentifier.Id"

    id: string ( Required )

Enums

AbsenceListMode enum

Type: string

Possible values:

  • All

  • WithAccessibleReasonUnapproved

  • WithAccessibleReasonAll

AccessType enum

Type: string

Possible values:

  • PUBLIC

  • CONFIDENTIAL

  • RESTRICTED

AllChannelsFilter enum

Type: string

Possible values:

  • CreatedByMe

  • Subscribed

AllChannelsSortColumn enum

Type: string

Possible values:

  • Name

  • Subscribers

  • Created

AppConnectionStatus enum

Type: string

Possible values:

  • CONNECTING

  • FAILED_TO_CONNECT

  • RECONNECTING

  • CONNECTED

AppUninstallationStatus enum

Type: string

Possible values:

  • SENDING_UNINSTALL_PAYLOAD

  • RETRYING_SENDING_UNINSTALL_PAYLOAD

  • FAILED

  • UNINSTALLED

ApplicationType enum

Type: string

Possible values:

  • Application

  • InternalApp

  • MarketplaceApp

AppsOrdering enum

Type: string

Possible values:

  • NAME_A_TO_Z

  • NAME_Z_TO_A

  • LAST_EDITED

BuiltInIssueField enum

Type: string

Possible values:

  • ID

  • DUE_DATE

  • ATTACHMENTS

  • STATUS

  • TITLE

  • DESCRIPTION

  • TAGS

  • ASSIGNEE

  • ATTACHMENT_COUNT

  • SUBITEMS_COUNT

BusyStatus enum

Type: string

Possible values:

  • Busy

  • Free

CDomainStatus enum

Type: string

Possible values:

  • AVAILABLE

  • OCCUPIED

  • BLOCKED

ChecklistSorting enum

Type: string

Possible values:

  • UPDATED

  • TITLE

  • FAV_TITLE

ClientBrowser enum

Type: string

Possible values:

  • Other

  • Chrome

  • Firefox

  • Safari

  • Edge

  • Opera

ClientDeviceType enum

Type: string

Possible values:

  • Other

  • Phone

  • Tablet

  • Desktop

ClientIDE enum

Type: string

Possible values:

  • Other

  • AppCode

  • AndroidStudio

  • CLion

  • DataGrip

  • DataSpell

  • GoLand

  • IDEACommunity

  • IDEAEdu

  • IDEAUltimate

  • MPS

  • PhpStorm

  • PyCharmCommunity

  • PyCharmEdu

  • PyCharmProfessional

  • RubyMine

  • WebStorm

ClientOS enum

Type: string

Possible values:

  • Other

  • Windows

  • MacOS

  • Linux

  • Android

  • iOS

CodeDiscussionSuggestedEditState enum

Type: string

Possible values:

  • Accepted

  • Rejected

  • Deleted

CodeReviewParticipantRole enum

Type: string

Possible values:

  • Reviewer

  • Author

  • Watcher

CodeReviewState enum

Type: string

Possible values:

  • Opened

  • Closed

  • Deleted

CodeReviewStateFilter enum

Type: string

Possible values:

  • Opened

  • Closed

  • RequiresAuthorAttention

  • NeedsReview

  • Merged

CodeReviewUnfurlContextField enum

Type: string

Possible values:

  • Title

  • Description

ColumnSortOrder enum

Type: string

Possible values:

  • ASC

  • DESC

CommitExecutionStatus enum

Type: string

Possible values:

  • SCHEDULED

  • PENDING

  • READY_TO_START

  • FAILED_TO_START

  • RUNNING

  • FAILING

  • SUCCEEDED

  • TERMINATED

  • FAILED

  • HANGING

ConnectionTopology enum

Type: string

Possible values:

  • MESH

  • SFU

CreateExternalIssueProjectError enum

Type: string

Possible values:

  • DUPLICATE_ISSUE_PREFIX

CustomFieldType enum

Type: string

Possible values:

  • AUTONUMBER

  • BOOLEAN

  • DATE

  • DATE_TIME

  • DOCUMENT

  • ENUM

  • INTEGER

  • ISSUE

  • LOCATION

  • OPEN_ENUM

  • PERCENTAGE

  • PROFILE

  • PROJECT

  • STRING

  • TEAM

  • URL

  • COMMIT

DarkTheme enum

Type: string

Possible values:

  • AUTO

  • ENABLED

  • DISABLED

DashboardContainerType enum

Type: string

Possible values:

  • OLD_PERSONAL

  • PROJECT

  • PERSONAL

DeploymentIdentifierStatus enum

Type: string

Possible values:

  • deploying

  • current

  • scheduled

DeploymentStatus enum

Type: string

Possible values:

  • SCHEDULED

  • DEPLOYING

  • FAILED

  • CURRENT

  • OBSOLETE

  • HANGING

DeploymentSyncStatus enum

Type: string

Possible values:

  • SYNCED

  • DIRTY

  • SYNCING

  • FAILED

DiffLineType enum

Type: string

Possible values:

  • ADDED

  • DELETED

  • MODIFIED

  • FILTERED_ADDED

  • FILTERED_DELETED

  • FILTERED

  • FILTERED_MODIFIED

  • CONFLICT_OLD

  • CONFLICT_NEW

DocumentBodyType enum

Type: string

Possible values:

  • TEXT

  • CHECKLIST

  • FILE

DraftDocumentType enum

Type: string

Possible values:

  • RICH_TEXT

  • WYSIWYG

  • MARKDOWN

  • NEW_RICH_TEXT

DurationTextFormat enum

Type: string

Possible values:

  • WEEKS

  • DAYS

  • HOURS

EmojiSearchMatchType enum

Type: string

Possible values:

  • Name

  • OtherName

  • Emoticon

  • Unicode

EndpointAppLevelAuthUpdateType enum

Type: string

Possible values:

  • PublicKeySignature

  • SigningKey

  • Bearer

  • Basic

EnumValueOrdering enum

Type: string

Possible values:

  • NAME_ASC

  • NAME_DESC

EnvVarType enum

Type: string

Possible values:

  • PLAIN_TEXT

  • PROJECT_PARAMETER

  • PROJECT_SECRET

EventConferenceKind enum

Type: string

Possible values:

  • NONE

  • GOOGLE_MEET

  • SPACE_TELEKOM

  • CUSTOM

EventParticipationStatus enum

Type: string

Possible values:

  • GOING

  • NOT_GOING

  • NOT_SURE

  • WAITING_FOR_RESPONSE

ExecutionStatus enum

Type: string

Possible values:

  • SCHEDULED

  • PENDING

  • READY_TO_START

  • RUNNING

  • FINISHING

  • FINISHED

  • TERMINATING

  • TERMINATED

  • HIBERNATING

  • HIBERNATED

  • RESTARTING

  • FAILED

  • SKIPPED

ExtendedTypeScopeType enum

Type: string

Possible values:

  • Org

  • Container

ExternalIssueCodeLinkingEventsShape enum

Type: string

Possible values:

  • Transactions

  • StatefulIssues

  • StatefulCodeEntities

FailureConditionType enum

Type: string

Possible values:

  • NON_ZERO_EXIT_CODE

  • TEST_FAILED

  • OUT_OF_MEMORY

  • TIME_OUT

FeatureFlagStatus enum

Type: string

Possible values:

  • WIP

  • EXPERIMENTAL

  • INTERNAL

FileDataType enum

Type: string

Possible values:

  • FILE

  • DIR

Gender enum

Type: string

Possible values:

  • Female

  • Male

  • Other

  • NotSpecified

GitCommitChangeType enum

Type: string

Possible values:

  • ADDED

  • DELETED

  • MODIFIED

GitEntryType enum

Type: string

Possible values:

  • EXE_FILE

  • FILE

  • DIR

  • GIT_LINK

  • SYM_LINK

GitFileAttribute.AttributeState enum

Type: string

Possible values:

  • Set

  • Unset

  • Custom

GitFileType enum

Type: string

Possible values:

  • TEXT

  • LARGE

  • LINK

  • IMAGE

  • BINARY_OTHER

GitGraphEdgeLineStyle enum

Type: string

Possible values:

  • SOLID

  • DASHED

  • DOTTED

GitGraphEdgeType enum

Type: string

Possible values:

  • UP

  • DOWN

GitMergeMode enum

Type: string

Possible values:

  • FF

  • FF_ONLY

  • NO_FF

GitMergeStatus enum

Type: string

Possible values:

  • Success

  • SuccessfulFastForward

  • Conflict

  • AlreadyMerged

  • MultipleMergeBase

  • TooManyChanges

  • Error

GitMergeStatusHttp enum

Type: string

Possible values:

  • SUCCESSFUL_MERGE

  • SUCCESSFUL_FAST_FORWARD

  • ALREADY_MERGED

GitRebaseMode enum

Type: string

Possible values:

  • FF

  • NO_FF

GitSquashMode enum

Type: string

Possible values:

  • ALL

  • AUTO

  • NONE

HA_Method enum

Type: string

Possible values:

  • REST_CREATE

  • REST_QUERY

  • REST_GET

  • REST_UPDATE

  • REST_DELETE

  • HTTP_GET

  • HTTP_POST

  • HTTP_PATCH

  • HTTP_PUT

  • HTTP_DELETE

HA_Primitive enum

Type: string

Possible values:

  • Byte

  • Short

  • Int

  • Long

  • Float

  • Double

  • Boolean

  • String

  • Date

  • DateTime

  • Duration

HA_Type.Object.Kind enum

Type: string

Possible values:

  • PAIR

  • TRIPLE

  • BATCH

  • SYNC_BATCH

  • MOD

  • REQUEST_BODY

HierarchyRole enum

Type: string

Possible values:

  • SEALED

  • OPEN

  • FINAL

  • ABSTRACT

  • INTERFACE

HierarchyRole2 enum

Type: string

Possible values:

  • SEALED_CLASS

  • OPEN_CLASS

  • FINAL_CLASS

  • ABSTRACT_CLASS

  • INTERFACE

  • SEALED_INTERFACE

IdeVersionSortOrder enum

Type: string

Possible values:

  • ByReleaseDate

  • ByVersionAndQuality

InterpolatedLineState enum

Type: string

Possible values:

  • Normal

  • Deleted

  • Modified

IssueListGrouping enum

Type: string

Possible values:

  • NONE

  • TAG

  • ASSIGNEE

  • STATUS

  • PROJECT

IssueSystemFieldEnum enum

Type: string

Possible values:

  • PROJECT

  • ASSIGNEE

  • CREATED_BY

  • STATUS

  • TAG

  • CREATION_TIME

  • DUE_DATE

  • TITLE

  • DELETED

  • PARENT_ISSUES

  • CHECKLISTS

  • BOARD

  • SUBSCRIBER

  • IMPORT_TRANSACTION

IssuesSorting enum

Type: string

Possible values:

  • UPDATED

  • CREATED

  • TITLE

  • DUE

JobExecutionDisplayStatus enum

Type: string

Possible values:

  • Awaiting

  • Running

  • Restarting

  • Finishing

  • Stopped

  • Succeeded

  • Failed

  • NoSuitableWorkers

  • WaitingForWorkers

  • Skipped

JobExecutionStatus enum

Type: string

Possible values:

  • Started

  • Succeeded

  • Failed

  • Terminated

JobSubscriptionType enum

Type: string

Possible values:

  • ALL_FINISHED

  • FAILED

JobTriggerType enum

Type: string

Possible values:

  • MANUAL

  • GIT_PUSH

  • SCHEDULE

  • GIT_BRANCH_DELETED

  • CODE_REVIEW_OPENED

  • CODE_REVIEW_CLOSED

  • SAFE_MERGE

LdapModuleType enum

Type: string

Possible values:

  • AD

  • OPEN_LDAP

LineEnding enum

Type: string

Possible values:

  • CR

  • LF

  • CRLF

LocationType enum

Type: string

Possible values:

  • Region

  • Campus

  • Building

  • Floor

  • Room

  • ConferenceRoom

M2.Access enum

Type: string

Possible values:

  • Private

  • Public

M2EmailNotificationType enum

Type: string

Possible values:

  • INSTANT

  • DELAYED

  • NONE

M2ObsoleteCause enum

Type: string

Possible values:

  • PermissionsDenied

MediaSource enum

Type: string

Possible values:

  • USER

  • SCREEN

MeetingJoiningPreference enum

Type: string

Possible values:

  • NOBODY

  • EVERYONE

MeetingModificationPreference enum

Type: string

Possible values:

  • ORGANIZER

  • PARTICIPANTS

  • EVERYONE

MeetingOrigin enum

Type: string

Possible values:

  • User

  • GoogleCalendar

MeetingVisibility enum

Type: string

Possible values:

  • PARTICIPANTS

  • EVERYONE

MergeRequestBranchType enum

Type: string

Possible values:

  • SOURCE

  • TARGET

MergeSelectOptions.Operation enum

Type: string

Possible values:

  • Merge

  • Rebase

  • DryRun

MessageButtonStyle enum

Type: string

Possible values:

  • PRIMARY

  • REGULAR

  • DANGER

  • SECONDARY

MessageStyle enum

Type: string

Possible values:

  • PRIMARY

  • SECONDARY

  • SUCCESS

  • ERROR

  • WARNING

MessageTextSize enum

Type: string

Possible values:

  • LARGE

  • REGULAR

  • SMALL

MessageTimestampFormat enum

Type: string

Possible values:

  • RELATIVE_TO_NOW

  • FULL

  • TIME_ONLY

  • DATE_ONLY

MessagesSorting enum

Type: string

Possible values:

  • FromOldestToNewest

  • FromNewestToOldest

NotificationFilter enum

Type: string

Possible values:

  • ALL_MESSAGES

  • MENTIONS

  • NOTHING

  • MUTE

OrgIndustryDTO enum

Type: string

Possible values:

  • SoftwareDevelopment

  • Science

  • Education

  • Finance

  • Health

  • Manufacturing

  • Retail

  • Transportation

  • Media

  • Hospitality

  • ProfessionalServices

  • NonProfit

  • Other

OrgSizeDTO enum

Type: string

Possible values:

  • JUST_ME

  • N_2_10

  • N_11_50

  • N_51_250

  • N_251_500

  • N_501_1000

  • N_1001_5000

  • MORE_THAN_5000

PackageRepositoryCredentials enum

Type: string

Possible values:

  • ANONYMOUS

  • PASSWORD

  • TOKEN

  • HEADER

PackageRepositoryEventAction enum

Type: string

Possible values:

  • published

  • removed

  • vulnerabilities

PackageRepositoryMode enum

Type: string

Possible values:

  • HOSTING

  • PROXY

PackagesSortColumn enum

Type: string

Possible values:

  • Downloads

  • LastAccessed

  • Created

  • Size

ParticipationState enum

Type: string

Possible values:

  • NONE

  • CONNECTED

  • DISCONNECTED

PasswordStrength enum

Type: string

Possible values:

  • NO_POLICY

  • FAIR

  • GOOD

  • STRONG

PermissionRoleType enum

Type: string

Possible values:

  • PREDEFINED

  • CUSTOM

  • AUTHORIZABLE

  • ANONYMOUS

PrivateFeedColor enum

Type: string

Possible values:

  • Blue

  • Purple

  • Yellow

  • Green

  • Grey

  • Orange

  • Pink

ProfileOrder enum

Type: string

Possible values:

  • DEFAULT

  • FULL_NAME

ProfileOrgRelation enum

Type: string

Possible values:

  • MEMBER

  • GUEST

  • ANY

ProjectFeature enum

Type: string

Possible values:

  • DOCUMENTS

  • ISSUES

  • BOARDS

  • REPOSITORIES

  • CODE_REVIEWS

  • JOBS

  • PACKAGES

  • DEV_ENVIRONMENTS

  • HOSTING

  • DEPLOYMENTS

  • TABLES

  • PARAMETERS

  • SECRETS

ProjectPinnedItemKind enum

Type: string

Possible values:

  • CodeRepository

  • PlanningIssueBoard

  • PackageRepository

  • AutomationJob

  • Document

  • DocumentFolder

  • DeployTarget

  • DocumentBook

  • DevEnvironment

  • PlanningIssueFilter

  • PlanningIssueFilterForMeAndUnresolved

  • PlanningIssueFilterUnresolved

  • ExternalIssueTrackerLink

ProjectTeamType enum

Type: string

Possible values:

  • LEGACY

  • MEMBERS

  • ATTACHED

RdWorkspaceState enum

Type: string

Possible values:

  • Initializing

  • Activating

  • Active

  • Unhealthy

  • Hibernating

  • Hibernated

  • Deleting

  • Deleted

  • Restarting

  • Failed

  • FailedToStart

  • Created

  • Inactive

RecurrentModification enum

Type: string

Possible values:

  • Me

  • SinceMe

  • All

RegisterNewUserType enum

Type: string

Possible values:

  • Member

  • ExternalCollaborator

  • Guest

RepositoryState enum

Type: string

Possible values:

  • READY

  • IN_PROGRESS

  • ERROR

ResolvedOption enum

Type: string

Possible values:

  • UNRESOLVED

  • RESOLVED

ReviewRevisionsChangedType enum

Type: string

Possible values:

  • Created

  • Added

  • Removed

ReviewSorting enum

Type: string

Possible values:

  • CreatedAtDesc

  • CreatedAtAsc

  • LastUpdatedDesc

  • LastUpdatedAsc

ReviewType enum

Type: string

Possible values:

  • CommitSetReview

  • MergeRequest

ReviewerChangedType enum

Type: string

Possible values:

  • Joined

  • Left

ReviewerState enum

Type: string

Possible values:

  • Accepted

  • Rejected

RightStatus enum

Type: string

Possible values:

  • NONE

  • REQUESTED

  • GRANTED

  • REJECTED

RoomOrigin enum

Type: string

Possible values:

  • Unknown

  • Chat

  • Adhoc

  • Meeting

RtTextAlign enum

Type: string

Possible values:

  • left

  • center

  • right

  • justify

SFUMediaKind enum

Type: string

Possible values:

  • video

  • audio

SafeMergeMessage.Type enum

Type: string

Possible values:

  • Progress

  • Success

  • Error

SafeMergeState enum

Type: string

Possible values:

  • STARTING

  • RUNNING

  • FAILED

  • SUCCEEDED

SnapshotState enum

Type: string

Possible values:

  • UNKNOWN

  • PENDING

  • COMPLETED

  • ERROR

SortOrderType enum

Type: string

Possible values:

  • ASC

  • DESC

SpecialDateValue enum

Type: string

Possible values:

  • NOT_SET

  • TODAY

  • YESTERDAY

  • NEXT_WEEK

  • THIS_WEEK

  • LAST_WEEK

SprintState enum

Type: string

Possible values:

  • CLOSED

  • CURRENT

  • PLANNED

SyncRecordModType enum

Type: string

Possible values:

  • CREATED

  • UPDATED

  • ARCHIVED

SyntaxMarkupType enum

Type: string

Possible values:

  • KEYWORD

  • COMMENT

  • NUM_LITERAL

  • STRING_LITERAL

  • DECLARATION

  • PARAMETER_ASSIGNMENT

  • IDENTIFIER_TYPE

  • IDENTIFIER_DECLARATION

  • IDENTIFIER

  • INVOCATION

  • DSL

  • KEY

  • TAG

  • ANNOTATION

  • PREPROCESSOR_ANNOTATION

  • PREPROCESSOR_MESSAGE

  • HIGHLIGHT

  • CODE_FOLD

  • SKIP

  • NAVIGATION_SYMBOL

Tier enum

Type: string

Possible values:

  • Free

  • Team

  • Organization

  • Classroom

  • Beta

  • Enterprise

TimeTrackingSubjectType enum

Type: string

Possible values:

  • ISSUE

TodoItemContentKind enum

Type: string

Possible values:

  • NONE

  • REGULAR

  • MESSAGE

  • ISSUE

  • BLOG

  • DOCUMENT

  • MEETING

  • CODE_REVIEW

  • EXTERNAL_ISSUE

TwoFactorAuthenticationStatus enum

Type: string

Possible values:

  • NOT_SETUP

  • INACTIVE

  • ACTIVE

UnfurlDateTimeFormat enum

Type: string

Possible values:

  • RELATIVE_TO_NOW

  • FULL

  • TIME_ONLY

  • DATE_ONLY

UnfurlDateTimeStyle enum

Type: string

Possible values:

  • REGULAR

  • SECONDARY

  • STRIKETHROUGH

  • BOLD

  • CODE

UnfurlViewType enum

Type: string

Possible values:

  • Inline

  • Attachment

VersionStatus enum

Type: string

Possible values:

  • Outdated

  • Active

VolumeState enum

Type: string

Possible values:

  • UNKNOWN

  • CREATING

  • AVAILABLE

  • IN_USE

  • DELETING

  • DELETED

  • ERROR

WarmupExecutionStatus enum

Type: string

Possible values:

  • Started

  • Failed

  • Terminated

  • SnapshotCreated

  • SnapshotDeleted

Weekday enum

Type: string

Possible values:

  • SUNDAY

  • MONDAY

  • TUESDAY

  • WEDNESDAY

  • THURSDAY

  • FRIDAY

  • SATURDAY

WorkerCapability enum

Type: string

Possible values:

  • Docker

  • DockerCompose

  • BlockStorage

  • Git

WorkerError enum

Type: string

Possible values:

  • StartError

  • DownloadError

  • Error

WorkerOSType enum

Type: string

Possible values:

  • Linux

  • Windows

  • Mac

  • Other

WorkerScope enum

Type: string

Possible values:

  • Organization

  • Project

WorkerStatus enum

Type: string

Possible values:

  • Healthy

  • Disconnected

  • Unhealthy

  • Suspended

  • GracefulShutdown

  • Locked

  • WithWarning

  • NotInitialized