Atlassian: Reorder custom field options (context)

← Issue custom field options operations · Get started

Operation atlassian.reordercustomfieldoptions

Provider route: PUT /{cloudId}/rest/api/3/field/{fieldId}/context/{contextId}/option/move. 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["issueCustomFieldOptions"]["reorderCustomFieldOptions"]>[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.issueCustomFieldOptions.reorderCustomFieldOptions(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.issue_custom_field_options.reorder_custom_field_options(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.fieldId	string	Required within parent
path.contextId	integer	Required within parent	Format: int64
body	Model	Required within parent	Expand Reorder custom field options (context) — request body — body

Referenced models: Reorder custom field options (context) — request body — body

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
$	null	Root

Schemas

Reorder custom field options (context) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	An ordered list of custom field option IDs and information on where to move them. Additional keys: not allowed
after	string	Optional	The ID of the custom field option or cascading option to place the moved options after. Required if `position` isn't provided. write Only: true
customFieldOptionIds	array	Required within parent	A list of IDs of custom field options to move. The order of the custom field option IDs in the list is the order they are given after the move. The list must contain custom field options or cascading options, but not both. write Only: true
customFieldOptionIds[]	string	Each item	write Only: true
position	string	Optional	The position the custom field options should be moved to. Required if `after` isn't provided. One of: First, Last write Only: true

Policy, approvals and errors

SDK function policy ID: atlassian.reordercustomfieldoptions. Catalog operation: reorderCustomFieldOptions. 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"]

No-content response statuses: [204]

Official provider source