GraphQL RepositoriesonlineFormStyle

`entities.onlineFormStyle`

Read online form style records with the onlineFormStyle repository, and change them with the online form style mutations. Same records as the REST OnlineFormStyles entity.

Example: first three online form style recordsGraphQLcURL

query FirstOnlineFormStyles {
  entities {
    onlineFormStyle {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstOnlineFormStyles { entities { onlineFormStyle { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'

Queries

Fields of entities { onlineFormStyle { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	OnlineFormStyleEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[OnlineFormStyleEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: OnlineFormStyleFilterInput, orderBy: [OnlineFormStyleOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[OnlineFormStyleEntity!]!
QUERY	`getByCriteria`(filter: OnlineFormStyleFilterInput, orderBy: [OnlineFormStyleOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	OnlineFormStyleEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createOnlineFormStyle`(input: CreateOnlineFormStyleInput!, validationLevel: [ValidationLevel!])	Create one record	CreateOnlineFormStylePayload
MUTATION	`updateOnlineFormStyle`(input: UpdateOnlineFormStyleInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateOnlineFormStylePayload
MUTATION	`bulkUpdateOnlineFormStyle`(input: [CreateOrUpdateOnlineFormStyleInput!]!, deleteInput: [DeleteOnlineFormStyleInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateOnlineFormStylePayload
MUTATION	`deleteOnlineFormStyle`(input: DeleteOnlineFormStyleInput!)	Soft-delete	DeleteOnlineFormStylePayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

OnlineFormStyleEntity object 10 fields: isDeleteProtected, id, isDeleted, …

Visual style (colors, fonts, layout) that can be applied to online forms.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`name`	String!	Name of the entity and its default text representation.
`settings`	OnlineFormStyleSettings	JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used.
`useLang`	Boolean	When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

OnlineFormStyleEntityConnection object pageInfo: PageInfo!, edges: [OnlineFormStyleEntityEdge]!, totalCount: Int

Paginated list of OnlineFormStyle records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[OnlineFormStyleEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

OnlineFormStyleEntityEdge object node: OnlineFormStyleEntity, cursor: String!

A Relay edge containing a OnlineFormStyleEntity and its cursor.

Field	Type	Description
`node`	OnlineFormStyleEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

OnlineFormStyleFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for OnlineFormStyle records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[OnlineFormStyleFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[OnlineFormStyleFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	OnlineFormStyleFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`useLang`	Boolean	When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.

OnlineFormStyleOrderByInput input Asc or Desc per field

Sorting of OnlineFormStyle records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`name`	OrderByEnum	Name of the entity and its default text representation.
`useLang`	OrderByEnum	When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateOnlineFormStyleInput input 7 fields: clientMutationId, modified, created, …

Field values of a new OnlineFormStyle record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`name`	String!	Name of the entity and its default text representation.
`settings`	JSONString	JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used.
`useLang`	Boolean	When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateOnlineFormStyleInput input 8 fields: clientMutationId, id, modified, …

Field values of an OnlineFormStyle record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`name`	String	Name of the entity and its default text representation.
`settings`	JSONString	JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used.
`useLang`	Boolean	When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	Int	Revision when entity was lastly changed.

DeleteOnlineFormStyleInput input clientMutationId: String, id: ID!

Id of the OnlineFormStyle record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateOnlineFormStyleInput input 8 fields: clientMutationId, id, modified, …

Id of an OnlineFormStyle record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`name`	String	Name of the entity and its default text representation.
`settings`	JSONString	JSON definition of the style applied to the form (colors, fonts, layout). When null, the default style is used.
`useLang`	Boolean	When true, the style name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateOnlineFormStylePayload object result: BulkUpdateResults!

Result of the bulkUpdateOnlineFormStyle mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateOnlineFormStylePayload object onlineFormStyle: OnlineFormStyleEntity, clientMutationId: String

Result of the createOnlineFormStyle mutation.

Field	Type	Description
`onlineFormStyle`	OnlineFormStyleEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteOnlineFormStylePayload object onlineFormStyle: OnlineFormStyleEntity, clientMutationId: String

Result of the deleteOnlineFormStyle mutation.

Field	Type	Description
`onlineFormStyle`	OnlineFormStyleEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateOnlineFormStylePayload object onlineFormStyle: OnlineFormStyleEntity, clientMutationId: String

Result of the updateOnlineFormStyle mutation.

Field	Type	Description
`onlineFormStyle`	OnlineFormStyleEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

OnlineFormStyleSettings object 37 fields: backgroundColor, buttonAreaPaddingVertical, buttonAreaPaddingHorizontal, …

Visual style of online forms: colors, spacing, borders and logo.

Field	Type	Description
`backgroundColor`	String	Background color of the page behind the form, as a CSS color.
`buttonAreaPaddingVertical`	String	Vertical padding of the area with the form buttons, as a CSS length.
`buttonAreaPaddingHorizontal`	String	Horizontal padding of the area with the form buttons, as a CSS length.
`buttonColor`	String	Background color of the form buttons, as a CSS color.
`buttonFontColor`	String	Text color of the form buttons, as a CSS color.
`buttonRadius`	String	Corner radius of the form buttons, as a CSS length.
`columnsHorizontalPadding`	String	Horizontal padding of the layout columns, as a CSS length.
`formBackgroundColor`	String	Background color of the form itself, as a CSS color.
`formHorizontalPadding`	String	Horizontal padding of the form, as a CSS length.
`formVerticalPadding`	String	Vertical padding of the form, as a CSS length.
`headerBottomMargin`	String	Space below the form header, as a CSS length.
`headerDescriptionBottomMargin`	String	Space below the description in the form header, as a CSS length.
`headerHorizontalPadding`	String	Horizontal padding of the form header, as a CSS length.
`headerImageVerticalPadding`	String	Vertical padding around the header image, as a CSS length.
`headerRibbonVisible`	Boolean!	When true, the header ribbon of the form is shown.
`headerTitleTopPadding`	String	Space above the form title in the header, as a CSS length.
`inputBackgroundColor`	String	Background color of input fields, as a CSS color.
`inputBorderColor`	String	Border color of input fields, as a CSS color.
`inputBorderRadius`	String	Corner radius of input fields, as a CSS length.
`inputBorderWidth`	String	Border width of input fields, as a CSS length.
`inputFocusBackgroundColor`	String	Background color of the input field that has focus, as a CSS color.
`inputFocusBorderColor`	String	Border color of the input field that has focus, as a CSS color.
`inputFontColor`	String	Text color of input fields, as a CSS color.
`inputHoverBackgroundColor`	String	Background color of an input field under the pointer, as a CSS color.
`inputHoverBorderColor`	String	Border color of an input field under the pointer, as a CSS color.
`primaryColor`	String!	Main accent color of the form, as a CSS color.
`questionDescriptionBottomMargin`	String	Space below the description of a question, as a CSS length.
`questionTitleBottomMargin`	String	Space below the title of a question, as a CSS length.
`questionVerticalMargin`	String	Vertical margin around each question, as a CSS length.
`questionVerticalPadding`	String	Vertical padding inside each question, as a CSS length.
`sectionBackgroundColor`	String	Background color of section headers, as a CSS color.
`sectionFontColor`	String	Text color of section headers, as a CSS color.
`sectionHeaderHorizontalPadding`	String	Horizontal padding of section headers, as a CSS length.
`sectionHeaderVerticalPadding`	String	Vertical padding of section headers, as a CSS length.
`sectionPadding`	String	Padding of form sections, as a CSS length.
`showFooterLogo`	Boolean!	When true, the logo is shown in the footer of the form.
`titleBottomMargin`	String	Space below the form title, as a CSS length.