Skip to content

Latest commit

 

History

History
252 lines (178 loc) · 7.04 KB

Folder.md

File metadata and controls

252 lines (178 loc) · 7.04 KB
Raw

Folder

Method HTTP request
children GET /v2/filesystem/folders/{folderRid}/children
children_page GET /v2/filesystem/folders/{folderRid}/children
create POST /v2/filesystem/folders
get GET /v2/filesystem/folders/{folderRid}

children

List all child Resources of the Folder.

This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is provided, this page size will also be used as the default.

Parameters

Name Type Description Notes
folder_rid FolderRid folderRid
page_size Optional[PageSize] pageSize [optional]
preview Optional[PreviewMode] preview [optional]

Return type

ResourceIterator[Resource]

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# FolderRid | folderRid
folder_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8"
# Optional[PageSize] | pageSize
page_size = None
# Optional[PreviewMode] | preview
preview = None


try:
    for folder in foundry_client.filesystem.Folder.children(
        folder_rid,
        page_size=page_size,
        preview=preview,
    ):
        pprint(folder)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Folder.children: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 ListChildrenOfFolderResponse application/json

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

children_page

List all child Resources of the Folder.

This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is provided, this page size will also be used as the default.

Parameters

Name Type Description Notes
folder_rid FolderRid folderRid
page_size Optional[PageSize] pageSize [optional]
page_token Optional[PageToken] pageToken [optional]
preview Optional[PreviewMode] preview [optional]

Return type

ListChildrenOfFolderResponse

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# FolderRid | folderRid
folder_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8"
# Optional[PageSize] | pageSize
page_size = None
# Optional[PageToken] | pageToken
page_token = None
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.filesystem.Folder.children_page(
        folder_rid,
        page_size=page_size,
        page_token=page_token,
        preview=preview,
    )
    print("The children_page response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Folder.children_page: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 ListChildrenOfFolderResponse application/json

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

create

Creates a new Folder.

Parameters

Name Type Description Notes
display_name ResourceDisplayName
parent_folder_rid FolderRid The parent folder Resource Identifier (RID). For Projects, this will be the Space RID and for Spaces, this value will be the root folder (ri.compass.main.folder.0).
preview Optional[PreviewMode] preview [optional]

Return type

Folder

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# ResourceDisplayName |
display_name = "My Folder"
# FolderRid | The parent folder Resource Identifier (RID). For Projects, this will be the Space RID and for Spaces, this value will be the root folder (`ri.compass.main.folder.0`).
parent_folder_rid = "ri.compass.main.folder.4cae7c13-b59f-48f6-9ef2-dbde603e4e33"
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.filesystem.Folder.create(
        display_name=display_name,
        parent_folder_rid=parent_folder_rid,
        preview=preview,
    )
    print("The create response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Folder.create: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Folder The created Folder application/json

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

get

Get the Folder with the specified rid.

Parameters

Name Type Description Notes
folder_rid FolderRid folderRid
preview Optional[PreviewMode] preview [optional]

Return type

Folder

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# FolderRid | folderRid
folder_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8"
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.filesystem.Folder.get(
        folder_rid,
        preview=preview,
    )
    print("The get response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Folder.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Folder application/json

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