{
"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"
]
}
