--- title: "List actions" method: POST path: "/tasks/v1/actions/list" tags: ["Actions"] --- # List actions `POST /tasks/v1/actions/list` ## Request body - S12TasksV1GetActionsRequest — The parameters for `GetActionsRequest` - `page_size` integer — Optional. 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_token` string — Optional. 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='. - `inspection_id` string — Optional. The ID of the inspection the action belongs to. Deprecated, inspectionID in `filters` should be used instead. - `offset` integer — Optional. Offset from where on the actions will be listed. - `sort_field` 'PRIORITY' | 'DATE_DUE' | 'CREATED_AT' | 'MODIFIED_AT' - `sort_direction` 'ASC' | 'DESC' - `without_count` boolean — Optional. If true, will not return the count of actions. - `task_filters` S12TasksV1TaskFilter[] — Optional. The array of filters to apply in your request. You can apply multiple filters in a single request. - `status_id` S12TasksV1TaskFilterStatusID — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the status_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the status_id should be one of the value provided - `priority_id` S12TasksV1TaskFilterPriorityID — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the priority_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the priority_id should be one of the value provided - `site_id` S12TasksV1TaskFilterSiteID — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the site_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the site_id should be one of the value provided - `template_id` S12TasksV1TaskFilterTemplateID — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the template_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the template_id should be one of the value provided. - `inspection_item_id` S12TasksV1TaskFilterInspectionItemID — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the inspection_item_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the inspection_item_id should be one of the value provided. - `inspection_id` S12TasksV1TaskFilterInspectionID — Operator: Can be FILTER_OPERATOR_IN OR FILTER_OPERATOR_NOT_IN. Value: OR relation, represents the inspection_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the inspection_id should be one of the value provided. - `creator_id` S12TasksV1TaskFilterCreatorID — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the creator_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the creator_id should be one of the value provided. - `reference` S12TasksV1TaskReference - `type` 'SENSOR' | 'SENSOR_ALERT' | 'INSPECTION' | 'INCIDENT' | 'SCHEDULE' | 'ACTION' | 'LINKED_INSPECTION' | 'ASSET_MAINTENANCE_PLAN' — Reference type. The idea here is to list all the "external" types that would be used as a reference when creating actions. - `id` string — Required. Reference ID. - `inspection_context` S12TasksV1TaskInspectionContext - `inspection_id` string — ID of the inspection associated with the action - `inspection_name` string — name of the inspection associated with the action - `inspection_item_id` string — ID of the inspectionItem associated with the action - `inspection_item_name` string — name of the inspectionItem associated with the action - `inspection_item_type` string — @deprecated The type of the inspectionItem associated with the action - `inspection_item_path` string[] — The path(breadcrumbs) of the inspectionItem associated with the action - `inspection_item_attachments` S12TasksV1TaskAttachments - `note` string — Note inside Attachments of inspectionItem Answer - `media` S12CommonMedia[] — images or pdf inside Attachments of inspectionItem Answer - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `list_answer` S12TasksV1TaskListAnswer - `responses` S12TasksV1TaskListResponse[] — Responses of inspection item - `label` string — Label for the response - `color` S12CommonColor - … - `text_answer` S12TasksV1TaskTextAnswer - `answer` string — Text answer content - `unit_symbol` 'MEASUREMENT_UNIT_SYMBOL_KILOMETERS' | 'MEASUREMENT_UNIT_SYMBOL_MILES' | 'MEASUREMENT_UNIT_SYMBOL_HOURS' | 'MEASUREMENT_UNIT_SYMBOL_MINUTES' | 'MEASUREMENT_UNIT_SYMBOL_INCHES' | 'MEASUREMENT_UNIT_SYMBOL_FOOT' | 'MEASUREMENT_UNIT_SYMBOL_MILLIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_CENTIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_METERS' | 'MEASUREMENT_UNIT_SYMBOL_MILLILITRES' | 'MEASUREMENT_UNIT_SYMBOL_LITRES' | 'MEASUREMENT_UNIT_SYMBOL_GALLONS' | 'MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS' | 'MEASUREMENT_UNIT_SYMBOL_SECONDS' | 'MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT' | 'MEASUREMENT_UNIT_SYMBOL_CELSIUS' | 'MEASUREMENT_UNIT_SYMBOL_KELVIN' | 'MEASUREMENT_UNIT_SYMBOL_OUNCE' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS' | 'MEASUREMENT_UNIT_SYMBOL_TONNES' | 'MEASUREMENT_UNIT_SYMBOL_GRAMS' | 'MEASUREMENT_UNIT_SYMBOL_KILOGRAMS' | 'MEASUREMENT_UNIT_SYMBOL_AMPERES' | 'MEASUREMENT_UNIT_SYMBOL_HERTZ' | 'MEASUREMENT_UNIT_SYMBOL_OHM' | 'MEASUREMENT_UNIT_SYMBOL_VOLTS' | 'MEASUREMENT_UNIT_SYMBOL_WATTS' | 'MEASUREMENT_UNIT_SYMBOL_CANDELA' | 'MEASUREMENT_UNIT_SYMBOL_CYCLES' | 'MEASUREMENT_UNIT_SYMBOL_PERCENT' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH' | 'MEASUREMENT_UNIT_SYMBOL_MOLE' | 'MEASUREMENT_UNIT_SYMBOL_DAYS' | 'MEASUREMENT_UNIT_SYMBOL_WEEKS' | 'MEASUREMENT_UNIT_SYMBOL_MONTHS' — Collection of symbols (km, mi, hr, etc) used in units of measurement. - MEASUREMENT_UNIT_SYMBOL_KILOMETERS: Measurement unit symbol for kilometers. - MEASUREMENT_UNIT_SYMBOL_MILES: Measurement unit symbol for miles. - MEASUREMENT_UNIT_SYMBOL_HOURS: Measurement unit symbol for hours. - MEASUREMENT_UNIT_SYMBOL_MINUTES: Measurement unit symbol for minutes. - MEASUREMENT_UNIT_SYMBOL_INCHES: Measurement unit symbol for inches. - MEASUREMENT_UNIT_SYMBOL_FOOT: Measurement unit symbol for foot. - MEASUREMENT_UNIT_SYMBOL_MILLIMETERS: Measurement unit symbol for Millimeters. - MEASUREMENT_UNIT_SYMBOL_CENTIMETERS: Measurement unit symbol for Centimeters. - MEASUREMENT_UNIT_SYMBOL_METERS: Measurement unit symbol for meters. - MEASUREMENT_UNIT_SYMBOL_MILLILITRES: Measurement unit symbol for millilitres. - MEASUREMENT_UNIT_SYMBOL_LITRES: Measurement unit symbol for litres. - MEASUREMENT_UNIT_SYMBOL_GALLONS: Measurement unit symbol for gallons. - MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS: Measurement unit symbol for cubic meters. - MEASUREMENT_UNIT_SYMBOL_SECONDS: Measurement unit symbol for seconds. - MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT: Measurement unit symbol for fahrenheit. - MEASUREMENT_UNIT_SYMBOL_CELSIUS: Measurement unit symbol for celsius. - MEASUREMENT_UNIT_SYMBOL_KELVIN: Measurement unit symbol for kelvin. - MEASUREMENT_UNIT_SYMBOL_OUNCE: Measurement unit symbol for ounce. - MEASUREMENT_UNIT_SYMBOL_POUNDS: Measurement unit symbol for pounds. - MEASUREMENT_UNIT_SYMBOL_TONNES: Measurement unit symbol for tonnes. - MEASUREMENT_UNIT_SYMBOL_GRAMS: Measurement unit symbol for grams. - MEASUREMENT_UNIT_SYMBOL_KILOGRAMS: Measurement unit symbol for kilograms. - MEASUREMENT_UNIT_SYMBOL_AMPERES: Measurement unit symbol for amperes. - MEASUREMENT_UNIT_SYMBOL_HERTZ: Measurement unit symbol for hertz. - MEASUREMENT_UNIT_SYMBOL_OHM: Measurement unit symbol for ohm. - MEASUREMENT_UNIT_SYMBOL_VOLTS: Measurement unit symbol for volts. - MEASUREMENT_UNIT_SYMBOL_WATTS: Measurement unit symbol for watts. - MEASUREMENT_UNIT_SYMBOL_CANDELA: Measurement unit symbol for candela. - MEASUREMENT_UNIT_SYMBOL_CYCLES: Measurement unit symbol for cycles. - MEASUREMENT_UNIT_SYMBOL_PERCENT: Measurement unit symbol for percent. - MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH: Measurement unit symbol for pounds per square inch. - MEASUREMENT_UNIT_SYMBOL_MOLE: Measurement unit symbol for mole. - MEASUREMENT_UNIT_SYMBOL_DAYS: Measurement unit symbol for days. - MEASUREMENT_UNIT_SYMBOL_WEEKS: Measurement unit symbol for weeks. - MEASUREMENT_UNIT_SYMBOL_MONTHS: Measurement unit symbol for months. - `format` 'TEXT' | 'NUMBER' — - TEXT: Normal textsingle item - NUMBER: Textsingle item with number format - `checkbox_answer` S12TasksV1TaskCheckboxAnswer - `answer` boolean — answer content for CheckboxAnswer - `media_answer` S12TasksV1TaskMediaAnswer - `media` S12CommonMedia[] — answer content of MediaItem - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `signature_answer` S12TasksV1TaskSignatureAnswer - `media` S12CommonMedia - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `name` string — name on the signature - `signed_at` string, date-time — Timestamp for when the signature answer was last updated - `drawing_answer` S12TasksV1TaskDrawingAnswer - `media` S12CommonMedia - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `slider_answer` S12TasksV1TaskSliderAnswer - `answer` number, double — number of sliderAnswer - `max` number, double — A double representing the maximum value allowed for this item. Negatives are allowed. - `min` number, double — A double representing the minimum value allowed for this item. Negatives are allowed. - `datetime_answer` S12TasksV1TaskDateTimeAnswer - `answer` string, date-time — answer content for DateTimeItem - `enable_date` boolean — Enable date turns on input for date values - `enable_time` boolean — Enable date turns on input for time values - `address_answer` S12TasksV1TaskAddressAnswer - `location_text` string — Location text - `location` S12TasksV1TaskAddressLocation — The location of the task. The latitude and longitude in the `geo_position` object are required. All other fields are optional, but add extra context to the location on platform. - `name` string — The name of the task's location. - `thoroughfare` string — The thoroughfare of the location. - `sub_thoroughfare` string — The sub_thoroughfare of the location, - `locality` string — The locality of the location - `sub_locality` string — The sub_locality of the location - `administrative_area` string — The administrative_area of the location - `sub_administrative_area` string — The sub_administrative_area of the location - `postal_code` string — The postal_code of the location - `country` string — The country of the location - `iso_country_code` string — The iso_country_code of the location - `geo_position` S12CommonGeoPosition — A position is the fundamental geographical geometry construct. - … - `switch_answer` S12TasksV1TaskSwitchAnswer — Answer returned for SwitchItem, exists in old inspections Users can’t change answer to them & can’t attach actions to them either. - `answer` boolean — Answer content for SwitchItem - `temperature_answer` S12TasksV1TaskTemperatureAnswer - `temperature` number, double — @deprecated. Use answer instead - `display_unit` 'KELVIN' | 'CELSIUS' | 'FAHRENHEIT' — - KELVIN: Represents Kelvin temperature unit - CELSIUS: Represents Celsius temperature unit - FAHRENHEIT: Represents Fahrenheit temperature unit - `between` S12TasksV1TaskRangeComparison — Used to compare values within a range. - `lower` number, double — Represents the lower value of the range. - `upper` number, double — Represents the upper value of the range. - `above` S12TasksV1TaskNumberComparison — Used to compare values against a single number. - `value` number, double - `below` S12TasksV1TaskNumberComparison — Used to compare values against a single number. - `value` number, double - `answer` number, double — answer of TemperatureAnswer - `inspection_deleted` boolean — Flag indicated whether the inspection has been deleted - `sensor_alert_context` S12TasksV1TaskSensorAlertContext - `sensor_alert_id` string — ID of sensor alert context associated with the action - `level` 'OK' | 'INFO' | 'WARN' | 'CRITICAL' — - OK: `OK` level indicates that device metric became healthy - INFO: `INFO` level indicates that the first alert event sent - WARN: `WARN` level indicates that the second alert event sent - CRITICAL: `CRITICAL` level indicates that the third alert event sent - `created_at` string, date-time — The time the alert event was created/updated. - `detected_at` string, date-time — The time the first alert event was detected. - `sensor_id` string — Sensor asset ID for which the event happened - `site_name` string — Name of the site at a time of event - `metric_type` 'TEMPERATURE' | 'HUMIDITY' | 'BATTERY' | 'SIGNAL' | 'AIR_QUALITY_PM25' | 'AIR_QUALITY_PM10' | 'TEMPERATURE_2' | 'DIFFERENTIAL_AIR_PRESSURE' | 'CO' | 'DOOR_OPEN_CLOSED' | 'BATTERY_VOLTAGE' | 'WEATHER' | 'WIND_SPEED' | 'WIND_DIRECTION' | 'WIND_GUST' | 'CO2' — - TEMPERATURE: Temperature metric - HUMIDITY: Humidity metric - BATTERY: Battery level. Percentage based i.e. 0 - 100 - SIGNAL: Signal strength metric - AIR_QUALITY_PM25: Air quality for particulate matter less than 2.5 microns - AIR_QUALITY_PM10: Air quality for particulate matter less than 10 microns - TEMPERATURE_2: Alternative temperature (Some hardware i.e. Avem Quirks do have 2 probes and are sending 2 temperatures) - DIFFERENTIAL_AIR_PRESSURE: Differential air pressure - CO: Carbon monoxide - DOOR_OPEN_CLOSED: Door open/closed boolean metric - BATTERY_VOLTAGE: Battery voltage metric - WEATHER: Weather (e.g. sunny, thunderstorms) - WIND_SPEED: Wind speed - WIND_DIRECTION: Wind direction - WIND_GUST: Wind gust - CO2: Carbon dioxide - `sensor_name` string — Name of the sensor at a time of event - `reading_type` string — Sensor reading type - `reading_name` string — Sensor reading name - `sensor_context` S12TasksV1TaskSensorContext - `incident_context` S12TasksV1TaskIncidentContext - `title` string — Title of the incident - `description` string — Description of the incident - `creator` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `status_id` string — Status ID of the incident - `category_id` string — Category of the incident - `due_at` string, date-time — Date/time the incident is due - `priority_id` string — Priority ID of the incident - `unique_id` string — The human readable unique ID of the incident - `collaborators` S12TasksV1TaskCollaborator[] — The collaborators of the incident - `collaborator_id` string — A UUID uniquely identifying this collaborator. - `collaborator_type` 'USER' | 'GROUP' | 'EXTERNAL_USER' | 'CONTRIBUTOR' — - USER: The collaborator is an internal user. - GROUP: The collaborator is a group. - EXTERNAL_USER: The collaborator is an external user. This happens when a task is assigned to an email address. - CONTRIBUTOR: The collaborator is a contributor. A contributor is an individual who raises a task anonymously. For example, creating an incident through the incident QR code functionality. - `assigned_role` 'ASSIGNEE' | 'CREATOR' — - ASSIGNEE: The collaborator has been assigned to a task. - CREATOR: The collaborator has created the task. - `user` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `group` S12TasksV1TaskGroup — The group that is assigned to a task. - `group_id` string — The UUID of this group. - `name` string — The name of the group - `external_user` S12TasksV1TaskExternalUser — The external user that is assigned to a task. - `id` string — The UUID uniquely identifying this external user. - `email` string — The email address of the external user. - `contributor` S12TasksV1TaskContributor - `id` string — The UUID uniquely identifying this contributor - `name` string — Optional. The contributor's name. - `email` string — Optional. The contributor's email address. - `contact` string — Optional. The contributor's (freetext) contact details. - `action_context` S12TasksV1TaskActionContext - `title` string — Title of the action - `description` string — Description of the action - `creator` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `status` S12TasksV1TaskStatus - `status_id` string — An ID uniquely identifying this task status message. For example: 'aa70d8a6-af37-44f4-8768d8899fe274c5' - `key` string — A pre-defined value that the system can use to handle the particular label e.g. analytics, filter based on it A key may look like: "to do" | "In progress" | "Done" | "Can't do" - `label` string — A label associated with the key, typically for display purposes - `display_order` integer — Used to order this status when displaying a list of statuses - `due_at` string, date-time — Date/time the action is due - `priority_id` string — Priority ID of the action - `unique_id` string — The human readable unique ID of the action - `collaborators` S12TasksV1TaskCollaborator[] — The collaborators of the action - `collaborator_id` string — A UUID uniquely identifying this collaborator. - `collaborator_type` 'USER' | 'GROUP' | 'EXTERNAL_USER' | 'CONTRIBUTOR' — - USER: The collaborator is an internal user. - GROUP: The collaborator is a group. - EXTERNAL_USER: The collaborator is an external user. This happens when a task is assigned to an email address. - CONTRIBUTOR: The collaborator is a contributor. A contributor is an individual who raises a task anonymously. For example, creating an incident through the incident QR code functionality. - `assigned_role` 'ASSIGNEE' | 'CREATOR' — - ASSIGNEE: The collaborator has been assigned to a task. - CREATOR: The collaborator has created the task. - `user` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `group` S12TasksV1TaskGroup — The group that is assigned to a task. - `group_id` string — The UUID of this group. - `name` string — The name of the group - `external_user` S12TasksV1TaskExternalUser — The external user that is assigned to a task. - `id` string — The UUID uniquely identifying this external user. - `email` string — The email address of the external user. - `contributor` S12TasksV1TaskContributor - `id` string — The UUID uniquely identifying this contributor - `name` string — Optional. The contributor's name. - `email` string — Optional. The contributor's email address. - `contact` string — Optional. The contributor's (freetext) contact details. - `inspection` S12TasksV1TaskInspection - `inspection_id` string — ID of the inspection the action belongs to - `inspection_name` string — The name of the inspection the action belongs to - `type` S12TasksV1Type — The type associated with an action. - `type` 'TASK_TYPE_ACTION' | 'TASK_TYPE_CUSTOM' — - TASK_TYPE_ACTION: Indicates this task is of type Action. - TASK_TYPE_CUSTOM: Indicates this task is of a custom type. - `id` string — The unique identifier of a type. - `name` string — The name of a type. - `linked_inspection_context` S12TasksV1TaskLinkedInspectionContext — Context of an inspection started from a template associated with the action. - `inspection_id` string — ID of the inspection associated with the action. - `template_id` string — ID of the template this inspection was created from. - `inspection_name` string — Name of the inspection linked to the action. - `is_complete` boolean — Flag to indicate the inspection is marked as complete. - `is_access_denied` boolean — Flag to indicate the access for the inspection is denied. - `is_deleted` boolean — Flag to indicate whether the inspection is deleted or not. - `created_at` string, date-time — The date the inspection was created. - `completed_at` string, date-time — The date the inspection was completed. - `template_name` string — Name of the template this inspection was created from. - `asset_maintenance_plan_context` S12TasksV1TaskAssetMaintenancePlanContext - `maintenance_plan` S12TasksV1TaskAssetMaintenancePlan — AssetMaintenancePlan represents the maintenance plan associated with the action. - `id` string — The ID of the maintenance plan. - `name` string — The name of the maintenance plan. - `state` 'ASSET_MAINTENANCE_PLAN_STATE_UNSPECIFIED' | 'ASSET_MAINTENANCE_PLAN_STATE_ACTIVE' | 'ASSET_MAINTENANCE_PLAN_STATE_DELETED' — - ASSET_MAINTENANCE_PLAN_STATE_UNSPECIFIED: ASSET_MAINTENANCE_PLAN_STATE_UNSPECIFIED is an unknown maintenance plan state. - ASSET_MAINTENANCE_PLAN_STATE_ACTIVE: ASSET_MAINTENANCE_PLAN_STATE_ACTIVE is a maintenance plan state that is active. - ASSET_MAINTENANCE_PLAN_STATE_DELETED: ASSET_MAINTENANCE_PLAN_STATE_DELETED is a maintenance plan state that is deleted. - `maintenance_program` S12TasksV1TaskAssetMaintenanceProgram — AssetMaintenanceProgram represents the maintenance program where the maintenance plan belongs. - `id` string — The ID of the maintenance program. - `name` string — The name of the maintenance program. - `state` 'ASSET_MAINTENANCE_PROGRAM_STATE_UNSPECIFIED' | 'ASSET_MAINTENANCE_PROGRAM_STATE_ACTIVE' | 'ASSET_MAINTENANCE_PROGRAM_STATE_DELETED' — - ASSET_MAINTENANCE_PROGRAM_STATE_UNSPECIFIED: ASSET_MAINTENANCE_PROGRAM_STATE_UNSPECIFIED is an unknown maintenance program state. - ASSET_MAINTENANCE_PROGRAM_STATE_ACTIVE: ASSET_MAINTENANCE_PROGRAM_STATE_ACTIVE is a maintenance program state that is active. - ASSET_MAINTENANCE_PROGRAM_STATE_DELETED: ASSET_MAINTENANCE_PROGRAM_STATE_DELETED is a maintenance program state that is deleted. - `created_at` S12TasksV1TaskFilterDuration — time duration filter. - `from` S12TasksV1TaskFilterTimeFrom — Operator: Should only be FILTER_OPERATOR_EQ. Value: represents the time should be after the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string, date-time — represents the time should be after the value provided. - `to` S12TasksV1TaskFilterTimeTo — Operator: Should only be FILTER_OPERATOR_EQ. Value: represents the time should be before the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string, date-time — represents the time should be before the value provided. - `modified_at` S12TasksV1TaskFilterDuration — time duration filter. - `from` S12TasksV1TaskFilterTimeFrom — Operator: Should only be FILTER_OPERATOR_EQ. Value: represents the time should be after the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string, date-time — represents the time should be after the value provided. - `to` S12TasksV1TaskFilterTimeTo — Operator: Should only be FILTER_OPERATOR_EQ. Value: represents the time should be before the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string, date-time — represents the time should be before the value provided. - `collaborators` S12TasksV1TaskFilterCollaborator — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the assignee_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` S12TasksV1TaskCollaborator[] — OR relation, represents the assignee_id should be one of the value provided. - `collaborator_id` string — A UUID uniquely identifying this collaborator. - `collaborator_type` 'USER' | 'GROUP' | 'EXTERNAL_USER' | 'CONTRIBUTOR' — - USER: The collaborator is an internal user. - GROUP: The collaborator is a group. - EXTERNAL_USER: The collaborator is an external user. This happens when a task is assigned to an email address. - CONTRIBUTOR: The collaborator is a contributor. A contributor is an individual who raises a task anonymously. For example, creating an incident through the incident QR code functionality. - `assigned_role` 'ASSIGNEE' | 'CREATOR' — - ASSIGNEE: The collaborator has been assigned to a task. - CREATOR: The collaborator has created the task. - `user` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `group` S12TasksV1TaskGroup — The group that is assigned to a task. - `group_id` string — The UUID of this group. - `name` string — The name of the group - `external_user` S12TasksV1TaskExternalUser — The external user that is assigned to a task. - `id` string — The UUID uniquely identifying this external user. - `email` string — The email address of the external user. - `contributor` S12TasksV1TaskContributor - `id` string — The UUID uniquely identifying this contributor - `name` string — Optional. The contributor's name. - `email` string — Optional. The contributor's email address. - `contact` string — Optional. The contributor's (freetext) contact details. - `due_at` S12TasksV1TaskFilterDuration — time duration filter. - `from` S12TasksV1TaskFilterTimeFrom — Operator: Should only be FILTER_OPERATOR_EQ. Value: represents the time should be after the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string, date-time — represents the time should be after the value provided. - `to` S12TasksV1TaskFilterTimeTo — Operator: Should only be FILTER_OPERATOR_EQ. Value: represents the time should be before the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string, date-time — represents the time should be before the value provided. - `title` S12TasksV1TaskFilterSearch — text search filter. - `term` string — `term` represents the text to search for. - `description` S12TasksV1TaskFilterSearch — text search filter. - `term` string — `term` represents the text to search for. - `asset_id` S12TasksV1TaskFilterAssetID — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the asset_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the asset_id should be one of the value provided - `label_id` S12TasksV1TaskFilterLabelID — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the label_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the label_id should be one of the value provided - `task_id` S12TasksV1TaskFilterTaskID — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the task_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the task_id should be one of the value provided. - `references` S12TasksV1TaskFilterReferences — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the reference_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the reference_id should be one of the value provided. - `type_id` S12TasksV1TaskFilterTypeID — Operator: Should only be FILTER_OPERATOR_IN. Value: The list of type ids to be filtered on. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — The list of type ids to be filtered on. - `asset_type_id` S12TasksV1TaskFilterAssetTypeID — Operator: Should only be FILTER_OPERATOR_IN. Value: OR relation, represents the asset_type_id should be one of the value provided. - `operator` 'FILTER_OPERATOR_EQ' | 'FILTER_OPERATOR_IN' | 'FILTER_OPERATOR_NOT_IN' - `value` string[] — OR relation, represents the asset_type_id should be one of the value provided - `include_custom_field_values` boolean — Include custom field values for actions ## Response `200` A successful response. - S12TasksV1ActionsResponse - `actions` S12TasksV1Action[] — List of Actions - `task` S12TasksV1Task - `task_id` string — An ID uniquely identifying this task message. For example: 'aa70d8a6-af37-44f4-8768d8899fe274c5' - `creator` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `title` string — Title of this task - `description` string — Description of this task - `created_at` string, date-time — Date/time this task was created - `due_at` string, date-time — Date/time this task is due - `priority_id` string — Priority ID of this task - `status_id` string — Status ID of this task @deprecated. For task type of action use status instead. In use by task type of incident. - `collaborators` S12TasksV1TaskCollaborator[] — Collaborators of this task - `collaborator_id` string — A UUID uniquely identifying this collaborator. - `collaborator_type` 'USER' | 'GROUP' | 'EXTERNAL_USER' | 'CONTRIBUTOR' — - USER: The collaborator is an internal user. - GROUP: The collaborator is a group. - EXTERNAL_USER: The collaborator is an external user. This happens when a task is assigned to an email address. - CONTRIBUTOR: The collaborator is a contributor. A contributor is an individual who raises a task anonymously. For example, creating an incident through the incident QR code functionality. - `assigned_role` 'ASSIGNEE' | 'CREATOR' — - ASSIGNEE: The collaborator has been assigned to a task. - CREATOR: The collaborator has created the task. - `user` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `group` S12TasksV1TaskGroup — The group that is assigned to a task. - `group_id` string — The UUID of this group. - `name` string — The name of the group - `external_user` S12TasksV1TaskExternalUser — The external user that is assigned to a task. - `id` string — The UUID uniquely identifying this external user. - `email` string — The email address of the external user. - `contributor` S12TasksV1TaskContributor - `id` string — The UUID uniquely identifying this contributor - `name` string — Optional. The contributor's name. - `email` string — Optional. The contributor's email address. - `contact` string — Optional. The contributor's (freetext) contact details. - `template_id` string — Template ID of the inspection the action belongs to - `inspection` S12TasksV1TaskInspection - `inspection_id` string — ID of the inspection the action belongs to - `inspection_name` string — The name of the inspection the action belongs to - `inspection_item` S12TasksV1TaskInspectionItem - `inspection_item_id` string — ID of the item in the inspection associated with the action - `inspection_item_name` string — The name of the item in the inspection associated with the action - `inspection_item_type` string — The type of the item in the inspection associated with the action - `inspection_item_response_values` string[] — The labels of the responses - `site` S12TasksV1TaskSite — The folder (site) data of this task. - `id` string — The UUID of the site associated with this task. - `name` string — The name of the site associated with this task. - `region` string — The region of the site associated with the task. - `area` string — The area of the site associated with the task - `modified_at` string, date-time — Date/time this task was last modified - `references` S12TasksV1TaskReference[] — References on this task. - `type` 'SENSOR' | 'SENSOR_ALERT' | 'INSPECTION' | 'INCIDENT' | 'SCHEDULE' | 'ACTION' | 'LINKED_INSPECTION' | 'ASSET_MAINTENANCE_PLAN' — Reference type. The idea here is to list all the "external" types that would be used as a reference when creating actions. - `id` string — Required. Reference ID. - `inspection_context` S12TasksV1TaskInspectionContext - `inspection_id` string — ID of the inspection associated with the action - `inspection_name` string — name of the inspection associated with the action - `inspection_item_id` string — ID of the inspectionItem associated with the action - `inspection_item_name` string — name of the inspectionItem associated with the action - `inspection_item_type` string — @deprecated The type of the inspectionItem associated with the action - `inspection_item_path` string[] — The path(breadcrumbs) of the inspectionItem associated with the action - `inspection_item_attachments` S12TasksV1TaskAttachments - `note` string — Note inside Attachments of inspectionItem Answer - `media` S12CommonMedia[] — images or pdf inside Attachments of inspectionItem Answer - … - `list_answer` S12TasksV1TaskListAnswer - `responses` S12TasksV1TaskListResponse[] — Responses of inspection item - … - `text_answer` S12TasksV1TaskTextAnswer - `answer` string — Text answer content - `unit_symbol` 'MEASUREMENT_UNIT_SYMBOL_KILOMETERS' | 'MEASUREMENT_UNIT_SYMBOL_MILES' | 'MEASUREMENT_UNIT_SYMBOL_HOURS' | 'MEASUREMENT_UNIT_SYMBOL_MINUTES' | 'MEASUREMENT_UNIT_SYMBOL_INCHES' | 'MEASUREMENT_UNIT_SYMBOL_FOOT' | 'MEASUREMENT_UNIT_SYMBOL_MILLIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_CENTIMETERS' | 'MEASUREMENT_UNIT_SYMBOL_METERS' | 'MEASUREMENT_UNIT_SYMBOL_MILLILITRES' | 'MEASUREMENT_UNIT_SYMBOL_LITRES' | 'MEASUREMENT_UNIT_SYMBOL_GALLONS' | 'MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS' | 'MEASUREMENT_UNIT_SYMBOL_SECONDS' | 'MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT' | 'MEASUREMENT_UNIT_SYMBOL_CELSIUS' | 'MEASUREMENT_UNIT_SYMBOL_KELVIN' | 'MEASUREMENT_UNIT_SYMBOL_OUNCE' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS' | 'MEASUREMENT_UNIT_SYMBOL_TONNES' | 'MEASUREMENT_UNIT_SYMBOL_GRAMS' | 'MEASUREMENT_UNIT_SYMBOL_KILOGRAMS' | 'MEASUREMENT_UNIT_SYMBOL_AMPERES' | 'MEASUREMENT_UNIT_SYMBOL_HERTZ' | 'MEASUREMENT_UNIT_SYMBOL_OHM' | 'MEASUREMENT_UNIT_SYMBOL_VOLTS' | 'MEASUREMENT_UNIT_SYMBOL_WATTS' | 'MEASUREMENT_UNIT_SYMBOL_CANDELA' | 'MEASUREMENT_UNIT_SYMBOL_CYCLES' | 'MEASUREMENT_UNIT_SYMBOL_PERCENT' | 'MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH' | 'MEASUREMENT_UNIT_SYMBOL_MOLE' | 'MEASUREMENT_UNIT_SYMBOL_DAYS' | 'MEASUREMENT_UNIT_SYMBOL_WEEKS' | 'MEASUREMENT_UNIT_SYMBOL_MONTHS' — Collection of symbols (km, mi, hr, etc) used in units of measurement. - MEASUREMENT_UNIT_SYMBOL_KILOMETERS: Measurement unit symbol for kilometers. - MEASUREMENT_UNIT_SYMBOL_MILES: Measurement unit symbol for miles. - MEASUREMENT_UNIT_SYMBOL_HOURS: Measurement unit symbol for hours. - MEASUREMENT_UNIT_SYMBOL_MINUTES: Measurement unit symbol for minutes. - MEASUREMENT_UNIT_SYMBOL_INCHES: Measurement unit symbol for inches. - MEASUREMENT_UNIT_SYMBOL_FOOT: Measurement unit symbol for foot. - MEASUREMENT_UNIT_SYMBOL_MILLIMETERS: Measurement unit symbol for Millimeters. - MEASUREMENT_UNIT_SYMBOL_CENTIMETERS: Measurement unit symbol for Centimeters. - MEASUREMENT_UNIT_SYMBOL_METERS: Measurement unit symbol for meters. - MEASUREMENT_UNIT_SYMBOL_MILLILITRES: Measurement unit symbol for millilitres. - MEASUREMENT_UNIT_SYMBOL_LITRES: Measurement unit symbol for litres. - MEASUREMENT_UNIT_SYMBOL_GALLONS: Measurement unit symbol for gallons. - MEASUREMENT_UNIT_SYMBOL_CUBIC_METERS: Measurement unit symbol for cubic meters. - MEASUREMENT_UNIT_SYMBOL_SECONDS: Measurement unit symbol for seconds. - MEASUREMENT_UNIT_SYMBOL_FAHRENHEIT: Measurement unit symbol for fahrenheit. - MEASUREMENT_UNIT_SYMBOL_CELSIUS: Measurement unit symbol for celsius. - MEASUREMENT_UNIT_SYMBOL_KELVIN: Measurement unit symbol for kelvin. - MEASUREMENT_UNIT_SYMBOL_OUNCE: Measurement unit symbol for ounce. - MEASUREMENT_UNIT_SYMBOL_POUNDS: Measurement unit symbol for pounds. - MEASUREMENT_UNIT_SYMBOL_TONNES: Measurement unit symbol for tonnes. - MEASUREMENT_UNIT_SYMBOL_GRAMS: Measurement unit symbol for grams. - MEASUREMENT_UNIT_SYMBOL_KILOGRAMS: Measurement unit symbol for kilograms. - MEASUREMENT_UNIT_SYMBOL_AMPERES: Measurement unit symbol for amperes. - MEASUREMENT_UNIT_SYMBOL_HERTZ: Measurement unit symbol for hertz. - MEASUREMENT_UNIT_SYMBOL_OHM: Measurement unit symbol for ohm. - MEASUREMENT_UNIT_SYMBOL_VOLTS: Measurement unit symbol for volts. - MEASUREMENT_UNIT_SYMBOL_WATTS: Measurement unit symbol for watts. - MEASUREMENT_UNIT_SYMBOL_CANDELA: Measurement unit symbol for candela. - MEASUREMENT_UNIT_SYMBOL_CYCLES: Measurement unit symbol for cycles. - MEASUREMENT_UNIT_SYMBOL_PERCENT: Measurement unit symbol for percent. - MEASUREMENT_UNIT_SYMBOL_POUNDS_PER_SQUARE_INCH: Measurement unit symbol for pounds per square inch. - MEASUREMENT_UNIT_SYMBOL_MOLE: Measurement unit symbol for mole. - MEASUREMENT_UNIT_SYMBOL_DAYS: Measurement unit symbol for days. - MEASUREMENT_UNIT_SYMBOL_WEEKS: Measurement unit symbol for weeks. - MEASUREMENT_UNIT_SYMBOL_MONTHS: Measurement unit symbol for months. - `format` 'TEXT' | 'NUMBER' — - TEXT: Normal textsingle item - NUMBER: Textsingle item with number format - `checkbox_answer` S12TasksV1TaskCheckboxAnswer - `answer` boolean — answer content for CheckboxAnswer - `media_answer` S12TasksV1TaskMediaAnswer - `media` S12CommonMedia[] — answer content of MediaItem - … - `signature_answer` S12TasksV1TaskSignatureAnswer - `media` S12CommonMedia - … - `name` string — name on the signature - `signed_at` string, date-time — Timestamp for when the signature answer was last updated - `drawing_answer` S12TasksV1TaskDrawingAnswer - `media` S12CommonMedia - … - `slider_answer` S12TasksV1TaskSliderAnswer - `answer` number, double — number of sliderAnswer - `max` number, double — A double representing the maximum value allowed for this item. Negatives are allowed. - `min` number, double — A double representing the minimum value allowed for this item. Negatives are allowed. - `datetime_answer` S12TasksV1TaskDateTimeAnswer - `answer` string, date-time — answer content for DateTimeItem - `enable_date` boolean — Enable date turns on input for date values - `enable_time` boolean — Enable date turns on input for time values - `address_answer` S12TasksV1TaskAddressAnswer - `location_text` string — Location text - `location` S12TasksV1TaskAddressLocation — The location of the task. The latitude and longitude in the `geo_position` object are required. All other fields are optional, but add extra context to the location on platform. - … - `switch_answer` S12TasksV1TaskSwitchAnswer — Answer returned for SwitchItem, exists in old inspections Users can’t change answer to them & can’t attach actions to them either. - `answer` boolean — Answer content for SwitchItem - `temperature_answer` S12TasksV1TaskTemperatureAnswer - `temperature` number, double — @deprecated. Use answer instead - `display_unit` 'KELVIN' | 'CELSIUS' | 'FAHRENHEIT' — - KELVIN: Represents Kelvin temperature unit - CELSIUS: Represents Celsius temperature unit - FAHRENHEIT: Represents Fahrenheit temperature unit - `between` S12TasksV1TaskRangeComparison — Used to compare values within a range. - … - `above` S12TasksV1TaskNumberComparison — Used to compare values against a single number. - … - `below` S12TasksV1TaskNumberComparison — Used to compare values against a single number. - … - `answer` number, double — answer of TemperatureAnswer - `inspection_deleted` boolean — Flag indicated whether the inspection has been deleted - `sensor_alert_context` S12TasksV1TaskSensorAlertContext - `sensor_alert_id` string — ID of sensor alert context associated with the action - `level` 'OK' | 'INFO' | 'WARN' | 'CRITICAL' — - OK: `OK` level indicates that device metric became healthy - INFO: `INFO` level indicates that the first alert event sent - WARN: `WARN` level indicates that the second alert event sent - CRITICAL: `CRITICAL` level indicates that the third alert event sent - `created_at` string, date-time — The time the alert event was created/updated. - `detected_at` string, date-time — The time the first alert event was detected. - `sensor_id` string — Sensor asset ID for which the event happened - `site_name` string — Name of the site at a time of event - `metric_type` 'TEMPERATURE' | 'HUMIDITY' | 'BATTERY' | 'SIGNAL' | 'AIR_QUALITY_PM25' | 'AIR_QUALITY_PM10' | 'TEMPERATURE_2' | 'DIFFERENTIAL_AIR_PRESSURE' | 'CO' | 'DOOR_OPEN_CLOSED' | 'BATTERY_VOLTAGE' | 'WEATHER' | 'WIND_SPEED' | 'WIND_DIRECTION' | 'WIND_GUST' | 'CO2' — - TEMPERATURE: Temperature metric - HUMIDITY: Humidity metric - BATTERY: Battery level. Percentage based i.e. 0 - 100 - SIGNAL: Signal strength metric - AIR_QUALITY_PM25: Air quality for particulate matter less than 2.5 microns - AIR_QUALITY_PM10: Air quality for particulate matter less than 10 microns - TEMPERATURE_2: Alternative temperature (Some hardware i.e. Avem Quirks do have 2 probes and are sending 2 temperatures) - DIFFERENTIAL_AIR_PRESSURE: Differential air pressure - CO: Carbon monoxide - DOOR_OPEN_CLOSED: Door open/closed boolean metric - BATTERY_VOLTAGE: Battery voltage metric - WEATHER: Weather (e.g. sunny, thunderstorms) - WIND_SPEED: Wind speed - WIND_DIRECTION: Wind direction - WIND_GUST: Wind gust - CO2: Carbon dioxide - `sensor_name` string — Name of the sensor at a time of event - `reading_type` string — Sensor reading type - `reading_name` string — Sensor reading name - `sensor_context` S12TasksV1TaskSensorContext - `incident_context` S12TasksV1TaskIncidentContext - `title` string — Title of the incident - `description` string — Description of the incident - `creator` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `status_id` string — Status ID of the incident - `category_id` string — Category of the incident - `due_at` string, date-time — Date/time the incident is due - `priority_id` string — Priority ID of the incident - `unique_id` string — The human readable unique ID of the incident - `collaborators` S12TasksV1TaskCollaborator[] — The collaborators of the incident - `collaborator_id` string — A UUID uniquely identifying this collaborator. - `collaborator_type` 'USER' | 'GROUP' | 'EXTERNAL_USER' | 'CONTRIBUTOR' — - USER: The collaborator is an internal user. - GROUP: The collaborator is a group. - EXTERNAL_USER: The collaborator is an external user. This happens when a task is assigned to an email address. - CONTRIBUTOR: The collaborator is a contributor. A contributor is an individual who raises a task anonymously. For example, creating an incident through the incident QR code functionality. - `assigned_role` 'ASSIGNEE' | 'CREATOR' — - ASSIGNEE: The collaborator has been assigned to a task. - CREATOR: The collaborator has created the task. - `user` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - … - `group` S12TasksV1TaskGroup — The group that is assigned to a task. - … - `external_user` S12TasksV1TaskExternalUser — The external user that is assigned to a task. - … - `contributor` S12TasksV1TaskContributor - … - `action_context` S12TasksV1TaskActionContext - `title` string — Title of the action - `description` string — Description of the action - `creator` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - `user_id` string — The UUID of this user. - `firstname` string — The first name of the user. - `lastname` string — The last name of the user. - `status` S12TasksV1TaskStatus - `status_id` string — An ID uniquely identifying this task status message. For example: 'aa70d8a6-af37-44f4-8768d8899fe274c5' - `key` string — A pre-defined value that the system can use to handle the particular label e.g. analytics, filter based on it A key may look like: "to do" | "In progress" | "Done" | "Can't do" - `label` string — A label associated with the key, typically for display purposes - `display_order` integer — Used to order this status when displaying a list of statuses - `due_at` string, date-time — Date/time the action is due - `priority_id` string — Priority ID of the action - `unique_id` string — The human readable unique ID of the action - `collaborators` S12TasksV1TaskCollaborator[] — The collaborators of the action - `collaborator_id` string — A UUID uniquely identifying this collaborator. - `collaborator_type` 'USER' | 'GROUP' | 'EXTERNAL_USER' | 'CONTRIBUTOR' — - USER: The collaborator is an internal user. - GROUP: The collaborator is a group. - EXTERNAL_USER: The collaborator is an external user. This happens when a task is assigned to an email address. - CONTRIBUTOR: The collaborator is a contributor. A contributor is an individual who raises a task anonymously. For example, creating an incident through the incident QR code functionality. - `assigned_role` 'ASSIGNEE' | 'CREATOR' — - ASSIGNEE: The collaborator has been assigned to a task. - CREATOR: The collaborator has created the task. - `user` S12TasksV1TaskUser — The user associated to the task. They could be a creator or assignee. - … - `group` S12TasksV1TaskGroup — The group that is assigned to a task. - … - `external_user` S12TasksV1TaskExternalUser — The external user that is assigned to a task. - … - `contributor` S12TasksV1TaskContributor - … - `inspection` S12TasksV1TaskInspection - `inspection_id` string — ID of the inspection the action belongs to - `inspection_name` string — The name of the inspection the action belongs to - `type` S12TasksV1Type — The type associated with an action. - `type` 'TASK_TYPE_ACTION' | 'TASK_TYPE_CUSTOM' — - TASK_TYPE_ACTION: Indicates this task is of type Action. - TASK_TYPE_CUSTOM: Indicates this task is of a custom type. - `id` string — The unique identifier of a type. - `name` string — The name of a type. - `linked_inspection_context` S12TasksV1TaskLinkedInspectionContext — Context of an inspection started from a template associated with the action. - `inspection_id` string — ID of the inspection associated with the action. - `template_id` string — ID of the template this inspection was created from. - `inspection_name` string — Name of the inspection linked to the action. - `is_complete` boolean — Flag to indicate the inspection is marked as complete. - `is_access_denied` boolean — Flag to indicate the access for the inspection is denied. - `is_deleted` boolean — Flag to indicate whether the inspection is deleted or not. - `created_at` string, date-time — The date the inspection was created. - `completed_at` string, date-time — The date the inspection was completed. - `template_name` string — Name of the template this inspection was created from. - `asset_maintenance_plan_context` S12TasksV1TaskAssetMaintenancePlanContext - `maintenance_plan` S12TasksV1TaskAssetMaintenancePlan — AssetMaintenancePlan represents the maintenance plan associated with the action. - `id` string — The ID of the maintenance plan. - `name` string — The name of the maintenance plan. - `state` 'ASSET_MAINTENANCE_PLAN_STATE_UNSPECIFIED' | 'ASSET_MAINTENANCE_PLAN_STATE_ACTIVE' | 'ASSET_MAINTENANCE_PLAN_STATE_DELETED' — - ASSET_MAINTENANCE_PLAN_STATE_UNSPECIFIED: ASSET_MAINTENANCE_PLAN_STATE_UNSPECIFIED is an unknown maintenance plan state. - ASSET_MAINTENANCE_PLAN_STATE_ACTIVE: ASSET_MAINTENANCE_PLAN_STATE_ACTIVE is a maintenance plan state that is active. - ASSET_MAINTENANCE_PLAN_STATE_DELETED: ASSET_MAINTENANCE_PLAN_STATE_DELETED is a maintenance plan state that is deleted. - `maintenance_program` S12TasksV1TaskAssetMaintenanceProgram — AssetMaintenanceProgram represents the maintenance program where the maintenance plan belongs. - `id` string — The ID of the maintenance program. - `name` string — The name of the maintenance program. - `state` 'ASSET_MAINTENANCE_PROGRAM_STATE_UNSPECIFIED' | 'ASSET_MAINTENANCE_PROGRAM_STATE_ACTIVE' | 'ASSET_MAINTENANCE_PROGRAM_STATE_DELETED' — - ASSET_MAINTENANCE_PROGRAM_STATE_UNSPECIFIED: ASSET_MAINTENANCE_PROGRAM_STATE_UNSPECIFIED is an unknown maintenance program state. - ASSET_MAINTENANCE_PROGRAM_STATE_ACTIVE: ASSET_MAINTENANCE_PROGRAM_STATE_ACTIVE is a maintenance program state that is active. - ASSET_MAINTENANCE_PROGRAM_STATE_DELETED: ASSET_MAINTENANCE_PROGRAM_STATE_DELETED is a maintenance program state that is deleted. - `completed_at` string, date-time — Date/time this task was completed at - `template_name` string — Template name of the inspection the action belongs to - `status` S12TasksV1TaskStatus - `status_id` string — An ID uniquely identifying this task status message. For example: 'aa70d8a6-af37-44f4-8768d8899fe274c5' - `key` string — A pre-defined value that the system can use to handle the particular label e.g. analytics, filter based on it A key may look like: "to do" | "In progress" | "Done" | "Can't do" - `label` string — A label associated with the key, typically for display purposes - `display_order` integer — Used to order this status when displaying a list of statuses - `asset_id` string — @deprecated Asset ID of this task - `asset` S12TasksV1TaskAsset - `id` string — The UUID of the asset associated with this task. - `code` string — The code of the asset associated with this task. - `type_id` string — The id of the asset type associated with this task. - `action_label` S12TasksV1ActionLabel[] — Label of a task - `label_id` string — (Required) The UUID of the action label. For example, "73361b5d-407a-424e-b20e-c932bc41706c". - `label_name` string — (Required) The name of the action label. - `unique_id` string — The human readable unique ID of the task - `type` 'TASK_TYPE_ACTION' | 'TASK_TYPE_CUSTOM' — - TASK_TYPE_ACTION: Indicates this task is of type Action. - TASK_TYPE_CUSTOM: Indicates this task is of a custom type. - `occurred_at` string, date-time — Date/time this task occurred at - `task_templates` S12TasksV1TaskTemplate[] — The list of templates linked to the action. - `template_id` string — The unique identifier of the template. - `name` string — Custom defined template name. - `is_deleted` boolean - `is_archived` boolean - `is_access_denied` boolean - `owner_id` string — The id of the owner of the template - `custom_field_and_values` S12TasksV1TaskCustomFieldAndValue[] — Custom fields and their values (if any) belonging to the action - `field` S12TypefieldV1Field — Describes the values of a field. - `id` string — A global unique identifier for a field. - `name` string — Name of the field. - `description` string — Description of the field. - `field_category` 'FIELD_CATEGORY_UNSPECIFIED' | 'FIELD_CATEGORY_SYSTEM_FIELD' | 'FIELD_CATEGORY_CUSTOM_FIELD' — - FIELD_CATEGORY_UNSPECIFIED: Field category Unspecified. - FIELD_CATEGORY_SYSTEM_FIELD: Field category pre-defined. - FIELD_CATEGORY_CUSTOM_FIELD: Field category custom. - `value_type` 'FIELD_VALUE_TYPE_UNSPECIFIED' | 'FIELD_VALUE_TYPE_STRING' | 'FIELD_VALUE_TYPE_MONEY' | 'FIELD_VALUE_TYPE_TIMESTAMP' | 'FIELD_VALUE_TYPE_USER_ID' | 'FIELD_VALUE_TYPE_SELECT' | 'FIELD_VALUE_TYPE_TEMPLATE_ID' | 'FIELD_VALUE_TYPE_MULTI_SELECT' | 'FIELD_VALUE_TYPE_SITE' | 'FIELD_VALUE_TYPE_MULTI_SITE' | 'FIELD_VALUE_TYPE_INTEGER' | 'FIELD_VALUE_TYPE_ADDRESS' | 'FIELD_VALUE_TYPE_TIMEZONE' | 'FIELD_VALUE_TYPE_CONTACT_DETAILS' — Type of FieldValue. Defaults to type String. - FIELD_VALUE_TYPE_UNSPECIFIED: Field value type unspecified. - FIELD_VALUE_TYPE_STRING: Field value type string. - FIELD_VALUE_TYPE_MONEY: Field value type money. - FIELD_VALUE_TYPE_TIMESTAMP: Field value type timestamp. - FIELD_VALUE_TYPE_USER_ID: Field value type user ID. - FIELD_VALUE_TYPE_SELECT: Field value type select - FIELD_VALUE_TYPE_TEMPLATE_ID: Field value type template ID. - FIELD_VALUE_TYPE_MULTI_SELECT: Field value type multi-select - FIELD_VALUE_TYPE_SITE: Field value type site - FIELD_VALUE_TYPE_MULTI_SITE: Field value type multi-site - FIELD_VALUE_TYPE_INTEGER: Field value type integer - FIELD_VALUE_TYPE_ADDRESS: Field value type address. - FIELD_VALUE_TYPE_TIMEZONE: Field value type timezone - FIELD_VALUE_TYPE_CONTACT_DETAILS: Field value type contact details - `domain` 'DOMAIN_UNSPECIFIED' | 'DOMAIN_GLOBAL' | 'DOMAIN_ASSETS' | 'DOMAIN_CONTRACTORS' | 'DOMAIN_LICENSES_AND_CREDENTIALS' | 'DOMAIN_TASKS' | 'DOMAIN_USERS' | 'DOMAIN_INVESTIGATIONS' | 'DOMAIN_STRUCTURES' | 'DOMAIN_INTEGRATIONS_HRIS_STAGING' — The domain is used to specify which domain the data is coming from. This allows the shared generic type field service to keep track of which domain owns the data, and enforce any domain-specific access control rules. - DOMAIN_UNSPECIFIED: Domain Unspecified. - DOMAIN_GLOBAL: Owned and managed by system can be used by multiple domains - DOMAIN_ASSETS: Owned and created from Assets domain - DOMAIN_CONTRACTORS: Owned and created from Contractor Management domain - DOMAIN_LICENSES_AND_CREDENTIALS: Owned and created from the Licenses and Credentials domain - DOMAIN_TASKS: Owned and created from the Tasks domain - DOMAIN_USERS: Owned and created from the Users domain - DOMAIN_INVESTIGATIONS: Owned and created from the Investigations domain - DOMAIN_STRUCTURES: Owned and created from the Organisational Structures domain - DOMAIN_INTEGRATIONS_HRIS_STAGING: Owned and created from the Integrations domain - `field_state` 'FIELD_STATE_UNSPECIFIED' | 'FIELD_STATE_ACTIVE' | 'FIELD_STATE_DELETED' | 'FIELD_STATE_ARCHIVED' — State of the field. - FIELD_STATE_UNSPECIFIED: Field state unspecified. - FIELD_STATE_ACTIVE: Field is active. - FIELD_STATE_DELETED: Field is deleted. - FIELD_STATE_ARCHIVED: Field is archived and no longer active, but not deleted. Cannot be applied to system fields. - `select_options` S12TypefieldV1FieldOption[] — The options of a field select. - `id` string — The id of a field select option. - `label` string — The label of a field select option. - `order` integer — The display order of this option, 0-indexed. Options should be displayed in ascending order of this field, matching the order they were defined in the field settings. - `created_by` string — CreatorID belonging to the field - `field_value` S12TypefieldV1FieldValue — Individual field value definition. - `field_id` string — A global unique identifier for a field. - `string_value` string — The string value of a field. - `money_value` S12CommonMoney — Represents an amount of money with its currency type. - `currency_code` string — The 3-letter currency code defined in ISO 4217. - `units` string, int64 — The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - `nanos` integer — Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example £-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - `timestamp_value` string, date-time — The timestamp value of a field. - `integer_value` string, int64 — The integer value of a field. Signed, 64-bit integer. - `address_location_value` S12TypefieldV1AddressLocation — Address and location details for a structure. - `name` string — The name of the location. - `thoroughfare` string — The thoroughfare of the location. - `sub_thoroughfare` string — The sub-thoroughfare of the location. - `locality` string — The locality of the location. - `sub_locality` string — The sub-locality of the location. - `administrative_area` string — The administrative area of the location. - `sub_administrative_area` string — The sub-administrative area of the location. - `postal_code` string — The postal code of the location. - `country` string — The country of the location. - `iso_country_code` string — The ISO country code of the location. - `geo_position` S12CommonGeoPosition — A position is the fundamental geographical geometry construct. - `longitude` number, double — The geographical longitude - `latitude` number, double — The geographical latitude - `accuracy` integer — The accuracy in meters - `contact_details_value` S12TypefieldV1ContactDetails — Contact details for a person or entity. - `name` string — The name of the contact. - `phone` string — The phone number of the contact. - `email` string — The email address of the contact. - `multi_select_value` S12TypefieldV1MultiSelectValue — MultiSelectValue represents the value of a multi-select custom field. option_ids contains the UUIDs of the selected options (as strings). An empty option_ids with has_value = true means the field was explicitly cleared. has_value = false (or absent) means the field has never been set on this record. - `option_ids` string[] — UUIDs of the selected options. May be empty if the field was explicitly cleared. - `has_value` boolean — True if this field has ever been explicitly saved (including a clear to empty). Distinguishes "user cleared all selections" from "field was never touched". - `type` S12TasksV1Type — The type associated with an action. - `type` 'TASK_TYPE_ACTION' | 'TASK_TYPE_CUSTOM' — - TASK_TYPE_ACTION: Indicates this task is of type Action. - TASK_TYPE_CUSTOM: Indicates this task is of a custom type. - `id` string — The unique identifier of a type. - `name` string — The name of a type. - `next_page_token` string — If there might be more results than those appearing in this response, then `next_page_token` is included. If empty then there are no more results. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. For Example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ=' - `total` integer — @deprecated. Use ActionsService.GetOrgActionCount instead. Total number of actions found ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/safetyculture/apis/safetyculture-api.md) · [All operations](https://skmtc.net/safetyculture/apis/safetyculture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safetyculture/safetyculture-api/revisions/5be91df61ded/schema)