← API reference
Mutation / apps

installSharedResource

Install a catalog template into the calling tenant, creating or updating the corresponding domain resource and recording the installation with ControlApp. Idempotent: re-installing an unchanged template returns the existing resource. Authorization is dynamic — the caller needs write permission on the resource kind the template installs (e.g. script:write for a SCRIPT template, workflow:write for a WORKFLOW one), so it is checked in the resolver once the template has been fetched. Failures are reported in the payload, not as GraphQL errors.

Arguments

botUserIdUserID

Required for workflow templates: execution bot user in the calling tenant.

TypeID of the catalog template to install ("srt_01K…"). Its resourceType decides which write permission the caller must hold.

Returns InstallSharedResourcePayload!

Scalar fields at a glance

successBoolean!
resourceTypeSharedResourceType
resourceIdString
↗ View the complete InstallSharedResourcePayload type

Explore in a view

App Authoring
View exact SDL
"""
Install a catalog template into the calling tenant, creating or updating the corresponding domain resource and recording the installation with ControlApp. Idempotent: re-installing an unchanged template returns the existing resource. Authorization is dynamic — the caller needs write permission on the resource kind the template installs (e.g. script:write for a SCRIPT template, workflow:write for a WORKFLOW one), so it is checked in the resolver once the template has been fetched. Failures are reported in the payload, not as GraphQL errors.
"""
installSharedResource(
  """
  Required for workflow templates: execution bot user in the calling tenant.
  """
  botUserId: UserID
  """
  TypeID of the catalog template to install ("srt_01K…"). Its `resourceType` decides which write permission the caller must hold.
  """
  templateId: SharedResourceTemplateID!
): InstallSharedResourcePayload! @topic(names: ["apps"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.