Confluence Connector Objects

NameDescription
AttachmentsGet information about a specific attachment.
AuditRecordsFetch a paginated list of AuditRecord instances dating back to a certain time.
BlogpostsGet information about a specific blogpost.
CommentsGet information about a specific comment.
ContributorsGet information about the users who have contributed to the content.
GroupMembersGet users of a specific group.
GroupsGet information about a specific group.
GroupsContentRestrictionsRetrieve information related to the groups restrictions applied to a certain content. The maximum number of restrictions per operation is limited to 200. ContentId is required.
LabelsGet information about the labels that a specific content has.
PageAncestorsTo look at a page hierarchy including who is the parent page.
PageChildrensTo look at a page hierarchy including who is the child page.
PageCommentsGet comments specific to a page.
PageContentsGet content from the page.
PagesGenerated schema file.
SpacePermissionsReturns space permissions for the specified space(s).
SpacesReturns information about a number of spaces.
TasksGet information regarding tasks.
UsersGet information about a user identified.
UsersContentRestrictionsRetrieve information related to the users restrictions applied to a certain content. The maximum number of restrictions per operation is limited to 200. ContentId is required.
ViewersAnalyticsGet the total number of distinct viewers a piece of content has.
ViewsAnalyticsGet the total number of views a piece of content has.
NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId of the attachment.
TypeStringTrueNoType of the content.
TitleStringTrueNoTitle of the attachment.
StatusStringTrueNoStatus of the attachment.
SpaceKeyStringTrueSpaces.KeyNoThe key of the space that the attachment belongs to.
SpaceTypeStringTrueSpaces.TypeNoThe type of the space that the attachment belongs to.
PositionStringTrueNoPosition of the attachment.
URLStringTrueNoURL of the attachment.
ExcerptStringTrueNoExcerpt of the attachment.
IsLatestBooleanTrueNoIndicator if this is the latest version of the attachment.
CreatedByUserNameStringTrueNoUsername of the user who created the attachment.
CreatedByUserTypeStringTrueNoType of the user who created the attachment.
CreatedDateDatetimeTrueNoDatetime for the creation of the attachment.
LastUpdatedDatetimeDatetimeTrueNoDatetime of the last updated version of the attachment.
LastUpdatedMessageStringTrueNoMessage of the last updated version.
LastUpdatedNumberIntegerTrueNoNumber of the last updated version.
LastUpdatedUserNameStringTrueNoUsername of the user who updated the latest version.
LastUpdatedUserTypeStringTrueNoType of the user who updated the latest version.
LastUpdatedIsMinorEditBooleanTrueNoIndicator if this version is a minor edit.
LastUpdatedIsHiddenBooleanTrueNoIndicator if the last updated version is hidden or not.
PreviousVersionUserNameStringTrueNoUsername of the user who updated the previous version.
PreviousVersionUserTypeStringTrueNoType of the user who updated the previous version.
PreviousVersionDatetimeDatetimeTrueNoDatetime when the previous version was edited.
PreviousVersionMessageStringTrueNoMessage for the previously edited version.
PreviousVersionNumberStringTrueNoNumber of the previously edited version.
PreviousVersionIsMinorEditBooleanTrueNoIndicator if the previous version was a minor edit.
PreviousVersionIsHiddenBooleanTrueNoIndicator if the previous version was hidden or not.
LinksEdituiStringTrueNoThe LinksEditui of the page content.
LinksSelfStringTrueNoThe LinksSelf of the content.
LinksTinyuiStringTrueNoThe LinksTinyui of the content.
LinksWebuiStringTrueNoThe LinksWebui of the content.
ItemURLStringTrueNoThe URL reference of the element in UI.
ContainerIdStringTrueNoThe Id of the container of the content.
MediaTypeStringTrueNoMedia Type of the attachment.
CQLStringFalseYesCQL (Confluence Query Language) allows you to build structured queries.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AffectedObjectNameStringTrueNoName of the object that was affected by changes.
AffectedObjectTypeStringTrueNoType of the object that was affected by changes.
AuthorDisplayNameStringTrueNoDisplay name of the person who made the changes.
AuthorTypeStringTrueNoType of the author who made the changes.
UserKeyStringTrueNoUnique identifier of the author.
UserNameStringTrueNoUser name of the author.
CategoryStringTrueNoCategory of the object.
CreationDateDatetimeTrueNoDate when the object was created.
DescriptionStringTrueNoDescription of the object.
RemoteAddressStringTrueNoRemote address of the object.
SummaryStringTrueNoSummary of the object.
IsSysAdminBooleanTrueNoIdentifier whether object is system administered or not.
SearchStringStringTrueNoText that is inserted by the user to search for a specific object.
StartDateDatetimeTrueNoStart date of the audit.
EndDateDatetimeTrueNoEnd date of the audit.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId of the blogpost.
TypeStringTrueNoType of the content.
TitleStringTrueNoTitle of the blogpost.
StatusStringTrueNoStatus of the blogpost.
SpaceKeyStringTrueSpaces.KeyNoThe key of the space that the blogpost belongs to.
SpaceTypeStringTrueSpaces.TypeNoThe type of the space that the blogpost belongs to.
PositionStringTrueNoPosition of the blogpost.
URLStringTrueNoURL of the blogpost.
ExcerptStringTrueNoExcerpt of the blogpost.
IsLatestBooleanTrueNoIndicator if this is the latest version of the blogpost.
CreatedByUserNameStringTrueNoUsername of the user who created the blogpost.
CreatedByUserTypeStringTrueNoType of the user who created the blogpost.
CreatedDateDatetimeTrueNoDatetime for the creation of the blogpost.
LastUpdatedDatetimeDatetimeTrueNoDatetime of the last updated version of the blogpost.
LastUpdatedMessageStringTrueNoMessage of the last updated version.
LastUpdatedNumberIntegerTrueNoNumber of the last updated version.
LastUpdatedUserNameStringTrueNoUsername of the user who updated the latest version.
LastUpdatedUserTypeStringTrueNoType of the user who updated the latest version.
LastUpdatedIsMinorEditBooleanTrueNoIndicator if this version is a minor edit.
LastUpdatedIsHiddenBooleanTrueNoIndicator if the last updated version is hidden or not.
PreviousVersionUserNameStringTrueNoUsername of the user who updated the previous version.
PreviousVersionUserTypeStringTrueNoType of the user who updated the previous version.
PreviousVersionDatetimeDatetimeTrueNoDatetime when the previous version was edited.
PreviousVersionMessageStringTrueNoMessage for the previously edited version.
PreviousVersionNumberStringTrueNoNumber of the previously edited version.
PreviousVersionIsMinorEditBooleanTrueNoIndicator if the previous version was a minor edit.
PreviousVersionIsHiddenBooleanTrueNoIndicator if the previous version was hidden or not.
LinksEdituiStringTrueNoThe LinksEditui of the page content.
LinksSelfStringTrueNoThe LinksSelf of the content.
LinksTinyuiStringTrueNoThe LinksTinyui of the content.
LinksWebuiStringTrueNoThe LinksWebui of the content.
ItemURLStringTrueNoThe URL reference of the element in UI.
ContainerIdStringTrueNoThe Id of the container of the content.
CQLStringFalseYesCQL (Confluence Query Language) allows you to build structured queries.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId of the comment.
TypeStringTrueNoType of the content.
TitleStringTrueNoTitle of the comment.
StatusStringTrueNoStatus of the comment.
SpaceKeyStringTrueSpaces.KeyNoThe key of the space that the comment belongs to.
SpaceTypeStringTrueSpaces.TypeNoThe type of the space that the comment belongs to.
PositionStringTrueNoPosition of the comment.
URLStringTrueNoURL of the comment.
ExcerptStringTrueNoExcerpt of the comment.
IsLatestBooleanTrueNoIndicator if this is the latest version of the comment.
CreatedByUserNameStringTrueNoUsername of the user who created the comment.
CreatedByUserTypeStringTrueNoType of the user who created the comment.
CreatedDateDatetimeTrueNoDatetime for the creation of the comment.
LastUpdatedDatetimeDatetimeTrueNoDatetime of the last updated version of the comment.
LastUpdatedMessageStringTrueNoMessage of the last updated version.
LastUpdatedNumberIntegerTrueNoNumber of the last updated version.
LastUpdatedUserNameStringTrueNoUsername of the user who updated the latest version.
LastUpdatedUserTypeStringTrueNoType of the user who updated the latest version.
LastUpdatedIsMinorEditBooleanTrueNoIndicator if this version is a minor edit.
LastUpdatedIsHiddenBooleanTrueNoIndicator if the last updated version is hidden or not.
PreviousVersionUserNameStringTrueNoUsername of the user who updated the previous version.
PreviousVersionUserTypeStringTrueNoType of the user who updated the previous version.
PreviousVersionDatetimeDatetimeTrueNoDatetime when the previous version was edited.
PreviousVersionMessageStringTrueNoMessage for the previously edited version.
PreviousVersionNumberStringTrueNoNumber of the previously edited version.
PreviousVersionIsMinorEditBooleanTrueNoIndicator if the previous version was a minor edit.
PreviousVersionIsHiddenBooleanTrueNoIndicator if the previous version was hidden or not.
LinksEdituiStringTrueNoThe LinksEditui of the page content.
LinksSelfStringTrueNoThe LinksSelf of the content.
LinksTinyuiStringTrueNoThe LinksTinyui of the content.
LinksWebuiStringTrueNoThe LinksWebui of the content.
ItemURLStringTrueNoThe URL reference of the element in UI.
ContainerIdStringTrueNoThe Id of the container of the content.
CQLStringFalseYesCQL (Confluence Query Language) allows you to build structured queries.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContentId [KEY]StringTrueNoThis is the Id of the content that support labels. This can be referenced from Attachments.Id, Pages.Id, Comments.Id or Blogposts.Id.
UserTypeStringTrueNoType of the contributor.
AccountIdStringTrueNoUnique account Id of the contributor. NOTE: This column is exclusive to &service; Cloud.
UserNameStringTrueNoUnique user key of the contributor. NOTE: This column is exclusive to &service; Server.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AccountIdStringTrueNoAccount Id of the user.
AccountTypeStringTrueNoAccount Type of the user.
DisplayNameStringTrueNoDisplay name of the user.
EmailStringTrueNoEmail address of the user.
PublicNameStringTrueNoPublic name or nickname of the user.
ProfilePicturePathStringTrueNoPath of the profile picture of the user.
ProfilePictureWidthIntTrueNoWidth of the profile picture of the user.
ProfilePictureHeightIntTrueNoHeight of the profile picture of the user.
ProfilePictureIsDefaultBooleanTrueNoIf isDefault of the profile picture of the user.
OperationsStringTrueNoAn operation and the target entity that it applies to
TypeStringTrueNoType of the user.
GroupIdStringTrueNoThe Id of the group.
NameStringFalseYesName of the Group to which these members belong to

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId of the group.
Name [KEY]StringTrueNoName of the group.
TypeStringTrueNoType of the group.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OperationStringTrueNoSpecifies the type of operation (read, update) that the restriction applies to.
NameStringTrueNoStores the name of the group that the restriction applies to.
TypeStringTrueNoSpecifies the type of the group.
ContentIdStringTrueNoThe ID of the content where the restriction is applied.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContentId [KEY]StringTrueNoThis is the Id of the content that support labels. This can be referenced from Attachments.Id, Pages.Id, or Blogposts.Id.
LabelIdStringTrueNoId of the label.
LabelNameStringTrueNoName of the label.
LabelPrefixStringTrueNoPrefix of the label.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the PageAncestors.
ExpandableAncestorsStringTrueNoThe ExpandableAncestors of the PageAncestors.
ExpandableBodyStringTrueNoThe ExpandableBody of the PageAncestors.
ExpandableChildrenStringTrueNoThe ExpandableChildren of the PageAncestors.
ExpandableChildTypesStringTrueNoThe ExpandableChildTypes of the PageAncestors.
ExpandableContainerStringTrueNoThe ExpandableContainer of the PageAncestors.
ExpandableDescendantsStringTrueNoThe ExpandableDescendants of the PageAncestors.
ExpandableHistoryStringTrueNoThe ExpandableHistory of the PageAncestors.
ExpandableMetadataStringTrueNoThe ExpandableMetadata of the PageAncestors.
ExpandableOperationsStringTrueNoThe ExpandableOperations of the PageAncestors.
ExpandableRestrictionsStringTrueNoThe ExpandableRestrictions of the PageAncestors.
ExpandableSchedulePublishDateDatetimeTrueNoThe ExpandableSchedulePublishDate of the PageAncestors.
ExpandableSpaceStringTrueNoThe ExpandableSpace of the PageAncestors.
ExpandableVersionStringTrueNoThe ExpandableVersion of the PageAncestors.
LinksEdituiStringTrueNoThe LinksEditui of the PageAncestors.
LinksSelfStringTrueNoThe LinksSelf of the PageAncestors.
LinksTinyuiStringTrueNoThe LinksTinyui of the PageAncestors.
LinksWebuiStringTrueNoThe LinksWebui of the PageAncestors.
ExtensionsPositionStringTrueNoThe ExtensionsPosition of the PageAncestors.
StatusStringTrueNoThe Status of the PageAncestors.
TitleStringTrueNoThe Title of the PageAncestors.
TypeStringTrueNoThe Type of the PageAncestors.
PageIdStringTruePages.IdNoThe Id of the page.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the PageChildrens.
ExpandableAncestorsStringTrueNoThe ExpandableAncestors of the PageChildrens.
ExpandableBodyStringTrueNoThe ExpandableBody of the PageChildrens.
ExpandableChildrenStringTrueNoThe ExpandableChildren of the PageChildrens.
ExpandableChildTypesStringTrueNoThe ExpandableChildTypes of the PageChildrens.
ExpandableContainerStringTrueNoThe ExpandableContainer of the PageChildrens.
ExpandableDescendantsStringTrueNoThe ExpandableDescendants of the PageChildrens.
ExpandableHistoryStringTrueNoThe ExpandableHistory of the PageChildrens.
ExpandableMetadataStringTrueNoThe ExpandableMetadata of the PageChildrens.
ExpandableOperationsStringTrueNoThe ExpandableOperations of the PageChildrens.
ExpandableRestrictionsStringTrueNoThe ExpandableRestrictions of the PageChildrens.
ExpandableSchedulePublishDateDatetimeTrueNoThe ExpandableSchedulePublishDate of the PageChildrens.
ExpandableSpaceStringTrueNoThe ExpandableSpace of the PageChildrens.
ExpandableVersionStringTrueNoThe ExpandableVersion of the PageChildrens.
LinksEdituiStringTrueNoThe LinksEditui of the PageChildrens.
LinksSelfStringTrueNoThe LinksSelf of the PageChildrens.
LinksTinyuiStringTrueNoThe LinksTinyui of the PageChildrens.
LinksWebuiStringTrueNoThe LinksWebui of the PageChildrens.
ExtensionsPositionStringTrueNoThe ExtensionsPosition of the PageChildrens.
StatusStringTrueNoThe Status of the PageChildrens.
TitleStringTrueNoThe Title of the PageChildrens.
TypeStringTrueNoThe Type of the PageChildrens.
PageIdStringTruePages.IdNoThe Id of the page.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the comments mentioned in the Page.
ExpandableAncestorsStringTrueNoThe ExpandableAncestors of the page comments.
ExpandableChildrenStringTrueNoThe ExpandableChildren of the page comments.
ExpandableContainerStringTrueNoThe ExpandableContainer of the page comments.
ExpandableDescendantsStringTrueNoThe ExpandableDescendants of the page comments.
ExpandableHistoryStringTrueNoThe ExpandableHistory of the page comments.
ExpandableMetadataStringTrueNoThe ExpandableMetadata of the page comments.
ExpandableOperationsStringTrueNoThe ExpandableOperations of the page comments.
ExpandableRestrictionsStringTrueNoThe ExpandableRestrictions of the page comments.
ExpandableSpaceStringTrueNoThe ExpandableSpace of the page comments.
ExpandableVersionStringTrueNoThe ExpandableVersion of the page comments.
LinksSelfStringTrueNoThe LinksSelf of the page comments.
LinksWebuiStringTrueNoThe LinksWebui of the page comments.
BodyExpandableAnonymousExportViewStringTrueNoThe BodyExpandableAnonymousExportView of the page comments.
BodyExpandableEditorStringTrueNoThe BodyExpandableEditor of the page comments.
BodyExpandableExportViewStringTrueNoThe BodyExpandableExportView of the page comments.
BodyExpandableStorageStringTrueNoThe BodyExpandableStorage of the page comments.
BodyExpandableStyledViewStringTrueNoThe BodyExpandableStyledView of the page comments.
BodyViewExpandableContentStringTrueNoThe BodyViewExpandableContent of the page comments.
BodyViewExpandableWebresourceStringTrueNoThe BodyViewExpandableWebresource of the page comments.
BodyViewRepresentationStringTrueNoThe BodyViewRepresentation of the page comments.
BodyViewValueStringTrueNoThe BodyViewValue of the page comments.
ExtensionsExpandableResolutionStringTrueNoThe ExtensionsExpandableResolution of the page comments.
ExtensionsLocationStringTrueNoThe ExtensionsLocation of the page comments.
StatusStringTrueNoThe Status of the page comments.
TitleStringTrueNoThe Title of the page comments.
TypeStringTrueNoThe Type of the page comments.
PageIdStringTruePages.IdNoThe Id of the page.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the page content.
ExpandableAncestorsStringTrueNoThe ExpandableAncestors of the page content.
ExpandableChildrenStringTrueNoThe ExpandableChildren of the page content.
ExpandableChildTypesStringTrueNoThe ExpandableChildTypes of the page content.
ExpandableContainerStringTrueNoThe ExpandableContainer of the page content.
ExpandableDescendantsStringTrueNoThe ExpandableDescendants of the page content.
ExpandableHistoryStringTrueNoThe ExpandableHistory of the page content.
ExpandableMetadataStringTrueNoThe ExpandableMetadata of the page content.
ExpandableOperationsStringTrueNoThe ExpandableOperations of the page content.
ExpandableRestrictionsStringTrueNoThe ExpandableRestrictions of the page content.
ExpandableSchedulePublishDateDatetimeTrueNoThe ExpandableSchedulePublishDate of the page content.
ExpandableSpaceStringTrueNoThe ExpandableSpace of the page content.
ExpandableVersionStringTrueNoThe ExpandableVersion of the page content.
LinksBaseStringTrueNoThe LinksBase of the page content.
LinksCollectionStringTrueNoThe LinksCollection of the page content.
LinksContextStringTrueNoThe LinksContext of the page content.
LinksEdituiStringTrueNoThe LinksEditui of the page content.
LinksSelfStringTrueNoThe LinksSelf of the page content.
LinksTinyuiStringTrueNoThe LinksTinyui of the page content.
LinksWebuiStringTrueNoThe LinksWebui of the page content.
BodyExpandableAnonymousExportViewStringTrueNoThe BodyExpandableAnonymousExportView of the page content.
BodyExpandableAtlasDocFormatStringTrueNoThe BodyExpandableAtlasDocFormat of the page content.
BodyExpandableDynamicStringTrueNoThe BodyExpandableDynamic of the page content.
BodyExpandableEditorStringTrueNoThe BodyExpandableEditor of the page content.
BodyExpandableEditor2StringTrueNoThe BodyExpandableEditor2 of the page content.
BodyExpandableExportViewStringTrueNoThe BodyExpandableExportView of the page content.
BodyExpandableStyledViewStringTrueNoThe BodyExpandableStyledView of the page content.
BodyExpandableViewStringTrueNoThe BodyExpandableView of the page content.
BodyStorageExpandableContentStringTrueNoThe BodyStorageExpandableContent of the page content.
BodyStorageEmbeddedContentStringTrueNoThe BodyStorageEmbeddedContent of the page content.
BodyStorageRepresentationStringTrueNoThe BodyStorageRepresentation of the page content.
BodyStorageValueStringTrueNoThe BodyStorageValue of the page content.
ExtensionsPositionStringTrueNoThe ExtensionsPosition of the page content.
StatusStringTrueNoThe Status of the page content.
TitleStringTrueNoThe Title of the page content.
TypeStringTrueNoThe Type of the page content.
PageIdStringTruePages.IdNoThe Id of the page.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoId of the content.
TypeStringTrueNoType of the content.
TitleStringFalseNoTitle of the content.
StatusStringFalseNoStatus of the content.
StorageStringFalseNoThe body content storage of the page..
AtlasDocFormatStringFalseNoThe body content in atlas doc format of the page.
PositionIntegerTrueNoPosition of the content.
OwnerIdStringFalseNoId of the owner of the page.
ParentIdLongFalseNoThe Id of the parent page.
SpaceIdStringFalseNoThe Id of the space the page rests.
SpaceKeyStringTrueSpaces.KeyNoThe key of the space that the content belongs to.
SpaceTypeStringTrueSpaces.TypeNoThe type of the space that the content belongs to.
PositionStringTrueNoPosition of the content.
URLStringTrueNoURL of the content.
ExcerptStringTrueNoExcerpt of the content.
IsLatestBooleanTrueNoIndicator if this is the latest version of the content.
CreatedByUserNameStringTrueNoUsername of the user who created the content.
CreatedByUserTypeStringTrueNoType of the user who created the content.
CreatedDateDatetimeTrueNoDatetime for the creation of the content.
LastUpdatedDatetimeDatetimeTrueNoDatetime of the last updated version of the content.
LastUpdatedMessageStringTrueNoMessage of the last updated version.
LastUpdatedNumberIntegerTrueNoNumber of the last updated version.
LastUpdatedUserNameStringTrueNoUsername of the user who updated the latest version.
LastUpdatedUserTypeStringTrueNoType of the user who updated the latest version.
LastUpdatedIsMinorEditBooleanTrueNoIndicator if this version is a minor edit.
LastUpdatedIsHiddenBooleanTrueNoIndicator if the last updated version is hidden or not.
PreviousVersionUserNameStringTrueNoUsername of the user who updated the previous version.
PreviousVersionUserTypeStringTrueNoType of the user who updated the previous version.
PreviousVersionDatetimeDatetimeTrueNoDatetime when the previous version was edited.
PreviousVersionMessageStringTrueNoMessage for the previously edited version.
PreviousVersionNumberStringTrueNoNumber of the previously edited version.
PreviousVersionIsMinorEditBooleanTrueNoIndicator if the previous version was a minor edit.
PreviousVersionIsHiddenBooleanTrueNoIndicator if the previous version was hidden or not.
VersionUserNameStringTrueNoUsername of the user who updated the previous version.
VersionUserTypeStringTrueNoType of the user who updated the previous version.
VersionDatetimeDatetimeTrueNoDatetime when the previous version was edited.
VersionMessageStringFalseNoMessage for the previously edited version.
VersionNumberIntegerFalseNoNumber of the previously edited version.
VersionIsMinorEditBooleanTrueNoIndicator if the previous version was a minor edit.
VersionIsHiddenBooleanTrueNoIndicator if the previous version was hidden or not.
LinksEdituiStringTrueNoThe LinksEditui of the page content.
LinksSelfStringTrueNoThe LinksSelf of the content.
LinksTinyuiStringTrueNoThe LinksTinyui of the content.
LinksWebuiStringTrueNoThe LinksWebui of the content.
ItemURLStringTrueNoThe URL reference of the element in UI.
CQLStringFalseYesCQL (Confluence Query Language) allows you to build structured queries.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe ID of the space permission.
OperationKeyStringTrueNoThe type of operation that the space permission corresponds to.
OperationTargetTypeStringTrueNoThe type of entity the operation type targets.
PrincipalIdStringTrueNoThe ID of the entity the space permissions corresponds to.
PrincipalTypeStringTrueNoThe type of the entity the space permissions corresponds to.
SpaceIdStringTrueSpaces.IdNoThe ID of the space that the permission is associated with.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoId of the space.
Key [KEY]StringTrueNoUnique key of the space.
NameStringTrueNoName of the space.
IconPathStringTrueNoPath of the space icon.
IconWidthIntegerTrueNoWidth of the space icon.
IconHeightIntegerTrueNoHeight of the space icon.
IsIconDefaultBooleanTrueNoIndicator if the icon is default.
ExcerptStringTrueNoExcerpt of the space.
TypeStringTrueNoType of the space.
UrlStringTrueNoUrl of the space.
LastModifiedDatetimeTrueNoLast modified datetime.
ItemURLStringTrueNoThe URL reference of the element in UI.
DescriptionStringTrueNoDescription of the space.
CQLStringFalseYesCQL (Confluence Query Language) allows you to build structured queries.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe ID of the task.
AssignedToStringTrueNoAccount ID of the user to whom this task is assigned.
AtlasDocStringTrueNoThe atlas doc format.
BlogPostIdStringTrueNoThe blog post ID of the task.
CompletedAtDatetimeTrueNoTime when task is completed.
CompletedByStringTrueNoAccount ID of the user who completed this task.
CreatedAtDatetimeTrueNoTime when task is created.
CreatedByStringTrueNoAccount ID of the user who created this task.
DueAtDatetimeTrueNoTime when task is due.
LocalIdStringTrueNoThe local ID.
PageIdStringTrueNoThe page ID of the task.
SpaceIdStringTrueNoThe space ID of the task.
StatusStringTrueNoThe status of the task.
StorageStringTrueNoThe body storage of the task.
UpdatedAtDatetimeTrueNoTime when task is updated.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AccountId [KEY]StringTrueNoUnique account id for the specific user. NOTE: This column is exclusive to &service; Cloud.
AccountTypeStringTrueNoType of the account for the specific user. NOTE: This column is exclusive to &service; Cloud.
PublicNameStringTrueNoFull name of the specific user. NOTE: This column is exclusive to &service; Cloud.
EmailStringTrueNoEmail of the specific user. NOTE: This column is exclusive to &service; Cloud.
UserKey [KEY]StringTrueNoUnique key for the specific user. NOTE: This column is exclusive to &service; Server.
UserNameStringTrueNoUser name of the specific user. NOTE: This column is exclusive to &service; Server.
StatusStringTrueNoStatus of the specific user. NOTE: This column is exclusive to &service; Server.
TypeStringTrueNoType of the specific user.
ExcerptStringTrueNoExcerpt of the user.
ProfilePicturePathStringTrueNoPath of the profile picture file.
ProfilePictureWidthIntegerTrueNoProfile picture width.
ProfilePictureHeightIntegerTrueNoProfile picture height.
IsDefaultPictureBooleanTrueNoIndicator showing if the profile picture is never changed.
DisplayNameStringTrueNoDisplay name of the specific user.
UrlStringTrueNoUrl of the user profile.
LastModifiedDatetimeTrueNoLast modified timestamp of the user information.
CQLStringFalseYesCQL (Confluence Query Language) allows you to build structured queries.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OperationStringTrueNoSpecifies the type of operation (read, update) that the restriction applies to.
UserKeyStringTrueNoSpecifies the UserKey, the unique identifier key for the user.
DisplayNameStringTrueNoThe display name of the user associated with the restriction.
UsernameStringTrueNoSpecifies the Username of the user.
TypeStringTrueNoSpecifies the type of the user (for example, 'known').
ContentIdStringTrueNoThe ID of the content where the restriction is applied.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContentIdStringTrueNoThe Id of the page content.
NumberOfDistinctViewersStringTrueNothe total number of distinct viewers a piece of content has.
FromDateDateFalseYesThe number of views for the content from the date.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContentIdStringTrueNoThe Id of the page content.
NumberOfViewsStringTrueNothe total number of views a piece of content has.
FromDateDateFalseYesThe number of views for the content from the date.

Return to Top