Classes

Rate this page:

Enumerations

ApiGroup

This enum is the names of API groupings within the total Atlassian API.

Property NameDefault valueDescription
CaasCAAS
CompassCOMPASS
ConfluenceCONFLUENCE
ContentPlatformApiCONTENT_PLATFORM_API
DevopsAriGraphDEVOPS_ARI_GRAPH
DevopsContainerRelationshipDEVOPS_CONTAINER_RELATIONSHIP
DevopsServiceDEVOPS_SERVICE
ForgeFORGE
HelpHELP
IdentityIDENTITY
JiraJIRA
PolarisPOLARIS
TeamsTEAMS
XenLogsApiXEN_LOGS_API

CompassBuildEventState

################################################################################################################### CompassComponentType Identifies the type of component.

Property NameDefault valueDescription
ApplicationAPPLICATIONA standalone software artifact that is directly consumable by an end-user.
LibraryLIBRARYA standalone software artifact that provides some functionality for other software via embedding.
OtherOTHERA software artifact that does not fit into the pre-defined categories.
ServiceSERVICEA software artifact that provides some functionality for other software over the network.

CompassCriteriaNumberComparatorOptions

Property NameDefault valueDescription
EqualsEQUALS
GreaterThanGREATER_THAN
GreaterThanOrEqualToGREATER_THAN_OR_EQUAL_TO
LessThanLESS_THAN
LessThanOrEqualToLESS_THAN_OR_EQUAL_TO

CompassCustomEventIcon

Property NameDefault valueDescription
CheckpointCHECKPOINT
InfoINFO
WarningWARNING

CompassDeploymentEventEnvironmentCategory

Property NameDefault valueDescription
DevelopmentDEVELOPMENT
ProductionPRODUCTION
StagingSTAGING
TestingTESTING
UnmappedUNMAPPED

CompassDeploymentEventState

Compass Deployment Event

Property NameDefault valueDescription
CancelledCANCELLED
FailedFAILED
InProgressIN_PROGRESS
PendingPENDING
RolledBackROLLED_BACK
SuccessfulSUCCESSFUL
UnknownUNKNOWN

CompassEventType

Property NameDefault valueDescription
AlertALERT
BuildBUILD
CustomCUSTOM
DeploymentDEPLOYMENT
FlagFLAG
IncidentINCIDENT
LifecycleLIFECYCLE

CompassFieldType

Specifies the type of value for a field.

Property NameDefault valueDescription
DateDATE
EnumENUM
NumberNUMBER
TextTEXT

CompassIncidentEventState

Property NameDefault valueDescription
ClosedCLOSED
DeletedDELETED
OpenOPEN
ResolvedRESOLVED

CompassLifecycleEventStage

Property NameDefault valueDescription
DeprecationDEPRECATION
EndOfLifeEND_OF_LIFE
PreReleasePRE_RELEASE
ProductionPRODUCTION

CompassLinkType

The types used to identify the intent of the link.

Property NameDefault valueDescription
ChatChannelCHAT_CHANNELChat Channels for contacting the owners/support of the component
DashboardDASHBOARDA link to the dashboard of the component.
DocumentDOCUMENTA link to the documentation of the component.
OnCallON_CALLA link to the on-call schedule of the component.
OtherLinkOTHER_LINKOther link for a Component.
ProjectPROJECTA link to the Jira or third-party project of the component.
RepositoryREPOSITORYA link to the source code repository of the component.

CompassMetricDefinitionType

Used to identify the type for the metric

Property NameDefault valueDescription
BuiltInBUILT_INPredefined metrics built in to Compass
CustomCUSTOMMetrics defined by the individual user

CompassQuerySortOrder

Property NameDefault valueDescription
AscASC
DescDESC

CompassRelationshipDirection

Defines the possible relationship directions between components.

Property NameDefault valueDescription
InwardINWARDGoing from the other component to this component.
OutwardOUTWARDGoing from this component to the other component.

CompassRelationshipType

Defines the relationship types. A relationship must be one of these types.

Property NameDefault valueDescription
DependsOnDEPENDS_ON

CompassScorecardImportance

The types used to identify the importance of the scorecard.

Property NameDefault valueDescription
RecommendedRECOMMENDEDRecommended to the component's owner when they select a scorecard to apply to their component.
RequiredREQUIREDAutomatically applied to all components of the specified type or types and cannot be removed.
UserDefinedUSER_DEFINEDCustom scorecard, focused on specific use cases within teams or departments.

ComponentSyncEventStatus

Status types of a data manager sync event.

Property NameDefault valueDescription
ServerErrorSERVER_ERRORA Compass internal server issue prevented the sync from occurring.
SuccessSUCCESSThe component updates were successfully synced to Compass.
UserErrorUSER_ERRORAn issue with the calling app or user input prevented the component from syncing to Compass.

GrantCheckProduct

Property NameDefault valueDescription
AvocadoAVOCADO
CompassCOMPASS
ConfluenceCONFLUENCE
JiraJIRA
JiraServicedeskJIRA_SERVICEDESK
NoGrantChecksNO_GRANT_CHECKSDon't check whether a user has been granted access to a specific site(cloudId)

RateLimitingCurrency

Property NameDefault valueDescription
CompassInsertMetricValueCurrencyCOMPASS_INSERT_METRIC_VALUE_CURRENCY
DevopsContainerRelationshipsReadCurrencyDEVOPS_CONTAINER_RELATIONSHIPS_READ_CURRENCY
DevopsContainerRelationshipsWriteCurrencyDEVOPS_CONTAINER_RELATIONSHIPS_WRITE_CURRENCY
DevopsServiceReadCurrencyDEVOPS_SERVICE_READ_CURRENCY
DevopsServiceWriteCurrencyDEVOPS_SERVICE_WRITE_CURRENCY
ForgeMetricsCurrencyFORGE_METRICS_CURRENCY
TeamMembersCurrencyTEAM_MEMBERS_CURRENCY
TeamsCurrencyTEAMS_CURRENCY
TestingServiceTESTING_SERVICE

Scope

Property NameDefault valueDescription
AdminContainerADMIN_CONTAINERoutbound-auth
AuthConfluenceUserAUTH_CONFLUENCE_USER
ConfluenceAtlassianExternalCONFLUENCE_ATLASSIAN_EXTERNALconfluence
DeleteConfluenceAttachmentDELETE_CONFLUENCE_ATTACHMENT
DeleteConfluenceBlogpostDELETE_CONFLUENCE_BLOGPOST
DeleteConfluenceCommentDELETE_CONFLUENCE_COMMENT
DeleteConfluenceCustomContentDELETE_CONFLUENCE_CUSTOM_CONTENT
DeleteConfluencePageDELETE_CONFLUENCE_PAGE
DeleteConfluenceSpaceDELETE_CONFLUENCE_SPACE
IdentityAtlassianExternalIDENTITY_ATLASSIAN_EXTERNAL
JiraAtlassianExternalJIRA_ATLASSIAN_EXTERNAL
ManageAppMANAGE_APPecosystem
ManageDirectoryMANAGE_DIRECTORY
ManageJiraConfigurationMANAGE_JIRA_CONFIGURATION
ManageJiraDataProviderMANAGE_JIRA_DATA_PROVIDER
ManageJiraProjectMANAGE_JIRA_PROJECT
ManageOrgMANAGE_ORGidentity
ManageServicedeskCustomerMANAGE_SERVICEDESK_CUSTOMER
MigrateConfluenceMIGRATE_CONFLUENCEplatform
ReadAccountREAD_ACCOUNT
ReadAvocadoEntityREAD_AVOCADO_ENTITYavocado
ReadCompassComponentREAD_COMPASS_COMPONENTcompass
ReadCompassEventREAD_COMPASS_EVENT
ReadCompassMetricREAD_COMPASS_METRIC
ReadCompassScorecardREAD_COMPASS_SCORECARD
ReadConfluenceAttachmentREAD_CONFLUENCE_ATTACHMENT
ReadConfluenceAuditLogREAD_CONFLUENCE_AUDIT_LOG
ReadConfluenceBlogpostREAD_CONFLUENCE_BLOGPOST
ReadConfluenceCommentREAD_CONFLUENCE_COMMENT
ReadConfluenceConfigurationREAD_CONFLUENCE_CONFIGURATION
ReadConfluenceContentAnalyticsREAD_CONFLUENCE_CONTENT_ANALYTICS
ReadConfluenceContentMetadataREAD_CONFLUENCE_CONTENT_METADATA
ReadConfluenceContentPermissionREAD_CONFLUENCE_CONTENT_PERMISSION
ReadConfluenceContentPropertyREAD_CONFLUENCE_CONTENT_PROPERTY
ReadConfluenceContentRestrictionREAD_CONFLUENCE_CONTENT_RESTRICTION
ReadConfluenceCustomContentREAD_CONFLUENCE_CUSTOM_CONTENT
ReadConfluenceGroupREAD_CONFLUENCE_GROUP
ReadConfluenceInlineTaskREAD_CONFLUENCE_INLINE_TASK
ReadConfluenceLabelREAD_CONFLUENCE_LABEL
ReadConfluencePageREAD_CONFLUENCE_PAGE
ReadConfluenceRelationREAD_CONFLUENCE_RELATION
ReadConfluenceSpaceREAD_CONFLUENCE_SPACE
ReadConfluenceSpacePermissionREAD_CONFLUENCE_SPACE_PERMISSION
ReadConfluenceSpacePropertyREAD_CONFLUENCE_SPACE_PROPERTY
ReadConfluenceSpaceSettingREAD_CONFLUENCE_SPACE_SETTING
ReadConfluenceTemplateREAD_CONFLUENCE_TEMPLATE
ReadConfluenceUserREAD_CONFLUENCE_USER
ReadConfluenceUserPropertyREAD_CONFLUENCE_USER_PROPERTY
ReadConfluenceWatcherREAD_CONFLUENCE_WATCHER
ReadContainerREAD_CONTAINER
ReadJiraUserREAD_JIRA_USERjira
ReadJiraWorkREAD_JIRA_WORK
ReadMeREAD_ME
ReadNotificationsREAD_NOTIFICATIONSnotification-log
ReadServicedeskRequestREAD_SERVICEDESK_REQUESTjira-servicedesk
StorageAppSTORAGE_APP
ViewUserprofileVIEW_USERPROFILE
WriteCompassComponentWRITE_COMPASS_COMPONENT
WriteCompassEventWRITE_COMPASS_EVENT
WriteCompassMetricWRITE_COMPASS_METRIC
WriteCompassScorecardWRITE_COMPASS_SCORECARD
WriteConfluenceAttachmentWRITE_CONFLUENCE_ATTACHMENT
WriteConfluenceAuditLogWRITE_CONFLUENCE_AUDIT_LOG
WriteConfluenceBlogpostWRITE_CONFLUENCE_BLOGPOST
WriteConfluenceCommentWRITE_CONFLUENCE_COMMENT
WriteConfluenceConfigurationWRITE_CONFLUENCE_CONFIGURATION
WriteConfluenceContentPropertyWRITE_CONFLUENCE_CONTENT_PROPERTY
WriteConfluenceContentRestrictionWRITE_CONFLUENCE_CONTENT_RESTRICTION
WriteConfluenceCustomContentWRITE_CONFLUENCE_CUSTOM_CONTENT
WriteConfluenceGroupWRITE_CONFLUENCE_GROUP
WriteConfluenceInlineTaskWRITE_CONFLUENCE_INLINE_TASK
WriteConfluenceLabelWRITE_CONFLUENCE_LABEL
WriteConfluencePageWRITE_CONFLUENCE_PAGE
WriteConfluenceRelationWRITE_CONFLUENCE_RELATION
WriteConfluenceSpaceWRITE_CONFLUENCE_SPACE
WriteConfluenceSpacePermissionWRITE_CONFLUENCE_SPACE_PERMISSION
WriteConfluenceSpacePropertyWRITE_CONFLUENCE_SPACE_PROPERTY
WriteConfluenceSpaceSettingWRITE_CONFLUENCE_SPACE_SETTING
WriteConfluenceTemplateWRITE_CONFLUENCE_TEMPLATE
WriteConfluenceUserPropertyWRITE_CONFLUENCE_USER_PROPERTY
WriteConfluenceWatcherWRITE_CONFLUENCE_WATCHER
WriteContainerWRITE_CONTAINER
WriteJiraWorkWRITE_JIRA_WORK
WriteNotificationsWRITE_NOTIFICATIONS
WriteServicedeskRequestWRITE_SERVICEDESK_REQUEST

DataProviderEventTypes

Property NameDefault valueDescription
ALERTSalerts
BUILDSbuilds
CUSTOMcustom
DEPLOYMENTSdeployments
FLAGSflags
INCIDENTSincidents
LIFECYCLESlifecycles

BuiltinMetricDefinitions

Property NameDefault valueDescription
AVAILABILITY_28Dari:cloud:compass::metric-definition/builtin/availability-28d
BUILD_SUCCESS_RATEari:cloud:compass::metric-definition/builtin/build-success-rate
BUILD_TIME_AVG_LAST_10ari:cloud:compass::metric-definition/builtin/build-time-avg-last-10
CHANGE_FAILURE_RATE_28Dari:cloud:compass::metric-definition/builtin/change-failure-rate-28d
CYCLOMATIC_COMPLEXITY_AVG_LAST_10ari:cloud:compass::metric-definition/builtin/cyclomatic-complexity-avg-last-10
DEPLOYMENT_TIME_AVG_LAST_25ari:cloud:compass::metric-definition/builtin/deployment-time-avg-last-25
MTTR_28Dari:cloud:compass::metric-definition/builtin/mttr-28d
OPEN_PULL_REQUESTSari:cloud:compass::metric-definition/builtin/open-pull-requests
OPEN_VULNERABILITIESari:cloud:compass::metric-definition/builtin/open-vulnerabilities
PULL_REQUEST_CYCLE_TIME_AVG_LAST_10ari:cloud:compass::metric-definition/builtin/pull-request-cycle-time-avg-last-10
RELIABILITY_28Dari:cloud:compass::metric-definition/builtin/reliability-28d
UNIT_TEST_COVERAGE_AVG_LAST_10ari:cloud:compass::metric-definition/builtin/unit-test-coverage-avg-last-10
WEEKLY_DEPLOYMENT_FREQUENCY_28Dari:cloud:compass::metric-definition/builtin/weekly-deployment-frequency-28d

Rate this page: