Skip to main content
Server path: /safetyculture-issues | Type: Application | PCID required: Yes

Tools


safetyculture_issues_customer_configuration_service_get_categories

List Categories Parameters:
ParameterTypeRequiredDefaultDescription
include_deletedbooleanNoOptional. If this is set to true, all categories including deleted categories will be returned.
searchstringNoSearch used to search for specific named categories
category_idsany[]NoDefine specific categoryIDs to filter for
page_tokenstringNoPage token used to scroll for the next set of categories
page_sizeintegerNoNumber of categories to respond with
sort_directionstringNoOptional. Direction for sorting.
is_managingbooleanNoOptional. Flag to indicate if the categories are being fetched to manage categories if true, the "admin:incidents" permission will be required, and category visibility is ignored.

safetyculture_issues_incidents_service_add_collaborators

Add Issue assignee Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the task being updated.
collaboratorsany[]NoRequired. The collaborators to be added to the task.
modified_atstringNoOptional. The timestamp of when this event occurred.

safetyculture_issues_incidents_service_delete_incidents

Delete Issues Parameters:
ParameterTypeRequiredDefaultDescription
idsany[]YesThe list of issue UUIDs to be deleted.
modified_atstringNoOptional. The UTC time and date the deletion took place.

safetyculture_issues_incidents_service_get_incident_by_id

Get Issue Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRequired. The unique ID of the incident to retrieve. Can either be a uuid or a org level unique incident id. Example: IS-4352

safetyculture_issues_incidents_service_get_incidents

List Issues Parameters:
ParameterTypeRequiredDefaultDescription
filtersany[]NoOptional. An array of filters can be provided in the request to filter the issues.
page_sizeintegerNoOptional. Number of issues to be returned in a single request. This must be a value between 1 and 100, any values outside of this range will be ignored. The presence of next_page_token in the response indicates that more results might be available.
page_tokenstringNoOptional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call. This can be used to retrieve more than 100 issues with multiple API calls. For example: ‘ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ=‘
sort_directionstringNoOptional. Direction for sorting.
sort_fieldstringNoOptional. Which field to use for sorting.

safetyculture_issues_incidents_service_get_incidents_count

Get count of Issues Parameters:
ParameterTypeRequiredDefaultDescription
filtersany[]NoOptional. An array of filters can be provided in the request to filter the issues.
page_sizeintegerNoOptional. Number of issues to be returned in a single request. This must be a value between 1 and 100, any values outside of this range will be ignored. The presence of next_page_token in the response indicates that more results might be available.
page_tokenstringNoOptional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call. This can be used to retrieve more than 100 issues with multiple API calls. For example: ‘ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ=‘
sort_directionstringNoOptional. Direction for sorting.
sort_fieldstringNoOptional. Which field to use for sorting.

safetyculture_issues_incidents_service_get_pdfreport

Export Issue to PDF Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesThe ID of the incident which the report is being created for

safetyculture_issues_incidents_service_remove_collaborators

Remove Issue assignee Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the task being updated.
collaboratorsany[]NoRequired. The collaborators to be removed from the task.
modified_atstringNoOptional. The timestamp of when this event occurred.

safetyculture_issues_incidents_service_submit_incident

Create Issue Parameters:
ParameterTypeRequiredDefaultDescription
access_tokenstringNoOptional. The access token used to authenticate the request. This field should be set when following the contributor flow. Otherwise, authenticate via normal means.
answered_questionsany[]NoOptional. An array of all, if any, custom questions that have been answered by the contributor @deprecated: Use QuestionAnswer instead. This was a field used for string custom questions. We’ve since moved to structured custom questions in the QuestionAnswer field.
asset_idstringNoOptional. The ID of the asset associated with this incident.
category_idstringYesRequired. ID of the incident’s category If not set, this incident will be stored with the default category(None)
contactstringNoOptional. The contact details of the contributor
created_atstringNoOptional. Date and time this incident was created
descriptionstringNoOptional. Description of the issue (maximum 500 characters).
emailstringNoOptional. The email address of the contributor
itemsany[]NoOptional. The category fields and questions that applied to this incident when it was created.
locationobjectNoThe location that the incident occurred at
mediaany[]NoOptional. Array of media items to be linked to the incident.
namestringNoOptional. The name of the contributor
occurred_atstringNoOptional. Date and time this incident occurred at
questions_and_answersany[]NoOptional. An array of all, if any, custom questions that have been answered for this issue.
site_idstringNoOptional. ID of the site to associate with the incident. If not provided, no site will be associated with the incident.
task_idstringNoOptional. The unique identifier of the incident If not provided, UUID will be generated server side
titlestringYesRequired. Title of the incident Title is limited to only 255 characters max

safetyculture_issues_incidents_service_update_asset

Update Issue asset Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the task being updated.
asset_idobjectNoOptional. The new asset UUID for the task. If this is empty, the asset will be unset.
modified_atstringNoOptional. The timestamp of when this event occurred.

safetyculture_issues_incidents_service_update_category

Update Category Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the issue being updated.
category_idstringYesRequired. The new category UUID for the issue. Call the GetCategories endpoint to get the available categories.
modified_atstringNoOptional. The timestamp of when this event occurred.

safetyculture_issues_incidents_service_update_description

Update Issue description Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the task being updated.
descriptionstringNoRequired. The new description for the task.
modified_atstringNoOptional. The timestamp of when this event occurred.

safetyculture_issues_incidents_service_update_due_at

Update Issue due date Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the task being updated
due_atstringNoOptional. Date/time this task is due. If this is empty, “due at” will be unset.
modified_atstringNoOptional. The timestamp of when this event occurred.

safetyculture_issues_incidents_service_update_occurred_at

Update Issue occurred at Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the task being updated.
modified_atstringNoOptional. The timestamp of when this event occurred.
occurred_atstringNoOptional. The new occurred at time for the task. If this is empty, the occurred at value will be unset.

safetyculture_issues_incidents_service_update_priority

Update Issue priority Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the task being updated.
modified_atstringNoOptional. The timestamp of when this event occurred.
priority_idstringYesRequired. The new priority UUID for the task.

safetyculture_issues_incidents_service_update_site

Update Issue site Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the task being updated.
modified_atstringNoOptional. The timestamp of when this event occurred.
site_idobjectNoOptional. The new site UUID for the task. If this is empty, the site will be unset. Use the GetFolders endpoint to get the available sites.

safetyculture_issues_incidents_service_update_status

Updates Issue status Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The ID of the action or issue you’re updating.
modified_atstringNoOptional. The UTC time and date the modification took place.
status_idstringYesRequired. The ID of the status you’re updating the action or issue to. An issue can be in an “Open” or “Resolved” status, where each status is represented by hardcoded UUID values. Issue statuses: - Open: 547ed646-5e34-4732-bb54-a199d304368a. - Resolved: 450484b1-56cd-4784-9b49-a3cf97d0c0ad. An action can be in a “To do”, “In progress”, “Complete”, or “Can’t do” status, where each status is represented by hardcoded UUID values. Action statuses: - To do: 17e793a1-26a3-4ecd-99ca-f38ecc6eaa2e. - In progress: 20ce0cb1-387a-47d4-8c34-bc6fd3be0e27. - Complete: 7223d809-553e-4714-a038-62dc98f3fbf3. - Can’t do: 06308884-41c2-4ee0-9da7-5676647d3d75.

safetyculture_issues_incidents_service_update_title

Update Issue title Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the task being updated.
modified_atstringNoOptional. The timestamp of when this event occurred.
titlestringNoRequired. The new title for the task. The title must be between 0 and 255 characters.