API

guillotine: HeadlessCms

Type gathering all content retrieval requests

get(key: ID): Content

Fetches a content

getChildren( key: ID, offset: Int, first: Int, sort: String ): [Content]

Fetches the children of a content

getChildrenConnection( key: ID, after: String, first: Int, sort: String ): ContentConnection

Fetches the children of a content and return the result as a connection

getPermissions(key: ID): Permissions

Fetches the permissions on a content

getSite: portal_Site

Fetches the parent site of the content corresponding to the current execution context

query( query: String, offset: Int, first: Int, sort: String, contentTypes: [String], filters: [FilterInput] ): [Content]

Queries contents

queryConnection( query: String!, after: String, first: Int, sort: String, contentTypes: [String], aggregations: [AggregationInput], filters: [FilterInput] ): QueryContentConnection

Queries contents and returns the result as a connection

getType(name: String!): ContentType

Retrieves the properties and icon of the specified content type

getTypes: [ContentType]

Retrieves the list of all content types available for the current site

_id: ID!

Content ID

_name: String!

Content name

_path: String!

Content path

creator: PrincipalKey

Content creator

modifier: PrincipalKey

Last content modifier

createdTime: String

Content creation time

modifiedTime: String

Last content modification time

owner: PrincipalKey

Content owner

type: String

Content type

displayName: String

Content display name

hasChildren: Boolean

true if the content has children content

language: String

Content language

valid: Boolean

true if the content is valid

dataAsJson: JSON

Content data

x: [ExtraData]

Content extra data. This field is deprecated and will be removed starting from version 6.0.0.

xAsJson: JSON

Content extra data

pageAsJson: JSON

Page specific information

pageTemplate: Content

Related page template content

components: [Component]

Flattened list of page components

attachments: [Attachment]

Content attachments

publish: PublishInfo

Publication information

pageUrl(type: UrlType, params: String): String

Util field to generate a URL pointing to the content

site: portal_Site

Link to the nearest site

parent: Content

Link to the content parent

children( offset: Int, first: Int, sort: String ): [Content]

Link to the direct child contents

childrenConnection( after: String, first: Int, sort: String ): ContentConnection

Connection to the direct child contents

permissions: Permissions

Content permissions

totalCount: Int!

Total number of related content

edges: [ContentEdge]

Edge to the related content

pageInfo: PageInfo

Paging information

totalCount: Int!

Total number of related content

edges: [ContentEdge]

Edge to the related content

pageInfo: PageInfo

Paging information

aggregationAsJson: JSON

Result of aggregations

node: Content!

Related content

cursor: String!

Edge cursor

startCursor: String!

Start cursor of the pagination

endCursor: String!

End cursor of the pagination

hasNext: Boolean!

Has more related contents at end cursor

inheritsPermissions: Boolean

Inherit permissions from parent content

permissions: [AccessControlEntry]

Permissions

principal: PrincipalKey

Principal key

allow: [Permission]

Allowed permissions

deny: [Permission]

Denied permissions

value: String

Principal key value

type: PrincipalType

Principal type

idProvider: String

ID Provider name

principalId: String

Principal ID inside this user store

name: String

Content type name

displayName: String

Content type display name

description: String

Content type description

superType: String

Parent content type

abstract: Boolean

true if the content type is abstract

final: Boolean

true if the content type cannot be used as super type

allowChildContent: Boolean

true if content can be added under a content of this type

contentDisplayNameScript: String

icon: Icon

form: [FormItem]

Content type fields schema

getInstances( offset: Int , first: Int , query: String , sort: String ): [Content]

Util field returning the contents of this type

getInstanceConnection( after: String , first: Int , query: String , sort: String ): ContentConnection

Util field returning the contents of this type as a connection

formItemType: FormItemType

Form item type

name: String

Form item name

label: String

Form item label

name: String

Mixin name

data: String

Mixin value

path: String

Component path

type: ComponentType

Component type

page: PageComponentData

Data for page components

layout: LayoutComponentData

Data for layout components

image: ImageComponentData

Data for image components

part: PartComponentData

Data for part components

text: TextComponentData

Data for text components

fragment: FragmentComponentData

Data for fragment components

descriptor: String

Controller descriptor

customized: Boolean

True if the page is customized

configAsJson: JSON

Component config

template: Content

Related template content

descriptor: String!

Controller descriptor

configAsJson: JSON

Component config

id: ID!

Image key

caption: String

Image caption

image: media_Image

Related image content

descriptor: String!

Controller descriptor

configAsJson: JSON

Component config

value(processHtml: ProcessHtmlInput): RichText!

Text value

id: ID!

Fragment key

fragment: Content

Related fragment content

name: String

Attachment name

label: String

Attachment label

size: Int

Attachment size

mimeType: String

Attachment mime type

attachmentUrl: String

Attachment URL

from: String

Scheduled publication start time

to: String

Scheduled publication end time

first: String

First publication time

mimeType: String

Icon mime type

modifiedTime: String

Icon last modification time

name: String!

Aggregation name

subAggregations: [AggregationInput]

Sub aggregations

terms: TermsAggregationInput

Terms aggregation

stats: StatsAggregationInput

Stats aggregation

range: RangeAggregationInput

Range aggregation

dateRange: DateRangeAggregationInput

DateRange aggregation

dateHistogram: DateHistogramAggregationInput

DateHistogram aggregation

getDistance: GeoDistanceAggregationInput

GeoDistance aggregation

min: MinAggregationInput

Min aggregation

max: MaxAggregationInput

Max aggregation

count: ValueCountAggregationInput

ValueCount aggregation

field: String!

The property path

order: String

How to order the results, type and direction. Supports _term (Alphabetic ordering of bucket keys) and _count (Numeric ordering of bucket sizes) types. Defaults to _term ASC.

size: Int

Bucket size, ordered by the given orderType and orderDirection. Defaults to 10.

minDocCount: Int

Only include bucket in result if number of hits more or equal minDocCount.

field: String!

The property path

field: String!

The property path

field: String!

The property path

field: String!

The property path

field: String!

The property path.

ranges: [ NumberRangeInput ]

The range-buckets to create.

from: Float

From-value is included in bucket.

to: Float

To-value is excluded.

field: String!

The property path.

format: String

Date/time format for buckets. Defaults to yyyy-MM-dd’T’HH:mm:ss.SSSZ.

ranges: [ DateRangeInput ]

The range-buckets to create.

from: String

From-value is included in bucket.

to: String

To-value is excluded.

field: String!

The property path.

interval: String

The time-unit interval for buckets. Supported time-unit notations are y, M, W,d,h,m,s.

format: String

Date/time format for buckets. Defaults to yyyy-MM-dd’T’HH:mm:ss.SSSZ.

minDocCount: Int

Only include bucket in result if number of hits is equal or greater than minDocCount.

field: String!

The property path.

unit: String

The measurement unit to use for the ranges. Allowed values are either full name or the abbreviation of the following: km (kilometers), m (meters), cm (centimeters), mm (millimeters), mi (miles), yd (yards), ft (feet) or nmi (nauticalmiles).

origin: GeoPointInput

The GeoPoint from which the distance is measured.

ranges: [ NumberRangeInput ]

The range-buckets to create.

lat: String!

The latitude.

lon: String!

The longitude.

boolean: BooleanFilterInput

Boolean filter

exists: ExistsFilterInput

ExistsFilter

notExists: NotExistsFilterInput

NotExists filter

hasValue: HasValueFilterInput

HasValue filter

ids: IdsFilterInput

Ids filter

must: [FilterInput]

All functions on the must array must evaluate to true for the filter to match

mustNot: [FilterInput]

All functions in the mustNot array must evaluate to false for the filter to match

should: [FilterInput]

At least one function in the should array must evaluate to `true for the filter to match

field: String!

The property path

field: String!

The property path

field: String!

The property path

stringValues: [String]

Array of string values to find a match

intValues: [Int]

Array of integer values to find a match

booleanValues: [Boolean]

Array of boolean values to find a match

floatValues: [Float]

Array of float values to find a match

values: [String]

Array of ids to match