Portfolio for Jira - Team Management Public API API Reference

Welcome to the Team Management Public API REST documentation. In order to access the endpoints you have to authenticate your REST calls.

Note: All URL paths should start with /jira/rest/teams-api/1.0
For example, the skill count URL is: /jira/rest/teams-api/1.0/skill/count

Schemes: http

Version: v1

skill

Returns entities. Specify pagination with page (default = 1) and size (default = 1) parameters or the requested ids with ids parameter!

GET /skill

page

in query

integer (int32)

(no description)

size

in query

integer (int32)

(no description)

ids

in query

integer[]

(no description)

Array values passed as multiple parameters: ?ids=aaa&ids=bbb

default

successful operation

Response Content-Types: application/json

skill

Entity creation operation. Returns the new entity Id.

POST /skill

SkillDTO

Request Content-Types: application/json

Request Example

{
  "id": "integer (int64)",
  "title": "string",
  "shareable": "boolean"
}

default

successful operation

Response Content-Types: application/json

skill

Return the total entities count

GET /skill/count

default

successful operation

Response Content-Types: application/json

skill

Check the existence of the given ids

POST /skill/exists

integer (int64)

Request Content-Types: application/json

Request Example

[
  "integer (int64)"
]

default

successful operation

Response Content-Types: application/json

skill

Get entity by id

GET /skill/{id}

in path

integer (int64)

(no description)

200 OK

Entity found

Response Content-Types: application/json

skill

Entity Update

POST /skill/{id}

SkillDTO

in path

integer (int64)

(no description)

Request Content-Types: application/json

Request Example

{
  "id": "integer (int64)",
  "title": "string",
  "shareable": "boolean"
}

default

successful operation

Response Content-Types: application/json

skill

Entity Deletion

DELETE /skill/{id}

in path

integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

person

Returns entities. Specify pagination with page (default = 1) and size (default = 1) parameters or the requested ids with ids parameter!

GET /person

page

in query

integer (int32)

(no description)

size

in query

integer (int32)

(no description)

ids

in query

integer[]

(no description)

Array values passed as multiple parameters: ?ids=aaa&ids=bbb

default

successful operation

Response Content-Types: application/json

person

Entity creation operation. Returns the new entity Id.

POST /person

PersonDTO

Request Content-Types: application/json

Request Example

{
  "id": "integer (int64)",
  "title": "string",
  "avatarUrl": "string",
  "startDate": "integer (int64)",
  "endDate": "integer (int64)",
  "jiraUser": {
    "jiraUserId": "string",
    "title": "string",
    "email": "string",
    "avatarUrl": "string",
    "jiraUsername": "string"
  },
  "abilities": [
    {
      "id": "integer (int64)",
      "skillId": "integer (int64)",
      "personId": "integer (int64)"
    }
  ],
  "absences": [
    {
      "id": "integer (int64)",
      "start": "integer (int64)",
      "end": "integer (int64)",
      "title": "string"
    }
  ]
}

default

successful operation

Response Content-Types: application/json

person

Deletes a Person Absence registry

DELETE /person/absence/{absenceId}

absenceId

in path

integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

person

Return the total entities count

GET /person/count

default

successful operation

Response Content-Types: application/json

person

Check the existence of the given ids

POST /person/exists

integer (int64)

Request Content-Types: application/json

Request Example

[
  "integer (int64)"
]

default

successful operation

Response Content-Types: application/json

person

Returns Person entities suppressing abilities and absences attributes. Specify pagination with page (default = 1) and size (default = 1) parameters or the requested ids with ids parameter!

GET /person/simple

page

in query

integer (int32)

(no description)

size

in query

integer (int32)

(no description)

ids

in query

integer[]

(no description)

Array values passed as multiple parameters: ?ids=aaa&ids=bbb

default

successful operation

Response Content-Types: application/json

person

Get entity by id

GET /person/{id}

in path

integer (int64)

(no description)

200 OK

Entity found

Response Content-Types: application/json

person

Entity Update

POST /person/{id}

PersonDTO

in path

integer (int64)

(no description)

Request Content-Types: application/json

Request Example

{
  "id": "integer (int64)",
  "title": "string",
  "avatarUrl": "string",
  "startDate": "integer (int64)",
  "endDate": "integer (int64)",
  "jiraUser": {
    "jiraUserId": "string",
    "title": "string",
    "email": "string",
    "avatarUrl": "string",
    "jiraUsername": "string"
  },
  "abilities": [
    {
      "id": "integer (int64)",
      "skillId": "integer (int64)",
      "personId": "integer (int64)"
    }
  ],
  "absences": [
    {
      "id": "integer (int64)",
      "start": "integer (int64)",
      "end": "integer (int64)",
      "title": "string"
    }
  ]
}

default

successful operation

Response Content-Types: application/json

person

Entity Deletion

DELETE /person/{id}

in path

integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

person

Return the abilities of a Person

GET /person/{personId}/abilities

personId

in path

integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

person

Creates a Person Absence registry

POST /person/{personId}/absence

AbsenceDTO

personId

in path

integer (int64)

(no description)

Request Content-Types: application/json

Request Example

{
  "id": "integer (int64)",
  "start": "integer (int64)",
  "end": "integer (int64)",
  "title": "string"
}

default

successful operation

Response Content-Types: application/json

person

Return the absences of a Person

GET /person/{personId}/absences

personId

in path

integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

person

Creates an Ability registry, associating a Skill to a Person. Returns an Ability creation response element, with the new Ability id.

PUT /person/{personId}/skill/{skillId}

personId

in path

integer (int64)

(no description)

skillId

in path

integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

person

Disassociates the Skill from the given Person, deleting the corresponding Ability registry.

DELETE /person/{personId}/skill/{skillId}

personId

in path

integer (int64)

(no description)

skillId

in path

integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

resource

Returns entities. Specify pagination with page (default = 1) and size (default = 1) parameters or the requested ids with ids parameter!

GET /resource

page

in query

integer (int32)

(no description)

size

in query

integer (int32)

(no description)

ids

in query

integer[]

(no description)

Array values passed as multiple parameters: ?ids=aaa&ids=bbb

default

successful operation

Response Content-Types: application/json

resource

Entity creation operation. Returns the new entity Id.

POST /resource

ResourceDTO

Request Content-Types: application/json

Request Example

{
  "id": "integer (int64)",
  "weeklyHours": "number (double)",
  "joinDate": "integer (int64)",
  "leaveDate": "integer (int64)",
  "teamId": "integer (int64)",
  "person": {
    "id": "integer (int64)",
    "title": "string",
    "avatarUrl": "string",
    "startDate": "integer (int64)",
    "endDate": "integer (int64)",
    "jiraUser": {
      "jiraUserId": "string",
      "title": "string",
      "email": "string",
      "avatarUrl": "string",
      "jiraUsername": "string"
    },
    "abilities": [
      {
        "id": "integer (int64)",
        "skillId": "integer (int64)",
        "personId": "integer (int64)"
      }
    ],
    "absences": [
      {
        "id": "integer (int64)",
        "start": "integer (int64)",
        "end": "integer (int64)",
        "title": "string"
      }
    ]
  },
  "availability": [
    {
      "weeklyHours": "number (double)",
      "title": "string",
      "start": "integer (int64)",
      "end": "integer (int64)"
    }
  ]
}

default

successful operation

Response Content-Types: application/json

resource

Return the total entities count

GET /resource/count

default

successful operation

Response Content-Types: application/json

resource

Check the existence of the given ids

POST /resource/exists

integer (int64)

Request Content-Types: application/json

Request Example

[
  "integer (int64)"
]

default

successful operation

Response Content-Types: application/json

resource

Get entity by id

GET /resource/{id}

in path

integer (int64)

(no description)

200 OK

Entity found

Response Content-Types: application/json

resource

Entity Update

POST /resource/{id}

ResourceDTO

in path

integer (int64)

(no description)

Request Content-Types: application/json

Request Example

{
  "id": "integer (int64)",
  "weeklyHours": "number (double)",
  "joinDate": "integer (int64)",
  "leaveDate": "integer (int64)",
  "teamId": "integer (int64)",
  "person": {
    "id": "integer (int64)",
    "title": "string",
    "avatarUrl": "string",
    "startDate": "integer (int64)",
    "endDate": "integer (int64)",
    "jiraUser": {
      "jiraUserId": "string",
      "title": "string",
      "email": "string",
      "avatarUrl": "string",
      "jiraUsername": "string"
    },
    "abilities": [
      {
        "id": "integer (int64)",
        "skillId": "integer (int64)",
        "personId": "integer (int64)"
      }
    ],
    "absences": [
      {
        "id": "integer (int64)",
        "start": "integer (int64)",
        "end": "integer (int64)",
        "title": "string"
      }
    ]
  },
  "availability": [
    {
      "weeklyHours": "number (double)",
      "title": "string",
      "start": "integer (int64)",
      "end": "integer (int64)"
    }
  ]
}

default

successful operation

Response Content-Types: application/json

resource

Entity Deletion

DELETE /resource/{id}

in path

integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

resource

Creates a Resource Availability registry

POST /resource/{resourceId}/availability

ResourceAvailabilityDTO

resourceId

in path

integer (int64)

(no description)

Request Content-Types: application/json

Request Example

{
  "weeklyHours": "number (double)",
  "title": "string",
  "start": "integer (int64)",
  "end": "integer (int64)"
}

default

successful operation

Response Content-Types: application/json

resource

Deletes the Resource Availability registry

DELETE /resource/{resourceId}/availability/{availabilityId}

resourceId

in path

integer (int64)

(no description)

availabilityId

in path

integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

teams

Returns entities. Specify pagination with page (default = 1) and size (default = 1) parameters or the requested ids with ids parameter!

GET /team

page

in query

integer (int32)

(no description)

size

in query

integer (int32)

(no description)

ids

in query

integer[]

(no description)

Array values passed as multiple parameters: ?ids=aaa&ids=bbb

default

successful operation

Response Content-Types: application/json

teams

Entity creation operation. Returns the new entity Id.

POST /team

TeamDTO

Request Content-Types: application/json

Request Example

{
  "id": "integer (int64)",
  "title": "string",
  "shareable": "boolean",
  "avatarUrl": "string",
  "resources": [
    {
      "id": "integer (int64)",
      "weeklyHours": "number (double)",
      "joinDate": "integer (int64)",
      "leaveDate": "integer (int64)",
      "teamId": "integer (int64)",
      "person": {
        "id": "integer (int64)",
        "title": "string",
        "avatarUrl": "string",
        "startDate": "integer (int64)",
        "endDate": "integer (int64)",
        "jiraUser": {
          "jiraUserId": "string",
          "title": "string",
          "email": "string",
          "avatarUrl": "string",
          "jiraUsername": "string"
        },
        "abilities": [
          {
            "id": "integer (int64)",
            "skillId": "integer (int64)",
            "personId": "integer (int64)"
          }
        ],
        "absences": [
          {
            "id": "integer (int64)",
            "start": "integer (int64)",
            "end": "integer (int64)",
            "title": "string"
          }
        ]
      },
      "availability": [
        {
          "weeklyHours": "number (double)",
          "title": "string",
          "start": "integer (int64)",
          "end": "integer (int64)"
        }
      ]
    }
  ]
}

default

successful operation

Response Content-Types: application/json

teams

Return the total entities count

GET /team/count

default

successful operation

Response Content-Types: application/json

teams

Check the existence of the given ids

POST /team/exists

integer (int64)

Request Content-Types: application/json

Request Example

[
  "integer (int64)"
]

default

successful operation

Response Content-Types: application/json

teams

Get entity by id

GET /team/{id}

in path

integer (int64)

(no description)

200 OK

Entity found

Response Content-Types: application/json

teams

Entity Update

POST /team/{id}

TeamDTO

in path

integer (int64)

(no description)

Request Content-Types: application/json

Request Example

{
  "id": "integer (int64)",
  "title": "string",
  "shareable": "boolean",
  "avatarUrl": "string",
  "resources": [
    {
      "id": "integer (int64)",
      "weeklyHours": "number (double)",
      "joinDate": "integer (int64)",
      "leaveDate": "integer (int64)",
      "teamId": "integer (int64)",
      "person": {
        "id": "integer (int64)",
        "title": "string",
        "avatarUrl": "string",
        "startDate": "integer (int64)",
        "endDate": "integer (int64)",
        "jiraUser": {
          "jiraUserId": "string",
          "title": "string",
          "email": "string",
          "avatarUrl": "string",
          "jiraUsername": "string"
        },
        "abilities": [
          {
            "id": "integer (int64)",
            "skillId": "integer (int64)",
            "personId": "integer (int64)"
          }
        ],
        "absences": [
          {
            "id": "integer (int64)",
            "start": "integer (int64)",
            "end": "integer (int64)",
            "title": "string"
          }
        ]
      },
      "availability": [
        {
          "weeklyHours": "number (double)",
          "title": "string",
          "start": "integer (int64)",
          "end": "integer (int64)"
        }
      ]
    }
  ]
}

default

successful operation

Response Content-Types: application/json

teams

Entity Deletion

DELETE /team/{id}

in path

integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

Schema Definitions

SkillDTO: object

id: integer (int64)
title: string
shareable: boolean false

Example

{
  "id": "integer (int64)",
  "title": "string",
  "shareable": "boolean"
}

ResourceAvailabilityDTO: object

weeklyHours: number (double)
title: string
start: integer (int64)
end: integer (int64)

Example

{
  "weeklyHours": "number (double)",
  "title": "string",
  "start": "integer (int64)",
  "end": "integer (int64)"
}

PersonDTO: object

id: integer (int64)
title: string
avatarUrl: string
startDate: integer (int64)
endDate: integer (int64)
jiraUser: JiraUserDTO
abilities: AbilityDTO
AbilityDTO
absences: AbsenceDTO
AbsenceDTO

Example

{
  "id": "integer (int64)",
  "title": "string",
  "avatarUrl": "string",
  "startDate": "integer (int64)",
  "endDate": "integer (int64)",
  "jiraUser": {
    "jiraUserId": "string",
    "title": "string",
    "email": "string",
    "avatarUrl": "string",
    "jiraUsername": "string"
  },
  "abilities": [
    {
      "id": "integer (int64)",
      "skillId": "integer (int64)",
      "personId": "integer (int64)"
    }
  ],
  "absences": [
    {
      "id": "integer (int64)",
      "start": "integer (int64)",
      "end": "integer (int64)",
      "title": "string"
    }
  ]
}

AbsenceDTO: object

id: integer (int64)
start: integer (int64)
end: integer (int64)
title: string

Example

{
  "id": "integer (int64)",
  "start": "integer (int64)",
  "end": "integer (int64)",
  "title": "string"
}

AbilityDTO: object

id: integer (int64)
skillId: integer (int64)
personId: integer (int64)

Example

{
  "id": "integer (int64)",
  "skillId": "integer (int64)",
  "personId": "integer (int64)"
}

TeamDTO: object

id: integer (int64)
title: string
shareable: boolean false
avatarUrl: string
resources: ResourceDTO
ResourceDTO

Example

{
  "id": "integer (int64)",
  "title": "string",
  "shareable": "boolean",
  "avatarUrl": "string",
  "resources": [
    {
      "id": "integer (int64)",
      "weeklyHours": "number (double)",
      "joinDate": "integer (int64)",
      "leaveDate": "integer (int64)",
      "teamId": "integer (int64)",
      "person": {
        "id": "integer (int64)",
        "title": "string",
        "avatarUrl": "string",
        "startDate": "integer (int64)",
        "endDate": "integer (int64)",
        "jiraUser": {
          "jiraUserId": "string",
          "title": "string",
          "email": "string",
          "avatarUrl": "string",
          "jiraUsername": "string"
        },
        "abilities": [
          {
            "id": "integer (int64)",
            "skillId": "integer (int64)",
            "personId": "integer (int64)"
          }
        ],
        "absences": [
          {
            "id": "integer (int64)",
            "start": "integer (int64)",
            "end": "integer (int64)",
            "title": "string"
          }
        ]
      },
      "availability": [
        {
          "weeklyHours": "number (double)",
          "title": "string",
          "start": "integer (int64)",
          "end": "integer (int64)"
        }
      ]
    }
  ]
}

JiraUserDTO: object

jiraUserId: string
title: string
email: string
avatarUrl: string
jiraUsername: string

Example

{
  "jiraUserId": "string",
  "title": "string",
  "email": "string",
  "avatarUrl": "string",
  "jiraUsername": "string"
}

ResourceDTO: object

id: integer (int64)
weeklyHours: number (double)
joinDate: integer (int64)
leaveDate: integer (int64)
teamId: integer (int64)
person: PersonDTO
availability: ResourceAvailabilityDTO
ResourceAvailabilityDTO

Example

{
  "id": "integer (int64)",
  "weeklyHours": "number (double)",
  "joinDate": "integer (int64)",
  "leaveDate": "integer (int64)",
  "teamId": "integer (int64)",
  "person": {
    "id": "integer (int64)",
    "title": "string",
    "avatarUrl": "string",
    "startDate": "integer (int64)",
    "endDate": "integer (int64)",
    "jiraUser": {
      "jiraUserId": "string",
      "title": "string",
      "email": "string",
      "avatarUrl": "string",
      "jiraUsername": "string"
    },
    "abilities": [
      {
        "id": "integer (int64)",
        "skillId": "integer (int64)",
        "personId": "integer (int64)"
      }
    ],
    "absences": [
      {
        "id": "integer (int64)",
        "start": "integer (int64)",
        "end": "integer (int64)",
        "title": "string"
      }
    ]
  },
  "availability": [
    {
      "weeklyHours": "number (double)",
      "title": "string",
      "start": "integer (int64)",
      "end": "integer (int64)"
    }
  ]
}

Documentation by Spectacle