Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
executable file 146 lines (136 sloc) 3.68 KB

Sitemap structure

Note: it’s not possible to fetch archived sitemaps, you will get HTTP 403 Sitemap archived response.

Get the sitemap structure

  • GET /v1/sitemaps/<sitemap_id>/structure
  • Required scope: sitemaps_read or sitemaps_write

Response

{
    "svgmainsection": [
        {
            "color": "#5a5151",
            "level": "home",
            "text": "Homepage",
            "order": 1,
            "id": "svgmld3kg61tyrrcjzb",
            "has_note": false,
            "has_url": false,
            "has_content": true,
            "has_files": false,
            "has_diagrams": false
        },
        {
            "color": "#57aa34",
            "archetype": "exrrliyswugymjz",
            "level": 1,
            "text": "Level 1",
            "order": 1000,
            "id": "svgz1wxw28i5deh25tt",
            "has_note": false,
            "has_url": false,
            "has_diagrams": false,
            "has_files": true,
            "has_content": false
        },
        {
            "level": 2,
            "text": "Level 2",
            "order": 1000,
            "id": "svgzcqzw2zegdehrliy",
            "parent": "svgz1wxw28i5deh25tt",
            "has_note": false,
            "has_url": true,
            "has_diagrams": false,
            "has_files": true,
            "has_content": false
        },
        {
            "color": "#cc2e2e",
            "textcolor": "#eacdcd",
            "level": "foot",
            "text": "Example",
            "order": 5000,
            "id": "svgvcqzzz9gpzegqypa",
            "has_note": true,
            "has_url": false,
            "has_diagrams": true,
            "has_files": false,
            "has_content": true
        }
    ],
    "svgtvberlfm9etj2iqp": [
        {
            "level": "home",
            "text": "Section Home",
            "order": 1,
            "id": "svgedzxjgdut1yndneo",
            "has_note": false,
            "has_url": false,
            "has_diagrams": false,
            "has_files": false,
            "has_content": true
        }
    ]
}

Possible other responses: 403 and 404.

See the description of a single page details on the (page endpoint)[./page.md].

Get the specified section structure

  • GET /v1/sitemaps/<sitemap_id>/structure/<section_id>
  • Required scope: sitemaps_read or sitemaps_write

Response

[
    {
        "color": "#5a5151",
        "level": "home",
        "text": "Homepage",
        "order": 1,
        "id": "svgmld3kg61tyrrcjzb",
        "has_note": false,
        "has_url": false,
        "has_content": true,
        "has_files": false,
        "has_diagrams": false
    },
    {
        "color": "#57aa34",
        "archetype": "exrrliyswugymjz",
        "level": 1,
        "text": "Level 1",
        "order": 1000,
        "id": "svgz1wxw28i5deh25tt",
        "has_note": false,
        "has_url": false,
        "has_diagrams": false,
        "has_files": true,
        "has_content": false
    },
    {
        "level": 2,
        "text": "Level 2",
        "order": 1000,
        "id": "svgzcqzw2zegdehrliy",
        "parent": "svgz1wxw28i5deh25tt",
        "has_note": false,
        "has_url": true,
        "has_diagrams": false,
        "has_files": true,
        "has_content": false
    },
    {
        "color": "#cc2e2e",
        "textcolor": "#eacdcd",
        "level": "foot",
        "text": "Example",
        "order": 5000,
        "id": "svgvcqzzz9gpzegqypa",
        "has_note": true,
        "has_url": false,
        "has_diagrams": true,
        "has_files": false,
        "has_content": true
    }
]

Possible other responses: 403 and 404.