Atlassian: Set time tracking settings

Atlassian timeTracking.setSharedTimeTrackingConfiguration: arguments, response, policy and SDK examples.

← Time tracking operations · Get started

Operation atlassian.setsharedtimetrackingconfiguration

Provider route: PUT /{cloudId}/rest/api/3/configuration/timetracking/options. 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["timeTracking"]["setSharedTimeTrackingConfiguration"]>[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.timeTracking.setSharedTimeTrackingConfiguration(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.time_tracking.set_shared_time_tracking_configuration(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}$
`body`	Model	Required within parent	Expand Set time tracking settings — request body — body

Referenced models: Set time tracking settings — 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
`$`	Model	Root	Expand Get time tracking settings — response body

Referenced models: Get time tracking settings — response body

Schemas

Get time tracking settings — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the time tracking configuration.
`defaultUnit`	JSON	Optional
`defaultUnit (anyOf 1)`	string	Alternative	The default unit of time applied to logged time. Known values: minute, hour, day, week
`defaultUnit (anyOf 2)`	null	Alternative
`timeFormat`	JSON	Optional
`timeFormat (anyOf 1)`	string	Alternative	The format that will appear on an issue's Time Spent field. Known values: pretty, days, hours
`timeFormat (anyOf 2)`	null	Alternative
`workingDaysPerWeek`	JSON	Optional
`workingDaysPerWeek (anyOf 1)`	JSON	Alternative
`workingDaysPerWeek (anyOf 1) (anyOf 1)`	number	Alternative	The number of days in a working week. Format: double
`workingDaysPerWeek (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workingDaysPerWeek (anyOf 2)`	null	Alternative
`workingHoursPerDay`	JSON	Optional
`workingHoursPerDay (anyOf 1)`	JSON	Alternative
`workingHoursPerDay (anyOf 1) (anyOf 1)`	number	Alternative	The number of hours in a working day. Format: double
`workingHoursPerDay (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workingHoursPerDay (anyOf 2)`	null	Alternative

Set time tracking settings — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the time tracking configuration. Additional keys: not allowed
`defaultUnit`	string	Required within parent	The default unit of time applied to logged time. One of: minute, hour, day, week
`timeFormat`	string	Required within parent	The format that will appear on an issue's Time Spent field. One of: pretty, days, hours
`workingDaysPerWeek`	number	Required within parent	The number of days in a working week. Format: double
`workingHoursPerDay`	number	Required within parent	The number of hours in a working day. Format: double

Policy, approvals and errors

SDK function policy ID: atlassian.setsharedtimetrackingconfiguration. Catalog operation: setsharedtimetrackingconfiguration. 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