Atlassian: Gets a custom project template

Atlassian projectTemplates.liveTemplate: arguments, response, policy and SDK examples.

← Project templates operations · Get started

Operation atlassian.livetemplate

Provider route: GET /{cloudId}/rest/api/3/project-template/live-template. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["projectTemplates"]["liveTemplate"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.projectTemplates.liveTemplate(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.project_templates.live_template(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`query`	object	Optional	Additional keys: not allowed
`query.projectId`	string	Optional
`query.templateKey`	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Gets a custom project template — response body

Referenced models: Gets a custom project template — response body

Schemas

Gets a custom project template — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`archetype`	JSON	Optional
`archetype (anyOf 1)`	Model	Alternative	Expand Gets a custom project template — response body — archetype real Type, style, type
`archetype (anyOf 2)`	null	Alternative
`defaultBoardView`	JSON	Optional
`defaultBoardView (anyOf 1)`	string	Alternative
`defaultBoardView (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`liveTemplateProjectIdReference`	JSON	Optional
`liveTemplateProjectIdReference (anyOf 1)`	JSON	Alternative
`liveTemplateProjectIdReference (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`liveTemplateProjectIdReference (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`liveTemplateProjectIdReference (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`projectTemplateKey`	JSON	Optional
`projectTemplateKey (anyOf 1)`	Model	Alternative	Expand Gets a custom project template — response body — project Template Key key, uuid
`projectTemplateKey (anyOf 2)`	null	Alternative
`snapshotTemplate`	JSON	Optional
`snapshotTemplate (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`snapshotTemplate (anyOf 1).*`	JSON	Additional keys
`snapshotTemplate (anyOf 2)`	null	Alternative
`templateGenerationOptions`	JSON	Optional
`templateGenerationOptions (anyOf 1)`	Model	Alternative	Expand Gets a custom project template — response body — template Generation Options enable Screen Delegated Admin Support, enable Workflow Delegated Admin Support
`templateGenerationOptions (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	Known values: LIVE, SNAPSHOT
`type (anyOf 2)`	null	Alternative

Referenced models: Gets a custom project template — response body — template Generation Options enable Screen Delegated Admin Support, enable Workflow Delegated Admin Support, Gets a custom project template — response body — archetype real Type, style, type, Gets a custom project template — response body — project Template Key key, uuid

Gets a custom project template — response body — template Generation Options enable Screen Delegated Admin Support, enable Workflow Delegated Admin Support

Field	Type	Presence	Description and constraints
`$`	object	Root
`enableScreenDelegatedAdminSupport`	JSON	Optional
`enableScreenDelegatedAdminSupport (anyOf 1)`	boolean	Alternative	Enable screen delegated admin support for the template. This means screen and associated schemes will be copied rather than referenced.
`enableScreenDelegatedAdminSupport (anyOf 2)`	null	Alternative
`enableWorkflowDelegatedAdminSupport`	JSON	Optional
`enableWorkflowDelegatedAdminSupport (anyOf 1)`	boolean	Alternative	Enable workflow delegated admin support for the template. This means workflows and workflow schemes will be copied rather than referenced.
`enableWorkflowDelegatedAdminSupport (anyOf 2)`	null	Alternative

Gets a custom project template — response body — archetype real Type, style, type

Field	Type	Presence	Description and constraints
`$`	object	Root
`realType`	JSON	Optional
`realType (anyOf 1)`	string	Alternative	Known values: BUSINESS, SOFTWARE, PRODUCT_DISCOVERY, SERVICE_DESK, CUSTOMER_SERVICE, OPS
`realType (anyOf 2)`	null	Alternative
`style`	JSON	Optional
`style (anyOf 1)`	string	Alternative	Known values: classic, next-gen
`style (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	Known values: BUSINESS, SOFTWARE, PRODUCT_DISCOVERY, SERVICE_DESK, CUSTOMER_SERVICE, OPS
`type (anyOf 2)`	null	Alternative

Gets a custom project template — response body — project Template Key key, uuid

Field	Type	Presence	Description and constraints
`$`	object	Root
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative
`key (anyOf 2)`	null	Alternative
`uuid`	JSON	Optional
`uuid (anyOf 1)`	string	Alternative	Format: uuid
`uuid (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.livetemplate. Catalog operation: livetemplate. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["manage:jira-configuration"]

Official provider source

Report an issue with this page