Project

Method	HTTP request	Release Stage
add_organizations	POST /v2/filesystem/projects/{projectRid}/addOrganizations	Public Beta
create	POST /v2/filesystem/projects/create	Public Beta
create_from_template	POST /v2/filesystem/projects/createFromTemplate	Public Beta
get	GET /v2/filesystem/projects/{projectRid}	Stable
organizations	GET /v2/filesystem/projects/{projectRid}/organizations	Public Beta
remove_organizations	POST /v2/filesystem/projects/{projectRid}/removeOrganizations	Public Beta
replace	PUT /v2/filesystem/projects/{projectRid}	Private Beta

add_organizations

Adds a list of Organizations to a Project.

Parameters

Name	Type	Description	Notes
project_rid	ProjectRid
organization_rids	List[OrganizationRid]
preview	Optional[PreviewMode]	Enables the use of preview functionality.	[optional]

Return type

None

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ProjectRid
project_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8"
# List[OrganizationRid]
organization_rids = ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.filesystem.Project.add_organizations(
        project_rid, organization_rids=organization_rids, preview=preview
    )
    print("The add_organizations response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Project.add_organizations: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
204	None		None

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

create

Creates a new Project.

Note that third-party applications using this endpoint via OAuth2 cannot be associated with an Ontology SDK as this will reduce the scope of operations to only those within specified projects. When creating the application, select "No, I won't use an Ontology SDK" on the Resources page.

Parameters

Name	Type	Description	Notes
default_roles	List[RoleId]
display_name	ResourceDisplayName
organization_rids	List[OrganizationRid]
role_grants	Dict[RoleId, List[PrincipalWithId]]
space_rid	SpaceRid
description	Optional[str]		[optional]
preview	Optional[PreviewMode]	Enables the use of preview functionality.	[optional]

Return type

Project

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# List[RoleId]
default_roles = ["8bf49052-dc37-4528-8bf0-b551cfb71268"]
# ResourceDisplayName
display_name = "My Important Project"
# List[OrganizationRid]
organization_rids = ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"]
# Dict[RoleId, List[PrincipalWithId]]
role_grants = {
    "8bf49052-dc37-4528-8bf0-b551cfb71268": [
        {"principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "principalType": "GROUP"}
    ]
}
# SpaceRid
space_rid = "ri.compass.main.folder.a86ad5f5-3db5-48e4-9fdd-00aa3e5731ca"
# Optional[str]
description = "project description"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.filesystem.Project.create(
        default_roles=default_roles,
        display_name=display_name,
        organization_rids=organization_rids,
        role_grants=role_grants,
        space_rid=space_rid,
        description=description,
        preview=preview,
    )
    print("The create response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Project.create: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Project		application/json

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

create_from_template

Creates a project from a project template.

Parameters

Name	Type	Description	Notes
template_rid	ProjectTemplateRid
variable_values	Dict[ProjectTemplateVariableId, ProjectTemplateVariableValue]
default_roles	Optional[List[RoleId]]		[optional]
organization_rids	Optional[List[OrganizationRid]]		[optional]
preview	Optional[PreviewMode]	Enables the use of preview functionality.	[optional]
project_description	Optional[str]		[optional]

Return type

Project

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ProjectTemplateRid
template_rid = "ri.compass.main.template.c410f510-2937-420e-8ea3-8c9bcb3c1791"
# Dict[ProjectTemplateVariableId, ProjectTemplateVariableValue]
variable_values = {"name": "my project name"}
# Optional[List[RoleId]]
default_roles = ["8bf49052-dc37-4528-8bf0-b551cfb71268"]
# Optional[List[OrganizationRid]]
organization_rids = ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None
# Optional[str]
project_description = None


try:
    api_response = client.filesystem.Project.create_from_template(
        template_rid=template_rid,
        variable_values=variable_values,
        default_roles=default_roles,
        organization_rids=organization_rids,
        preview=preview,
        project_description=project_description,
    )
    print("The create_from_template response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Project.create_from_template: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Project		application/json

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

get

Get the Project with the specified rid.

Parameters

Name	Type	Description	Notes
project_rid	ProjectRid

Return type

Project

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ProjectRid
project_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8"


try:
    api_response = client.filesystem.Project.get(project_rid)
    print("The get response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Project.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Project		application/json

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

organizations

List of Organizations directly applied to a Project. The number of Organizations on a Project is typically small so the pageSize and pageToken parameters are not required.

Parameters

Name	Type	Description	Notes
project_rid	ProjectRid
page_size	Optional[PageSize]	The page size to use for the endpoint.	[optional]
page_token	Optional[PageToken]	The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request.	[optional]
preview	Optional[PreviewMode]	Enables the use of preview functionality.	[optional]

Return type

ListOrganizationsOfProjectResponse

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ProjectRid
project_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8"
# Optional[PageSize] | The page size to use for the endpoint.
page_size = None
# Optional[PageToken] | The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request.
page_token = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    for project in client.filesystem.Project.organizations(
        project_rid, page_size=page_size, page_token=page_token, preview=preview
    ):
        pprint(project)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Project.organizations: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	ListOrganizationsOfProjectResponse		application/json

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

remove_organizations

Removes Organizations from a Project.

Parameters

Name	Type	Description	Notes
project_rid	ProjectRid
organization_rids	List[OrganizationRid]
preview	Optional[PreviewMode]	Enables the use of preview functionality.	[optional]

Return type

None

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ProjectRid
project_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8"
# List[OrganizationRid]
organization_rids = ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.filesystem.Project.remove_organizations(
        project_rid, organization_rids=organization_rids, preview=preview
    )
    print("The remove_organizations response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Project.remove_organizations: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
204	None		None

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

replace

Replace the Project with the specified rid.

Parameters

Name	Type	Description	Notes
project_rid	ProjectRid
display_name	ResourceDisplayName	The display name of the Project. Must be unique and cannot contain a /
description	Optional[str]	The description associated with the Project.	[optional]
preview	Optional[PreviewMode]	Enables the use of preview functionality.	[optional]

Return type

Project

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ProjectRid
project_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8"
# ResourceDisplayName | The display name of the Project. Must be unique and cannot contain a /
display_name = "My Important Project"
# Optional[str] | The description associated with the Project.
description = "project description"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.filesystem.Project.replace(
        project_rid, display_name=display_name, description=description, preview=preview
    )
    print("The replace response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Project.replace: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Project	The replaced Project	application/json

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

FilesExpand file tree

Project.md

Latest commit

History

Project.md

File metadata and controls

Project

add_organizations

Parameters

Return type

Example

Authorization

HTTP response details

create

Parameters

Return type

Example

Authorization

HTTP response details

create_from_template

Parameters

Return type

Example

Authorization

HTTP response details

get

Parameters

Return type

Example

Authorization

HTTP response details

organizations

Parameters

Return type

Example

Authorization

HTTP response details

remove_organizations

Parameters

Return type

Example

Authorization

HTTP response details

replace

Parameters

Return type

Example

Authorization

HTTP response details