Versions Compared

Old Version 13

changes.mady.by.user Alejandro Vega

Saved on

compared with

New Version Current

changes.mady.by.user Alejandro Vega

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Note: This method will allow you to view the documentation in Swagger UI, but you will only be able to interact with the API if it can be accessed from a public URL/IP address. In that case, replace http://localhost:5000/ in the url field with the correct address. Otherwise, you will need to install locally (see below) on the system that is running the Django backend in order to issue API calls through Swagger UI.

Starting with Open API version 3.1.0, a new Swagger Editor was release (this is the linked version above)

Legacy Open API Swagger Editor which supports versions 3.0.X can be accessed by visiting https://editor.swagger.io/

Installing Swagger Editor locally

...

Expand
titleAccount management (accounts)

  • Status
    colourGreen
    titlePOST
    /accounts/api-token-auth/ Generate API token to authorize session

  • Status
    colourGreen
    titlePOST
    ​/accounts​/changePassword​/ Change the password of the specified user
    Status
    colourBlue
    titleGET
    /accounts​/check_user/ Return username of logged in user

Expand
titleGeneral high-level API calls (api)

  • Status
    colourBlue
    titleGET
    ​/api​/folder​/{folderId}​/tree​/ Return a tree containing all children of the specified folder

  • Status
    colourBlue
    titleGET
    ​/api​/request​/{requestId}​/ Return the contents of the specified request

  • Status
    colourBlue
    titleGET
    ​/api​/status​/ Report the status of the API backend, including mode

  • Status
    colourBlue
    titleGET
    ​/api​/tree​/ Return the highest level tree for this install

  • Status
    colourBlue
    titleGET
    ​/api​/{entity}​/allconfig​/ Return a full listing of an entity type (nodes, apps, objects)

  • Status
    colourBlue
    titleGET
    ​/api​/{entity}​/allconfig​fromtypes/ Return a full listing of an entity type (nodes, apps, objects)

  • Status
    colourBlue
    titleGET
    ​/api​/{schemaId}​/schema​/ Return the schema file for the specified schema ID

  • Status
    colourBlue
    titleGET
    ​/api​/itemTypes Return list of schema item types

  • Status
    colourBlue
    titleGET
    ​/api​​/schema​/ Return the schema files for the specified schema IDs

  • Status
    colourGreen
    titlePOST
    ​/api​/{category}/{itemId}/move/ Move node or folder to new location

  • Status
    colourGreen
    titlePOST
    ​/api​/folder/add/ Add new folder

  • Status
    colourBlue
    titleGET
    ​/api​/folder/{folderId}/view/ Get folder properties

  • Status
    colourGreen
    titlePOST
    ​/api​/folder/{folderId}/delete/Delete folder

  • Status
    colourBlue
    titleGET
    ​/api​/folder/{folderId}/config/ Get folder configurations

  • Status
    colourGreen
    titlePOST
    ​/api​/folder/{folderId}/config/Adjust the settings of the specified node

...