Portfolio for Jira - Public API API Reference

Welcome to the Portfolio for Jira 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/jpo-api/1.0
For example, the plan count URL is: /jira/rest/jpo-api/1.0/plan/count

Schemes: http
Version: v1

plan

plan

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

GET /plan
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
plan

Entity creation operation. Returns the new entity Id.

POST /plan
PlanDTO

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "nonWorkingDays": [
    {
      "id": "integer (int64)",
      "planId": "integer (int64)",
      "title": "string",
      "start": "integer (int64)",
      "end": "integer (int64)"
    }
  ],
  "planTeams": [
    "integer (int64)"
  ],
  "excludedVersions": [
    "integer (int64)"
  ],
  "heuristicThreshold": "integer (int32)",
  "globalSprintLength": "integer (int32)",
  "weekdayConfiguration": [
    "integer (int32)"
  ],
  "title": "string",
  "timeZone": "string",
  "defaultTeamWeeklyCapacity": "number (double)",
  "globalDefaultVelocity": "number (double)",
  "hoursPerDay": "number (double)",
  "hasSprintConstraint": "boolean",
  "strictStageDivision": "boolean",
  "multiScenarioEnabled": "boolean",
  "syncStartEnabled": "boolean",
  "commitIssueAssignee": "boolean",
  "minLoadUnstrEpics": "integer (int64)",
  "maxResourcesPerStory": "integer (int64)",
  "assigneeSchedulingLevel": "integer (int64)",
  "schedulingVerbosity": "integer (int64)",
  "unestimatedIssuesOption": "integer (int64)",
  "schedulingStartCustomField": "integer (int64)",
  "schedulingEndCustomField": "integer (int64)",
  "dependencyModeOption": "integer (int64)",
  "planningUnit": "integer (int64)",
  "programId": "integer (int64)",
  "portfolioPlanVersion": "integer (int64)"
}
default

successful operation

Response Content-Types: application/json
plan

Return the total entities count

GET /plan/count
default

successful operation

Response Content-Types: application/json
plan

Check the existence of the given ids

POST /plan/exists
integer (int64)
Request Content-Types: application/json
Request Example
[
  "integer (int64)"
]
default

successful operation

Response Content-Types: application/json
plan

Get entity by id

GET /plan/{id}
id
in path
integer (int64)

(no description)

200 OK

Entity found

Response Content-Types: application/json
plan

Entity Update

POST /plan/{id}
PlanDTO

id
in path
integer (int64)

(no description)

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "nonWorkingDays": [
    {
      "id": "integer (int64)",
      "planId": "integer (int64)",
      "title": "string",
      "start": "integer (int64)",
      "end": "integer (int64)"
    }
  ],
  "planTeams": [
    "integer (int64)"
  ],
  "excludedVersions": [
    "integer (int64)"
  ],
  "heuristicThreshold": "integer (int32)",
  "globalSprintLength": "integer (int32)",
  "weekdayConfiguration": [
    "integer (int32)"
  ],
  "title": "string",
  "timeZone": "string",
  "defaultTeamWeeklyCapacity": "number (double)",
  "globalDefaultVelocity": "number (double)",
  "hoursPerDay": "number (double)",
  "hasSprintConstraint": "boolean",
  "strictStageDivision": "boolean",
  "multiScenarioEnabled": "boolean",
  "syncStartEnabled": "boolean",
  "commitIssueAssignee": "boolean",
  "minLoadUnstrEpics": "integer (int64)",
  "maxResourcesPerStory": "integer (int64)",
  "assigneeSchedulingLevel": "integer (int64)",
  "schedulingVerbosity": "integer (int64)",
  "unestimatedIssuesOption": "integer (int64)",
  "schedulingStartCustomField": "integer (int64)",
  "schedulingEndCustomField": "integer (int64)",
  "dependencyModeOption": "integer (int64)",
  "planningUnit": "integer (int64)",
  "programId": "integer (int64)",
  "portfolioPlanVersion": "integer (int64)"
}
default

successful operation

Response Content-Types: application/json
plan

Entity Deletion

DELETE /plan/{id}
id
in path
integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

hierarchy

hierarchy

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

GET /hierarchy
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
hierarchy

Entity creation operation. Returns the new entity Id.

POST /hierarchy
HierarchyLevelDTO

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "title": "string",
  "issueTypeIds": [
    "string"
  ]
}
default

successful operation

Response Content-Types: application/json
hierarchy

Return the total entities count

GET /hierarchy/count
default

successful operation

Response Content-Types: application/json
hierarchy

Check the existence of the given ids

POST /hierarchy/exists
integer (int64)
Request Content-Types: application/json
Request Example
[
  "integer (int64)"
]
default

successful operation

Response Content-Types: application/json
hierarchy

Get entity by id

GET /hierarchy/{id}
id
in path
integer (int64)

(no description)

200 OK

Entity found

Response Content-Types: application/json
hierarchy

Entity Update

POST /hierarchy/{id}
HierarchyLevelDTO

id
in path
integer (int64)

(no description)

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "title": "string",
  "issueTypeIds": [
    "string"
  ]
}
default

successful operation

Response Content-Types: application/json
hierarchy

Entity Deletion

DELETE /hierarchy/{id}
id
in path
integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

program

program

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

GET /program
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
program

Entity creation operation. Returns the new entity Id.

POST /program
ProgramDTO

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "title": "string",
  "owner": "string",
  "description": "string"
}
default

successful operation

Response Content-Types: application/json
program

Return the total entities count

GET /program/count
default

successful operation

Response Content-Types: application/json
program

Check the existence of the given ids

POST /program/exists
integer (int64)
Request Content-Types: application/json
Request Example
[
  "integer (int64)"
]
default

successful operation

Response Content-Types: application/json
program

Get entity by id

GET /program/{id}
id
in path
integer (int64)

(no description)

200 OK

Entity found

Response Content-Types: application/json
program

Entity Update

POST /program/{id}
ProgramDTO

id
in path
integer (int64)

(no description)

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "title": "string",
  "owner": "string",
  "description": "string"
}
default

successful operation

Response Content-Types: application/json
program

Entity Deletion

DELETE /program/{id}
id
in path
integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

stage

stage

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

GET /stage
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
stage

Entity creation operation. Returns the new entity Id.

POST /stage
StageDTO

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "planId": "integer (int64)",
  "title": "string",
  "skillId": "integer (int64)",
  "weight": "number (double)",
  "color": "string"
}
default

successful operation

Response Content-Types: application/json
stage

Return the total entities count

GET /stage/count
default

successful operation

Response Content-Types: application/json
stage

Check the existence of the given ids

POST /stage/exists
integer (int64)
Request Content-Types: application/json
Request Example
[
  "integer (int64)"
]
default

successful operation

Response Content-Types: application/json
stage

Get entity by id

GET /stage/{id}
id
in path
integer (int64)

(no description)

200 OK

Entity found

Response Content-Types: application/json
stage

Entity Update

POST /stage/{id}
StageDTO

id
in path
integer (int64)

(no description)

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "planId": "integer (int64)",
  "title": "string",
  "skillId": "integer (int64)",
  "weight": "number (double)",
  "color": "string"
}
default

successful operation

Response Content-Types: application/json
stage

Entity Deletion

DELETE /stage/{id}
id
in path
integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

nonworkingday

nonworkingday

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

GET /nonworkingday
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
nonworkingday

Entity creation operation. Returns the new entity Id.

POST /nonworkingday
NonWorkingDayDTO

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "planId": "integer (int64)",
  "title": "string",
  "start": "integer (int64)",
  "end": "integer (int64)"
}
default

successful operation

Response Content-Types: application/json
nonworkingday

Return the total entities count

GET /nonworkingday/count
default

successful operation

Response Content-Types: application/json
nonworkingday

Check the existence of the given ids

POST /nonworkingday/exists
integer (int64)
Request Content-Types: application/json
Request Example
[
  "integer (int64)"
]
default

successful operation

Response Content-Types: application/json
nonworkingday

GET /nonworkingday/plan/{planId}

planId
in path
integer (int64)

(no description)

200 OK

Entity found

Response Content-Types: application/json
nonworkingday

Get entity by id

GET /nonworkingday/{id}
id
in path
integer (int64)

(no description)

200 OK

Entity found

Response Content-Types: application/json
nonworkingday

Entity Update

POST /nonworkingday/{id}
NonWorkingDayDTO

id
in path
integer (int64)

(no description)

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "planId": "integer (int64)",
  "title": "string",
  "start": "integer (int64)",
  "end": "integer (int64)"
}
default

successful operation

Response Content-Types: application/json
nonworkingday

Entity Deletion

DELETE /nonworkingday/{id}
id
in path
integer (int64)

(no description)

default

successful operation

Response Content-Types: application/json

Schema Definitions

NonWorkingDayDTO: object

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

PlanDTO: object

id: integer (int64)
nonWorkingDays: NonWorkingDayDTO
NonWorkingDayDTO
planTeams: integer[]
integer (int64)
excludedVersions: integer[]
integer (int64)
heuristicThreshold: integer (int32)
globalSprintLength: integer (int32)
weekdayConfiguration: integer[]
integer (int32)
title: string
timeZone: string
defaultTeamWeeklyCapacity: number (double)
globalDefaultVelocity: number (double)
hoursPerDay: number (double)
hasSprintConstraint: boolean false
strictStageDivision: boolean false
multiScenarioEnabled: boolean false
syncStartEnabled: boolean false
commitIssueAssignee: boolean false
minLoadUnstrEpics: integer (int64)
maxResourcesPerStory: integer (int64)
assigneeSchedulingLevel: integer (int64)
schedulingVerbosity: integer (int64)
unestimatedIssuesOption: integer (int64)
schedulingStartCustomField: integer (int64)
schedulingEndCustomField: integer (int64)
dependencyModeOption: integer (int64)
planningUnit: integer (int64)
programId: integer (int64)
portfolioPlanVersion: integer (int64)
Example
{
  "id": "integer (int64)",
  "nonWorkingDays": [
    {
      "id": "integer (int64)",
      "planId": "integer (int64)",
      "title": "string",
      "start": "integer (int64)",
      "end": "integer (int64)"
    }
  ],
  "planTeams": [
    "integer (int64)"
  ],
  "excludedVersions": [
    "integer (int64)"
  ],
  "heuristicThreshold": "integer (int32)",
  "globalSprintLength": "integer (int32)",
  "weekdayConfiguration": [
    "integer (int32)"
  ],
  "title": "string",
  "timeZone": "string",
  "defaultTeamWeeklyCapacity": "number (double)",
  "globalDefaultVelocity": "number (double)",
  "hoursPerDay": "number (double)",
  "hasSprintConstraint": "boolean",
  "strictStageDivision": "boolean",
  "multiScenarioEnabled": "boolean",
  "syncStartEnabled": "boolean",
  "commitIssueAssignee": "boolean",
  "minLoadUnstrEpics": "integer (int64)",
  "maxResourcesPerStory": "integer (int64)",
  "assigneeSchedulingLevel": "integer (int64)",
  "schedulingVerbosity": "integer (int64)",
  "unestimatedIssuesOption": "integer (int64)",
  "schedulingStartCustomField": "integer (int64)",
  "schedulingEndCustomField": "integer (int64)",
  "dependencyModeOption": "integer (int64)",
  "planningUnit": "integer (int64)",
  "programId": "integer (int64)",
  "portfolioPlanVersion": "integer (int64)"
}

StageDTO: object

id: integer (int64)
planId: integer (int64)
title: string
skillId: integer (int64)
weight: number (double)
color: string
Example
{
  "id": "integer (int64)",
  "planId": "integer (int64)",
  "title": "string",
  "skillId": "integer (int64)",
  "weight": "number (double)",
  "color": "string"
}

ProgramDTO: object

id: integer (int64)
title: string
owner: string
description: string
Example
{
  "id": "integer (int64)",
  "title": "string",
  "owner": "string",
  "description": "string"
}

HierarchyLevelDTO: object

id: integer (int64)
title: string
issueTypeIds: string[]
string
Example
{
  "id": "integer (int64)",
  "title": "string",
  "issueTypeIds": [
    "string"
  ]
}
Documentation by Spectacle