> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# safetyculture-issues
> SafetyCulture Issues - create, track, and manage workplace issues
**Server path:** `/safetyculture-issues` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| [`safetyculture_issues_customer_configuration_service_get_categories`](#safetyculture_issues_customer_configuration_service_get_categories) | List Categories |
| [`safetyculture_issues_incidents_service_add_collaborators`](#safetyculture_issues_incidents_service_add_collaborators) | Add Issue assignee |
| [`safetyculture_issues_incidents_service_delete_incidents`](#safetyculture_issues_incidents_service_delete_incidents) | Delete Issues |
| [`safetyculture_issues_incidents_service_get_incident_by_id`](#safetyculture_issues_incidents_service_get_incident_by_id) | Get Issue |
| [`safetyculture_issues_incidents_service_get_incidents`](#safetyculture_issues_incidents_service_get_incidents) | List Issues |
| [`safetyculture_issues_incidents_service_get_incidents_count`](#safetyculture_issues_incidents_service_get_incidents_count) | Get count of Issues |
| [`safetyculture_issues_incidents_service_get_pdfreport`](#safetyculture_issues_incidents_service_get_pdfreport) | Export Issue to PDF |
| [`safetyculture_issues_incidents_service_remove_collaborators`](#safetyculture_issues_incidents_service_remove_collaborators) | Remove Issue assignee |
| [`safetyculture_issues_incidents_service_submit_incident`](#safetyculture_issues_incidents_service_submit_incident) | Create Issue |
| [`safetyculture_issues_incidents_service_update_asset`](#safetyculture_issues_incidents_service_update_asset) | Update Issue asset |
| [`safetyculture_issues_incidents_service_update_category`](#safetyculture_issues_incidents_service_update_category) | Update Category |
| [`safetyculture_issues_incidents_service_update_description`](#safetyculture_issues_incidents_service_update_description) | Update Issue description |
| [`safetyculture_issues_incidents_service_update_due_at`](#safetyculture_issues_incidents_service_update_due_at) | Update Issue due date |
| [`safetyculture_issues_incidents_service_update_occurred_at`](#safetyculture_issues_incidents_service_update_occurred_at) | Update Issue occurred at |
| [`safetyculture_issues_incidents_service_update_priority`](#safetyculture_issues_incidents_service_update_priority) | Update Issue priority |
| [`safetyculture_issues_incidents_service_update_site`](#safetyculture_issues_incidents_service_update_site) | Update Issue site |
| [`safetyculture_issues_incidents_service_update_status`](#safetyculture_issues_incidents_service_update_status) | Updates Issue status |
| [`safetyculture_issues_incidents_service_update_title`](#safetyculture_issues_incidents_service_update_title) | Update Issue title |
***
## safetyculture\_issues\_customer\_configuration\_service\_get\_categories
List Categories
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `include_deleted` | boolean | No | — | Optional. If this is set to true, all categories including deleted categories will be returned. |
| `search` | string | No | — | Search used to search for specific named categories |
| `category_ids` | string\[] | No | — | Define specific categoryIDs to filter for |
| `page_token` | string | No | — | Page token used to scroll for the next set of categories |
| `page_size` | integer | No | — | Number of categories to respond with |
| `sort_direction` | string | No | — | Optional. Direction for sorting. |
| `is_managing` | boolean | No | — | Optional. 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include_deleted": {
"type": "boolean",
"description": "Optional. If this is set to true, all categories including deleted categories will be returned."
},
"search": {
"type": "string",
"description": "Search used to search for specific named categories"
},
"category_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Define specific categoryIDs to filter for"
},
"page_token": {
"type": "string",
"description": "Page token used to scroll for the next set of categories"
},
"page_size": {
"type": "integer",
"description": "Number of categories to respond with"
},
"sort_direction": {
"type": "string",
"description": "Optional. Direction for sorting.",
"enum": [
"SORT_DIRECTION_UNSPECIFIED",
"SORT_DIRECTION_ASC",
"SORT_DIRECTION_DESC"
]
},
"is_managing": {
"type": "boolean",
"description": "Optional. 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."
}
},
"required": [
"PCID"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_add\_collaborators
Add Issue assignee
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ---------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `collaborators` | object\[] | Yes | — | Required. The collaborators to be added to the task. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"collaborators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collaborator_id": {
"type": "string",
"description": "A UUID uniquely identifying this collaborator."
},
"collaborator_type": {
"type": "string",
"enum": [
"USER",
"GROUP",
"EXTERNAL_USER",
"CONTRIBUTOR"
],
"description": "The type of the collaborator i.e. group or user."
},
"assigned_role": {
"type": "string",
"enum": [
"ASSIGNEE",
"CREATOR"
],
"description": "The role of the collaborator in this task."
},
"user": {
"type": "object",
"description": "Collaborator details for an authenticated user."
},
"group": {
"type": "object",
"description": "Collaborator details for a group."
},
"external_user": {
"type": "object",
"description": "Collaborator details for an external user."
},
"contributor": {
"type": "object",
"description": "Collaborator details for a contributor."
}
}
},
"description": "Required. The collaborators to be added to the task."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
}
},
"required": [
"PCID",
"task_id",
"collaborators"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_delete\_incidents
Delete Issues
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | -------------------------------------------------------- |
| `ids` | string\[] | Yes | — | The list of issue UUIDs to be deleted. |
| `modified_at` | string | No | — | Optional. The UTC time and date the deletion took place. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of issue UUIDs to be deleted."
},
"modified_at": {
"type": "string",
"description": "Optional. The UTC time and date the deletion took place."
}
},
"required": [
"PCID",
"ids"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_get\_incident\_by\_id
Get Issue
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | Required. The unique ID of the incident to retrieve. Can either be a uuid or a org level unique incident id. Example: IS-4352 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Required. The unique ID of the incident to retrieve. Can either be a uuid or a org level unique incident id. Example: IS-4352"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_get\_incidents
List Issues
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filters` | object\[] | No | — | Optional. An array of filters can be provided in the request to filter the issues. |
| `page_size` | integer | No | — | Optional. 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_token` | string | No | — | 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. This can be used to retrieve more than 100 issues with multiple API calls. For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ=' |
| `sort_direction` | string | No | — | Optional. Direction for sorting. |
| `sort_field` | string | No | — | Optional. Which field to use for sorting. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status_id": {
"type": "object",
"description": "`StatusID` filters issues on status."
},
"priority_id": {
"type": "object",
"description": "`PriorityID` filters issues on priority."
},
"category_id": {
"type": "object",
"description": "`CategoryID` filters issues on category."
},
"site_id": {
"type": "object",
"description": "`SiteID` filters issues on site."
},
"assignee_id": {
"type": "object",
"description": "`AssigneeID` filters issues on assignee."
},
"creator_id": {
"type": "object",
"description": "`CreatorID` filters issues on creator."
},
"title": {
"type": "object",
"description": "`title` filters issues on title text"
},
"description": {
"type": "object",
"description": "`description` filters issues on description text"
},
"task_id": {
"type": "object",
"description": "`TaskID` filters issues on task IDs"
},
"due_at": {
"type": "object",
"description": "`DueAt` filters on issues due at time"
},
"created_at": {
"type": "object",
"description": "`CreatedAt` filters on issues created at time"
},
"occurred_at": {
"type": "object",
"description": "`OccurredAt` filters on issues occurred at time"
},
"keyword": {
"type": "object",
"description": "`Keyword` filters according to a search string"
},
"modified_at": {
"type": "object",
"description": "`ModifiedAt` filters on issues modified at time"
},
"completed_at": {
"type": "object",
"description": "`CompletedAt` filters on issues completed at time"
},
"asset_id": {
"type": "object",
"description": "`AssetID` filters issues on asset."
}
}
},
"description": "Optional. An array of filters can be provided in the request to filter the issues."
},
"page_size": {
"type": "integer",
"description": "Optional. 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_token": {
"type": "string",
"description": "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. This can be used to retrieve more than 100 issues with multiple API calls. For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='"
},
"sort_direction": {
"type": "string",
"description": "Optional. Direction for sorting.",
"enum": [
"SORT_DIRECTION_UNKNOWN",
"ASC",
"DESC"
]
},
"sort_field": {
"type": "string",
"description": "Optional. Which field to use for sorting.",
"enum": [
"SORT_FIELD_UNKNOWN",
"PRIORITY",
"DATE_DUE",
"CREATED_AT",
"MODIFIED_AT",
"OCCURRED_AT"
]
}
},
"required": [
"PCID"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_get\_incidents\_count
Get count of Issues
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filters` | object\[] | No | — | Optional. An array of filters can be provided in the request to filter the issues. |
| `page_size` | integer | No | — | Optional. 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_token` | string | No | — | 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. This can be used to retrieve more than 100 issues with multiple API calls. For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ=' |
| `sort_direction` | string | No | — | Optional. Direction for sorting. |
| `sort_field` | string | No | — | Optional. Which field to use for sorting. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status_id": {
"type": "object",
"description": "`StatusID` filters issues on status."
},
"priority_id": {
"type": "object",
"description": "`PriorityID` filters issues on priority."
},
"category_id": {
"type": "object",
"description": "`CategoryID` filters issues on category."
},
"site_id": {
"type": "object",
"description": "`SiteID` filters issues on site."
},
"assignee_id": {
"type": "object",
"description": "`AssigneeID` filters issues on assignee."
},
"creator_id": {
"type": "object",
"description": "`CreatorID` filters issues on creator."
},
"title": {
"type": "object",
"description": "`title` filters issues on title text"
},
"description": {
"type": "object",
"description": "`description` filters issues on description text"
},
"task_id": {
"type": "object",
"description": "`TaskID` filters issues on task IDs"
},
"due_at": {
"type": "object",
"description": "`DueAt` filters on issues due at time"
},
"created_at": {
"type": "object",
"description": "`CreatedAt` filters on issues created at time"
},
"occurred_at": {
"type": "object",
"description": "`OccurredAt` filters on issues occurred at time"
},
"keyword": {
"type": "object",
"description": "`Keyword` filters according to a search string"
},
"modified_at": {
"type": "object",
"description": "`ModifiedAt` filters on issues modified at time"
},
"completed_at": {
"type": "object",
"description": "`CompletedAt` filters on issues completed at time"
},
"asset_id": {
"type": "object",
"description": "`AssetID` filters issues on asset."
}
}
},
"description": "Optional. An array of filters can be provided in the request to filter the issues."
},
"page_size": {
"type": "integer",
"description": "Optional. 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_token": {
"type": "string",
"description": "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. This can be used to retrieve more than 100 issues with multiple API calls. For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='"
},
"sort_direction": {
"type": "string",
"description": "Optional. Direction for sorting.",
"enum": [
"SORT_DIRECTION_UNKNOWN",
"ASC",
"DESC"
]
},
"sort_field": {
"type": "string",
"description": "Optional. Which field to use for sorting.",
"enum": [
"SORT_FIELD_UNKNOWN",
"PRIORITY",
"DATE_DUE",
"CREATED_AT",
"MODIFIED_AT",
"OCCURRED_AT"
]
}
},
"required": [
"PCID"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_get\_pdfreport
Export Issue to PDF
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------ |
| `task_id` | string | Yes | — | The ID of the incident which the report is being created for |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "The ID of the incident which the report is being created for"
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_remove\_collaborators
Remove Issue assignee
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | -------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `collaborators` | object\[] | Yes | — | Required. The collaborators to be removed from the task. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"collaborators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collaborator_id": {
"type": "string",
"description": "A UUID uniquely identifying this collaborator."
},
"collaborator_type": {
"type": "string",
"enum": [
"USER",
"GROUP",
"EXTERNAL_USER",
"CONTRIBUTOR"
],
"description": "The type of the collaborator i.e. group or user."
},
"assigned_role": {
"type": "string",
"enum": [
"ASSIGNEE",
"CREATOR"
],
"description": "The role of the collaborator in this task."
},
"user": {
"type": "object",
"description": "Collaborator details for an authenticated user."
},
"group": {
"type": "object",
"description": "Collaborator details for a group."
},
"external_user": {
"type": "object",
"description": "Collaborator details for an external user."
},
"contributor": {
"type": "object",
"description": "Collaborator details for a contributor."
}
}
},
"description": "Required. The collaborators to be removed from the task."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
}
},
"required": [
"PCID",
"task_id",
"collaborators"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_submit\_incident
Create Issue
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `access_token` | string | No | — | Optional. The access token used to authenticate the request. This field should be set when following the contributor flow. Otherwise, authenticate via normal means. |
| `answered_questions` | string\[] | No | — | Optional. 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_id` | string | No | — | Optional. The ID of the asset associated with this incident. |
| `category_id` | string | Yes | — | Required. ID of the incident's category If not set, this incident will be stored with the default category(None) |
| `contact` | string | No | — | Optional. The contact details of the contributor |
| `created_at` | string | No | — | Optional. Date and time this incident was created |
| `description` | string | No | — | Optional. Description of the issue (maximum 500 characters). |
| `email` | string | No | — | Optional. The email address of the contributor |
| `items` | object\[] | No | — | Optional. The category fields and questions that applied to this incident when it was created. |
| `location` | object | No | — | The location that the incident occurred at |
| `media` | object\[] | No | — | Optional. Array of media items to be linked to the incident. |
| `name` | string | No | — | Optional. The name of the contributor |
| `occurred_at` | string | No | — | Optional. Date and time this incident occurred at |
| `questions_and_answers` | object\[] | No | — | Optional. An array of all, if any, custom questions that have been answered for this issue. |
| `site_id` | string | No | — | Optional. ID of the site to associate with the incident. If not provided, no site will be associated with the incident. |
| `task_id` | string | No | — | Optional. The unique identifier of the incident If not provided, UUID will be generated server side |
| `title` | string | Yes | — | Required. Title of the incident Title is limited to only 255 characters max |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"access_token": {
"type": "string",
"description": "Optional. The access token used to authenticate the request. This field should be set when following the contributor flow. Otherwise, authenticate via normal means."
},
"answered_questions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional. 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_id": {
"type": "string",
"description": "Optional. The ID of the asset associated with this incident."
},
"category_id": {
"type": "string",
"description": "Required. ID of the incident's category If not set, this incident will be stored with the default category(None)"
},
"contact": {
"type": "string",
"description": "Optional. The contact details of the contributor"
},
"created_at": {
"type": "string",
"description": "Optional. Date and time this incident was created"
},
"description": {
"type": "string",
"description": "Optional. Description of the issue (maximum 500 characters)."
},
"email": {
"type": "string",
"description": "Optional. The email address of the contributor"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the item."
},
"name": {
"type": "string",
"description": "Name of the item"
},
"is_mandatory": {
"type": "boolean",
"description": "Whether or not the item must be filled before submission"
},
"type": {
"type": "string",
"enum": [
"ITEM_TYPE_UNSPECIFIED",
"ITEM_TYPE_TITLE",
"ITEM_TYPE_DESCRIPTION",
"ITEM_TYPE_SITE",
"ITEM_TYPE_MEDIA",
"ITEM_TYPE_LOCATION",
"ITEM_TYPE_QUESTION",
"ITEM_TYPE_OCCURRED_AT",
"ITEM_TYPE_ASSET"
],
"description": "Type of item"
},
"question_data": {
"type": "object",
"description": "Question represents the question structure for a custom question."
},
"is_disabled": {
"type": "boolean",
"description": "Whether or not the item is disabled and hidden from submission"
}
}
},
"description": "Optional. The category fields and questions that applied to this incident when it was created."
},
"location": {
"type": "object",
"description": "The location that the incident occurred at",
"properties": {
"name": {
"type": "string",
"description": "The name of the task's location."
},
"thoroughfare": {
"type": "string",
"description": "The thoroughfare of the location."
},
"sub_thoroughfare": {
"type": "string",
"description": "The sub_thoroughfare of the location,"
},
"locality": {
"type": "string",
"description": "The locality of the location"
},
"sub_locality": {
"type": "string",
"description": "The sub_locality of the location"
},
"administrative_area": {
"type": "string",
"description": "The administrative_area of the location"
},
"sub_administrative_area": {
"type": "string",
"description": "The sub_administrative_area of the location"
},
"postal_code": {
"type": "string",
"description": "The postal_code of the location"
},
"country": {
"type": "string",
"description": "The country of the location"
},
"iso_country_code": {
"type": "string",
"description": "The iso_country_code of the location"
},
"geo_position": {
"type": "object",
"description": "The geometry of the location"
}
}
},
"media": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"token": {
"type": "string",
"description": "The token value"
},
"filename": {
"type": "string",
"description": "full file name, including file extension"
},
"media_type": {
"type": "string",
"enum": [
"MEDIA_TYPE_IMAGE",
"MEDIA_TYPE_VIDEO",
"MEDIA_TYPE_PDF",
"MEDIA_TYPE_DOCX",
"MEDIA_TYPE_XLSX"
],
"description": "- 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)."
}
}
},
"description": "Optional. Array of media items to be linked to the incident."
},
"name": {
"type": "string",
"description": "Optional. The name of the contributor"
},
"occurred_at": {
"type": "string",
"description": "Optional. Date and time this incident occurred at"
},
"questions_and_answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"question_id": {
"type": "string",
"description": "The ID of the question being answered."
},
"answer_text": {
"type": "object",
"description": "AnswerText indicates that the question being answered has a text response."
},
"answer_multiple_choice": {
"type": "object",
"description": "MultipleChoiceOption indicates that the question being answered is a multiple choice question."
}
}
},
"description": "Optional. An array of all, if any, custom questions that have been answered for this issue."
},
"site_id": {
"type": "string",
"description": "Optional. ID of the site to associate with the incident. If not provided, no site will be associated with the incident."
},
"task_id": {
"type": "string",
"description": "Optional. The unique identifier of the incident If not provided, UUID will be generated server side"
},
"title": {
"type": "string",
"description": "Required. Title of the incident Title is limited to only 255 characters max"
}
},
"required": [
"PCID",
"category_id",
"title"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_update\_asset
Update Issue asset
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `asset_id` | object | No | — | Optional. The new asset UUID for the task. If this is empty, the asset will be unset. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"asset_id": {
"type": "object",
"description": "Optional. The new asset UUID for the task. If this is empty, the asset will be unset.",
"properties": {
"value": {
"type": "string",
"description": "The value value"
}
}
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_update\_category
Update Category
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the issue being updated. |
| `category_id` | string | Yes | — | Required. The new category UUID for the issue. Call the `GetCategories` endpoint to get the available categories. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the issue being updated."
},
"category_id": {
"type": "string",
"description": "Required. The new category UUID for the issue. Call the `GetCategories` endpoint to get the available categories."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
}
},
"required": [
"PCID",
"task_id",
"category_id"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_update\_description
Update Issue description
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `description` | string | Yes | — | Required. The new description for the task. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"description": {
"type": "string",
"description": "Required. The new description for the task."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
}
},
"required": [
"PCID",
"task_id",
"description"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_update\_due\_at
Update Issue due date
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated |
| `due_at` | string | No | — | Optional. Date/time this task is due. If this is empty, "due at" will be unset. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated"
},
"due_at": {
"type": "string",
"description": "Optional. Date/time this task is due. If this is empty, \"due at\" will be unset."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_update\_occurred\_at
Update Issue occurred at
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
| `occurred_at` | string | No | — | Optional. The new occurred at time for the task. If this is empty, the occurred at value will be unset. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
},
"occurred_at": {
"type": "string",
"description": "Optional. The new occurred at time for the task. If this is empty, the occurred at value will be unset."
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_update\_priority
Update Issue priority
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
| `priority_id` | string | Yes | — | Required. The new priority UUID for the task. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
},
"priority_id": {
"type": "string",
"description": "Required. The new priority UUID for the task."
}
},
"required": [
"PCID",
"task_id",
"priority_id"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_update\_site
Update Issue site
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
| `site_id` | object | No | — | Optional. 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
},
"site_id": {
"type": "object",
"description": "Optional. 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.",
"properties": {
"value": {
"type": "string",
"description": "The value value"
}
}
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_update\_status
Updates Issue status
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The ID of the action or issue you're updating. |
| `modified_at` | string | No | — | Optional. The UTC time and date the modification took place. |
| `status_id` | string | Yes | — | Required. 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`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The ID of the action or issue you're updating."
},
"modified_at": {
"type": "string",
"description": "Optional. The UTC time and date the modification took place."
},
"status_id": {
"type": "string",
"description": "Required. 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`."
}
},
"required": [
"PCID",
"task_id",
"status_id"
]
}
```
***
## safetyculture\_issues\_incidents\_service\_update\_title
Update Issue title
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------- |
| `task_id` | string | Yes | — | Required. The UUID of the task being updated. |
| `modified_at` | string | No | — | Optional. The timestamp of when this event occurred. |
| `title` | string | No | — | Required. The new title for the task. The title must be between 0 and 255 characters. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Required. The UUID of the task being updated."
},
"modified_at": {
"type": "string",
"description": "Optional. The timestamp of when this event occurred."
},
"title": {
"type": "string",
"description": "Required. The new title for the task. The title must be between 0 and 255 characters."
}
},
"required": [
"PCID",
"task_id"
]
}
```