Skip to content

FoldersApi.md

Latest commit

 

History

History
324 lines (230 loc) · 9.33 KB

FoldersApi.md

File metadata and controls

324 lines (230 loc) · 9.33 KB

caplinked.FoldersApi

All URIs are relative to https://sandbox.caplinked.com/api/v1

Method HTTP request Description
delete_folders_id DELETE /folders/{id} Delete folder
get_folders_id GET /folders/{id} Get folder information
post_folders POST /folders Create new folder
post_folders_id_copy POST /folders/{id}/copy Copy folder
post_folders_id_move POST /folders/{id}/move Move folder
put_folders_id PUT /folders/{id} Update folder information

delete_folders_id

FolderDelete delete_folders_id(id, workspace_id)

Delete folder

Delete folder

Example

from __future__ import print_function
import time
import caplinked
from caplinked.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = caplinked.FoldersApi()
id = 56 # int | ID of folder to delete
workspace_id = 'workspace_id_example' # str | ID of workspace

try: 
    # Delete folder
    api_response = api_instance.delete_folders_id(id, workspace_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FoldersApi->delete_folders_id: %s\n" % e)

Parameters

Name Type Description Notes
id int ID of folder to delete
workspace_id str ID of workspace

Return type

FolderDelete

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_folders_id

FolderContent get_folders_id(id, workspace_id)

Get folder information

Get folder information

Example

from __future__ import print_function
import time
import caplinked
from caplinked.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = caplinked.FoldersApi()
id = 56 # int | ID of folder
workspace_id = 'workspace_id_example' # str | ID of workspace

try: 
    # Get folder information
    api_response = api_instance.get_folders_id(id, workspace_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FoldersApi->get_folders_id: %s\n" % e)

Parameters

Name Type Description Notes
id int ID of folder
workspace_id str ID of workspace

Return type

FolderContent

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_folders

FolderMeta post_folders(workspace_id, name, parent_id=parent_id)

Create new folder

Create new folder

Example

from __future__ import print_function
import time
import caplinked
from caplinked.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = caplinked.FoldersApi()
workspace_id = 'workspace_id_example' # str | ID of workspace
name = 'name_example' # str | Name of new folder
parent_id = 0 # int | ID of parent folder (defaults to root folder [id=0]) (optional) (default to 0)

try: 
    # Create new folder
    api_response = api_instance.post_folders(workspace_id, name, parent_id=parent_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FoldersApi->post_folders: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id str ID of workspace
name str Name of new folder
parent_id int ID of parent folder (defaults to root folder [id=0]) [optional] [default to 0]

Return type

FolderMeta

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_folders_id_copy

FolderCopyMove post_folders_id_copy(id, workspace_id, destination_folder_id)

Copy folder

Copy folder into another folder (existing folder will not be modified). The copied folder will inherit group folder permissions from its new parent folder.

Example

from __future__ import print_function
import time
import caplinked
from caplinked.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = caplinked.FoldersApi()
id = 56 # int | ID of folder to copy
workspace_id = 'workspace_id_example' # str | ID of workspace
destination_folder_id = 56 # int | ID of destination parent folder

try: 
    # Copy folder
    api_response = api_instance.post_folders_id_copy(id, workspace_id, destination_folder_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FoldersApi->post_folders_id_copy: %s\n" % e)

Parameters

Name Type Description Notes
id int ID of folder to copy
workspace_id str ID of workspace
destination_folder_id int ID of destination parent folder

Return type

FolderCopyMove

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_folders_id_move

FolderCopyMove post_folders_id_move(id, workspace_id, destination_folder_id)

Move folder

Move folder into another folder

Example

from __future__ import print_function
import time
import caplinked
from caplinked.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = caplinked.FoldersApi()
id = 56 # int | ID of folder to move
workspace_id = 'workspace_id_example' # str | ID of workspace
destination_folder_id = 56 # int | ID of destination parent folder

try: 
    # Move folder
    api_response = api_instance.post_folders_id_move(id, workspace_id, destination_folder_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FoldersApi->post_folders_id_move: %s\n" % e)

Parameters

Name Type Description Notes
id int ID of folder to move
workspace_id str ID of workspace
destination_folder_id int ID of destination parent folder

Return type

FolderCopyMove

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_folders_id

FolderMeta put_folders_id(id, workspace_id, folder_name=folder_name, folder_index=folder_index)

Update folder information

Update folder information

Example

from __future__ import print_function
import time
import caplinked
from caplinked.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = caplinked.FoldersApi()
id = 56 # int | Update folder name and index
workspace_id = 'workspace_id_example' # str | ID of workspace
folder_name = 'folder_name_example' # str | Name of folder (optional)
folder_index = 56 # int | Index number of folder within current folder scope (integer) (optional)

try: 
    # Update folder information
    api_response = api_instance.put_folders_id(id, workspace_id, folder_name=folder_name, folder_index=folder_index)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FoldersApi->put_folders_id: %s\n" % e)

Parameters

Name Type Description Notes
id int Update folder name and index
workspace_id str ID of workspace
folder_name str Name of folder [optional]
folder_index int Index number of folder within current folder scope (integer) [optional]

Return type

FolderMeta

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]