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 )

AbsenceEvent type
object with fields :

AbsenceReasonRecord type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

  • name : string ( Required )

  • description : string ( Required )

  • defaultAvailability : boolean ( Required )

  • approvalRequired : boolean ( Required )

  • icon : string ( Required )

AbsenceRecord type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

  • member : TD_MemberProfile ( Required )

  • icon : string ( Required )

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

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

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

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

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

  • available : boolean ( Required )

  • approval : AbsenceApproval ( Nullable and Optional , defaults to null )

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

AccessRecord type
object with fields :

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

  • address : string ( Required )

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

AllChannelsListEntry type
object with fields :

  • channelId : string ( Required )

  • name : string ( Required )

  • description : string ( Required )

  • access : M2.Access ( Required )

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

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

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

  • subscribed : boolean ( Required )

AllReactionsToItemRecord type
object with fields :

ApiIcon type
object with fields :

  • icon : string ( Required )

ApplicationPayload type

Name Type
className string

Possible values:

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 )

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

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

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

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

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

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

ArticleHitDetails type
object with fields :

ArticleImportResult type
object with fields :

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

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

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

ArticleMarkdownImage type
object with fields :

  • alt : string ( Required )

  • src : string ( Required )

ArticlePreviewRecord type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

  • previewImages : array of ArticleMarkdownImage ( Required )

  • preview : string ( Required )

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

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

ArticleRecord type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

  • title : string ( Required )

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

  • author : TD_MemberProfile ( Required )

  • aliases : array of BG_ArticleAlias ( Required )

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

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

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

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

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

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

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

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

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

  • previewImages : array of ArticleMarkdownImage ( Required )

  • preview : string ( Required )

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

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

  • content : string ( Required )

  • editable : boolean ( Required )

  • channel : M2ChannelRecord ( Required )

  • channelContent : M2ChannelContentRecord ( Required )

  • reactions : AllReactionsToItemRecord ( Required )

AssignedPerson type
object with fields :

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

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

Attachment type

Name Type
className string

Possible values:

AttachmentIn type

Name Type
className string

Possible values:

AttachmentInfo type
object with fields :

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

AuthModuleUsage type
object with fields :

  • authModule : ES_AuthModule ( Required )

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

AutomationJobExecutionUnfurlDetails type
object with fields :

  • jobExecutionId : string ( Required )

  • projectRef : PR_Project ( Required )

  • repoName : string ( Required )

AutomationJobUnfurlDetails type
object with fields :

  • jobId : string ( Required )

  • jobName : string ( Required )

  • projectRef : PR_Project ( Required )

  • repoName : string ( Required )

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

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

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

AvatarCropSquare type
object with fields :

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

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

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

BG_ArticleAlias type
object with fields :

  • alias : string ( Required )

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

BG_ArticleId type
object with fields :

  • id : string ( Required )

BG_Stats type
object with fields :

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

  • teams : array of object with fields :

    • first : TD_Team ( Required )

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

    ( Required )
  • projects : array of object with fields :

    • first : PR_Project ( Required )

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

    ( Nullable and Optional , defaults to null )
  • locations : array of object with fields :

    • first : TD_Location ( Required )

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

    ( Required )

BaseMenuActionContext type
object with fields :

  • menuId : string ( Required )

BillingFeedChannel type
object with fields :

BillingReport type
object with fields :

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

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

  • plans : array of PurchasedBillingPlan ( Required )

  • activeUsers : array of integer (format: int64) ( Required )

  • applications : array of integer (format: int64) ( Required )

  • chatMessages : array of integer (format: int64) ( Required )

  • ciCredits : array of integer (format: int64) ( Required )

  • trafficTotal : array of integer (format: int64) ( Required )

  • trafficFiles : array of integer (format: int64) ( Required )

  • trafficGit : array of integer (format: int64) ( Required )

  • trafficPackages : array of integer (format: int64) ( Required )

  • storageTotal : array of integer (format: int64) ( Required )

  • storageFiles : array of integer (format: int64) ( Required )

  • storageGit : array of integer (format: int64) ( Required )

  • storagePackages : array of integer (format: int64) ( Required )

  • storageAutomation : array of integer (format: int64) ( Required )

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

BirthdayEvent type
object with fields :

  • profile : TD_MemberWithTeam ( Required )

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

BlogCalendarEvent type
object with fields :

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

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

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

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

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

BlogPublicationDetails type
object with fields :

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

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

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

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

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

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

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 )

BoardMemberOwners type
object with fields :

BoardOwners type
object with fields :

BoardRecord type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

  • name : string ( Required )

  • board : BoardRecord ( Required )

  • data : BoardWidgetData ( Nullable and Optional , defaults to null )

  • info : BoardInfo ( Required )

BoardTeamOwners type
object with fields :

  • teams : array of TD_Team ( Required )

BoardWidgetData type
object with fields :

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

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

BookHitDetails type
object with fields :

  • ref : KB_Book ( Required )

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

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

BooleanCFType type
No properties

BooleanCFValue type
object with fields :

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

Branch type
object with fields :

  • branchName : string ( Required )

BranchInfo type
object with fields :

  • head : string ( Required )

  • ref : string ( Required )

CAutomationTaskPrincipalDetails type
object with fields :

  • project : PR_Project ( Required )

  • name : string ( Required )

  • id : string ( Required )

CBuiltInServicePrincipalDetails type
object with fields :

  • name : string ( Required )

CExternalServicePrincipalDetails type
object with fields :

CFConstraint type

Name Type
className string

Possible values:

CFEnumValuesModification type
object with fields :

  • valuesToAdd : array of EnumValueData ( Required )

  • valuesToUpdate : array of EnumValueData ( Required )

  • valuesToDelete : array of string ( Required )

CFType type

Name Type
className string

Possible values:

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:

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 )

CalendarEventSpec type
object with fields :

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

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

  • recurrenceRule : RecurrenceRule ( Nullable and Optional , defaults to null )

  • allDay : boolean ( Required )

  • timezone : ATimeZone ( Required )

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

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

  • busyStatus : BusyStatus ( Nullable and Optional , defaults to null )

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

CertainReactionToItemRecord type
object with fields :

  • id : string ( Required )

  • itemId : string ( Required )

  • reaction : ReactionTypeRecord ( Required )

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

  • meReacted : boolean ( Required )

  • principals : array of CPrincipal ( Required )

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

CertificateInfo type
object with fields :

  • certificateType : string ( Required )

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

  • serialNumber : string ( Required )

  • issuedBy : string ( Required )

  • issuedTo : string ( Required )

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

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

  • algorithm : string ( Required )

  • fingerprint : Fingerprint ( Required )

ChannelAttachmentMenuActionContext type
object with fields :

  • menuId : string ( Required )

  • channelId : string ( Required )

ChannelItemRecord type
object with fields :

  • text : string ( Required )

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

  • author : CPrincipal ( Required )

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

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

  • reactions : AllReactionsToItemRecord ( Nullable and Optional , defaults to null )

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

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

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

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

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

  • id : string ( Required )

  • archived : boolean ( Required )

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

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

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

  • issues : array of Issue ( Required )

ChannelItemSnapshot type
object with fields :

  • id : string ( Required )

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

  • text : string ( Required )

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

  • author : CPrincipal ( Required )

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

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

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

ChannelMessageMenuActionContext type
object with fields :

  • menuId : string ( Required )

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

  • messageId : string ( Required )

ChannelParticipant type
object with fields :

  • principal : CPrincipal ( Required )

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

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

ChannelSpecificDefaults type
object with fields :

ChatChannel type

Name Type
className string

Possible values:

ChatChannel.FromId type
object with fields :

  • id : string ( Required )

ChatChannel.FromName type
object with fields :

  • name : string ( Required )

ChatMessage type

Name Type
className string

Possible values:

ChatMessage.Block type
object with fields :

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

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

  • sections : array of MessageSectionElement ( Required )

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

ChatMessage.Text type
object with fields :

  • text : string ( Required )

ChatModification type

Name Type
className string

Possible values:

Checklist type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

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

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

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

  • name : string ( Required )

  • root : PlanItem ( Nullable and Optional , defaults to null )

  • rootTag : PlanningTag ( Nullable and Optional , defaults to null )

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

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

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

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

ClientInfo type
object with fields :

  • os : ClientOS ( Nullable and Optional , defaults to null )

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

  • browser : ClientBrowser ( Nullable and Optional , defaults to null )

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

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

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

CodeDiscussionAddedFeedEvent type
object with fields :

CodeDiscussionAnchor type
object with fields :

  • project : ProjectKey ( Required )

  • repository : string ( Required )

  • revision : string ( Required )

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

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

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

  • interpolatedLineState : InterpolatedLineState ( Nullable and Optional , defaults to null )

CodeDiscussionRecord type
object with fields :

  • id : string ( Required )

  • projectId : string ( Required )

  • anchor : CodeDiscussionAnchor ( Required )

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

  • channel : M2ChannelRecord ( Required )

  • resolved : boolean ( Required )

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

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

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

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

  • reviews : array of CodeReviewRecord ( Nullable and Optional , defaults to null )

  • archived : boolean ( Required )

CodeDiscussionSnippet type

Name Type
className string

Possible values:

CodeDiscussionSnippet.InlineDiffSnippet type
object with fields :

CodeDiscussionSnippet.PlainSnippet type
object with fields :

CodeLine type
object with fields :

  • text : string ( Required )

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

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

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

CodeReviewDetailedInfo type
object with fields :

CodeReviewDiscussionAddedFeedEvent type
object with fields :

CodeReviewDiscussionCounter type
object with fields :

  • id : string ( Required )

  • discussionCounter : Counter ( Required )

CodeReviewDiscussionRecord type
object with fields :

  • id : string ( Required )

  • review : CodeReviewRecord ( Required )

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

  • channel : M2ChannelRecord ( Required )

  • resolved : boolean ( Required )

CodeReviewParticipant type
object with fields :

CodeReviewParticipantQualityGateSlot type
object with fields :

  • rule : array of string ( Required )

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

CodeReviewParticipantRecord type
object with fields :

  • id : string ( Required )

  • projectId : string ( Required )

  • role : CodeReviewParticipantRole ( Required )

  • profile : TD_MemberProfile ( Required )

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

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

  • archived : boolean ( Required )

CodeReviewParticipants type
object with fields :

CodeReviewPendingMessageCounter type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

CodeReviewRecord type

Name Type
className string

Possible values:

CodeReviewWithCount type
object with fields :

CodeSnippetAnchor type
object with fields :

  • projectKey : ProjectKey ( Required )

  • repository : string ( Required )

  • revision : string ( Required )

  • filename : string ( Required )

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

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

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

CommandDetail type
object with fields :

  • name : string ( Required )

  • description : string ( Required )

Commands type
object with fields :

CommitSetReviewRecord type
object with fields :

  • id : string ( Required )

  • project : ProjectKey ( Required )

  • projectId : string ( Required )

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

  • title : string ( Required )

  • state : CodeReviewState ( Required )

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

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

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

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

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

  • discussionCounter : Counter ( Required )

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

  • reviewers : array of CodeReviewParticipantRecord ( Required )

  • authors : array of CodeReviewParticipantRecord ( Required )

  • watchers : array of CodeReviewParticipantRecord ( Required )

ContainerHelmChart type
object with fields :

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

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

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

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

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

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

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

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

  • dependencies : array of ContainerHelmChartDependency ( Required )

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

ContainerHelmChartDependency type
object with fields :

  • name : string ( Required )

  • version : string ( Required )

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

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

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

ContainerImage type
object with fields :

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

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

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

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

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

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

  • platform : ContainerImagePlatform ( Nullable and Optional , defaults to null )

  • history : array of ContainerImageLayer ( Required )

  • children : array of ContainerManifest ( Required )

  • config : ContainerImageConfig ( Nullable and Optional , defaults to null )

  • annotation : ContainerImageAnnotation ( Nullable and Optional , defaults to null )

ContainerImageAnnotation type
object with fields :

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

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

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

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

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

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

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

ContainerImageConfig type
object with fields :

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

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

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

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

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

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

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

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

ContainerImageLayer type
object with fields :

  • id : string ( Required )

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

  • statement : string ( Required )

  • command : string ( Required )

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

ContainerImagePlatform type
object with fields :

  • os : string ( Required )

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

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

ContainerManifest type
object with fields :

  • name : string ( Required )

  • digest : string ( Required )

  • tags : array of string ( Required )

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

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

  • mediaType : string ( Required )

  • manifestType : string ( Required )

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

  • image : ContainerImage ( Nullable and Optional , defaults to null )

  • chart : ContainerHelmChart ( Nullable and Optional , defaults to null )

ContainerPackageType type
object with fields :

  • id : string ( Required )

ContainerPackageVersionDetails type
object with fields :

  • type : PackageType ( Required )

  • repository : string ( Required )

  • name : string ( Required )

  • version : string ( Required )

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

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

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

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

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

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

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

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

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

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

  • mediaType : string ( Required )

  • manifestType : string ( Required )

  • image : ContainerImage ( Nullable and Optional , defaults to null )

  • chart : ContainerHelmChart ( Nullable and Optional , defaults to null )

Counter type
object with fields :

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

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

Currency type
object with fields :

  • code : string ( Required )

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

  • signAsPrefix : boolean ( Required )

CustomField type
object with fields :

  • extendedType : ExtendedType ( Required )

  • id : string ( Required )

  • name : string ( Required )

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

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

  • type : CFType ( Required )

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

  • required : boolean ( Required )

  • private : boolean ( Required )

  • access : AccessType ( Nullable and Optional , defaults to null )

  • defaultValue : CFValue ( Required )

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

  • scope : ExtendedTypeScope ( Nullable and Optional , defaults to null )

  • archived : boolean ( Required )

CustomFieldValue type
object with fields :

CustomFieldsRecord type
object with fields :

DR_Draft type
object with fields :

  • id : string ( Required )

  • title : string ( Required )

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

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

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

  • shared : boolean ( Required )

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

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

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

  • publishedFlag : boolean ( Required )

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

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

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

  • editors : array of TD_MemberProfile ( Required )

  • editorsTeams : array of TD_Team ( Required )

  • document : TextDocument ( Required )

DR_DraftHeader type
object with fields :

  • id : string ( Required )

  • title : string ( Required )

  • author : TD_MemberProfile ( Required )

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

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

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

  • shared : boolean ( Required )

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

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

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

DTO_FullRightWithoutType type
object with fields :

  • code : string ( Required )

  • title : string ( Required )

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

  • grantedForUsers : boolean ( Required )

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

DTO_Meeting type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

  • summary : string ( Required )

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

  • locations : array of TD_Location ( Required )

  • profiles : array of TD_MemberProfile ( Required )

  • teams : array of TD_Team ( Required )

  • occurrenceRule : CalendarEventSpec ( Required )

  • origin : MeetingOrigin ( Required )

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

  • visibility : MeetingVisibility ( Required )

  • modificationPreference : MeetingModificationPreference ( Required )

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

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

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

  • privateDataSubstituted : boolean ( Required )

  • canModify : boolean ( Required )

  • canDelete : boolean ( Required )

  • canJoin : boolean ( Required )

  • externalParticipants : array of string ( Required )

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

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

DTO_Right type
object with fields :

  • typeCode : string ( Required )

  • code : string ( Required )

DTO_RightType type
object with fields :

  • typeCode : string ( Required )

  • title : string ( Required )

DTO_RightType_Right type
object with fields :

DTO_RightsDeps type
object with fields :

  • code : string ( Required )

  • deps : array of string ( Required )

DTO_RightsGroup type
object with fields :

  • title : string ( Required )

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

  • rights : array of DTO_Right ( Required )

DTO_RightsWithHierarchy type
object with fields :

DateCFConstraint type
object with fields :

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

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

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

DateCFType type
No properties

DateCFValue type
object with fields :

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

DateTimeViewParams type
object with fields :

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

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

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

DeleteMessage type
object with fields :

  • id : string ( Required )

DeletedAttachment type
object with fields :

  • deletedIdentity : string ( Required )

Diff type
object with fields :

  • added : array of string ( Required )

  • removed : array of string ( Required )

  • removeAll : boolean ( Required )

DiffContext type
object with fields :

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

  • right : DiffSide ( Required )

DiffSide type

Name Type
className string

Possible values:

DiffSide.Empty type
object with fields :

  • revision : string ( Required )

DiffSide.NonEmpty type
object with fields :

  • revision : string ( Required )

  • path : string ( Required )

DocumentFolderPublicationItem type
object with fields :

  • folderId : string ( Required )

DocumentFolderRecord type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

  • name : string ( Required )

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

  • subfolders : array of DocumentFolderRecord ( Required )

  • documents : array of DR_DraftHeader ( Required )

  • owner : TD_MemberProfile ( Required )

  • alias : string ( Required )

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

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

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

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

DocumentPublicationItem type
object with fields :

ES_App type
object with fields :

  • id : string ( Required )

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

  • clientId : string ( Required )

  • name : string ( Required )

  • clientCredentialsFlowEnabled : boolean ( Required )

  • codeFlowEnabled : boolean ( Required )

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

  • implicitFlowEnabled : boolean ( Required )

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

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

  • hasVerificationToken : boolean ( Required )

  • hasSigningKey : boolean ( Required )

  • archived : boolean ( Required )

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

ES_ApplicationPassword type
object with fields :

  • id : string ( Required )

  • profile : TD_MemberProfile ( Required )

  • name : string ( Required )

  • scope : string ( Required )

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

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

ES_ApprovedScope type
object with fields :

  • id : string ( Required )

  • scope : string ( Required )

  • offlineAllowed : boolean ( Required )

ES_AuthModule type
object with fields :

  • id : string ( Required )

  • key : string ( Required )

  • name : string ( Required )

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

  • enabled : boolean ( Required )

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

  • settings : ES_AuthModuleSettings ( Required )

ES_AuthModuleSettings type

Name Type
className string

Possible values:

ES_AuthenticationSession type
object with fields :

  • id : string ( Required )

  • profile : TD_MemberProfile ( Required )

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

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

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

  • current : boolean ( Required )

ES_AzureAuthModuleSettings type
object with fields :

  • tenantId : string ( Required )

  • clientId : string ( Required )

  • clientSecret : string ( Required )

  • registerNewUsers : boolean ( Required )

  • emailVerified : boolean ( Required )

ES_BuiltinAuthModuleSettings type
object with fields :

  • passwordStrengthPolicy : PasswordStrength ( Required )

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

ES_BuiltinProfileLoginDetails type
object with fields :

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

ES_ContainerRegistrySettings type
object with fields :

  • immutableTags : boolean ( Required )

ES_DefaultProfileLoginDetails type
object with fields :

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

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

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

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

  • emailVerified : boolean ( Required )

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

ES_ExternalPasswordAuthModuleSettings type

Name Type
className string

Possible values:

ES_FederatedAuthModuleSettings type

Name Type
className string

Possible values:

ES_GithubAuthModuleSettings type
object with fields :

  • githubUrl : string ( Required )

  • clientId : string ( Required )

  • clientSecret : string ( Required )

  • registerNewUsers : boolean ( Required )

  • organizations : array of string ( Required )

ES_GithubProfileLoginDetails type
object with fields :

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

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

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

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

  • emailVerified : boolean ( Required )

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

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

ES_GoogleAuthModuleSettings type
object with fields :

  • clientId : string ( Required )

  • clientSecret : string ( Required )

  • registerNewUsers : boolean ( Required )

  • domains : array of string ( Required )

ES_HiddenAuthModuleSettings type
object with fields :

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

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

ES_HubAuthModuleSettings type
object with fields :

  • hubUrl : string ( Required )

  • clientId : string ( Required )

  • clientSecret : string ( Required )

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

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

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

ES_HubProfileLoginDetails type
object with fields :

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

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

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

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

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

  • emailVerified : boolean ( Required )

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

ES_LdapAttributeNames type
object with fields :

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

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

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

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

ES_LdapAuthModuleSettings type
object with fields :

  • type : LdapModuleType ( Required )

  • registerNewUsers : boolean ( Required )

  • serverUrl : string ( Required )

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

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

  • sslKeystore : SSLKeystore ( Nullable and Optional , defaults to null )

  • teamMappings : array of ES_TeamMapping ( Required )

  • referralIgnored : boolean ( Required )

  • filter : string ( Required )

  • bindUserDN : string ( Required )

  • bindUserPassword : string ( Required )

  • attributeNames : ES_LdapAttributeNames ( Required )

ES_MavenRepositorySettings type
object with fields :

  • enableSnapshots : boolean ( Required )

ES_NpmRegistrySettings type
No properties

ES_NuGetFeedSettings type
No properties

ES_OAuth2AuthModuleSettings type

Name Type
className string

Possible values:

ES_OAuthConsent type
object with fields :

ES_OIDCAuthModuleSettings type
object with fields :

  • clientId : string ( Required )

  • clientSecret : string ( Required )

  • registerNewUsers : boolean ( Required )

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

  • issuer : string ( Required )

  • authorizationEndpoint : string ( Required )

  • tokenEndpoint : string ( Required )

  • tokenKeysEndpoint : string ( Required )

  • userInfoEndpoint : string ( Required )

  • domains : array of string ( Required )

ES_PackageRepositorySettings type

Name Type
className string

Possible values:

ES_PasswordAuthModuleSettings type

Name Type
className string

Possible values:

ES_PermanentToken type
object with fields :

  • id : string ( Required )

  • name : string ( Required )

  • profile : TD_MemberProfile ( Required )

  • scope : string ( Required )

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

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

ES_ProfileLogin type
object with fields :

ES_ProfileLoginDetails type

Name Type
className string

Possible values:

ES_RefreshToken type
object with fields :

  • id : string ( Required )

  • scope : string ( Required )

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

ES_SamlAttributeNames type
object with fields :

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

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

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

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

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

  • emailVerified : boolean ( Required )

ES_SamlAuthModuleSettings type
object with fields :

  • idpUrl : string ( Required )

  • idpEntityId : string ( Required )

  • idpCertificateSHA256 : string ( Required )

  • spEntityId : string ( Required )

  • sslKeystore : SSLKeystore ( Nullable and Optional , defaults to null )

  • registerNewUsers : boolean ( Required )

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

  • attributeNames : ES_SamlAttributeNames ( Required )

ES_Service type
object with fields :

  • id : string ( Required )

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

  • type : OAuthServiceType ( Required )

  • clientId : string ( Required )

  • name : string ( Required )

  • redirectURIs : string ( Required )

  • archived : boolean ( Required )

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

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

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

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

ES_SshKey type
object with fields :

  • fingerprint : string ( Required )

  • comment : string ( Required )

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

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

ES_TeamMapping type
object with fields :

  • teamId : string ( Required )

  • externalGroupName : string ( Required )

EditMessage type
object with fields :

  • text : string ( Required )

  • id : string ( Required )

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

EmojiReactionRecord type
object with fields :

  • id : string ( Required )

  • itemId : string ( Required )

  • emoji : string ( Required )

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

  • meReacted : boolean ( Required )

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

EmojiSearchMatchData type
object with fields :

  • emoji : string ( Required )

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

  • matchType : EmojiSearchMatchType ( Required )

EntityHit type
object with fields :

  • score : number (format: double) ( Required )

  • title : string ( Required )

  • snippets : array of MatchSnippet ( Required )

  • details : EntityHitDetails ( Required )

EntityHitDetails type

Name Type
className string

Possible values:

EntityType type
object with fields :

  • key : string ( Required )

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

  • groupKey : string ( Required )

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

EnumCFType type
object with fields :

EnumCFValue type
object with fields :

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

EnumListCFType type
object with fields :

EnumListCFValue type
object with fields :

EnumValueData type
object with fields :

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

  • value : string ( Required )

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

EstimationDTO type
object with fields :

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

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

ExtendedType type
object with fields :

  • key : string ( Required )

  • displayName : string ( Required )

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

  • scopeType : ExtendedTypeScopeType ( Required )

ExternalArticle type
object with fields :

  • title : string ( Required )

  • content : string ( Required )

  • authorId : string ( Required )

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

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

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

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

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

ExternalCheckDTO type
object with fields :

  • repository : string ( Required )

  • revision : string ( Required )

  • executionStatus : CommitExecutionStatus ( Required )

  • url : string ( Required )

  • externalServiceName : string ( Required )

  • taskName : string ( Required )

  • taskId : string ( Required )

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

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

ExternalEntityInfoRecord type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

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

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

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

  • transaction : ImportTransactionRecord ( Required )

ExternalIssue type
object with fields :

  • summary : string ( Required )

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

  • status : string ( Required )

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

  • externalId : string ( Required )

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

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

FailureConditionDTO type

Name Type
className string

Possible values:

FeatureFlag type
object with fields :

  • name : string ( Required )

  • description : string ( Required )

  • status : FeatureFlagStatus ( Required )

  • owner : string ( Required )

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

FeedEvent type

Name Type
className string

Possible values:

FileAttachment type
object with fields :

  • id : string ( Required )

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

  • filename : string ( Required )

Fingerprint type
object with fields :

  • md5 : string ( Required )

  • sha1 : string ( Required )

  • sha256 : string ( Required )

  • sha384 : string ( Required )

  • sha512 : string ( Required )

FolderHitDetails type
object with fields :

FolderPublicationItem type

Name Type
className string

Possible values:

GitAuthorInfo type
object with fields :

  • name : string ( Required )

  • email : string ( Required )

GitCommitInfo type
object with fields :

  • id : string ( Required )

  • message : string ( Required )

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

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

  • author : GitAuthorInfo ( Required )

  • committer : GitAuthorInfo ( Required )

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

  • parents : array of string ( Required )

  • heads : array of string ( Required )

GitCommitWithGraph type
object with fields :

GitCommitterProfile type
object with fields :

  • author : string ( Required )

  • email : string ( Required )

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

GitGraphLayoutEdge type
object with fields :

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

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

  • type : GitGraphEdgeType ( Required )

  • style : GitGraphEdgeLineStyle ( Required )

  • hasArrow : boolean ( Required )

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

GitGraphLayoutLine type
object with fields :

GitGraphLayoutNode type
object with fields :

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

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

GlobalPermissionTarget type
No properties

HA_DefaultValue type

Name Type
className string

Possible values:

HA_DefaultValue.Collection type
object with fields :

HA_DefaultValue.Const type

Name Type
className string

Possible values:

HA_DefaultValue.Const.EnumEntry type
object with fields :

  • entryName : string ( Required )

HA_DefaultValue.Const.Primitive type
object with fields :

  • expression : string ( Required )

HA_DefaultValue.Map type
object with fields :

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

HA_DefaultValue.Reference type
object with fields :

  • paramName : string ( Required )

HA_Deprecation type
object with fields :

  • message : string ( Required )

  • since : string ( Required )

  • forRemoval : boolean ( Required )

HA_Dto type
object with fields :

  • id : string ( Required )

  • name : string ( Required )

  • fields : array of HA_DtoField ( Required )

  • hierarchyRole : HierarchyRole ( Required )

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

  • implements : array of HA_Dto ( Required )

  • inheritors : array of HA_Dto ( Required )

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

  • record : boolean ( Required )

HA_DtoField type
object with fields :

  • field : HA_Field ( Required )

  • extension : boolean ( Required )

HA_Endpoint type
object with fields :

  • resource : HA_Resource ( Required )

  • method : HA_Method ( Required )

  • parameters : array of HA_Parameter ( Required )

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

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

  • path : HA_Path ( Required )

  • displayName : string ( Required )

  • functionName : string ( Required )

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

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

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

HA_Enum type
object with fields :

  • id : string ( Required )

  • name : string ( Required )

  • values : array of string ( Required )

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

HA_Field type
object with fields :

  • name : string ( Required )

  • type : HA_Type ( Required )

  • defaultValue : HA_DefaultValue ( Nullable and Optional , defaults to null )

  • optional : boolean ( Required )

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

HA_MenuId type
object with fields :

  • menuId : string ( Required )

  • context : HA_Dto ( Required )

HA_Model type
object with fields :

HA_Parameter type
object with fields :

  • field : HA_Field ( Required )

  • path : boolean ( Required )

HA_Path type
object with fields :

HA_PathSegment type

Name Type
className string

Possible values:

HA_PathSegment.Const type
object with fields :

  • value : string ( Required )

HA_PathSegment.PrefixedVar type
object with fields :

  • prefix : string ( Required )

  • name : string ( Required )

HA_PathSegment.Var type
object with fields :

  • name : string ( Required )

HA_Resource type
object with fields :

  • id : string ( Required )

  • path : HA_Path ( Required )

  • displaySingular : string ( Required )

  • displayPlural : string ( Required )

  • parentResource : HA_Resource ( Nullable and Optional , defaults to null )

  • endpoints : array of HA_Endpoint ( Required )

  • nestedResources : array of HA_Resource ( Required )

HA_Right type
object with fields :

  • title : string ( Required )

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

HA_Type type

Name Type
className string

Possible values:

HA_Type.Array type
object with fields :

  • elementType : HA_Type ( Required )

  • nullable : boolean ( Required )

HA_Type.Dto type
object with fields :

  • dto : HA_Dto ( Required )

  • nullable : boolean ( Required )

HA_Type.Enum type
object with fields :

  • enum : HA_Enum ( Required )

  • nullable : boolean ( Required )

HA_Type.Map type
object with fields :

  • valueType : HA_Type ( Required )

  • nullable : boolean ( Required )

HA_Type.Object type
object with fields :

HA_Type.Primitive type
object with fields :

  • primitive : HA_Primitive ( Required )

  • nullable : boolean ( Required )

HA_Type.Ref type
object with fields :

  • dto : HA_Dto ( Required )

  • nullable : boolean ( Required )

HA_Type.UrlParam type
object with fields :

HA_UrlParameter type
object with fields :

  • id : string ( Required )

  • name : string ( Required )

  • options : array of HA_UrlParameterOption ( Required )

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

HA_UrlParameterOption type

Name Type
className string

Possible values:

HA_UrlParameterOption.Const type
object with fields :

  • value : string ( Required )

  • optionName : string ( Required )

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

HA_UrlParameterOption.Var type
object with fields :

  • parameter : HA_Field ( Required )

  • prefixRequired : boolean ( Required )

  • optionName : string ( Required )

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

HolidaysEvent type
object with fields :

ImageAttachment type
object with fields :

  • id : string ( Required )

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

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

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

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

  • variants : array of ImageAttachmentVariant ( Nullable and Optional , defaults to null )

ImageAttachmentMeta type
object with fields :

ImageAttachmentVariant type
object with fields :

  • id : string ( Required )

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

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

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

ImageAttachmentVariantsMeta type
object with fields :

  • id : string ( Required )

  • name : string ( Required )

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

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

ImportMetadata type
object with fields :

  • importSource : string ( Required )

ImportSource type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

  • importer : CPrincipal ( Required )

  • name : string ( Required )

ImportTransactionRecord type
object with fields :

  • id : string ( Required )

  • archived : boolean ( Required )

  • importer : CPrincipal ( Required )

  • externalSource : string ( Required )

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

ImportedEntityInfo type
object with fields :

  • source : ImportSource ( Required )

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

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

InlineDiffLine type
object with fields :

  • text : string ( Required )

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

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

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

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

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

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

  • deletes : array of TextRange ( Nullable and Optional , defaults to null )

  • inserts : array of TextRange ( Nullable and Optional , defaults to null )

IntCFConstraint type
object with fields :

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

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

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

IntCFType type
No properties

IntCFValue type
object with fields :

  • value : integer (format: int32)