Atlassian: Get I Ds of deleted worklogs

Atlassian issueWorklogs.getIdsOfWorklogsDeletedSince: arguments, response, policy and SDK examples.

← Issue worklogs operations · Get started

Operation atlassian.getidsofworklogsdeletedsince

Provider route: GET /{cloudId}/rest/api/3/worklog/deleted. 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["issueWorklogs"]["getIdsOfWorklogsDeletedSince"]>[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.issueWorklogs.getIdsOfWorklogsDeletedSince(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_worklogs.get_ids_of_worklogs_deleted_since(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.since`	integer	Optional	Default: 0 Format: int64

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 I Ds of deleted worklogs — response body

Referenced models: Get I Ds of deleted worklogs — response body

Schemas

Get I Ds of deleted worklogs — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	List of changed worklogs.
`lastPage`	JSON	Optional
`lastPage (anyOf 1)`	boolean	Alternative
`lastPage (anyOf 2)`	null	Alternative
`nextPage`	JSON	Optional
`nextPage (anyOf 1)`	string	Alternative	The URL of the next list of changed worklogs. Format: uri Read only: true
`nextPage (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of this changed worklogs list. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative
`since`	JSON	Optional
`since (anyOf 1)`	JSON	Alternative
`since (anyOf 1) (anyOf 1)`	integer	Alternative	The datetime of the first worklog item in the list. Format: int64 Read only: true
`since (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`since (anyOf 2)`	null	Alternative
`until`	JSON	Optional
`until (anyOf 1)`	JSON	Alternative
`until (anyOf 1) (anyOf 1)`	integer	Alternative	The datetime of the last worklog item in the list. Format: int64 Read only: true
`until (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`until (anyOf 2)`	null	Alternative
`values`	JSON	Optional
`values (anyOf 1)`	array	Alternative	Changed worklog list. Read only: true
`values (anyOf 1)[]`	Model	Each item	Expand Get I Ds of deleted worklogs — response body — values Changed worklog list item
`values (anyOf 2)`	null	Alternative

Referenced models: Get I Ds of deleted worklogs — response body — values Changed worklog list item

Get I Ds of deleted worklogs — response body — values Changed worklog list item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a changed worklog.
`properties`	JSON	Optional
`properties (anyOf 1)`	array	Alternative	Details of properties associated with the change. Read only: true
`properties (anyOf 1)[]`	Model	Each item	Expand Get user property — response body
`properties (anyOf 2)`	null	Alternative
`updatedTime`	JSON	Optional
`updatedTime (anyOf 1)`	JSON	Alternative
`updatedTime (anyOf 1) (anyOf 1)`	integer	Alternative	The datetime of the change. Format: int64 Read only: true
`updatedTime (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`updatedTime (anyOf 2)`	null	Alternative
`worklogId`	JSON	Optional
`worklogId (anyOf 1)`	JSON	Alternative
`worklogId (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the worklog. Format: int64 Read only: true
`worklogId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`worklogId (anyOf 2)`	null	Alternative

Referenced models: Get user property — response body

Get user property — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the property. Required on create and update.
`key (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	JSON	Alternative	The value of the property. Required on create and update.
`value (anyOf 2)`	null	Alternative

Policy, approvals and errors

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