Skip to main content

Arguments

maxVersionSupported : Int default: 1

The maximum version of backend screens supported by the client.

List of key-value pairs (strings) to pass as parameters to the screen.

screenId : ID! required

The ID of the screen to return.

Returns

BackendScreenType

A backend screen is the top-level container for mobile UI.

Allowed Viewers

Customer Partner User Third party

Query Complexity

1

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Query

query BackendScreen( $maxVersionSupported: Int, $params: [BackendScreenParamInputType], $screenId: ID! ) { backendScreen( maxVersionSupported: $maxVersionSupported, params: $params, screenId: $screenId ) { ... on ComponentListType { ...ComponentListTypeFragment } ... on Dashboard { ...DashboardFragment } ... on FormScreenType { ...FormScreenTypeFragment } ... on GenericBackendScreen { ...GenericBackendScreenFragment } } }

Variables

{ "maxVersionSupported": 46, "params": BackendScreenParamInputType, "screenId": "83407141" }

Response

{ "data": { "backendScreen": ComponentListType } }