Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
    • Non-Project Work Items
    • Contributor Work Associations
    • Contributions
    Cloud
    Capacity Planning / Reference / REST API

    Non-Project Work Items

    OpenAPI
    GET

    List non-project work itemsPreview

    Lists non-project work items, optionally filtered by name, with cursor-based pagination.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Query parameters

    query

    string

    first

    integer

    after

    string

    last

    integer

    before

    string

    Responses

    OK

    application/json

    GetNonProjectWorkItemsResponse

    Paginated response containing non-project work items

    GET/non-project-work-items
    1 2 3 curl --request GET \ --url 'https://api.atlassian.com/ex/capacity-planning/{cloudId}/v1/non-project-work-items' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "nonProjectWorkItems": [ { "ari": "ari:cloud:capacity-planning::custom-contribution-target/activation/a729796c-2ed4-4307-913a-d82357bb2f9a/3f2504e0-4f89-41d3-9a0c-0305e82c3301", "id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "name": "<string>" } ], "pageInfo": { "endCursor": "<string>", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "<string>" } }
    POST

    Create a non-project work itemPreview

    Creates a non-project work item.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Request bodyapplication/json

    name

    string

    Required

    Responses

    Created

    application/json

    CreateNonProjectWorkItemResponse

    Response containing the created non-project work item

    POST/non-project-work-items
    1 2 3 4 5 6 7 curl --request POST \ --url 'https://api.atlassian.com/ex/capacity-planning/{cloudId}/v1/non-project-work-items' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>" }'
    201Response
    1 2 3 4 5 6 7 { "nonProjectWorkItem": { "ari": "ari:cloud:capacity-planning::custom-contribution-target/activation/a729796c-2ed4-4307-913a-d82357bb2f9a/3f2504e0-4f89-41d3-9a0c-0305e82c3301", "id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "name": "<string>" } }
    GET

    Get a non-project work item by idPreview

    Retrieves a single non-project work item by its server-allocated UUID.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    id

    string

    Required

    Responses

    OK

    application/json

    NonProjectWorkItemDto

    A non-project work item

    GET/non-project-work-items/{id}
    1 2 3 curl --request GET \ --url 'https://api.atlassian.com/ex/capacity-planning/{cloudId}/v1/non-project-work-items/{id}' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 { "ari": "ari:cloud:capacity-planning::custom-contribution-target/activation/a729796c-2ed4-4307-913a-d82357bb2f9a/3f2504e0-4f89-41d3-9a0c-0305e82c3301", "id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "name": "<string>" }
    PUT

    Update a non-project work itemPreview

    Updates the mutable fields (name) of an existing non-project work item.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    id

    string

    Required

    Request bodyapplication/json

    name

    string

    Required

    Responses

    OK

    application/json

    NonProjectWorkItemDto

    A non-project work item

    PUT/non-project-work-items/{id}
    1 2 3 4 5 6 7 curl --request PUT \ --url 'https://api.atlassian.com/ex/capacity-planning/{cloudId}/v1/non-project-work-items/{id}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>" }'
    200Response
    1 2 3 4 5 { "ari": "ari:cloud:capacity-planning::custom-contribution-target/activation/a729796c-2ed4-4307-913a-d82357bb2f9a/3f2504e0-4f89-41d3-9a0c-0305e82c3301", "id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "name": "<string>" }

    Rate this page: