Tempo Ticket Management

This connector integrates Tempo Ticket Management with Swimlane Turbine to manage worklogs.

Prerequsite

The asset requires an URL and a token to interact with the API.

Capabilities

The connector has the following capabilities:

Create Worklogs

Delete Worklogs

Modify Worklogs

Retrieve Worklogs

Search Worklogs

Documentation

Here is the API Documentation link for the Connector Tempo Documentation

Configurations

Tempo Ticket Management Authentication

Authenticates using bearer token such as a JWT, etc.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
token	Token	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Create Worklogs

Creates a new Worklog using the provided input and returns the newly created Worklog.

Endpoint

URL: /worklogs

Method: POST

Input

Argument Name	Type	Required	Description
attributes	array	Optional	Array of objects (WorkAttributeValueInput) unique The list of work attribute of this Worklog.
attributes.key	string	Required	The key of the WorkAttributeValue.
attributes.value	string	Optional	The value of the WorkAttributeValue.
authorAccountId	string	Optional	The Account id of the user author.
billableSeconds	number	Optional	The amount of seconds billable.
description	string	Optional	The description of the Worklog.
issueId	number	Optional	The id of the issue associated to this worklog.
remainingEstimateSeconds	number	Optional	The total amount of estimated remaining seconds.
startDate	string	Optional	The start date of the Worklog.
startTime	string	Optional	The start time of the Worklog.
timeSpentSeconds	number	Optional	The total amount of time spent in seconds.

Input Example

{"json_body":{"attributes":[{"key":"_COLOR_","value":"green"}],"authorAccountId":"123456:01234567-89ab-cdef-0123-456789abcdef","billableSeconds":100201,"description":"Investigating a problem with our external database system.","issueId":124,"remainingEstimateSeconds":5,"startDate":"2019-08-24","startTime":"20:06:00","timeSpentSeconds":126}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
attributes	object	Output field: attributes
attributes.self	string	Output field: attributes.self
attributes.values	array	Value for the parameter
attributes.values.key	string	Value for the parameter
attributes.values.value	string	Value for the parameter
author	object	Output field: author
author.accountId	string	Unique identifier
author.self	string	Output field: author.self
billableSeconds	number	Output field: billableSeconds
createdAt	string	Output field: createdAt
description	string	Output field: description
issue	object	Output field: issue
issue.id	number	Unique identifier
issue.self	string	Output field: issue.self
self	string	Output field: self
startDate	string	Date value
startTime	string	Time value
tempoWorklogId	number	Unique identifier
timeSpentSeconds	number	Output field: timeSpentSeconds
updatedAt	string	Output field: updatedAt

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"attributes":{"self":"https://api.tempo.io/[...]","values":[]},"author":{"accountId":"123456:01234567-89ab-cdef-0123-456789abcdef","self":"https://api.tempo.io/[...]"},"billableSeconds":100201,"createdAt":"2017-02-06T16:41:41Z","description":"Investigating a problem with our external database system","issue":{"id":124,"self":"https://api.tempo.io/[...]"},"self":"https://api.tempo.io/[...]","startDate":"2019-08-24","startTime":"2...

Delete Worklogs

Deletes an existing Worklog for the given id

Endpoint

URL: /worklogs/{{id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.id	string	Required	Parameters for the Delete Worklogs action

Input Example

{"path_parameters":{"id":"id"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":204,"response_headers":{},"reason":"OK"}

Modify Worklogs

Updates an existing Worklog for the given id using the provided input and returns the updated Worklog

Endpoint

URL: /worklogs/{{id}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.id	string	Required	Parameters for the Modify Worklogs action
attributes	array	Optional	The list of work attribute of this Worklog
attributes.key	string	Required	The key of the WorkAttributeValue
attributes.value	string	Optional	The value of the WorkAttributeValue
authorAccountId	string	Optional	The Account id of the user author
billableSeconds	number	Optional	The amount of seconds billable
description	string	Optional	The description of the Worklog
remainingEstimateSeconds	number	Optional	The total amount of estimated remaining seconds
startDate	string	Optional	The start date of the Worklog
startTime	string	Optional	The start time of the Worklog
timeSpentSeconds	number	Optional	The total amount of time spent in seconds

Input Example

{"json_body":{"attributes":[{"key":"_COLOR_","value":"green"}],"authorAccountId":"1111aaaa2222bbbb3333cccc","billableSeconds":100201,"description":"Investigating a problem with our external database system","remainingEstimateSeconds":120,"startDate":"2019-08-24","startTime":"20:06:00","timeSpentSeconds":3600},"path_parameters":{"id":"id"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
attributes	array	Output field: attributes
author	object	Output field: author
author.accountId	string	Unique identifier
author.self	string	Output field: author.self
billableSeconds	number	Output field: billableSeconds
createdAt	string	Output field: createdAt
description	string	Output field: description
issue	object	Output field: issue
issue.id	number	Unique identifier
issue.self	string	Output field: issue.self
self	string	Output field: self
startDate	string	Date value
startTime	string	Time value
tempoWorklogId	number	Unique identifier
timeSpentSeconds	number	Output field: timeSpentSeconds
updatedAt	string	Output field: updatedAt

Output Example

Retrieve Worklogs

Retrieves a list of Worklogs that matches the given search parameters

Endpoint

URL: /worklogs

Method: GET

Input

Argument Name	Type	Required	Description
parameters.projectId	array	Optional	Retrieve only worklogs for the given project ids.
parameters.issueId	array	Optional	Retrieve only worklogs for the given issue ids.
parameters.from	string	Optional	Retrieve results starting with this date.
parameters.to	string	Optional	Retrieve results up to and including this date.
parameters.updatedFrom	string	Optional	Retrieve results that have been updated from this date(e.g"2023-11-16") or date time (e.g "2023-11-06T16:48:59Z").
parameters.offset	number	Optional	Skip over a number of elements by specifying an offset value for the query.
parameters.limit	number	Optional	Limit the number of elements on the response
parameters.orderBy	string	Optional	Order results by the specified field descending. If no order is specified, results will by default be ordered by START_DATE_TIME and ID ascending.

Input Example

{"parameters":{"projectId":[1001,1002],"issueId":[1001,1002],"from":"2017-02-06","to":"2017-02-08","updatedFrom":"2017-02-06T16:41:41Z","offset":0,"limit":50,"orderBy":"ID"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
metadata	object	Response data
metadata.count	number	Response data
metadata.limit	number	Response data
metadata.next	string	Response data
metadata.offset	number	Response data
metadata.previous	string	Response data
results	array	Result of the operation
results.attributes	object	Result of the operation
results.attributes.self	string	Result of the operation
results.attributes.values	array	Value for the parameter
results.attributes.values.key	string	Value for the parameter
results.attributes.values.value	string	Value for the parameter
results.author	object	Result of the operation
results.author.accountId	string	Unique identifier
results.author.self	string	Result of the operation
results.billableSeconds	number	Result of the operation
results.createdAt	string	Result of the operation
results.description	string	Result of the operation
results.issue	object	Result of the operation
results.issue.id	number	Unique identifier
results.issue.self	string	Result of the operation
results.self	string	Result of the operation
results.startDate	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"metadata":{"count":1,"limit":50,"next":"https://api.tempo.io/[...]","offset":0,"previous":"https://api.tempo.io/[...]"},"results":[{}],"self":"https://api.tempo.io/[...]"}}

Search Worklogs

Retrieves a list of existing Worklogs that matches the given search parameters.

Endpoint

URL: worklogs/search

Method: POST

Input

Argument Name	Type	Required	Description
parameters.offset	number	Optional	Parameters for the Search Worklogs action
parameters.limit	number	Optional	Parameters for the Search Worklogs action
authorIds	array	Optional	Ids of the authors you want to search worklogs for.
from	string	Optional	Retrieve worklogs starting with this date.
issueIds	array	Optional	Ids of the issues you want to search worklogs for
orderBy	array	Optional	Order results by the specified criteria. If no order is specified, results will by default be ordered by START_DATE_TIME(ASC) and ID(ASC)
orderBy.field	string	Optional	Parameter for Search Worklogs
orderBy.order	string	Optional	Parameter for Search Worklogs
projectIds	array	Optional	Ids of the projects you want to search worklogs for
to	string	Optional	Retrieve worklogs that ends up to and including this date.
updatedFrom	string	Optional	Retrieve results that have been updated from this date(e.g "2023-11-16") or date time (e.g "2023-11-06T16:48:59Z")

Input Example

{"parameters":{"offset":0,"limit":50},"json_body":{"authorIds":["123456:01234567-89ab-cdef-0123-456789abcdef","123456:01234567-89ab-cdef-0123-456789abcdef"],"from":"2022-05-17","issueIds":["10000","100001"],"orderBy":[{"field":"ID","order":"ASC"}],"projectIds":["1","2"],"to":"2022-05-17","updatedFrom":"2022-05-17T01:06:01Z"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
metadata	object	Response data
metadata.count	number	Response data
metadata.limit	number	Response data
metadata.next	string	Response data
metadata.offset	number	Response data
metadata.previous	string	Response data
results	array	Result of the operation
results.attributes	object	Result of the operation
results.attributes.self	string	Result of the operation
results.attributes.values	array	Value for the parameter
results.attributes.values.key	string	Value for the parameter
results.attributes.values.value	string	Value for the parameter
results.author	object	Result of the operation
results.author.accountId	string	Unique identifier
results.author.self	string	Result of the operation
results.billableSeconds	number	Result of the operation
results.createdAt	string	Result of the operation
results.description	string	Result of the operation
results.issue	object	Result of the operation
results.issue.id	number	Unique identifier
results.issue.self	string	Result of the operation
results.self	string	Result of the operation
results.startDate	string	Result of the operation

Output Example

Response Headers

Header	Description	Example
Content-Type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Thu, 01 Jan 2024 00:00:00 GMT