This documentation relates to an older version 2.5 of the Structure Plugin for JIRA. View the current documentation home.

Skip to end of metadata
Go to start of metadata

Structure REST API is yet under active development. The functionality available through REST is not complete, yet it allows to work with the structures.

The API is also not stable, although we're not seeing major changes coming to the main resources.

General Notes

REST Resource Address

Structure REST API resources have the URL

BASEURL/rest/structure/1.0/NAME

where BASEURL is the base JIRA address (http://localhost:2990/jira being standard base URL for development environment) and NAME is the name of the resource.

Authentication

Authentication is done via standard JIRA authentication engine and supported by cookies. When accessing REST API from a remote application, you may need to set up the session first by calling JIRA authentication REST resource. (You don't need to do that if you access Structure REST API from a JavaScript on a page from the same JIRA instance.)

Most read operations are available to non-authenticated access (subject to permission checks for the anonymous user). Most mutation operations are available to authenticated users only.

REST Resources and Operations

Structure resources

/structure/ GET

list structures

/structure/ POST

create a structure

/structure/{id} GET

read information about a structure

/structure/{id}/update POST

update one or several structure fields

/structure/{id} DELETE

delete a structure

Forest resources

/structure/id/forest GET

get a forest

/structure/id/forest POST

make changes to a forest

  • No labels