Atlassian: Get project features

Atlassian projectFeatures.getFeaturesForProject: arguments, response, policy and SDK examples.

← Project features operations · Get started

Operation atlassian.getfeaturesforproject

Provider route: GET /{cloudId}/rest/api/3/project/{projectIdOrKey}/features. 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["projectFeatures"]["getFeaturesForProject"]>[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.projectFeatures.getFeaturesForProject(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_features.get_features_for_project(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}$
`path.projectIdOrKey`	string	Required within parent

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 Get project features — response body

Referenced models: Get project features — response body

Schemas

Get project features — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The list of features on a project.
`features`	JSON	Optional
`features (anyOf 1)`	array	Alternative	The project features.
`features (anyOf 1)[]`	Model	Each item	Expand Get project features — response body — features The project features item
`features (anyOf 2)`	null	Alternative

Referenced models: Get project features — response body — features The project features item

Get project features — response body — features The project features item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a project feature.
`feature`	JSON	Optional
`feature (anyOf 1)`	string	Alternative	The key of the feature.
`feature (anyOf 2)`	null	Alternative
`imageUri`	JSON	Optional
`imageUri (anyOf 1)`	string	Alternative	URI for the image representing the feature.
`imageUri (anyOf 2)`	null	Alternative
`localisedDescription`	JSON	Optional
`localisedDescription (anyOf 1)`	string	Alternative	Localized display description for the feature.
`localisedDescription (anyOf 2)`	null	Alternative
`localisedName`	JSON	Optional
`localisedName (anyOf 1)`	string	Alternative	Localized display name for the feature.
`localisedName (anyOf 2)`	null	Alternative
`prerequisites`	JSON	Optional
`prerequisites (anyOf 1)`	array	Alternative	List of keys of the features required to enable the feature.
`prerequisites (anyOf 1)[]`	string	Each item
`prerequisites (anyOf 2)`	null	Alternative
`projectId`	JSON	Optional
`projectId (anyOf 1)`	JSON	Alternative
`projectId (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the project. Format: int64
`projectId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`projectId (anyOf 2)`	null	Alternative
`state`	JSON	Optional
`state (anyOf 1)`	string	Alternative	The state of the feature. When updating the state of a feature, only ENABLED and DISABLED are supported. Responses can contain all values Known values: ENABLED, DISABLED, COMING_SOON
`state (anyOf 2)`	null	Alternative
`toggleLocked`	JSON	Optional
`toggleLocked (anyOf 1)`	boolean	Alternative	Whether the state of the feature can be updated.
`toggleLocked (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getfeaturesforproject. Catalog operation: getfeaturesforproject. 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: ["read:jira-work"]

Official provider source

Report an issue with this page