@managed-api/tempo-cloud-v4-sr-connect

ScriptRunner Connect Managed API for Tempo Cloud

Managed API for Tempo Cloud is an API Client for Tempo Cloud by Adaptavist. You can read more about Managed APIs here.

This is ScriptRunner Connect runtime specific version of the Managed API (with sr-connect suffix). If you want to use Managed API in any other runtime, have a look at the runtime agnostic version.

Supported API calls

• fetch
• Account
  • createAccount
  • deleteAccount
  • getAccountById
  • getAccounts
  • getLinks
  • searchAccounts
  • updateAccount
  • Category
    • createCategory
    • deleteCategory
    • getAllCategoriesOrCategoryById
    • getCategoryByKey
    • updateCategory
    • Type
      • getTypes
  • Link
    • createLink
    • deleteLink
    • getLinkById
    • getLinkByProject
• Customer
  • createCustomer
  • deleteCustomer
  • getAccountsByCustomer
  • getCustomer
  • getCustomers
  • updateCustomer
• GenericResource
  • getGenericResource
  • searchGenericResources
• Plan
  • createPlan
  • deletePlanById
  • getPlanById
  • getPlans
  • getPlansForGenericResource
  • getPlansForUser
  • searchPlans
  • updatePlan
• Work
  • Attribute
    • createAttribute
    • deleteAttribute
    • getAttribute
    • getAttributes
    • updateAttribute
• Worklog
  • createWorklog
  • deleteWorklog
  • getWorklog
  • getWorklogs
  • updateWorklog
  • Search
    • getJiraWorklogIdsByTempoWorklogIds
    • getWorklogsByAccount
    • getWorklogsByIssueId
    • getWorklogsByProjectId
    • getWorklogsByTeam
    • getWorklogsByUser
    • searchWorklogs
  • Work
    • createAttributeValues
    • getAttributeValue
    • getAttributeValues
    • searchAttributeValues

Constructing Managed API

In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:

import { TempoCloudApi } from '@managed-api/tempo-cloud-v4-sr-connect';

export default async function() {
    const api = new TempoCloudApi('API_CONNECTION_ID');
}

Contact

Feel free to drop ideas, suggestions or improvements into our Slack community channel.

Changelog

2.0.0

• Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

0.16.0

Changes

• Updated OpenApi Specification

• Field issueId was removed from Worklog.updateWorklog.

• Changed the previous Plan.getPlans method to Plan.searchPlans.

Added support for the following Plan method:

• Retrieve Plans that can be used as Plan.getPlans or All.getPlans.

Added support for the following Worklog.Work method:

• Search Work Attribute values that can be used as Worklog.Work.searchAttributeValues or All.searchWorkAttributeValuesForWorklogs.

0.12.0

Changed response type for the following Account methods:

• Retrieve Accounts that can be used as Account.getAccounts or All.getAccounts.

0.11.0

Added support for the following Account methods:

• Retrieve Account links that can be used as Account.getLinks or All.getLinks.

Added support for the following Account.Category methods:

• Retrieve Category / Retrieve all Categories that can be used as Account.Category.getAllCategoriesOrCategoryById or All.getAllCategoriesOrCategoryById.
• Create Category that can be used as Account.Category.createCategory or All.createCategory.
• Delete Category that can be used as Account.Category.deleteCategory or All.deleteCategory.
• Retrieve Category that can be used as Account.Category.getCategoryByKey or All.getCategoryByKey.
• Update Category that can be used as Account.Category.updateCategory or All.updateCategory.

Added support for the following Account.Category.Type methods:

• Retrieve Category Types that can be used as Account.Category.Type.getTypes or All.getCategoryTypes.

Added support for the following Account.Link methods:

• Create Account Link that can be used as Account.Link.createLink or All.createAccountLink.
• Retrieve Account Link by Project that can be used as Account.Link.getLinkByProject or All.getAccountLinkByProject.
• Delete Account Link that can be used as Account.Link.deleteLink or All.deleteAccountLink.
• Retrieve Account Link that can be used as Account.Link.getLinkById or All.getAccountLinkById.

Added support for the following Customer methods:

• Retrieve all Customers that can be used as Customer.getCustomers or All.getCustomers.
• Create Customer that can be used as Customer.createCustomer or All.createCustomer.
• Retrieve Customer that can be used as Customer.getCustomer or All.getCustomer.
• Retrieve Accounts associated with the Customer that can be used as Customer.getAccountsByCustomer or All.getAccountsByCustomer.
• Delete Customer that can be used as Customer.deleteCustomer or All.deleteCustomer.
• Update Customer that can be used as Customer.updateCustomer or All.updateCustomer.

0.10.0

Changed response type for the following Work.Attribute methods:

• Retrieve Attributes that can be used as Work.Attribute.getAttributes or All.getWorkAttributes.

0.9.0

Added support for the following Account methods:

• Create Account that can be used as Account.createAccount or All.createAccount.
• Delete Account that can be used as Account.deleteAccount or All.deleteAccount.
• Update Account that can be used as Account.updateAccount or All.updateAccount.

Added support for the following Work.Attribute methods:

• Retrieve Attributes that can be used as Work.Attribute.getAttributes or All.getWorkAttributes.
• Create Attribute that can be used as Work.Attribute.createAttribute or All.createWorkAttribute.
• Delete Attribute that can be used as Work.Attribute.deleteAttribute or All.deleteWorkAttribute.
• Retrieve Attribute that can be used as Work.Attribute.getAttribute or All.getWorkAttribute.
• Update Attribute that can be used as Work.Attribute.updateAttribute or All.updateWorkAttribute.

0.8.0

Added support for the following Account methods:

• Retrieve Accounts that can be used as Account.getAccounts or All.getAccounts.
• Search Accounts that can be used as Account.searchAccounts or All.searchAccounts.
• Retrieve Account that can be used as Account.getAccountById or All.getAccountById.

Added support for the following GenericResource methods:

• Search Generic Resources that can be used as GenericResource.searchGenericResources or All.searchGenericResources.
• Retrieve Generic Resources that can be used as GenericResource.getGenericResource or All.getGenericResource.

Added support for the following Plan methods:

• Create Plan that can be used as Plan.createPlan or All.createPlan.
• Retrieve Plans for Generic Resource that can be used as Plan.getPlansForGenericResource or All.getPlansForGenericResource.
• Search Plans that can be used as Plan.getPlans or All.getPlans.
• Retrieve Plans for User that can be used as Plan.getPlansForUser or All.getPlansForUser.
• Delete Plan that can be used as Plan.deletePlanById or All.deletePlanById.
• Retrieve Plan that can be used as Plan.getPlanById or All.getPlanById.
• Update Plan that can be used as Plan.updatePlan or All.updatePlan.

0.3.0

Removed support for the following methods:

• Worklog.Search.getWorklogsByFilterId or All.getWorklogsByFilterId.
• Worklog.getJiraWorklog or All.getJiraWorklog.

Added support for the following Worklog.Search method:

• Retrieve Jira Worklog Ids by Tempo Worklog Ids that can be used as Worklog.Search.getJiraWorklogIdsByTempoWorklogIds or All.getJiraWorklogIdsByTempoWorklogIds.

Fixed following methods:

• Search Worklogs associated to Issue Id that can be used as Worklog.Search.getWorklogsByIssueId or All.getWorklogsByIssueId.
• Retrieve Worklogs associated to project Id that can be used as Worklog.Search.getWorklogsByProjectId or All.getWorklogsByProjectId.

0.1.0

Added support for the following Worklog methods:

• Retrieve Worklogs that can be used as Worklog.getWorklogs or All.getWorklogs.
• Create Worklog that can be used as Worklog.createWorklog or All.createWorklog.
• Retrieve Worklog for Jira Worklog ID that can be used as Worklog.getJiraWorklog or All.getJiraWorklog.
• Delete Worklog that can be used as Worklog.deleteWorklog or All.deleteWorklog.
• Retrieve Worklog that can be used as Worklog.getWorklog or All.getWorklog.
• Update Worklog that can be used as Worklog.updateWorklog or All.updateWorklog.

Added support for the following Worklog.Search methods:

• Search Worklogs associated to Account that can be used as Worklog.Search.getWorklogsByAccount or All.getWorklogsByAccount.
• Search Worklogs associated to Issue that can be used as Worklog.Search.getWorklogsByJiraIssueIdOrKey or All.getWorklogsByJiraIssueIdOrKey.
• Search Worklogs associated to Jira filter ID that can be used as Worklog.Search.getWorklogsByFilterId or All.getWorklogsByFilterId.
• Search Worklogs associated to Project that can be used as Worklog.Search.getWorklogsByProject or All.getWorklogsByProject.
• Search Worklogs that can be used as Worklog.Search.searchWorklogs or All.searchWorklogs.
• Search Worklogs associated to Team that can be used as Worklog.Search.getWorklogsByTeam or All.getWorklogsByTeam.
• Search Worklogs associated to User that can be used as Worklog.Search.getWorklogsByUser or All.getWorklogsByUser.

Added support for the following Worklog.Work methods:

• Bulk create Work Attribute values for Worklogs that can be used as Worklog.Work.createAttributeValues or All.createWorkAttributeValuesForWorklogs.
• Retrieve Work Attribute values for Worklog that can be used as Worklog.Work.getAttributeValues or All.getWorkAttributeValuesForWorklog.
• Retrieve Work Attribute value for Worklog that can be used as Worklog.Work.getAttributeValue or All.getWorkAttributeValueForWorklog.

Copyright Adaptavist 2024 (c) All rights reserved