{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"asset_id": {
"type": "string",
"description": "ID of the Asset associated with the action"
},
"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": "The collaborators involved into this action."
},
"created_at": {
"type": "string",
"description": "Date and time this action was created."
},
"description": {
"type": "string",
"description": "Description of the action (maximum 30000 characters)."
},
"due_at": {
"type": "string",
"description": "Date/time this action is due"
},
"field_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "string",
"description": "A global unique identifier for a field."
},
"string_value": {
"type": "string",
"description": "The string value of a field."
},
"money_value": {
"type": "object",
"description": "The money value of a field."
},
"timestamp_value": {
"type": "string",
"format": "date-time",
"description": "The timestamp value of a field."
},
"integer_value": {
"type": "string",
"format": "int64",
"description": "The integer value of a field. Signed, 64-bit integer."
},
"address_location_value": {
"type": "object",
"description": "The address location value of a field."
},
"contact_details_value": {
"type": "object",
"description": "The contact details value of a field."
}
}
},
"description": "Array of custom fields and their values to create with the action."
},
"inspection_id": {
"type": "string",
"description": "ID of the inspection the action belongs to If not set, this action is a standalone action and the inspection ID will be null."
},
"inspection_item_id": {
"type": "string",
"description": "ID of the item in the inspection associated with the action"
},
"label_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of the labels associated with the action."
},
"priority_id": {
"type": "string",
"description": "ID of the action's priority If not set, this action will be stored with the default priority(none)."
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SENSOR",
"SENSOR_ALERT",
"INSPECTION",
"INCIDENT",
"SCHEDULE",
"ACTION",
"LINKED_INSPECTION",
"ASSET_MAINTENANCE_PLAN"
],
"description": "Required. Reference Type."
},
"id": {
"type": "string",
"description": "Required. Reference ID."
},
"inspection_context": {
"type": "object",
"description": "Inspection Context"
},
"sensor_alert_context": {
"type": "object",
"description": "Sensor Alert Context"
},
"sensor_context": {
"type": "object",
"description": "Sensor Context"
},
"incident_context": {
"type": "object",
"description": "Incident Context"
},
"action_context": {
"type": "object",
"description": "Action Context"
},
"linked_inspection_context": {
"type": "object",
"description": "Context of an inspection started from a template associated with the action."
},
"asset_maintenance_plan_context": {
"type": "object",
"description": "Asset Maintenance Plan Context"
}
}
},
"description": "Array of references attached to this action."
},
"site_id": {
"type": "string",
"description": "ID of the Site associated with the action."
},
"status_id": {
"type": "string",
"description": "ID of the action's status If not set, this action will be stored with the default status(to do)."
},
"task_id": {
"type": "string",
"description": "The unique identifier of the action If not provided, UUID will be generated server side."
},
"template_id": {
"type": "string",
"description": "If a template ID is provided then an inspection ID must be provided. If not set, this action is a standalone action and the template ID will be null."
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of templates to be linked to the action."
},
"title": {
"type": "string",
"description": "Required. Title of the action Title is limited to only 255 characters max."
},
"type": {
"type": "object",
"description": "The type to create an action in.",
"properties": {
"type": {
"type": "string",
"description": "The type associated with an action. We currently only support one type: `Action`.",
"enum": [
"TASK_TYPE_ACTION",
"TASK_TYPE_CUSTOM"
]
},
"id": {
"type": "string",
"description": "The unique identifier of a type."
},
"name": {
"type": "string",
"description": "The name of a type."
}
}
}
},
"required": [
"PCID",
"title"
]
}