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

Response samples

Content type
application/json
{
  • "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.

externalId
string

Identifier of the tag in the connected system. The external ID will be sent when time is posted with this tag, so that the posted time can be recorded against the relevant record in the connected system.

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

Request samples

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

Response samples

Content type
application/json
{ }

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

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

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete an existing tag

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

Tag name to delete.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{ }

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

Request samples

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

Response samples

Content type
application/json
{ }

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

Request samples

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

Response samples

Content type
application/json
{ }

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

Request samples

Content type
application/json
{
  • "tagName": "string",
  • "keyword": "string"
}

Response samples

Content type
application/json
{ }

Activity Type

Start activity types sync session

Initiates a sync session and responds with syncSessionId that can be used for further activity types uploads within the session. While activity types can be sent to WiseTime in batches without a sync session, starting a sync session for the batch uploads means that WiseTime will be able to detect activity types that are no longer in the connected system, and delete these when the sync session is completed by the connector.

Authorizations:
ConnectApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "syncSessionId": "string"
}