JetBrains Space Help

API Reference

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

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

Object types

ATimeZone type

object with fields:

  • id: string ( Required )

ATimeZoneWithOffset type

object with fields:

  • id: string ( Required )

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

AbsenceApproval type

object with fields:

  • approved: boolean ( Required )

  • approvedBy: TD_MemberProfile ( Required )

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

AbsenceApprovalWebhookEvent type

object with fields:

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

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 )

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 )

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

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)

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 )

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

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

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

  • authors: array of CodeReviewParticipantRecord ( Required )

  • watchers: array of CodeReviewParticipantRecord ( Required )

CodeReviewPendingMessageCounter type

object with fields:

  • id: string ( Required )

  • archived: boolean ( Required )

CodeReviewRecord type

Name

Type

className

string

Possible values:

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 )

  • repository: string ( Required )

  • reviewId: string ( Required )

  • title: string ( Required )

  • isMergeRequest: boolean ( Required )

CodeReviewWithCount type

object with fields:

  • review: CodeReviewRecord ( Required )

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

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

  • authors: array of CodeReviewParticipantRecord ( Required )

  • watchers: array of CodeReviewParticipantRecord ( Required )

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

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)

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)

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

  • visibility: MeetingVisibility ( Required )

  • modificationPreference: MeetingModificationPreference ( Required )

  • joiningPreference: MeetingJoiningPreference ( Nullable and Optional , defaults to null)

  • organizer: MeetingOrganizer ( Nullable and Optional , defaults to null)

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

  • privateDataSubstituted: boolean ( Required )

  • canModify: boolean ( Required )

  • canDelete: boolean ( Required )

  • canJoin: boolean ( Required )

  • externalParticipants: array of string ( Required )

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

  • eventAttachments: array of MeetingAttachment ( Nullable and Optional , defaults to null)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • archived: boolean ( Required )

  • 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