Procore.Api.QualitySafetyInspectionsChecklistItems (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyInspectionsChecklistItems.

Summary

Functions

rest_v10_checklist_lists_list_id_items_id_get(connection, procore_company_id, list_id, id, project_id, section_id, opts \\ [])

Show Checklist Item Retrieves Checklist Item in a specified Checklist

rest_v10_checklist_lists_list_id_items_id_patch(connection, procore_company_id, list_id, id, checklist_item_body, opts \\ [])

Update Checklist Item Updates Checklist Item in a specified Checklist

rest_v10_checklist_lists_list_id_items_item_id_item_attachments_post(connection, procore_company_id, list_id, item_id, project_id, section_id, attachment, opts \\ [])

Create Checklist Item Attachment Uploads an Attachment to the specified Checklist Item

rest_v10_projects_project_id_checklist_items_item_id_item_response_delete(connection, procore_company_id, item_id, project_id, opts \\ [])

Delete Checklist Item Response Removes the Checklist Item Response for a specified Checklist Item

rest_v10_projects_project_id_checklist_items_item_id_item_response_get(connection, procore_company_id, item_id, project_id, opts \\ [])

Show Checklist Item Response Returns the Checklist Item Response for a specified Checklist Item

rest_v10_projects_project_id_checklist_items_item_id_item_response_post(connection, procore_company_id, item_id, project_id, checklist_item_response_body, opts \\ [])

Create Checklist Item Response Create Checklist Item Response for a specified Checklist Item Checklist Item Response can have one of the following payload formats (text_value, number_value, date_value, response_option, status) A specific Item Type can only leverage its corresponding format. *For instance, Number Items can only leverage a number_value while Date Items can only leverage a date_value.

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

List Checklist (Inspections) Items Lists Checklist (Inspections) Items in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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

List Checklist (Inspections) Items Lists Checklist (Inspections) Items in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Functions

Link to this function

rest_v10_checklist_lists_list_id_items_id_get(connection, procore_company_id, list_id, id, project_id, section_id, opts \\ [])

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

Show Checklist Item Retrieves Checklist Item in a specified Checklist

Parameters

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

Returns

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

rest_v10_checklist_lists_list_id_items_id_patch(connection, procore_company_id, list_id, id, checklist_item_body, opts \\ [])

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

Update Checklist Item Updates Checklist Item in a specified Checklist

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • list_id (integer()): Checklist ID
  • id (integer()): Item ID
  • checklist_item_body (ChecklistItemBody):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_checklist_lists_list_id_items_item_id_item_attachments_post(connection, procore_company_id, list_id, item_id, project_id, section_id, attachment, opts \\ [])

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

Create Checklist Item Attachment Uploads an Attachment to the specified Checklist Item

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • list_id (integer()): Checklist ID
  • item_id (integer()): Checklist Item ID
  • project_id (integer()): The ID of the Project the Item belongs to
  • section_id (integer()): The ID of the Section the Item belongs to
  • attachment (String.t): Item Attachment. To upload an attachment you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with the attachment file.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_checklist_items_item_id_item_response_delete(connection, procore_company_id, item_id, project_id, opts \\ [])

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

Delete Checklist Item Response Removes the Checklist Item Response for a specified Checklist Item

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • item_id (integer()): Checklist Item ID
  • 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_projects_project_id_checklist_items_item_id_item_response_get(connection, procore_company_id, item_id, project_id, opts \\ [])

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

Show Checklist Item Response Returns the Checklist Item Response for a specified Checklist Item

Parameters

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

Returns

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

rest_v10_projects_project_id_checklist_items_item_id_item_response_post(connection, procore_company_id, item_id, project_id, checklist_item_response_body, opts \\ [])

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

Create Checklist Item Response Create Checklist Item Response for a specified Checklist Item Checklist Item Response can have one of the following payload formats (text_value, number_value, date_value, response_option, status) A specific Item Type can only leverage its corresponding format. *For instance, Number Items can only leverage a number_value while Date Items can only leverage a date_value.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • item_id (integer()): Checklist Item ID
  • project_id (integer()): Unique identifier for the project.
  • checklist_item_response_body (ChecklistItemResponseBody):
  • opts (keyword): Optional parameters

Returns

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

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

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

List Checklist (Inspections) Items Lists Checklist (Inspections) Items in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"filters[updated_at]" (Date.t): Return item(s) last updated 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[section_id]" ([integer()]): Return item(s) with the specified Checklist Section IDs
    • :"filters[list_id]" ([integer()]): Return item(s) with the specified Checklist List IDs
    • :"filters[item_response_status]" (String.t): Filter item(s) with matching item_response status.
    • :sort (String.t): Sort item(s) by the chosen param; check below for a list of options. The direction of sorting is ascending by default; for descending sort, insert the - symbol before the param.

Returns

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

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

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

List Checklist (Inspections) Items Lists Checklist (Inspections) Items in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"filters[updated_at]" (Date.t): Return item(s) last updated 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[section_id]" ([integer()]): Return item(s) with the specified Checklist Section IDs
    • :"filters[list_id]" ([integer()]): Return item(s) with the specified Checklist List IDs

Returns

  • {:ok, [%ChecklistListItem{}, ...]} on success
  • {:error, Tesla.Env.t} on failure