Procore.Api.CoreProjectLinksLinks (procore_sdk v0.3.0)
API calls for all endpoints tagged CoreProjectLinksLinks.
Summary
Functions
List links Returns a list of Project Home Links on a given project. This endpoint will be deprecated; please use the V2 endpoint.
Delete link Send a specific Project Home Link to the recycle bin. Note: Requires either Company Admin or Project Home Admin permission. This endpoint will be deprecated; please use the V2 endpoint.
Show link Show detailed information for a specific Project Home Link
Update link Update one or more attributes of a specific Project Home Link. Note: Requires either Company Admin or Project Home Admin permission. This endpoint will be deprecated; please use the V2 endpoint.
Retrieve recycled link Retrieves and restores a specific Project Home Link from the recycle bin. Note: Requires either Company Admin or Project Home Admin permission.
Create link Creates a Project Home Link on a given project. Note: Requires either Company Admin or Project Home Admin permission. This endpoint will be deprecated; please use the V2 endpoint.
List recycled links Returns a list of all Project Home Links in the recycle bin for a specific project. Note: Requires either Company Admin or Project Home Admin permission.
Functions
rest_v10_links_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_links_get(Tesla.Env.client(), integer(), integer(), keyword()) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV10LinksGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List links Returns a list of Project Home Links on a given project. This endpoint will be deprecated; please use the V2 endpoint.
Parameters
connection(Procore.Connection): Connection to serverprocore_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
Returns
{:ok, [%RestV10LinksGet200ResponseInner{}, ...]}on success{:error, Tesla.Env.t}on failure
rest_v10_links_id_delete(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_links_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete link Send a specific Project Home Link to the recycle bin. Note: Requires either Company Admin or Project Home Admin permission. This endpoint will be deprecated; please use the V2 endpoint.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.id(integer()): Link IDopts(keyword): Optional parameters
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure
rest_v10_links_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_links_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10LinksPost201Response.t()} | {:error, Tesla.Env.t()}
Show link Show detailed information for a specific Project Home Link
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.id(integer()): Link IDopts(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10LinksPost201Response.t}on success{:error, Tesla.Env.t}on failure
rest_v10_links_id_patch(connection, procore_company_id, project_id, id, rest_v10_links_post_request, opts \\ [])
@spec rest_v10_links_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10LinksPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10LinksPost201Response.t()} | {:error, Tesla.Env.t()}
Update link Update one or more attributes of a specific Project Home Link. Note: Requires either Company Admin or Project Home Admin permission. This endpoint will be deprecated; please use the V2 endpoint.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.id(integer()): Link IDrest_v10_links_post_request(RestV10LinksPostRequest):opts(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10LinksPost201Response.t}on success{:error, Tesla.Env.t}on failure
rest_v10_links_id_restore_patch(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_links_id_restore_patch( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10LinksPost201Response.t()} | {:error, Tesla.Env.t()}
Retrieve recycled link Retrieves and restores a specific Project Home Link from the recycle bin. Note: Requires either Company Admin or Project Home Admin permission.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.id(integer()): Link IDopts(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10LinksPost201Response.t}on success{:error, Tesla.Env.t}on failure
rest_v10_links_post(connection, procore_company_id, project_id, rest_v10_links_post_request, opts \\ [])
@spec rest_v10_links_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV10LinksPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10LinksPost201Response.t()} | {:error, Tesla.Env.t()}
Create link Creates a Project Home Link on a given project. Note: Requires either Company Admin or Project Home Admin permission. This endpoint will be deprecated; please use the V2 endpoint.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.project_id(integer()): Unique identifier for the project.rest_v10_links_post_request(RestV10LinksPostRequest):opts(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10LinksPost201Response.t}on success{:error, Tesla.Env.t}on failure
rest_v10_links_recycle_bin_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_links_recycle_bin_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV10LinksRecycleBinGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List recycled links Returns a list of all Project Home Links in the recycle bin for a specific project. Note: Requires either Company Admin or Project Home Admin permission.
Parameters
connection(Procore.Connection): Connection to serverprocore_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
Returns
{:ok, [%RestV10LinksRecycleBinGet200ResponseInner{}, ...]}on success{:error, Tesla.Env.t}on failure