← All types
Ob Object

SharedResourceEnvelope

A template published in the shared-resource catalog: the metadata a tenant browses before installing it. Served by ControlApp, not by this tenant's database; the template's payload itself is not exposed here.

Fields

TypeID of the catalog template ("srt_01K…"). Stable across versions and the id to pass to installSharedResource.

Kind of resource this template installs; determines which domain resource is created on install and which write permission is required.

Possible values (8)
CUSTOM_APP

Custom application template

WORKFLOW

Workflow template

SCRIPT

Script template

DASHBOARD

Dashboard template

INTEGRATION_DEFINITION

Integration definition template

TEMPLATE

Template template

ML_MODEL_CONFIG

ML model configuration template

PRODUCT_TEMPLATE

Product template

name

String!Non-null

Human-readable display name of the template, as shown in the catalog.

handle

String!Non-null

Stable machine-readable slug identifying the template in the catalog, independent of its display name.

Long-form summary of what the template does. Null when the author supplied none.

icon

StringNullable

Icon identifier for catalog listings, chosen by the template author. Null when unset.

Catalog grouping the template is filed under (matched exactly by the category argument of sharedResources). Null when uncategorised.

tags

[String!]!Non-null

Free-form keywords used for catalog search and filtering. Empty when the author supplied none.

author

StringNullable

Name of the publisher of the template. Null when the catalog entry is unattributed.

version

String!Non-null

Version string of the template as published; recorded on the installation record so upgrades can be detected.

Publication status. Only PUBLISHED templates are intended for installation; DEPRECATED ones remain resolvable for already-installed tenants.

Possible values (3)
DRAFT

Template is in draft and not publicly visible

PUBLISHED

Template is published and available for installation

DEPRECATED

Template is deprecated and should not be installed

ISO 8601 timestamp of when the template was first published to the catalog.

ISO 8601 timestamp of the template's last catalog edit (content, metadata, or status).

Referenced by (2)
Exact type SDL
"""
A template published in the shared-resource catalog: the metadata a tenant browses before installing it. Served by ControlApp, not by this tenant's database; the template's payload itself is not exposed here.
"""
type SharedResourceEnvelope {
  """
  TypeID of the catalog template ("srt_01K…"). Stable across versions and the id to pass to `installSharedResource`.
  """
  id: SharedResourceTemplateID!
  """
  Kind of resource this template installs; determines which domain resource is created on install and which write permission is required.
  """
  resourceType: SharedResourceType!
  """Human-readable display name of the template, as shown in the catalog."""
  name: String!
  """
  Stable machine-readable slug identifying the template in the catalog, independent of its display name.
  """
  handle: String!
  """
  Long-form summary of what the template does. Null when the author supplied none.
  """
  description: String
  """
  Icon identifier for catalog listings, chosen by the template author. Null when unset.
  """
  icon: String
  """
  Catalog grouping the template is filed under (matched exactly by the `category` argument of `sharedResources`). Null when uncategorised.
  """
  category: String
  """
  Free-form keywords used for catalog search and filtering. Empty when the author supplied none.
  """
  tags: [String!]!
  """
  Name of the publisher of the template. Null when the catalog entry is unattributed.
  """
  author: String
  """
  Version string of the template as published; recorded on the installation record so upgrades can be detected.
  """
  version: String!
  """
  Publication status. Only `PUBLISHED` templates are intended for installation; `DEPRECATED` ones remain resolvable for already-installed tenants.
  """
  status: SharedResourceStatus!
  """
  ISO 8601 timestamp of when the template was first published to the catalog.
  """
  createdAt: String!
  """
  ISO 8601 timestamp of the template's last catalog edit (content, metadata, or status).
  """
  updatedAt: String!
}