Please enable JavaScript to view this site.

Made in EU
Atlassian Confluence Forums

Atlassian Confluence Data Model

Navigation: Schema: Confluence > Tables

SpaceByKey: Atlassian Confluence Space by Key

Catalog: JIRA

Schema: Confluence

Primary Keys: id

Label: Space by Key

This is a read-only table function. The Atlassian Confluence API may not support changing the data or the Invantive SQL driver for Atlassian Confluence does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Atlassian Confluence API.

Select Atlassian Confluence API URL: /space/{spaceKey}?expand=settings,lookAndFeel,icon,description.plain,description.view,theme,homepage

Insert Atlassian Confluence API URL: /space/{spaceKey}?expand=settings,lookAndFeel,icon,description.plain,description.view,theme,homepage

Update Atlassian Confluence API URL: /space/{spaceKey}?expand=settings,lookAndFeel,icon,description.plain,description.view,theme,homepage

Delete Atlassian Confluence API URL: /space/{spaceKey}?expand=settings,lookAndFeel,icon,description.plain,description.view,theme,homepage

Field Selection Method: NotRequired

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function SpaceByKey. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

spaceKey

string

☐

 

The key of the space to be returned.

 

Table Function Columns

The columns of the table function SpaceByKey are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

homepage_body_anonymous_export_view_representation

string

 

☐

 

homepage_body_anonymous_export_view_value

string

 

☐

 

homepage_body_atlas_doc_format_representation

string

 

☐

 

homepage_body_atlas_doc_format_value

string

 

☐

 

homepage_body_editor_representation

string

 

☐

 

homepage_body_editor_value

string

 

☐

 

homepage_body_editor2_representation

string

 

☐

 

homepage_body_editor2_value

string

 

☐

 

homepage_body_export_view_representation

string

 

☐

 

homepage_body_export_view_value

string

 

☐

 

homepage_body_storage_representation

string

 

☐

 

homepage_body_storage_value

string

 

☐

 

homepage_body_styled_view_representation

string

 

☐

 

homepage_body_styled_view_value

string

 

☐

 

homepage_body_view_representation

string

 

☐

 

homepage_body_view_value

string

 

☐

 

homepage_history_contributors

string

 

☐

 

homepage_history_createdBy_accountId

string

 

☐

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user.

homepage_history_createdBy_accountType

string

 

☐

The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk

homepage_history_createdBy_active

boolean

 

☐

Indicates whether the user is active.

homepage_history_createdBy_displayName

string

 

☐

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

homepage_history_createdBy_emailAddress

string

 

☐

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_createdBy_key

string

 

☐

This property is no longer available and will be removed from the documentation soon

homepage_history_createdBy_locale

string

 

☐

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_createdBy_name

string

 

☐

This property is no longer available and will be removed from the documentation soon.

homepage_history_createdBy_timeZone

string

 

☐

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_createdDate

datetime

 

☐

 

homepage_history_lastUpdated_by_accountId

string

 

☐

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user.

homepage_history_lastUpdated_by_accountType

string

 

☐

The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk

homepage_history_lastUpdated_by_active

boolean

 

☐

Indicates whether the user is active.

homepage_history_lastUpdated_by_displayName

string

 

☐

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

homepage_history_lastUpdated_by_emailAddress

string

 

☐

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_lastUpdated_by_key

string

 

☐

This property is no longer available and will be removed from the documentation soon

homepage_history_lastUpdated_by_locale

string

 

☐

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_lastUpdated_by_name

string

 

☐

This property is no longer available and will be removed from the documentation soon.

homepage_history_lastUpdated_by_timeZone

string

 

☐

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_lastUpdated_collaborators

string

 

☐

 

homepage_history_lastUpdated_friendlyWhen

string

 

☐

 

homepage_history_lastUpdated_links

string

 

☐

 

homepage_history_lastUpdated_message

string

 

☐

 

homepage_history_lastUpdated_minorEdit

boolean

 

☐

 

homepage_history_lastUpdated_number

int32

 

☐

 

homepage_history_lastUpdated_when

string

 

☐

 

homepage_history_latest

boolean

 

☐

 

homepage_history_nextVersion_by_accountId

string

 

☐

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user.

homepage_history_nextVersion_by_accountType

string

 

☐

The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk

homepage_history_nextVersion_by_active

boolean

 

☐

Indicates whether the user is active.

homepage_history_nextVersion_by_displayName

string

 

☐

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

homepage_history_nextVersion_by_emailAddress

string

 

☐

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_nextVersion_by_key

string

 

☐

This property is no longer available and will be removed from the documentation soon

homepage_history_nextVersion_by_locale

string

 

☐

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_nextVersion_by_name

string

 

☐

This property is no longer available and will be removed from the documentation soon.

homepage_history_nextVersion_by_timeZone

string

 

☐

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_nextVersion_collaborators

string

 

☐

 

homepage_history_nextVersion_friendlyWhen

string

 

☐

 

homepage_history_nextVersion_links

string

 

☐

 

homepage_history_nextVersion_message

string

 

☐

 

homepage_history_nextVersion_minorEdit

boolean

 

☐

 

homepage_history_nextVersion_number

int32

 

☐

 

homepage_history_nextVersion_when

string

 

☐

 

homepage_history_previousVersion_by_accountId

string

 

☐

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user.

homepage_history_previousVersion_by_accountType

string

 

☐

The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk

homepage_history_previousVersion_by_active

boolean

 

☐

Indicates whether the user is active.

homepage_history_previousVersion_by_displayName

string

 

☐

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

homepage_history_previousVersion_by_emailAddress

string

 

☐

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_previousVersion_by_key

string

 

☐

This property is no longer available and will be removed from the documentation soon

homepage_history_previousVersion_by_locale

string

 

☐

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_previousVersion_by_name

string

 

☐

This property is no longer available and will be removed from the documentation soon.

homepage_history_previousVersion_by_timeZone

string

 

☐

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

homepage_history_previousVersion_collaborators

string

 

☐

 

homepage_history_previousVersion_friendlyWhen

string

 

☐

 

homepage_history_previousVersion_links

string

 

☐

 

homepage_history_previousVersion_message

string

 

☐

 

homepage_history_previousVersion_minorEdit

boolean

 

☐

 

homepage_history_previousVersion_number

int32

 

☐

 

homepage_history_previousVersion_when

string

 

☐

 

homepage_id

int64

 

☐

 

homepage_key

string

 

☐

 

homepage_status

string

 

☐

 

homepage_title

string

 

☐

 

homepage_type

string

 

☐

 

homepage_version_by_accountId

string

 

☐

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user.

homepage_version_by_accountType

string

 

☐

The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk

homepage_version_by_active

boolean

 

☐

Indicates whether the user is active.

homepage_version_by_displayName

string

 

☐

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

homepage_version_by_emailAddress

string

 

☐

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

homepage_version_by_key

string

 

☐

This property is no longer available and will be removed from the documentation soon

homepage_version_by_locale

string

 

☐

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

homepage_version_by_name

string

 

☐

This property is no longer available and will be removed from the documentation soon.

homepage_version_by_timeZone

string

 

☐

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

homepage_version_collaborators

string

 

☐

 

homepage_version_friendlyWhen

string

 

☐

 

homepage_version_links

string

 

☐

 

homepage_version_message

string

 

☐

 

homepage_version_minorEdit

boolean

 

☐

 

homepage_version_number

int32

 

☐

 

homepage_version_when

string

 

☐

 

icon_height

int32

 

☐

 

icon_isDefault

boolean

 

☐

 

icon_path

string

 

☐

 

icon_width

int32

 

☐

 

id

int64

 

☐

ID.

key

string

 

☐

Key.

lookAndFeel_bordersAndDividers

string

 

☐

 

lookAndFeel_content_body_background

string

 

☐

 

lookAndFeel_content_body_backgroundColor

string

 

☐

 

lookAndFeel_content_body_backgroundImage

string

 

☐

 

lookAndFeel_content_body_backgroundSize

string

 

☐

 

lookAndFeel_content_body_borderRadius

string

 

☐

 

lookAndFeel_content_body_padding

string

 

☐

 

lookAndFeel_content_container_background

string

 

☐

 

lookAndFeel_content_container_backgroundColor

string

 

☐

 

lookAndFeel_content_container_backgroundImage

string

 

☐

 

lookAndFeel_content_container_backgroundSize

string

 

☐

 

lookAndFeel_content_container_borderRadius

string

 

☐

 

lookAndFeel_content_container_padding

string

 

☐

 

lookAndFeel_content_header_background

string

 

☐

 

lookAndFeel_content_header_backgroundColor

string

 

☐

 

lookAndFeel_content_header_backgroundImage

string

 

☐

 

lookAndFeel_content_header_backgroundSize

string

 

☐

 

lookAndFeel_content_header_borderRadius

string

 

☐

 

lookAndFeel_content_header_padding

string

 

☐

 

lookAndFeel_content_screen_background

string

 

☐

 

lookAndFeel_content_screen_backgroundColor

string

 

☐

 

lookAndFeel_content_screen_backgroundImage

string

 

☐

 

lookAndFeel_content_screen_backgroundSize

string

 

☐

 

lookAndFeel_content_screen_gutterBottom

string

 

☐

 

lookAndFeel_content_screen_gutterLeft

string

 

☐

 

lookAndFeel_content_screen_gutterRight

string

 

☐

 

lookAndFeel_content_screen_gutterTop

string

 

☐

 

lookAndFeel_header_backgroundColor

string

 

☐

 

lookAndFeel_header_button_backgroundColor

string

 

☐

 

lookAndFeel_header_button_color

string

 

☐

 

lookAndFeel_header_primaryNavigation_color

string

 

☐

 

lookAndFeel_header_primaryNavigation_hoverOrFocus

string

 

☐

 

lookAndFeel_header_search_backgroundColor

string

 

☐

 

lookAndFeel_header_search_color

string

 

☐

 

lookAndFeel_header_secondaryNavigation_color

string

 

☐

 

lookAndFeel_header_secondaryNavigation_hoverOrFocus

string

 

☐

 

lookAndFeel_headings

string

 

☐

 

lookAndFeel_links

string

 

☐

 

lookAndFeel_menus_color

string

 

☐

 

lookAndFeel_menus_hoverOrFocus

string

 

☐

 

name

string

 

☐

Name.

settings_routeOverrideEnabled

boolean

 

☐

Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

status

string

 

☐

Status.

type

string

 

☐

Type.

 

15-06-2022 21:49 Version 22.0.232-PROD+3445

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer