Rate this page:
This enum is the names of API groupings within the total Atlassian API.
| Property Name | Default value | Description |
|---|---|---|
| Caas | CAAS | |
| Compass | COMPASS | |
| Confluence | CONFLUENCE | |
| ContentPlatformApi | CONTENT_PLATFORM_API | |
| DevopsAriGraph | DEVOPS_ARI_GRAPH | |
| DevopsContainerRelationship | DEVOPS_CONTAINER_RELATIONSHIP | |
| DevopsService | DEVOPS_SERVICE | |
| Forge | FORGE | |
| Help | HELP | |
| Identity | IDENTITY | |
| Jira | JIRA | |
| Polaris | POLARIS | |
| Teams | TEAMS | |
| XenLogsApi | XEN_LOGS_API |
################################################################################################################### CompassComponentType Identifies the type of component.
| Property Name | Default value | Description |
|---|---|---|
| Application | APPLICATION | A standalone software artifact that is directly consumable by an end-user. |
| Library | LIBRARY | A standalone software artifact that provides some functionality for other software via embedding. |
| Other | OTHER | A software artifact that does not fit into the pre-defined categories. |
| Service | SERVICE | A software artifact that provides some functionality for other software over the network. |
| Property Name | Default value | Description |
|---|---|---|
| Equals | EQUALS | |
| GreaterThan | GREATER_THAN | |
| GreaterThanOrEqualTo | GREATER_THAN_OR_EQUAL_TO | |
| LessThan | LESS_THAN | |
| LessThanOrEqualTo | LESS_THAN_OR_EQUAL_TO |
| Property Name | Default value | Description |
|---|---|---|
| Checkpoint | CHECKPOINT | |
| Info | INFO | |
| Warning | WARNING |
| Property Name | Default value | Description |
|---|---|---|
| Development | DEVELOPMENT | |
| Production | PRODUCTION | |
| Staging | STAGING | |
| Testing | TESTING | |
| Unmapped | UNMAPPED |
Compass Deployment Event
| Property Name | Default value | Description |
|---|---|---|
| Cancelled | CANCELLED | |
| Failed | FAILED | |
| InProgress | IN_PROGRESS | |
| Pending | PENDING | |
| RolledBack | ROLLED_BACK | |
| Successful | SUCCESSFUL | |
| Unknown | UNKNOWN |
| Property Name | Default value | Description |
|---|---|---|
| Alert | ALERT | |
| Build | BUILD | |
| Custom | CUSTOM | |
| Deployment | DEPLOYMENT | |
| Flag | FLAG | |
| Incident | INCIDENT | |
| Lifecycle | LIFECYCLE |
Specifies the type of value for a field.
| Property Name | Default value | Description |
|---|---|---|
| Date | DATE | |
| Enum | ENUM | |
| Number | NUMBER | |
| Text | TEXT |
| Property Name | Default value | Description |
|---|---|---|
| Closed | CLOSED | |
| Deleted | DELETED | |
| Open | OPEN | |
| Resolved | RESOLVED |
| Property Name | Default value | Description |
|---|---|---|
| Deprecation | DEPRECATION | |
| EndOfLife | END_OF_LIFE | |
| PreRelease | PRE_RELEASE | |
| Production | PRODUCTION |
The types used to identify the intent of the link.
| Property Name | Default value | Description |
|---|---|---|
| ChatChannel | CHAT_CHANNEL | Chat Channels for contacting the owners/support of the component |
| Dashboard | DASHBOARD | A link to the dashboard of the component. |
| Document | DOCUMENT | A link to the documentation of the component. |
| OnCall | ON_CALL | A link to the on-call schedule of the component. |
| OtherLink | OTHER_LINK | Other link for a Component. |
| Project | PROJECT | A link to the Jira or third-party project of the component. |
| Repository | REPOSITORY | A link to the source code repository of the component. |
Used to identify the type for the metric
| Property Name | Default value | Description |
|---|---|---|
| BuiltIn | BUILT_IN | Predefined metrics built in to Compass |
| Custom | CUSTOM | Metrics defined by the individual user |
| Property Name | Default value | Description |
|---|---|---|
| Asc | ASC | |
| Desc | DESC |
Defines the possible relationship directions between components.
| Property Name | Default value | Description |
|---|---|---|
| Inward | INWARD | Going from the other component to this component. |
| Outward | OUTWARD | Going from this component to the other component. |
Defines the relationship types. A relationship must be one of these types.
| Property Name | Default value | Description |
|---|---|---|
| DependsOn | DEPENDS_ON |
The types used to identify the importance of the scorecard.
| Property Name | Default value | Description |
|---|---|---|
| Recommended | RECOMMENDED | Recommended to the component's owner when they select a scorecard to apply to their component. |
| Required | REQUIRED | Automatically applied to all components of the specified type or types and cannot be removed. |
| UserDefined | USER_DEFINED | Custom scorecard, focused on specific use cases within teams or departments. |
Status types of a data manager sync event.
| Property Name | Default value | Description |
|---|---|---|
| ServerError | SERVER_ERROR | A Compass internal server issue prevented the sync from occurring. |
| Success | SUCCESS | The component updates were successfully synced to Compass. |
| UserError | USER_ERROR | An issue with the calling app or user input prevented the component from syncing to Compass. |
| Property Name | Default value | Description |
|---|---|---|
| Avocado | AVOCADO | |
| Compass | COMPASS | |
| Confluence | CONFLUENCE | |
| Jira | JIRA | |
| JiraServicedesk | JIRA_SERVICEDESK | |
| NoGrantChecks | NO_GRANT_CHECKS | Don't check whether a user has been granted access to a specific site(cloudId) |
| Property Name | Default value | Description |
|---|---|---|
| CompassInsertMetricValueCurrency | COMPASS_INSERT_METRIC_VALUE_CURRENCY | |
| DevopsContainerRelationshipsReadCurrency | DEVOPS_CONTAINER_RELATIONSHIPS_READ_CURRENCY | |
| DevopsContainerRelationshipsWriteCurrency | DEVOPS_CONTAINER_RELATIONSHIPS_WRITE_CURRENCY | |
| DevopsServiceReadCurrency | DEVOPS_SERVICE_READ_CURRENCY | |
| DevopsServiceWriteCurrency | DEVOPS_SERVICE_WRITE_CURRENCY | |
| ForgeMetricsCurrency | FORGE_METRICS_CURRENCY | |
| TeamMembersCurrency | TEAM_MEMBERS_CURRENCY | |
| TeamsCurrency | TEAMS_CURRENCY | |
| TestingService | TESTING_SERVICE |
| Property Name | Default value | Description |
|---|---|---|
| AdminContainer | ADMIN_CONTAINER | outbound-auth |
| AuthConfluenceUser | AUTH_CONFLUENCE_USER | |
| ConfluenceAtlassianExternal | CONFLUENCE_ATLASSIAN_EXTERNAL | confluence |
| DeleteConfluenceAttachment | DELETE_CONFLUENCE_ATTACHMENT | |
| DeleteConfluenceBlogpost | DELETE_CONFLUENCE_BLOGPOST | |
| DeleteConfluenceComment | DELETE_CONFLUENCE_COMMENT | |
| DeleteConfluenceCustomContent | DELETE_CONFLUENCE_CUSTOM_CONTENT | |
| DeleteConfluencePage | DELETE_CONFLUENCE_PAGE | |
| DeleteConfluenceSpace | DELETE_CONFLUENCE_SPACE | |
| IdentityAtlassianExternal | IDENTITY_ATLASSIAN_EXTERNAL | |
| JiraAtlassianExternal | JIRA_ATLASSIAN_EXTERNAL | |
| ManageApp | MANAGE_APP | ecosystem |
| ManageDirectory | MANAGE_DIRECTORY | |
| ManageJiraConfiguration | MANAGE_JIRA_CONFIGURATION | |
| ManageJiraDataProvider | MANAGE_JIRA_DATA_PROVIDER | |
| ManageJiraProject | MANAGE_JIRA_PROJECT | |
| ManageOrg | MANAGE_ORG | identity |
| ManageServicedeskCustomer | MANAGE_SERVICEDESK_CUSTOMER | |
| MigrateConfluence | MIGRATE_CONFLUENCE | platform |
| ReadAccount | READ_ACCOUNT | |
| ReadAvocadoEntity | READ_AVOCADO_ENTITY | avocado |
| ReadCompassComponent | READ_COMPASS_COMPONENT | compass |
| ReadCompassEvent | READ_COMPASS_EVENT | |
| ReadCompassMetric | READ_COMPASS_METRIC | |
| ReadCompassScorecard | READ_COMPASS_SCORECARD | |
| ReadConfluenceAttachment | READ_CONFLUENCE_ATTACHMENT | |
| ReadConfluenceAuditLog | READ_CONFLUENCE_AUDIT_LOG | |
| ReadConfluenceBlogpost | READ_CONFLUENCE_BLOGPOST | |
| ReadConfluenceComment | READ_CONFLUENCE_COMMENT | |
| ReadConfluenceConfiguration | READ_CONFLUENCE_CONFIGURATION | |
| ReadConfluenceContentAnalytics | READ_CONFLUENCE_CONTENT_ANALYTICS | |
| ReadConfluenceContentMetadata | READ_CONFLUENCE_CONTENT_METADATA | |
| ReadConfluenceContentPermission | READ_CONFLUENCE_CONTENT_PERMISSION | |
| ReadConfluenceContentProperty | READ_CONFLUENCE_CONTENT_PROPERTY | |
| ReadConfluenceContentRestriction | READ_CONFLUENCE_CONTENT_RESTRICTION | |
| ReadConfluenceCustomContent | READ_CONFLUENCE_CUSTOM_CONTENT | |
| ReadConfluenceGroup | READ_CONFLUENCE_GROUP | |
| ReadConfluenceInlineTask | READ_CONFLUENCE_INLINE_TASK | |
| ReadConfluenceLabel | READ_CONFLUENCE_LABEL | |
| ReadConfluencePage | READ_CONFLUENCE_PAGE | |
| ReadConfluenceRelation | READ_CONFLUENCE_RELATION | |
| ReadConfluenceSpace | READ_CONFLUENCE_SPACE | |
| ReadConfluenceSpacePermission | READ_CONFLUENCE_SPACE_PERMISSION | |
| ReadConfluenceSpaceProperty | READ_CONFLUENCE_SPACE_PROPERTY | |
| ReadConfluenceSpaceSetting | READ_CONFLUENCE_SPACE_SETTING | |
| ReadConfluenceTemplate | READ_CONFLUENCE_TEMPLATE | |
| ReadConfluenceUser | READ_CONFLUENCE_USER | |
| ReadConfluenceUserProperty | READ_CONFLUENCE_USER_PROPERTY | |
| ReadConfluenceWatcher | READ_CONFLUENCE_WATCHER | |
| ReadContainer | READ_CONTAINER | |
| ReadJiraUser | READ_JIRA_USER | jira |
| ReadJiraWork | READ_JIRA_WORK | |
| ReadMe | READ_ME | |
| ReadNotifications | READ_NOTIFICATIONS | notification-log |
| ReadServicedeskRequest | READ_SERVICEDESK_REQUEST | jira-servicedesk |
| StorageApp | STORAGE_APP | |
| ViewUserprofile | VIEW_USERPROFILE | |
| WriteCompassComponent | WRITE_COMPASS_COMPONENT | |
| WriteCompassEvent | WRITE_COMPASS_EVENT | |
| WriteCompassMetric | WRITE_COMPASS_METRIC | |
| WriteCompassScorecard | WRITE_COMPASS_SCORECARD | |
| WriteConfluenceAttachment | WRITE_CONFLUENCE_ATTACHMENT | |
| WriteConfluenceAuditLog | WRITE_CONFLUENCE_AUDIT_LOG | |
| WriteConfluenceBlogpost | WRITE_CONFLUENCE_BLOGPOST | |
| WriteConfluenceComment | WRITE_CONFLUENCE_COMMENT | |
| WriteConfluenceConfiguration | WRITE_CONFLUENCE_CONFIGURATION | |
| WriteConfluenceContentProperty | WRITE_CONFLUENCE_CONTENT_PROPERTY | |
| WriteConfluenceContentRestriction | WRITE_CONFLUENCE_CONTENT_RESTRICTION | |
| WriteConfluenceCustomContent | WRITE_CONFLUENCE_CUSTOM_CONTENT | |
| WriteConfluenceGroup | WRITE_CONFLUENCE_GROUP | |
| WriteConfluenceInlineTask | WRITE_CONFLUENCE_INLINE_TASK | |
| WriteConfluenceLabel | WRITE_CONFLUENCE_LABEL | |
| WriteConfluencePage | WRITE_CONFLUENCE_PAGE | |
| WriteConfluenceRelation | WRITE_CONFLUENCE_RELATION | |
| WriteConfluenceSpace | WRITE_CONFLUENCE_SPACE | |
| WriteConfluenceSpacePermission | WRITE_CONFLUENCE_SPACE_PERMISSION | |
| WriteConfluenceSpaceProperty | WRITE_CONFLUENCE_SPACE_PROPERTY | |
| WriteConfluenceSpaceSetting | WRITE_CONFLUENCE_SPACE_SETTING | |
| WriteConfluenceTemplate | WRITE_CONFLUENCE_TEMPLATE | |
| WriteConfluenceUserProperty | WRITE_CONFLUENCE_USER_PROPERTY | |
| WriteConfluenceWatcher | WRITE_CONFLUENCE_WATCHER | |
| WriteContainer | WRITE_CONTAINER | |
| WriteJiraWork | WRITE_JIRA_WORK | |
| WriteNotifications | WRITE_NOTIFICATIONS | |
| WriteServicedeskRequest | WRITE_SERVICEDESK_REQUEST |
| Property Name | Default value | Description |
|---|---|---|
| ALERTS | alerts | |
| BUILDS | builds | |
| CUSTOM | custom | |
| DEPLOYMENTS | deployments | |
| FLAGS | flags | |
| INCIDENTS | incidents | |
| LIFECYCLES | lifecycles |
| Property Name | Default value | Description |
|---|---|---|
| AVAILABILITY_28D | ari:cloud:compass::metric-definition/builtin/availability-28d | |
| BUILD_SUCCESS_RATE | ari:cloud:compass::metric-definition/builtin/build-success-rate | |
| BUILD_TIME_AVG_LAST_10 | ari:cloud:compass::metric-definition/builtin/build-time-avg-last-10 | |
| CHANGE_FAILURE_RATE_28D | ari:cloud:compass::metric-definition/builtin/change-failure-rate-28d | |
| CYCLOMATIC_COMPLEXITY_AVG_LAST_10 | ari:cloud:compass::metric-definition/builtin/cyclomatic-complexity-avg-last-10 | |
| DEPLOYMENT_TIME_AVG_LAST_25 | ari:cloud:compass::metric-definition/builtin/deployment-time-avg-last-25 | |
| MTTR_28D | ari:cloud:compass::metric-definition/builtin/mttr-28d | |
| OPEN_PULL_REQUESTS | ari:cloud:compass::metric-definition/builtin/open-pull-requests | |
| OPEN_VULNERABILITIES | ari:cloud:compass::metric-definition/builtin/open-vulnerabilities | |
| PULL_REQUEST_CYCLE_TIME_AVG_LAST_10 | ari:cloud:compass::metric-definition/builtin/pull-request-cycle-time-avg-last-10 | |
| RELIABILITY_28D | ari:cloud:compass::metric-definition/builtin/reliability-28d | |
| UNIT_TEST_COVERAGE_AVG_LAST_10 | ari:cloud:compass::metric-definition/builtin/unit-test-coverage-avg-last-10 | |
| WEEKLY_DEPLOYMENT_FREQUENCY_28D | ari:cloud:compass::metric-definition/builtin/weekly-deployment-frequency-28d |
Rate this page: