Procore.Api.CoreProjectDocumentsProjectDocuments (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreProjectDocumentsProjectDocuments.

Summary

Functions

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

List project Document Custom Tags Return a list of Document Custom Tags for a specified Project.

rest_v10_projects_project_id_document_custom_tags_id_delete(connection, procore_company_id, project_id, id, document_id, opts \\ [])

Delete Document Custom Tag Delete a Custom Tag From a specified Folder or File

rest_v10_projects_project_id_document_custom_tags_post(connection, procore_company_id, project_id, body41, opts \\ [])

Create Document Custom Tag Create a new Custom Tag for the specified Folder or File

Functions

Link to this function

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

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

List project Document Custom Tags Return a list of Document Custom Tags for a 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.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[document_id]" (integer()): ID of the Folder or File

Returns

  • {:ok, [%RestV10ProjectsProjectIdDocumentCustomTagsGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_projects_project_id_document_custom_tags_id_delete(connection, procore_company_id, project_id, id, document_id, opts \\ [])

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

Delete Document Custom Tag Delete a Custom Tag From a specified Folder or File

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.
  • id (integer()): ID of the Custom Tag
  • document_id (integer()): ID of the Folder or File to remove the Custom Tag from
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_document_custom_tags_post(connection, procore_company_id, project_id, body41, opts \\ [])

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

Create Document Custom Tag Create a new Custom Tag for the specified Folder or File

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.
  • body41 (Body41):
  • opts (keyword): Optional parameters

Returns

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