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

Tools


safetyculture_actions_customer_configuration_service_get_action_labels

Get all action labels

safetyculture_actions_scheduling_service_create_new_schedule

Create a new schedule Parameters:
ParameterTypeRequiredDefaultDescription
assignmentobjectYesSpecifies which users are assigned to complete the work.
completion_rulestringNoCompletion rule for the schedule. Determines how many assigned users must complete the work for an occurrence to be considered complete. Defaults to COMPLETION_RULE_ANY (any single assigned user can complete it) if not specified.
recurrenceobjectYesThe recurrence pattern that defines when and how frequently the scheduled event occurs.
targetobjectNoSpecifies which sites or assets this schedule applies to. When set, a separate occurrence is created for each target (site or asset) at each recurrence. When not set, the schedule creates occurrences directly for the assigned users.
titlestringYesTitle of the schedule.
work_typeobjectNoThe work to be done as part of the schedule.

safetyculture_actions_service_create_action

Create an action Parameters:
ParameterTypeRequiredDefaultDescription
asset_idstringNoID of the Asset associated with the action
collaboratorsany[]NoThe collaborators involved into this action.
created_atstringNoDate and time this action was created.
descriptionstringNoDescription of the action (maximum 30000 characters).
due_atstringNoDate/time this action is due
field_valuesany[]NoArray of custom fields and their values to create with the action.
inspection_idstringNoID of the inspection the action belongs to If not set, this action is a standalone action and the inspection ID will be null.
inspection_item_idstringNoID of the item in the inspection associated with the action
label_idsany[]NoIDs of the labels associated with the action.
priority_idstringNoID of the action’s priority If not set, this action will be stored with the default priority(none).
referencesany[]NoArray of references attached to this action.
site_idstringNoID of the Site associated with the action.
status_idstringNoID of the action’s status If not set, this action will be stored with the default status(to do).
task_idstringNoThe unique identifier of the action If not provided, UUID will be generated server side.
template_idstringNoIf a template ID is provided then an inspection ID must be provided. If not set, this action is a standalone action and the template ID will be null.
template_idsany[]NoThe list of templates to be linked to the action.
titlestringYesRequired. Title of the action Title is limited to only 255 characters max.
typeobjectNoThe type to create an action in.

Create an action link Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The unique identifier for the action

safetyculture_actions_service_delete_actions

Delete actions (Bulk) Parameters:
ParameterTypeRequiredDefaultDescription
idsany[]NoThe list of action ids to be deleted
modified_atstringNoOptional. The UTC time and date the deletion took place.

safetyculture_actions_service_get_action

Get an Action Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesID to query data for

Get an action link Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The unique identifier for the action

safetyculture_actions_service_get_actions

List actions Parameters:
ParameterTypeRequiredDefaultDescription
inspection_idstringNoOptional. The ID of the inspection the action belongs to. Deprecated, inspectionID in filters should be used instead.
offsetintegerNoOptional. Offset from where on the actions will be listed.
page_sizeintegerNoOptional. Number of actions to be returned in a single request. Maximum 100. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available. For example: ‘20’.
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. For example: ‘ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ=’.
sort_directionstringNoOptional. Direction for sorting.
sort_fieldstringNoOptional. Which field to use for sorting.
task_filtersany[]NoOptional. The array of filters to apply in your request. You can apply multiple filters in a single request.
without_countbooleanNoOptional. If true, will not return the count of actions.

Delete an action link Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The unique identifier for the action

safetyculture_actions_service_update_action_labels

Updates the labels associated with an action Parameters:
ParameterTypeRequiredDefaultDescription
action_idstringYesaction_id is the ID of the action to be updated.
label_idsany[]NoThe list of label IDs to associate with the action. Multiple labels can be added. Note: Sending an empty list for label_ids will remove all labels currently associated with the action.
modified_atstringNoDate and time this label was modified.

safetyculture_actions_service_update_asset

Update the asset of an action 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_actions_service_update_assignees

Update the assignees of an action Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The unique identifier for the task to be updated.
assigneesany[]YesRequired. The assignees to be assigned to the task.
modified_atstringNoOptional. The UTC time and date the modification took place.

safetyculture_actions_service_update_description

Update the description of an action 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_actions_service_update_due_at

Update the due date of an action 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_actions_service_update_priority

Update the priority of an action 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_actions_service_update_site

Update the site of an action 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_actions_service_update_status

Update the status of an action 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_actions_service_update_title

Update the title of an action 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.

safetyculture_actions_timeline_service_add_comment

Add comment to timeline Parameters:
ParameterTypeRequiredDefaultDescription
commentstringYesRequired. The content of the comment.
created_atstringNoOptional. Date/time this comment was added.
event_idstringNoOptional. The unique identifier for the event. This will be auto-generated if omitted.
task_idstringYesRequired. The UUID for the task the comment is being added to.

safetyculture_actions_timeline_service_get_timeline

List timeline events Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesRequired. The UUID of the task whose timeline will be retrieved.