Project Structure

LIVE

https://app.polarix.io

GET

/api/{version}/projects/{project_id}/structure

Retrieves Project structure based on the {project_id} path parameter. Project ID is retrieved by calling the "Project List" endpoint.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

version

number

required

Target Polarix.io API version

Example:

project_id

string

required

Project ID retrieved by calling the "Project List" endpoint

Example:

6582ed0344adfe123d04f772

Header Params

x-api-key

string

required

Example:

1234abcd

string

optional

use text/xml if XML is required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://app.polarix.io/api/1.0/projects/6582ed0344adfe123d04f772/structure' \
--header 'x-api-key: 1234abcd' \
--header 'Accept: application/json'

Responses

🟢200Success — JSON

application/json

Body

array of:

integer

required

name

string

required

parent_id

integer | null

required

Example

[
    {
        "id": 1,
        "name": "Pillar",
        "parent_id": null
    },
    {
        "id": 2,
        "name": "Communication Objective",
        "parent_id": 1
    },
    {
        "id": 3,
        "name": "Scientific Statement",
        "parent_id": 2
    }
]

🟢200Success — XML

🟠401Unauthorized — JSON

🟠401Unauthorized — XML

🔴500Server Error — JSON

🔴500Server Error — XML

Project

Project Lexicon