Jump to

• Request
• Response

Get Data Table Folders

get

/rest/v16/folders

This endpoint returns a list of data table folders visible to the current user.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : folders-collection

Type: object

Show Source

• _state: object state
  Title: state

  This object describes the folder permissions for the current user.
• items: array Folders List
  Title: Folders List

  List of accessible folders

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of accessible folders",
            "title":"Folders List",
            "items":{
                "$ref":"#/definitions/folders-createResponse"
            }
        },
        "_state":{
            "$ref":"#/definitions/folders-state"
        }
    }
}

Nested Schema : state

Type: object

Title: state

This object describes the folder permissions for the current user.

Show Source

• allowDelete: boolean
  Title: Allow Delete

  Identifies if the current user is allowed to delete the data table folder(s).
• allowUpdate: boolean
  Title: Allow Update

  Identifies if the current user is allowed to create and update the data table folder(s).

{
    "type":"object",
    "properties":{
        "allowUpdate":{
            "type":"boolean",
            "description":"Identifies if the current user is allowed to create and update the data table folder(s).",
            "title":"Allow Update"
        },
        "allowDelete":{
            "type":"boolean",
            "description":"Identifies if the current user is allowed to delete the data table folder(s).",
            "title":"Allow Delete"
        }
    },
    "title":"state",
    "description":"This object describes the folder permissions for the current user."
}

Nested Schema : Folders List

Type: array

Title: Folders List

List of accessible folders

Show Source

• Array of: object folders-createResponse

{
    "type":"array",
    "description":"List of accessible folders",
    "title":"Folders List",
    "items":{
        "$ref":"#/definitions/folders-createResponse"
    }
}

Nested Schema : folders-createResponse

Type: object

Show Source

• _state: object state
  Title: state

  This object describes the folder permissions for the current user.
• dateAdded: string
  Title: Date Added

  The date the data table folder was created.
• dateModified: string
  Title: Date Last Modified

  The date of the last data table folder modification.
• id: integer(int64)
  Title: Folder Id

  The unique identifier of the data table folder.
• name: string
  Title: Folder Name

  The data table folder name.
• variableName: string
  Title: FolderVariable Name

  The variable name of the data table folder

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the data table folder.",
            "title":"Folder Id"
        },
        "variableName":{
            "type":"string",
            "description":"The variable name of the data table folder",
            "title":"FolderVariable Name"
        },
        "name":{
            "type":"string",
            "description":"The data table folder name.",
            "title":"Folder Name"
        },
        "dateModified":{
            "type":"string",
            "description":"The date of the last data table folder modification.",
            "title":"Date Last Modified"
        },
        "dateAdded":{
            "type":"string",
            "description":"The date the data table folder was created.",
            "title":"Date Added"
        },
        "_state":{
            "$ref":"#/definitions/folders-state"
        }
    }
}

Back to Top