POST /rest/api/2/plans/plan
Creates a plan.
Permissions required: Administer Jira global permission.
Servers
- https://your-domain.atlassian.net
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
useGroupId |
Boolean | No |
Whether to accept group IDs instead of group names. Group names are deprecated. Default value: false |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
leadAccountId |
String | No |
The account ID of the plan lead. |
customFields[] |
Array | No |
The custom fields for the plan. |
customFields[].filter |
Boolean | No |
Allows filtering issues based on their values for the custom field. |
customFields[].customFieldId |
Integer | Yes |
The custom field ID. |
name |
String | Yes |
The plan name. |
crossProjectReleases[] |
Array | No |
The cross-project releases to include in the plan. |
crossProjectReleases[].name |
String | Yes |
The cross-project release name. |
crossProjectReleases[].releaseIds[] |
Array | No |
The IDs of the releases to include in the cross-project release. |
permissions[] |
Array | No |
The permissions for the plan. |
permissions[].type |
String | Yes |
The permission type. This must be "View" or "Edit". Possible values:
|
issueSources[] |
Array | Yes |
The issue sources to include in the plan. |
issueSources[].type |
String | Yes |
The issue source type. This must be "Board", "Project" or "Filter". Possible values:
|
issueSources[].value |
Integer | Yes |
The issue source value. This must be a board ID if the type is "Board", a project ID if the type is "Project" or a filter ID if the type is "Filter". |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.