WiseTime Connect
Documentation Powered by ReDoc

WiseTime Connect API (1.2.3)

Download OpenAPI specification:Download

WiseTime Connect API Support: contact@wisetime.io URL: https://wisetime.io/docs/connect

Use the WiseTime Connect API to build connectors to your application.

Authentication

ConnectApiKeyAuth

See the Authentication documentation page for more details.

Security Scheme Type API Key
Header parameter name: x-api-key

Team Info

Retrieve information about the team

Authorizations:
ConnectApiKeyAuth

Responses

200

Successfully found the team info.

401

A valid API key is required to access this resource.

500

An unexpected error occured.

get/team/info
https://wisetime.io/connect/api/team/info

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "teamName": "string"
}

Tags

Create a new tag, or update the tag if it already exists

Authorizations:
ConnectApiKeyAuth
Request Body schema: application/json
name
string

Tag name to create. If a tag by this name already exists, the tag will be updated.

description
string

Displayed in the GUI and search functions. An empty (or null) description will be ignored, the description will remain with the previous value instead of replacing it.

excludeTagNameKeyword
boolean

The default behaviour when creating a tag is for the tagName to be added as a keyword for the tag. If excludeTagNameKeyword is set to true, the tagName will not be added as a keyword, unless it is explicitly defined in the additionalKeywords list of the request.

path
string

Path at which to create the tag. The path must start with a / and end with a / For example /myteam/inprotech/ Use / to create tag in root.

managedBy
string

Identifier of the resource that manages this tag. If blank or missing, the value will be defaulted to the connector's name.

metadata
object (TagMetadataSet)

You can assign metadata to a tag. You provide this information as a name-value (key-value) pair. The metadata names are case sensitive and will be displayed in reports, it is recommended the names be descriptive to clarify its meaning. In the case of providing any name-value where the name is already assigned as metadata to the tag, the value will be updated with value supplied. To delete/remove a name-value pair stored as metadata on a tag, you must use the tag-metadata-delete operation.

additionalKeywords
Array of strings

A tag is applied to a time row if one of its keywords matches text in the time row activity description. Keywords provided via this property will be added to the list of existing keywords for the tag. Existing keywords won't be removed.

url
string

If a URL is provided, the tag will be a clickable link in the WiseTime console. Clicking on the tag will open the URL.

Responses

200

Tag successfully created or updated.

400

Invalid request. Tag name is missing or path is invalid.

401

A valid API key is required to access this resource.

402

Number of tags plan limit exceeded.

500

An unexpected error occured.

post/tag
https://wisetime.io/connect/api/tag

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "excludeTagNameKeyword": true,
  • "path": "string",
  • "managedBy": "string",
  • "metadata":
    {
    },
  • "additionalKeywords":
    [
    ],
  • "url": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Create new tags, or update existing in batch (up to 2000 items at once)

Authorizations:
ConnectApiKeyAuth
Request Body schema: application/json
tags
Array of objects (UpsertTagRequest)

Responses

200

Tag successfully created or updated.

400

Invalid request. Tag name is missing or path is invalid.

401

A valid API key is required to access this resource.

402

Number of tags plan limit exceeded.

500

An unexpected error occured.

post/tag/batch
https://wisetime.io/connect/api/tag/batch

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tags":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errors":
    [
    ]
}

Delete an existing tag

Authorizations:
ConnectApiKeyAuth
Request Body schema: application/json
name
string

Tag name to delete.

Responses

200

Tag successfully updated.

400

Invalid request. Tag name is required.

401

A valid API key is required to access this resource.

404

Tag not found.

500

An unexpected error occured.

post/tag/delete
https://wisetime.io/connect/api/tag/delete

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Permanently deletes the specified metadata from an existing tag.

Provide the metadata names that you want to delete.

Authorizations:
ConnectApiKeyAuth
Request Body schema: application/json
tagName
required
string

The tag from which to delete the tag metadata.

metadataNames
required
Array of strings

The name(s) of the tag metadata to delete.

Responses

200

Fulfilled when metadata was deleted, not found or already deleted.

400

Invalid request. Tag name and metadata are required.

401

A valid API key is required to access this resource.

404

Metadata cannot be deleted since the requested tag does not exist.

500

An unexpected error occured.

post/tag/metadata/delete
https://wisetime.io/connect/api/tag/metadata/delete

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tagName": "string",
  • "metadataNames":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Add one or more keywords to an existing tag

Authorizations:
ConnectApiKeyAuth
Request Body schema: application/json
tagName
string

The tag to which to add the keywords.

additionalKeywords
Array of strings

One or more new keywords for the tag. Keywords provided via this property will be added to the list of existing keywords for the tag. Existing keywords won't be removed.

Responses

200

Keyword(s) successfully added.

400

Invalid request. Tag name and additional keywords are required.

401

A valid API key is required to access this resource.

404

Tag not found.

500

An unexpected error occured.

post/tag/keyword
https://wisetime.io/connect/api/tag/keyword

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tagName": "string",
  • "additionalKeywords":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Delete an existing keyword from a tag

Authorizations:
ConnectApiKeyAuth
Request Body schema: application/json
tagName
string

The tag from which to delete the keywords.

keyword
string

The keyword to delete.

Responses

200

Tag successfully deleted.

400

Invalid request. Tag name and keyword are required.

401

A valid API key is required to access this resource.

404

Tag or keyword not found.

500

An unexpected error occured.

post/tag/keyword/delete
https://wisetime.io/connect/api/tag/keyword/delete

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tagName": "string",
  • "keyword": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Posted Time

Returns posted time with pending status.

Use this endpoint to fetch posted time for processing. This is a long polling call (an alternative to using the webhook mechanism). The connection will be held open for a maximum of 60 seconds or until there is a new posted time event. When calling this method without first calling the /postedtime/registerfetchclient endpoint, recording posted time for fetching will implicitly be turned on.

Authorizations:
ConnectApiKeyAuth
query Parameters
limit
integer

Maximum amount of posted time entries to retrieve. If not set, the API will return up to a maximum of 25 entries for each request.

Responses

200

List of posted time events.

400

Invalid request. Limit cannot be smaller than 1.

401

A valid API key is required to access this resource.

409

This team has a registered posted time webhook. Switching to use fetch client is required.

500

An unexpected error occured.

get/postedtime
https://wisetime.io/connect/api/postedtime

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Register the intent to fetch time from the /postedtime endpoint.

WiseTime will start recording posted time events that can be fetched via the /postedtime endpoint.

Authorizations:
ConnectApiKeyAuth
Request Body schema: application/json

Responses

200

Fetch client successfully registered.

400

Invalid request. Callback URL is required.

401

A valid API key is required to access this resource.

409

This team already has a registered fetch client or webhook.

500

An unexpected error occured.

post/postedtime/registerfetchclient
https://wisetime.io/connect/api/postedtime/registerfetchclient

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Delete existing fetch client, unsubscribing your application from posted time fetching.

WiseTime will stop recording posted time events for fetch when users post time to your team.

Authorizations:
ConnectApiKeyAuth
Request Body schema: application/json

Responses

200

Fetch client successfully unregistered.

401

A valid API key is required to access this resource.

404

Fetch client not found.

409

This team has a registered posted time webhook. Switching to use fetch client is required.

500

An unexpected error occured.

post/postedtime/unregisterfetchclient
https://wisetime.io/connect/api/postedtime/unregisterfetchclient

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Updates the status of a received time group. Providing its success or failure to be processed.

This is intended for use with the fetch mechanism only. Not to be used with webhooks. If this endpoint isn't called for a time group within a certain amount of time after fetching it the time group will be made available again for fetching.

Authorizations:
ConnectApiKeyAuth
Request Body schema: application/json
timeGroupId
string

ID of the time group to be updated.

status
string
Enum: "SUCCESS" "FAILURE" "RETRIABLE_FAILURE"

This field describes the status of the posted time group. On SUCCESS the time group will be marked as successfully posted. On FAILURE the time group will be marked as failed and the attached message will displayed to the user. On RETRIABLE_FAILURE the time group will be marked as temporary failed and scheduled for retry. The attached message might be displayed to the user.

message
string

Reason for the failure, will be displayed to the user.

externalId
string

Reference in external system to time group.

Responses

200

Status of the time group was updated successfully.

400

Invalid request.

401

A valid API key is required to access this resource.

404

The time group/fetch client id pair was not found.

409

This team has a registered posted time webhook. Switching to use fetch client is required.

500

An unexpected error occured.

post/postedtime/status
https://w