Procore.Api.CoreDocumentsDocuments (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreDocumentsDocuments.

Summary

Functions

rest_v10_companies_company_id_documents_get(connection, procore_company_id, company_id, opts \\ [])

Company Folder and File index Return a list of all folders and files in the company

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

Project Folder and File index Return a list of all folders and files in the project

Functions

Link to this function

rest_v10_companies_company_id_documents_get(connection, procore_company_id, company_id, opts \\ [])

@spec rest_v10_companies_company_id_documents_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [Procore.Model.ExampleOfAFolderThatIsAFile.t()]}
  | {:error, Tesla.Env.t()}

Company Folder and File index Return a list of all folders and files in the company

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters
    • :view (String.t): Determines how much information to include in the response. normal is the default, extended provides additional data. The example below shows the extended response.
    • :sort (String.t): Field to sort by. If the field is passed with a - (EX: -updated_at) it is sorted in reverse order
    • :"filters[created_by_id]" ([integer()]): Return item(s) created by the specified User IDs
    • :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[document_type]"(String.t): Return item(s) that are file or folder -:"filters[file_type]"([String.t]): Return item(s) that have the file extensions -:"filters[is_in_recycle_bin]"(boolean()): Return item(s) that are in or not in the recycle bin -:"filters[search]"(String.t): Return item(s) that contain string in document name and file description -:"filters[folder_id]"(integer()): Returns the folder for a given id with all subfolders and subfiles up to a depth of 100. Depths greater than 100 will need multiple queries to get all children. -:page(integer()): Page -:per_page(integer()): Elements per page ### Returns -, ...]}on success -` on failure
Link to this function

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

@spec rest_v10_projects_project_id_documents_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [Procore.Model.ExampleOfAFolderThatIsAFile.t()]}
  | {:error, Tesla.Env.t()}

Project Folder and File index Return a list of all folders and files in the 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.
  • opts (keyword): Optional parameters
    • :view (String.t): Determines how much information to include in the response. normal is the default, extended provides additional data. The example below shows the extended response.
    • :sort (String.t): Field to sort by. If the field is passed with a - (EX: -updated_at) it is sorted in reverse order
    • :"filters[created_by_id]" ([integer()]): Return item(s) created by the specified User IDs
    • :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[document_type]"(String.t): Return item(s) that are file or folder -:"filters[file_type]"([String.t]): Return item(s) that have the file extensions -:"filters[is_in_recycle_bin]"(boolean()): Return item(s) that are in or not in the recycle bin -:"filters[search]"(String.t): Return item(s) that contain string in document name and file description -:"filters[folder_id]"(integer()): Returns the folder for a given id with all subfolders and subfiles up to a depth of 100. Depths greater than 100 will need multiple queries to get all children. -:"filters[custom_tag_ids]"([integer()]): Return item(s) with specified custom tag IDs -:"filters[private]"(boolean()): If true, returns only item(s) with aprivatestatus. -:page(integer()): Page -:per_page(integer()): Elements per page ### Returns -, ...]}on success -` on failure