Procore.Api.CoreProjectDocumentsProjectFoldersAndFiles (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreProjectDocumentsProjectFoldersAndFiles.

Summary

Functions

rest_v10_file_versions_id_get(connection, procore_company_id, id, project_id, opts \\ [])

Show project file version Show detailed information about a File Version.

rest_v10_file_versions_post(connection, procore_company_id, project_id, file_id, file_version, opts \\ [])

Create project file version Upload a new version of a specific file in the Project Documents tool. See the Procore Support website articles on Project Documents for additional information.

rest_v10_files_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

Delete project File Delete the specified File by moving it to the recycle bin.

rest_v10_files_id_get(connection, procore_company_id, id, project_id, opts \\ [])

Show project File Show detailed information about a File.

rest_v10_files_id_patch(connection, procore_company_id, id, project_id, file, opts \\ [])

Update project File Update the specified File (creates a new file version).

rest_v10_files_post(connection, procore_company_id, project_id, file, opts \\ [])

Create project File Create a new File in the specified Project.

rest_v10_folders_get(connection, procore_company_id, project_id, opts \\ [])

List project folders and files Returns a list of folders and files for a specified project. Note: this operation will return all of the folders and files within the root folder of that project's document structure. For any folders that are nested more deeply an empty array [] will be returned.

rest_v10_folders_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

Delete Project Folder Delete the specified folder by moving it to the recycle bin.

rest_v10_folders_id_get(connection, procore_company_id, id, project_id, opts \\ [])

Show Project Folder Show detail on the specified folder. Must be either true or false.

rest_v10_folders_id_patch(connection, procore_company_id, id, project_id, rest_v10_folders_id_patch_request, opts \\ [])

Update Project Folder Update the specified folder.

rest_v10_folders_post(connection, procore_company_id, project_id, rest_v10_folders_post_request, opts \\ [])

Create Project Folder Create a new folder in the specified project.

Functions

Link to this function

rest_v10_file_versions_id_get(connection, procore_company_id, id, project_id, opts \\ [])

@spec rest_v10_file_versions_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10FileVersionsPost201Response.t()}
  | {:error, Tesla.Env.t()}

Show project file version Show detailed information about a File Version.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the file version
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10FileVersionsPost201Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_file_versions_post(connection, procore_company_id, project_id, file_id, file_version, opts \\ [])

@spec rest_v10_file_versions_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10FileVersionsPostRequestFileVersion.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10FileVersionsPost201Response.t()}
  | {:error, Tesla.Env.t()}

Create project file version Upload a new version of a specific file in the Project Documents tool. See the Procore Support website articles on Project Documents for additional information.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • file_id (integer()): The id of the File
  • file_version (Procore.Model.RestV10FileVersionsPostRequestFileVersion.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10FileVersionsPost201Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_files_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

@spec rest_v10_files_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Delete project File Delete the specified File by moving it to the recycle bin.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the File
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_files_id_get(connection, procore_company_id, id, project_id, opts \\ [])

@spec rest_v10_files_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10FilesPost201Response.t()}
  | {:error, Tesla.Env.t()}

Show project File Show detailed information about a File.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the File
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :show_latest_version_only (boolean()): Show only latest File version

Returns

  • {:ok, Procore.Model.RestV10FilesPost201Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_files_id_patch(connection, procore_company_id, id, project_id, file, opts \\ [])

@spec rest_v10_files_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10FilesIdPatchRequestFile.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10FilesPost201Response.t()}
  | {:ok, Procore.Model.RestV10FilesIdPatch409Response.t()}
  | {:error, Tesla.Env.t()}

Update project File Update the specified File (creates a new file version).

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the File
  • project_id (integer()): Unique identifier for the project.
  • file (Procore.Model.RestV10FilesIdPatchRequestFile.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10FilesPost201Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_files_post(connection, procore_company_id, project_id, file, opts \\ [])

@spec rest_v10_files_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10FilesPostRequestFile.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10FilesPost201Response.t()}
  | {:error, Tesla.Env.t()}

Create project File Create a new File in the specified Project.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • file (Procore.Model.RestV10FilesPostRequestFile.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10FilesPost201Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_folders_get(connection, procore_company_id, project_id, opts \\ [])

@spec rest_v10_folders_get(Tesla.Env.client(), integer(), integer(), keyword()) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.Folder.t()}
  | {:error, Tesla.Env.t()}

List project folders and files Returns a list of folders and files for a specified project. Note: this operation will return all of the folders and files within the root folder of that project's document structure. For any folders that are nested more deeply an empty array [] will be returned.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :exclude_folders (boolean()): Exclude child folders from results. Must be either true or false.
    • :exclude_files (boolean()): Exclude child files from results. Must be either true or false.
    • :show_latest_file_version_only (boolean()): Show only the latest file version. Must be either true or false.

Returns

  • {:ok, Procore.Model.Folder.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_folders_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

@spec rest_v10_folders_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Delete Project Folder Delete the specified folder by moving it to the recycle bin.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the folder
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_folders_id_get(connection, procore_company_id, id, project_id, opts \\ [])

@spec rest_v10_folders_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.Folder.t()}
  | {:error, Tesla.Env.t()}

Show Project Folder Show detail on the specified folder. Must be either true or false.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the folder
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :exclude_folders (boolean()): Exclude children Folders from results. Must be either true or false.
    • :exclude_files (boolean()): Exclude children files from results. Must be either true or false.
    • :show_latest_file_version_only (boolean()): Show only the latest file version. Must be either true or false.

Returns

  • {:ok, Procore.Model.Folder.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_folders_id_patch(connection, procore_company_id, id, project_id, rest_v10_folders_id_patch_request, opts \\ [])

@spec rest_v10_folders_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10FoldersIdPatchRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.Folder1.t()}
  | {:error, Tesla.Env.t()}

Update Project Folder Update the specified folder.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the folder
  • project_id (integer()): Unique identifier for the project.
  • rest_v10_folders_id_patch_request (RestV10FoldersIdPatchRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.Folder1.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_folders_post(connection, procore_company_id, project_id, rest_v10_folders_post_request, opts \\ [])

@spec rest_v10_folders_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10FoldersPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.Folder1.t()}
  | {:error, Tesla.Env.t()}

Create Project Folder Create a new folder in the specified project.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • rest_v10_folders_post_request (RestV10FoldersPostRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.Folder1.t} on success
  • {:error, Tesla.Env.t} on failure