HTTP status code 200

Account has been successfully created

Body

Media type: application/json

Type: object

• self: required (string)
• key: required (string)
• id: required (integer)
• name: required (string)
• status: required (one of OPEN, CLOSED, ARCHIVED)
• global: required (boolean - default: false)
• monthlyBudget: (integer)
• lead: required (lead)
  • self: (string)
  • accountId: required (string)
  • displayName: (string)
• contact: (contact)
  • self: (string)
  • accountId: (string)
  • displayName: required (string)
  • type: required (one of USER, EXTERNAL)

    Indicates if the user is a registered Jira user (USER) or not (EXTERNAL)

• category: (category)
  • self: required (string)
  • key: required (string)
  • id: required (integer)
  • name: required (string)
  • type: required (type)
    • name: required (string)
• customer: (customer)
  • self: required (string)
  • key: required (string)
  • id: required (integer)
  • name: required (string)
• links: required (links)
  • self: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT",
  "key": "CLOUDBAY_DEVELOPMENT",
  "id": 7,
  "name": "Cloudbay: Development",
  "status": "OPEN",
  "global": false,
  "monthlyBudget": 600,
  "lead": {
    "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
    "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
    "displayName": "Erica Jefferson"
  },
  "contact": {
    "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
    "accountId": "1111aaaa2222bbbb3333cccc",
    "displayName": "John Brown",
    "type": "USER"
  },
  "category": {
    "self": "https://api.tempo.io/core/3/account-categories/development",
    "key": "development",
    "id": 14,
    "name": "Development",
    "type": {
      "name": "BILLABLE"
    }
  },
  "customer": {
    "self": "https://api.tempo.io/core/3/customers/cloudbay",
    "key": "cloudbay",
    "id": 234,
    "name": "CloudBay"
  },
  "links": {
    "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT/links"
  }
}

HTTP status code 400

Account cannot be created for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Account with this key already exists"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

List accounts

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
• results: required (array of Account)

  Items: Account

  • self: required (string)
  • key: required (string)
  • id: required (integer)
  • name: required (string)
  • status: required (one of OPEN, CLOSED, ARCHIVED)
  • global: required (boolean - default: false)
  • monthlyBudget: (integer)
  • lead: required (lead)
    • self: (string)
    • accountId: required (string)
    • displayName: (string)
  • contact: (contact)
    • self: (string)
    • accountId: (string)
    • displayName: required (string)
    • type: required (one of USER, EXTERNAL)

      Indicates if the user is a registered Jira user (USER) or not (EXTERNAL)

  • category: (category)
    • self: required (string)
    • key: required (string)
    • id: required (integer)
    • name: required (string)
    • type: required (type)
      • name: required (string)
  • customer: (customer)
    • self: required (string)
    • key: required (string)
    • id: required (integer)
    • name: required (string)
  • links: required (links)
    • self: required (string)

Examples:

{
  "self": "https://api.tempo.io/core/3/accounts",
  "metadata": {
    "count": 2
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT",
      "key": "CLOUDBAY_DEVELOPMENT",
      "id": 7,
      "name": "Cloudbay: Development",
      "status": "OPEN",
      "global": false,
      "monthlyBudget": 600,
      "lead": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
        "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
        "displayName": "Erica Jefferson"
      },
      "contact": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
        "accountId": "1111aaaa2222bbbb3333cccc",
        "displayName": "John Brown",
        "type": "USER"
      },
      "category": {
        "self": "https://api.tempo.io/core/3/account-categories/300",
        "key": "300",
        "id": 14,
        "name": "Development",
        "type": {
          "name": "BILLABLE"
        }
      },
      "customer": {
        "self": "https://api.tempo.io/core/3/customers/100201",
        "key": "100201",
        "id": 234,
        "name": "CloudBay"
      },
      "links": {
        "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT/links"
      }
    },
    {
      "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_CAPEX",
      "key": "CLOUDBAY_CAPEX",
      "id": 8,
      "name": "Cloudbay: Capex",
      "status": "CLOSED",
      "global": false,
      "lead": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
        "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
        "displayName": "Erica Jefferson"
      },
      "links": {
        "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_CAPEX/links"
      }
    }
  ]
}

{
  "self": "https://api.tempo.io/core/3/accounts?status=OPEN",
  "metadata": {
    "count": 2
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT",
      "key": "CLOUDBAY_DEVELOPMENT",
      "id": 7,
      "name": "Cloudbay: Development",
      "status": "OPEN",
      "global": false,
      "monthlyBudget": 600,
      "lead": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
        "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
        "displayName": "Erica Jefferson"
      },
      "contact": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
        "accountId": "1111aaaa2222bbbb3333cccc",
        "displayName": "John Brown",
        "type": "USER"
      },
      "category": {
        "self": "https://api.tempo.io/core/3/account-categories/300",
        "key": "300",
        "id": 14,
        "name": "Development",
        "type": {
          "name": "BILLABLE"
        }
      },
      "customer": {
        "self": "https://api.tempo.io/core/3/customers/100201",
        "key": "100201",
        "id": 234,
        "name": "CloudBay"
      },
      "links": {
        "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT/links"
      }
    },
    {
      "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_CAPEX",
      "key": "CLOUDBAY_CAPEX",
      "id": 8,
      "name": "Cloudbay: Capex",
      "status": "OPEN",
      "global": false,
      "lead": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
        "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
        "displayName": "Erica Jefferson"
      },
      "contact": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
        "accountId": "1111aaaa2222bbbb3333cccc",
        "displayName": "John Brown",
        "type": "USER"
      },
      "category": {
        "self": "https://api.tempo.io/core/3/account-categories/300",
        "key": "300",
        "id": 14,
        "name": "Development",
        "type": {
          "name": "BILLABLE"
        }
      },
      "customer": {
        "self": "https://api.tempo.io/core/3/customers/100201",
        "key": "100201",
        "id": 234,
        "name": "CloudBay"
      },
      "links": {
        "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_CAPEX/links"
      }
    }
  ]
}

{
  "self": "https://api.tempo.io/core/3/accounts?id=123",
  "metadata": {
    "count": 1
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT",
      "key": "CLOUDBAY_DEVELOPMENT",
      "id": 7,
      "name": "Cloudbay: Development",
      "status": "OPEN",
      "global": false,
      "monthlyBudget": 600,
      "lead": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
        "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
        "displayName": "Erica Jefferson"
      },
      "contact": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
        "accountId": "1111aaaa2222bbbb3333cccc",
        "displayName": "John Brown",
        "type": "USER"
      },
      "category": {
        "self": "https://api.tempo.io/core/3/account-categories/300",
        "key": "300",
        "id": 14,
        "name": "Development",
        "type": {
          "name": "BILLABLE"
        }
      },
      "customer": {
        "self": "https://api.tempo.io/core/3/customers/100201",
        "key": "100201",
        "id": 234,
        "name": "CloudBay"
      },
      "links": {
        "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT/links"
      }
    }
  ]
}

HTTP status code 400

The query is not valid for some reason

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Id cannot be combined with other parameters"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Account data of the given key

Body

Media type: application/json

Type: object

• self: required (string)
• key: required (string)
• id: required (integer)
• name: required (string)
• status: required (one of OPEN, CLOSED, ARCHIVED)
• global: required (boolean - default: false)
• monthlyBudget: (integer)
• lead: required (lead)
  • self: (string)
  • accountId: required (string)
  • displayName: (string)
• contact: (contact)
  • self: (string)
  • accountId: (string)
  • displayName: required (string)
  • type: required (one of USER, EXTERNAL)

    Indicates if the user is a registered Jira user (USER) or not (EXTERNAL)

• category: (category)
  • self: required (string)
  • key: required (string)
  • id: required (integer)
  • name: required (string)
  • type: required (type)
    • name: required (string)
• customer: (customer)
  • self: required (string)
  • key: required (string)
  • id: required (integer)
  • name: required (string)
• links: required (links)
  • self: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT",
  "key": "CLOUDBAY_DEVELOPMENT",
  "id": 7,
  "name": "Cloudbay: Development",
  "status": "OPEN",
  "global": false,
  "monthlyBudget": 600,
  "lead": {
    "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
    "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
    "displayName": "Erica Jefferson"
  },
  "contact": {
    "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
    "accountId": "1111aaaa2222bbbb3333cccc",
    "displayName": "John Brown",
    "type": "USER"
  },
  "category": {
    "self": "https://api.tempo.io/core/3/account-categories/development",
    "key": "development",
    "id": 14,
    "name": "Development",
    "type": {
      "name": "BILLABLE"
    }
  },
  "customer": {
    "self": "https://api.tempo.io/core/3/customers/cloudbay",
    "key": "cloudbay",
    "id": 234,
    "name": "CloudBay"
  },
  "links": {
    "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT/links"
  }
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Account cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Account not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Account has been successfully updated

Body

Media type: application/json

Type: object

• self: required (string)
• key: required (string)
• id: required (integer)
• name: required (string)
• status: required (one of OPEN, CLOSED, ARCHIVED)
• global: required (boolean - default: false)
• monthlyBudget: (integer)
• lead: required (lead)
  • self: (string)
  • accountId: required (string)
  • displayName: (string)
• contact: (contact)
  • self: (string)
  • accountId: (string)
  • displayName: required (string)
  • type: required (one of USER, EXTERNAL)

    Indicates if the user is a registered Jira user (USER) or not (EXTERNAL)

• category: (category)
  • self: required (string)
  • key: required (string)
  • id: required (integer)
  • name: required (string)
  • type: required (type)
    • name: required (string)
• customer: (customer)
  • self: required (string)
  • key: required (string)
  • id: required (integer)
  • name: required (string)
• links: required (links)
  • self: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT",
  "key": "CLOUDBAY_DEVELOPMENT",
  "id": 7,
  "name": "Cloudbay: Development",
  "status": "OPEN",
  "global": false,
  "monthlyBudget": 600,
  "lead": {
    "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
    "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
    "displayName": "Erica Jefferson"
  },
  "contact": {
    "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
    "accountId": "1111aaaa2222bbbb3333cccc",
    "displayName": "John Brown",
    "type": "USER"
  },
  "category": {
    "self": "https://api.tempo.io/core/3/account-categories/development",
    "key": "development",
    "id": 14,
    "name": "Development",
    "type": {
      "name": "BILLABLE"
    }
  },
  "customer": {
    "self": "https://api.tempo.io/core/3/customers/cloudbay",
    "key": "cloudbay",
    "id": 234,
    "name": "CloudBay"
  },
  "links": {
    "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT/links"
  }
}

HTTP status code 400

Account cannot be updated for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Account with this key already exists"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Account cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Account not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 204

Account has been successfully deleted

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Account cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Account not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

List of all links for this account

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
• results: required (array of AccountLink)

  Items: AccountLink

  • self: required (string)
  • id: required (number)
  • scope: required (scope)
    • self: required (string)
    • id: required (number)
    • type: required (PROJECT)
  • account: required (account)
    • self: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT/links",
  "metadata": {
    "count": 1
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/account-links/1",
      "id": 1,
      "scope": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/project/PRJ-1",
        "id": 100100,
        "type": "PROJECT"
      },
      "account": {
        "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT"
      }
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Account cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Account not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Category has been successfully created

Body

Media type: application/json

Type: object

• self: required (string)
• key: required (string)
• id: required (integer)
• name: required (string)
• type: required (type)
  • name: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/account-categories/CLOUDBAY_DEVELOPMENT",
  "key": "CLOUDBAY_DEVELOPMENT",
  "id": 14,
  "name": "Cloudbay: Development",
  "type": {
    "name": "BILLABLE"
  }
}

HTTP status code 400

Category cannot be created for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Category with this key already exists"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

List of all categories

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
• results: required (array of Category)

  Items: Category

  • self: required (string)
  • key: required (string)
  • id: required (integer)
  • name: required (string)
  • type: required (type)
    • name: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/account-categories",
  "metadata": {
    "count": 1
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/account-categories/300",
      "key": "300",
      "id": 14,
      "name": "Development",
      "type": {
        "name": "BILLABLE"
      }
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Category data of the given key

Body

Media type: application/json

Type: object

• self: required (string)
• key: required (string)
• id: required (integer)
• name: required (string)
• type: required (type)
  • name: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/account-categories/CLOUDBAY_DEVELOPMENT",
  "key": "CLOUDBAY_DEVELOPMENT",
  "id": 14,
  "name": "Cloudbay: Development",
  "type": {
    "name": "BILLABLE"
  }
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Category cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Invalid category key"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Category has been successfully updated

Body

Media type: application/json

Type: object

• self: required (string)
• key: required (string)
• id: required (integer)
• name: required (string)
• type: required (type)
  • name: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/account-categories/CLOUDBAY_DEVELOPMENT",
  "key": "CLOUDBAY_DEVELOPMENT",
  "id": 14,
  "name": "Cloudbay: Development",
  "type": {
    "name": "BILLABLE"
  }
}

HTTP status code 400

Category cannot be updated for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Category with this key already exists"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Category cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Invalid category key"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 204

Category has been successfully deleted

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Category cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Invalid category key"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Account-link has been successfully-created

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (number)
• scope: required (scope)
  • self: required (string)
  • id: required (number)
  • type: required (PROJECT)
• account: required (account)
  • self: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/account-links/1",
  "id": 1,
  "scope": {
    "self": "https://my-cloud-instance.atlassian.net/rest/api/2/project/PRJ-1",
    "id": 100100,
    "type": "PROJECT"
  },
  "account": {
    "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT"
  }
}

HTTP status code 400

Account-link cannot be created for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Invalid account key"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Retrieve a account-link

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (number)
• scope: required (scope)
  • self: required (string)
  • id: required (number)
  • type: required (PROJECT)
• account: required (account)
  • self: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/account-links/1",
  "id": 1,
  "scope": {
    "self": "https://my-cloud-instance.atlassian.net/rest/api/2/project/PRJ-1",
    "id": 100100,
    "type": "PROJECT"
  },
  "account": {
    "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT"
  }
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Account-link cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Link not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 204

Account-link has been successfully deleted

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Account-link cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Link not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Retrieve account-links

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
• results: required (array of AccountLinkByScope)

  Items: AccountLinkByScope

  • self: required (string)
  • id: required (number)
  • scope: required (scope)
    • self: required (string)
  • account: required (account)
    • self: required (string)
    • key: required (string)
    • id: required (integer)
    • name: required (string)
    • status: required (one of OPEN, CLOSED, ARCHIVED)
    • global: required (boolean - default: false)
    • monthlyBudget: (integer)
    • lead: required (lead)
      • self: (string)
      • accountId: required (string)
      • displayName: (string)
    • contact: (contact)
      • self: (string)
      • accountId: (string)
      • displayName: required (string)
      • type: required (one of USER, EXTERNAL)

        Indicates if the user is a registered Jira user (USER) or not (EXTERNAL)

    • category: (category)
      • self: required (string)
      • key: required (string)
      • id: required (integer)
      • name: required (string)
      • type: required (type)
        • name: required (string)
    • customer: (customer)
      • self: required (string)
      • key: required (string)
      • id: required (integer)
      • name: required (string)
    • links: required (links)
      • self: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/account-links/project/PROJ-1",
  "metadata": {
    "count": 2
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/account-links/1",
      "id": 1,
      "scope": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/project/PROJ-1"
      },
      "account": {
        "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT",
        "key": "CLOUDBAY_DEVELOPMENT",
        "id": 7,
        "name": "Cloudbay: Development",
        "status": "OPEN",
        "global": false,
        "monthlyBudget": 600,
        "lead": {
          "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
          "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
          "displayName": "Erica Jefferson"
        },
        "contact": {
          "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
          "accountId": "1111aaaa2222bbbb3333cccc",
          "displayName": "John Brown",
          "type": "USER"
        },
        "category": {
          "self": "https://api.tempo.io/core/3/account-categories/300",
          "key": "300",
          "id": 14,
          "name": "Development",
          "type": {
            "name": "BILLABLE"
          }
        },
        "customer": {
          "self": "https://api.tempo.io/core/3/customers/100201",
          "key": "100201",
          "id": 234,
          "name": "CloudBay"
        },
        "links": {
          "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT/links"
        }
      }
    },
    {
      "self": "https://api.tempo.io/core/3/account-links/2",
      "id": 2,
      "scope": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/project/PROJ-1"
      },
      "account": {
        "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_CAPEX",
        "key": "CLOUDBAY_CAPEX",
        "id": 8,
        "name": "Cloudbay: Capex",
        "status": "OPEN",
        "global": false,
        "lead": {
          "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
          "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
          "displayName": "Erica Jefferson"
        },
        "links": {
          "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_CAPEX/links"
        }
      }
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Customer has been successfully created

Body

Media type: application/json

Type: object

• self: required (string)
• key: required (string)
• id: required (integer)
• name: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/customers/CLOUDBAY_DEVELOPMENT",
  "key": "CLOUDBAY_DEVELOPMENT",
  "id": 234,
  "name": "GreenCloud"
}

HTTP status code 400

Customer cannot be created for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Customer with this key already exists"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

List of all customers

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
• results: required (array of Customer)

  Items: Customer

  • self: required (string)
  • key: required (string)
  • id: required (integer)
  • name: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/customers",
  "metadata": {
    "count": 1
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/customers/GreenCloud",
      "key": "GreenCloud",
      "id": 234,
      "name": "GreenCloud"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Customer data of the given key

Body

Media type: application/json

Type: object

• self: required (string)
• key: required (string)
• id: required (integer)
• name: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/customers/CLOUDBAY_DEVELOPMENT",
  "key": "CLOUDBAY_DEVELOPMENT",
  "id": 234,
  "name": "GreenCloud"
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Customer cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Invalid customer key"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Customer has been successfully updated

Body

Media type: application/json

Type: object

• self: required (string)
• key: required (string)
• id: required (integer)
• name: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/customers/CLOUDBAY_DEVELOPMENT",
  "key": "CLOUDBAY_DEVELOPMENT",
  "id": 234,
  "name": "GreenCloud"
}

HTTP status code 400

Customer cannot be updated for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Customer with this key already exists"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Customer cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Invalid customer key"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 204

Customer has been successfully deleted

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Customer cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Invalid customer key"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

A list of accounts

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
• results: required (array of Account)

  Items: Account

  • self: required (string)
  • key: required (string)
  • id: required (integer)
  • name: required (string)
  • status: required (one of OPEN, CLOSED, ARCHIVED)
  • global: required (boolean - default: false)
  • monthlyBudget: (integer)
  • lead: required (lead)
    • self: (string)
    • accountId: required (string)
    • displayName: (string)
  • contact: (contact)
    • self: (string)
    • accountId: (string)
    • displayName: required (string)
    • type: required (one of USER, EXTERNAL)

      Indicates if the user is a registered Jira user (USER) or not (EXTERNAL)

  • category: (category)
    • self: required (string)
    • key: required (string)
    • id: required (integer)
    • name: required (string)
    • type: required (type)
      • name: required (string)
  • customer: (customer)
    • self: required (string)
    • key: required (string)
    • id: required (integer)
    • name: required (string)
  • links: required (links)
    • self: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/customers/CLOUDBAY/accounts",
  "metadata": {
    "count": 2
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT",
      "key": "CLOUDBAY_DEVELOPMENT",
      "id": 7,
      "name": "Cloudbay: Development",
      "status": "OPEN",
      "global": false,
      "monthlyBudget": 600,
      "lead": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
        "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
        "displayName": "Erica Jefferson"
      },
      "contact": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
        "accountId": "1111aaaa2222bbbb3333cccc",
        "displayName": "John Brown",
        "type": "USER"
      },
      "category": {
        "self": "https://api.tempo.io/core/3/account-categories/300",
        "key": "300",
        "id": 14,
        "name": "Development",
        "type": {
          "name": "BILLABLE"
        }
      },
      "customer": {
        "self": "https://api.tempo.io/core/3/customers/CLOUDBAY",
        "key": "CLOUDBAY",
        "id": 234,
        "name": "CloudBay"
      },
      "links": {
        "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_DEVELOPMENT/links"
      }
    },
    {
      "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_CAPEX",
      "key": "CLOUDBAY_CAPEX",
      "id": 8,
      "name": "Cloudbay: Capex",
      "status": "ARCHIVED",
      "global": true,
      "lead": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=123456:01234567-89ab-cdef-0123-456789abcdef",
        "accountId": "123456:01234567-89ab-cdef-0123-456789abcdef",
        "displayName": "Erica Jefferson"
      },
      "customer": {
        "self": "https://api.tempo.io/core/3/customers/CLOUDBAY",
        "key": "CLOUDBAY",
        "id": 234,
        "name": "CloudBay"
      },
      "links": {
        "self": "https://api.tempo.io/core/3/accounts/CLOUDBAY_CAPEX/links"
      }
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Customer cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Invalid customer key"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Generic resource has been successfully created

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• createdAt: required (datetime)
• createdBy: required (createdBy)
  • self: required (string)
  • accountId: required (string)
• updatedAt: required (datetime)
• updatedBy: required (updatedBy)
  • self: required (string)
  • accountId: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/generic-resources/5",
  "id": 5,
  "name": "Frontend dev",
  "createdAt": "2022-02-22T15:09:00Z",
  "createdBy": {
    "self": "https://test.atlassian.net/rest/api/2/user?accountId=jira-account-id",
    "accountId": "jira-account-id"
  },
  "updatedAt": "2022-02-22T15:09:00Z",
  "updatedBy": {
    "self": "https://test.atlassian.net/rest/api/2/user?accountId=jira-account-id",
    "accountId": "jira-account-id"
  }
}

HTTP status code 400

Generic resource cannot be created for some reason

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "A generic resource already exists with this name."
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Generic resource with the given id

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• createdAt: required (datetime)
• createdBy: required (createdBy)
  • self: required (string)
  • accountId: required (string)
• updatedAt: required (datetime)
• updatedBy: required (updatedBy)
  • self: required (string)
  • accountId: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/generic-resources/5",
  "id": 5,
  "name": "Frontend dev",
  "createdAt": "2022-02-22T15:09:00Z",
  "createdBy": {
    "self": "https://test.atlassian.net/rest/api/2/user?accountId=jira-account-id",
    "accountId": "jira-account-id"
  },
  "updatedAt": "2022-02-22T15:09:00Z",
  "updatedBy": {
    "self": "https://test.atlassian.net/rest/api/2/user?accountId=jira-account-id",
    "accountId": "jira-account-id"
  }
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 404

Generic resource cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Generic resource was not found."
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Generic resource has been updated successfully

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• createdAt: required (datetime)
• createdBy: required (createdBy)
  • self: required (string)
  • accountId: required (string)
• updatedAt: required (datetime)
• updatedBy: required (updatedBy)
  • self: required (string)
  • accountId: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/generic-resources/6",
  "id": 6,
  "name": "Backend dev",
  "createdAt": "2022-02-23T15:07:00Z",
  "createdBy": {
    "self": "https://test.atlassian.net/rest/api/2/user?accountId=creator-jira-account-id",
    "accountId": "creator-jira-account-id"
  },
  "updatedAt": "2022-02-28T17:08:00Z",
  "updatedBy": {
    "self": "https://test.atlassian.net/rest/api/2/user?accountId=current-user-jira-account-id",
    "accountId": "current-user-jira-account-id"
  }
}

HTTP status code 400

Generic resource cannot be updated for some reason

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "A generic resource already exists with this name."
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Generic resource cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Generic resource was not found."
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 204

Generic resource has been successfully deleted

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
  • searchBody: required (searchBody)
    • offset: (integer - default: 0)
    • limit: (integer - default: 50)
    • ids: (array of )
    • query: (string)

      A string to match against Generic Resource name.

• results: required (array of Generic Resource)

  Items: Generic Resource

  • self: required (string)
  • id: required (integer)
  • name: required (string)
  • createdAt: required (datetime)
  • createdBy: required (createdBy)
    • self: required (string)
    • accountId: required (string)
  • updatedAt: required (datetime)
  • updatedBy: required (updatedBy)
    • self: required (string)
    • accountId: required (string)

Example:

{
  "self": "https://api.tempo.io/core/3/generic-resources/search",
  "metadata": {
    "count": 2,
    "searchBody": {
      "offset": 0,
      "limit": 50,
      "ids": [3, 4, 5, 6],
      "query": "dev"
    }
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/generic-resources/6",
      "id": 5,
      "name": "Frontend dev",
      "createdAt": "2022-02-22T15:09:00Z",
      "createdBy": {
        "self": "https://test.atlassian.net/rest/api/2/user?accountId=jira-account-id",
        "accountId": "jira-account-id"
      },
      "updatedAt": "2022-02-22T15:09:00Z",
      "updatedBy": {
        "self": "https://test.atlassian.net/rest/api/2/user?accountId=jira-account-id",
        "accountId": "jira-account-id"
      }
    },
    {
      "self": "https://api.tempo.io/core/3/generic-resources/6",
      "id": 6,
      "name": "Backend dev",
      "createdAt": "2022-02-23T15:07:00Z",
      "createdBy": {
        "self": "https://test.atlassian.net/rest/api/2/user?accountId=creator-jira-account-id",
        "accountId": "creator-jira-account-id"
      },
      "updatedAt": "2022-02-28T17:08:00Z",
      "updatedBy": {
        "self": "https://test.atlassian.net/rest/api/2/user?accountId=current-user-jira-account-id",
        "accountId": "current-user-jira-account-id"
      }
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Holiday scheme data of the scheme that was created

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• description: (string)
• defaultScheme: required (boolean)
• memberCount: required (number)

HTTP status code 400

Holiday scheme cannot be created for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "You must specify a scheme name"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Holiday scheme data of the scheme that matches the provided id

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• description: (string)
• defaultScheme: required (boolean)
• memberCount: required (number)

Example:

{
  "self": "https://api.tempo.io/core/3/holiday-schemes/123",
  "id": 123,
  "name": "Default Holiday Scheme",
  "description": "Employees are part of this scheme by default",
  "defaultScheme": true,
  "memberCount": 33
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday scheme cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Holiday scheme not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Holiday scheme has been successfully updated

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• description: (string)
• defaultScheme: required (boolean)
• memberCount: required (number)

HTTP status code 400

Holiday scheme cannot be updated for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "You must specify a scheme name"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday scheme cannot be found in the system

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 204

Holiday scheme been successfully deleted

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday scheme cannot be found in the system

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

The Holiday scheme has been successfully set as default

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• description: (string)
• defaultScheme: required (boolean)
• memberCount: required (number)

Example:

{
  "self": "https://api.tempo.io/core/3/holiday-schemes/123",
  "id": 123,
  "name": "Default Holiday Scheme",
  "description": "Employees are part of this scheme by default",
  "defaultScheme": true,
  "memberCount": 33
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday scheme cannot be found in the system

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Holiday data of the scheme that matches the provided id and year

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
• results: required (array of Holiday)

  Items: Holiday

  • name: required (string)
  • description: (string)
  • durationSeconds: required (number)

Example:

{
  "self": "https://api.tempo.io/core/3/holiday-schemes/123/holidays?year=2021",
  "metadata": {
    "count": 2
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/holidays/1",
      "id": 1,
      "schemeId": 1,
      "type": "FIXED",
      "name": "Company Day",
      "description": "Go and have some fun",
      "durationSeconds": 28800,
      "date": "2021-02-24"
    },
    {
      "self": "https://api.tempo.io/core/3/holidays/2",
      "id": 2,
      "schemeId": 1,
      "type": "FLOATING",
      "name": "Christmas Eve",
      "description": "The day before Christmas",
      "durationSeconds": 14400,
      "date": "2021-12-24"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday scheme cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Holiday scheme not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Holiday data that was created

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (number)
• schemeId: required (number)
• type: required (one of FIXED, FLOATING)
• name: required (string)
• description: (string)
• durationSeconds: required (number)
• date: required (date-only)

Example:

{
  "self": "https://api.tempo.io/core/3/holidays/1",
  "id": 1,
  "schemeId": 1,
  "type": "FIXED",
  "name": "Christmas Eve",
  "description": "The day before Christmas",
  "durationSeconds": 14400,
  "date": "2021-12-24"
}

HTTP status code 400

Holiday cannot be created for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "You must specify a holiday name"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Holiday data that matches the provided id

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (number)
• schemeId: required (number)
• type: required (one of FIXED, FLOATING)
• name: required (string)
• description: (string)
• durationSeconds: required (number)
• date: required (date-only)

Example:

{
  "self": "https://api.tempo.io/core/3/holidays/1",
  "id": 1,
  "schemeId": 1,
  "type": "FIXED",
  "name": "Christmas Eve",
  "description": "The day before Christmas",
  "durationSeconds": 14400,
  "date": "2021-12-24"
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Holiday not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Holiday has been successfully updated

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (number)
• schemeId: required (number)
• type: required (one of FIXED, FLOATING)
• name: required (string)
• description: (string)
• durationSeconds: required (number)
• date: required (date-only)

HTTP status code 400

Holiday cannot be updated for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "You must specify a holiday name"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday cannot be found in the system

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 204

Holiday been successfully deleted

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday cannot be found in the system

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Floating Holiday data of the scheme

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
• results: required (array of Holiday)

  Items: Holiday

  • name: required (string)
  • description: (string)
  • durationSeconds: required (number)

Example:

{
  "self": "https://api.tempo.io/core/3/holiday-schemes/4/holidays/floating",
  "metadata": {
    "count": 2
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/holiday-schemes/4/holidays/9",
      "id": 9,
      "schemeId": 4,
      "type": "FLOATING",
      "name": "Awesome day",
      "description": "what an awesome day",
      "durationSeconds": 86400,
      "date": "2015-09-01"
    },
    {
      "self": "https://api.tempo.io/core/3/holiday-schemes/4/holidays/3",
      "id": 3,
      "schemeId": 4,
      "type": "FLOATING",
      "name": "Labour Day",
      "description": "Labour day",
      "durationSeconds": 86400,
      "date": "2021-04-30"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday scheme cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Holiday scheme not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Members in the holiday scheme

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
• results: required (array of Holiday scheme)

  Items: Holiday scheme

  • self: required (string)
  • id: required (integer)
  • name: required (string)
  • description: (string)
  • defaultScheme: required (boolean)
  • memberCount: required (number)

Example:

{
  "self": "https://api.tempo.io/core/3/holiday-schemes/1/members&offset=0&limit=50",
  "metadata": {
    "count": 18,
    "offset": 0,
    "limit": 50
  },
  "results": [
    // skipped
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday scheme cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Holiday scheme not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 204

Users have been successfully added to the holiday scheme

HTTP status code 400

Holiday scheme membershop cannot be updated for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "User is invalid"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Holiday scheme cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Holiday scheme not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

The user holiday scheme

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• description: (string)
• defaultScheme: required (boolean)
• memberCount: required (number)

Example:

{
  "self": "https://api.tempo.io/core/3/holiday-schemes/123",
  "id": 123,
  "name": "Default Holiday Scheme",
  "description": "Employees are part of this scheme by default",
  "defaultScheme": true,
  "memberCount": 33
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Body

Media type: application/json

Type: object

• periods: required (array of Period)

  Items: Period

  • from: required (date-only)
  • to: required (date-only)

Example:

{
  "periods": [
    {
      "from": "2017-12-01",
      "to": "2017-12-31"
    },
    {
      "from": "2018-01-01",
      "to": "2018-01-31"
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

List of permission roles

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
• results: required (array of Permission role)

  Items: Permission role

  • self: required (string)
  • id: required (integer)
  • name: required (string)
  • permissions: required (array of Permission role permission)

    Items: Permission role permission

    • key: required (string)

      Permission key.

  • permittedUsers: required (array of User)

    Items: User

    • self: (string)
    • accountId: required (string)
    • displayName: (string)
  • accessType: required (one of TEAM, GLOBAL)

    GLOBAL permission roles don't have entities.

  • accessEntities: required (array of Permission role entity)

    Items: Permission role entity

    • self: required (string)
    • id: required (number)

      Id of the linked entity, for example teamId for access type TEAM.

  • editable: required (boolean)

    Editable roles are manually created with updatable members.

Example:

{
  "self": "https://api.tempo.io/core/3/permission-roles",
  "metadata": {
    "count": 2
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/permission-roles/6",
      "id": 6,
      "name": "Team Role",
      "permissions": [
        {
          "key": "permissions.worklog.view"
        }
      ],
      "permittedUsers": [
        {
          "self": "https://test.atlassian.net/rest/api/2/user?accountId=jira-account-id",
          "accountId": "jira-account-id-adm1n",
          "displayName": "John Brown"
        }
      ],
      "accessType": "TEAM",
      "accessEntities": [
        {
          "id": 1,
          "self": "https://api.tempo.io/core/3/teams/1"
        }
      ],
      "editable": true
    },
    {
      "self": "https://api.tempo.io/core/3/permission-roles/7",
      "id": 7,
      "name": "Global Role",
      "permissions": [
        {
          "key": "permissions.worklog.manage"
        }
      ],
      "permittedUsers": [
        {
          "self": "https://test.atlassian.net/rest/api/2/user?accountId=jira-account-id",
          "accountId": "jira-account-id-adm1n",
          "displayName": "John Brown"
        }
      ],
      "accessType": "GLOBAL",
      "accessEntities": [
      ],
      "editable": true
    }
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Permission role has been successfully created

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• permissions: required (array of Permission role permission)

  Items: Permission role permission

  • key: required (string)

    Permission key.

• permittedUsers: required (array of User)

  Items: User

  • self: (string)
  • accountId: required (string)
  • displayName: (string)
• accessType: required (one of TEAM, GLOBAL)

  GLOBAL permission roles don't have entities.

• accessEntities: required (array of Permission role entity)

  Items: Permission role entity

  • self: required (string)
  • id: required (number)

    Id of the linked entity, for example teamId for access type TEAM.

• editable: required (boolean)

  Editable roles are manually created with updatable members.

Example:

{
  "self": "https://api.tempo.io/core/3/permission-roles/6",
  "id": 6,
  "name": "The Role",
  "permissions": [
    {
      "key": "permissions.worklog.view"
    }
  ],
  "permittedUsers": [
    {
      "self": "https://test.atlassian.net/rest/api/2/user?accountId=jira-account-id",
      "accountId": "jira-account-id",
      "displayName": "John Brown"
    }
  ],
  "accessType": "TEAM",
  "accessEntities": [
    {
      "id": 1,
      "self": "https://api.tempo.io/core/3/teams/1"
    }
  ],
  "editable": true
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

A permission role

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• permissions: required (array of Permission role permission)

  Items: Permission role permission

  • key: required (string)

    Permission key.

• permittedUsers: required (array of User)

  Items: User

  • self: (string)
  • accountId: required (string)
  • displayName: (string)
• accessType: required (one of TEAM, GLOBAL)

  GLOBAL permission roles don't have entities.

• accessEntities: required (array of Permission role entity)

  Items: Permission role entity

  • self: required (string)
  • id: required (number)

    Id of the linked entity, for example teamId for access type TEAM.

• editable: required (boolean)

  Editable roles are manually created with updatable members.

Example:

{
  "self": "https://api.tempo.io/core/3/permission-roles/6",
  "id": 6,
  "name": "The Role",
  "permissions": [
    {
      "key": "permissions.worklog.view"
    }
  ],
  "permittedUsers": [
    {
      "self": "https://test.atlassian.net/rest/api/2/user?accountId=jira-account-id",
      "accountId": "jira-account-id",
      "displayName": "John Brown"
    }
  ],
  "accessType": "TEAM",
  "accessEntities": [
    {
      "id": 1,
      "self": "https://api.tempo.io/core/3/teams/1"
    }
  ],
  "editable": true
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Permission role cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Permission role not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Permission role has been successfully updated

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• name: required (string)
• permissions: required (array of Permission role permission)

  Items: Permission role permission

  • key: required (string)

    Permission key.

• permittedUsers: required (array of User)

  Items: User

  • self: (string)
  • accountId: required (string)
  • displayName: (string)
• accessType: required (one of TEAM, GLOBAL)

  GLOBAL permission roles don't have entities.

• accessEntities: required (array of Permission role entity)

  Items: Permission role entity

  • self: required (string)
  • id: required (number)

    Id of the linked entity, for example teamId for access type TEAM.

• editable: required (boolean)

  Editable roles are manually created with updatable members.

Example:

{
  "name": "The Role",
  "permissionKeys": [
    "permissions.worklog.view"
  ],
  "permittedAccountIds": [
    "jira-account-id"
  ],
  "accessType": "TEAM",
  "accessEntityIds" : [
    1
  ]
}

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Permission role cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Permission role not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 204

Permission role has been successfully deleted

HTTP status code 401

Client must be authenticated to access this resource.

HTTP status code 403

Authenticated user is missing permission to fulfill the request

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "The logged-in-user does not have required permission to view this data"
    }
  ]
}

HTTP status code 404

Permission role cannot be found in the system

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Permission role not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
  • offset: required (integer - default: 0)
  • limit: required (integer - default: 50 - maximum: 1000)
  • next: (string)
  • previous: (string)
• results: required (array of Plan)

  Items: Plan

  • self: required (string)
  • id: required (integer)
  • startDate: required (date-only)
  • endDate: required (date-only)
  • secondsPerDay: required (number)
  • includeNonWorkingDays: required (boolean)
  • description: (string)
  • createdAt: required (datetime)
  • updatedAt: required (datetime)
  • assignee: required (assignee)
    • self: required (string)
    • type: required (one of USER, TEAM, GENERIC)
  • planItem: required (planItem)
    • self: required (string)
    • type: required (one of ISSUE, PROJECT)
  • recurrence: required (recurrence)
    • rule: required (one of NEVER, WEEKLY, BIWEEKLY, MONTHLY)
    • recurrenceEndDate: required (date-only)
  • dates: required (dates)
    • metadata: required (metadata)
      • count: required (integer)
      • all: required (string)
    • values: required (array of PlanPeriod)

      Items: PlanPeriod

      • from: required (date-only)
      • to: required (date-only)
      • timePlannedSeconds: required (number)
  • planApproval: required (planApproval)

    Is included only if there is an approval linked to the plan.

    • type: required (one of REQUESTED, REJECTED, APPROVED)

Example:

{
  "self": "https://api.tempo.io/core/3/plans?assigneeType=USER&planItemType=ISSUE&from=2017-11-01&to=2017-12-31&updatedFrom=2017-02-01&offset=0&limit=50",
  "metadata": {
    "count": 2,
    "offset": 0,
    "limit": 50
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/plans/223",
      "id": 223,
      "startDate": "2017-07-13",
      "endDate": "2017-11-13",
      "secondsPerDay": 3600,
      "includeNonWorkingDays": false,
      "description": "This is an issue plan",
      "createdAt": "2017-02-23T15:07:00Z",
      "updatedAt": "2017-02-23T15:07:00Z",
      "assignee": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
        "type": "USER"
      },
      "planItem": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/issue/ISS-555",
        "type": "ISSUE"
      },
      "recurrence": {
        "rule": "MONTHLY",
        "recurrenceEndDate": "2018-12-31"
      },
      "dates": {
        "metadata": {
          "count": 2,
          "all": "https://api.tempo.io/core/3/plans/123?from=2017-07-13&to=2018-12-31"
        },
        "values": [
          {
            "from": "2017-11-13",
            "to": "2017-11-13",
            "timePlannedSeconds": 3600
          },
          {
            "from": "2017-12-13",
            "to": "2017-12-13",
            "timePlannedSeconds": 3600
          }
        ]
      },
      "planApproval": {
        "status": "REQUESTED"
      }
    },
    {
      "self": "https://api.tempo.io/core/3/plans/289",
      "id": 289,
      "startDate": "2017-07-13",
      "endDate": "2017-11-13",
      "secondsPerDay": 14400,
      "includeNonWorkingDays": false,
      "description": "This is a project plan",
      "createdAt": "2017-02-23T15:07:00Z",
      "updatedAt": "2017-02-23T15:07:00Z",
      "assignee": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
        "type": "USER"
      },
      "planItem": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/project/1000100",
        "type": "PROJECT"
      },
      "recurrence": {
        "rule": "WEEKLY",
        "recurrenceEndDate": "2018-04-01"
      },
      "dates": {
        "metadata": {
          "count": 7,
          "all": "https://api.tempo.io/core/3/plans/123?from=2017-07-13&to=2018-04-01"
        },
        "values": [
          {
            "from": "2017-11-15",
            "to": "2017-11-15",
            "timePlannedSeconds": 14400
          },
          {
            "from": "2017-11-22",
            "to": "2017-11-22",
            "timePlannedSeconds": 14400
          },
          {
            "from": "2017-11-29",
            "to": "2017-11-29",
            "timePlannedSeconds": 14400
          },
          {
            "from": "2017-12-06",
            "to": "2017-12-06",
            "timePlannedSeconds": 14400
          },
          {
            "from": "2017-12-13",
            "to": "2017-12-13",
            "timePlannedSeconds": 14400
          },
          {
            "from": "2017-12-20",
            "to": "2017-12-20",
            "timePlannedSeconds": 14400
          },
          {
            "from": "2017-12-27",
            "to": "2017-12-27",
            "timePlannedSeconds": 14400
          }
        ]
      }
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Plan has been successfully created

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• startDate: required (date-only)
• endDate: required (date-only)
• secondsPerDay: required (number)
• includeNonWorkingDays: required (boolean)
• description: (string)
• createdAt: required (datetime)
• updatedAt: required (datetime)
• assignee: required (assignee)
  • self: required (string)
  • type: required (one of USER, TEAM, GENERIC)
• planItem: required (planItem)
  • self: required (string)
  • type: required (one of ISSUE, PROJECT)
• recurrence: required (recurrence)
  • rule: required (one of NEVER, WEEKLY, BIWEEKLY, MONTHLY)
  • recurrenceEndDate: required (date-only)
• dates: required (dates)
  • metadata: required (metadata)
    • count: required (integer)
    • all: required (string)
  • values: required (array of PlanPeriod)

    Items: PlanPeriod

    • from: required (date-only)
    • to: required (date-only)
    • timePlannedSeconds: required (number)
• planApproval: required (planApproval)

  Is included only if there is an approval linked to the plan.

  • type: required (one of REQUESTED, REJECTED, APPROVED)

Example:

{
  "self": "https://api.tempo.io/core/3/plans/123",
  "id": 123,
  "startDate": "2017-12-15",
  "endDate": "2017-12-15",
  "secondsPerDay": 28800,
  "includeNonWorkingDays": false,
  "description": "This is a plan",
  "createdAt": "2017-02-23T15:07:00Z",
  "updatedAt": "2017-02-23T15:07:00Z",
  "assignee": {
    "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
    "type": "USER"
  },
  "planItem": {
    "self": "https://my-cloud-instance.atlassian.net/rest/api/2/project/1000110",
    "type": "PROJECT"
  },
  "recurrence": {
    "rule": "NEVER",
    "recurrenceEndDate": "2017-12-15"
  },
  "dates": {
    "metadata": {
      "count": 1,
      "all": "https://api.tempo.io/core/3/plans/123?from=2017-12-15&to=2017-12-15"
    },
    "values": [
      {
        "from": "2017-12-15",
        "to": "2017-12-15",
        "timePlannedSeconds": 28800
      }
    ]
  }
}

HTTP status code 400

Plan cannot be created for some reasons

Body

Media type: application/json

Type: object

• errors: required (array of items)

  Items: items

  • message: required (string)

Example:

{
  "errors": [
    {
      "message": "Issue not found"
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Body

Media type: application/json

Type: object

• self: required (string)
• metadata: required (metadata)
  • count: required (integer)
  • offset: required (integer - default: 0)
  • limit: required (integer - default: 50 - maximum: 1000)
  • next: (string)
  • previous: (string)
• results: required (array of Plan with time broken down by days)

  Items: Plan with time broken down by days

  • self: required (string)
  • id: required (integer)
  • startDate: required (date-only)
  • endDate: required (date-only)
  • secondsPerDay: required (number)
  • includeNonWorkingDays: required (boolean)
  • description: (string)
  • createdAt: required (datetime)
  • updatedAt: required (datetime)
  • assignee: required (assignee)
    • self: required (string)
    • type: required (one of USER, GENERIC)
  • planItem: required (planItem)
    • self: required (string)
    • type: required (one of ISSUE, PROJECT)
  • recurrence: required (recurrence)
    • rule: required (one of NEVER, WEEKLY, BIWEEKLY, MONTHLY)
    • recurrenceEndDate: required (date-only)
  • dates: required (dates)
    • metadata: required (metadata)
      • count: required (integer)
      • all: required (string)
    • values: required (array of PlanDate)

      Items: PlanDate

      • date: required (date-only)
      • timePlannedSeconds: required (number)
  • planApproval: required (planApproval)

    Is included only if there is an approval linked to the plan.

    • type: required (one of REQUESTED, REJECTED, APPROVED)

Example:

{
  "self": "https://api.tempo.io/core/3/plans?assigneeType=USER&planItemType=ISSUE&from=2022-01-13&to=2022-01-20&updatedFrom=2017-02-01&offset=0&limit=50",
  "metadata": {
    "count": 2,
    "offset": 0,
    "limit": 50
  },
  "results": [
    {
      "self": "https://api.tempo.io/core/3/plans/223",
      "id": 223,
      "startDate": "2022-01-12",
      "endDate": "2022-01-14",
      "secondsPerDay": 3600,
      "includeNonWorkingDays": false,
      "description": "This is a user plan",
      "createdAt": "2022-01-06T15:07:00Z",
      "updatedAt": "2022-01-06T15:07:00Z",
      "assignee": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/user?accountId=1111aaaa2222bbbb3333cccc",
        "type": "USER"
      },
      "planItem": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/issue/ISS-555",
        "type": "ISSUE"
      },
      "recurrence": {
        "rule": "WEEKLY",
        "recurrenceEndDate": "2018-12-31"
      },
      "dates": {
        "metadata": {
          "count": 4,
          "all": "https://api.tempo.io/core/3/plans/123?from=2022-01-13&to=2022-01-20"
        },
        "values": [
          {
            "date": "2022-01-13",
            "timePlannedSeconds": 3600
          },
          {
            "date": "2022-01-14",
            "timePlannedSeconds": 3600
          },
          {
            "date": "2022-01-19",
            "timePlannedSeconds": 3600
          },
          {
            "date": "2022-01-20",
            "timePlannedSeconds": 3600
          }
        ]
      },
      "planApproval": {
        "status": "REQUESTED"
      }
    },
    {
      "self": "https://api.tempo.io/core/3/plans/224",
      "id": 224,
      "startDate": "2022-01-12",
      "endDate": "2022-01-14",
      "secondsPerDay": 7200,
      "includeNonWorkingDays": false,
      "description": "This is a plan on genreic resource",
      "createdAt": "2022-01-06T15:08:00Z",
      "updatedAt": "2022-01-06T15:08:00Z",
      "assignee": {
        "self": "https://test.api.tempo.io/core/3/generic-resources/123",
        "type": "GENERIC"
      },
      "planItem": {
        "self": "https://my-cloud-instance.atlassian.net/rest/api/2/issue/ISS-555",
        "type": "ISSUE"
      },
      "recurrence": {
        "rule": "NEVER",
        "recurrenceEndDate": "2022-01-14"
      },
      "dates": {
        "metadata": {
          "count": 2,
          "all": "https://api.tempo.io/core/3/plans/123?from=2022-01-13&to=2022-01-20"
        },
        "values": [
          {
            "date": "2022-01-13",
            "timePlannedSeconds": 7200
          },
          {
            "date": "2022-01-14",
            "timePlannedSeconds": 7200
          }
        ]
      }
    }
  ]
}

Secured by OAuth 2.0

Headers

• Authorization: required (string)

  Used to send a valid OAuth 2 token : "Authorization: Bearer ${token}"

HTTP status code 200

Plan of the given id

Body

Media type: application/json

Type: object

• self: required (string)
• id: required (integer)
• startDate: required (date-only)
• endDate: required (date-only)
• secondsPerDay: required (number)
• includeNonWorkingDays: required (boolean)
• description: (string)
• createdAt: required (datetime)
• updatedAt: required (datetime)
• assignee: required (assignee)
  • self: required (string)
  • type: required (one of USER, TEAM, GENERIC)
• planItem: required (planItem)
  • self: required (string)
  • type: required (one of ISSUE, PROJECT)
• recurrence: required (recurrence)
  • rule: required (one of NEVER, WEEKLY, BIWEEKLY, MONTHLY)
  • recurrenceEndDate: required (date-only)
• dates: required (dates)
  • metadata: required (metadata)
    • count: required (integer)
    • all: required (string)
  • values: required (array of PlanPeriod)

    Items: PlanPeriod

    • from: required (date-only)
    • to: required (date-only)
    • timePlannedSeconds: required (number)
• planApproval: required (planApproval)

  Is included only if there is an approval linked to the plan.

  • type: required (one of REQUESTED, REJECTED, APPROVED)