afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/IncidentRelatedItem.json

139 lines
4.4 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"associated_objects",
"field_reference"
],
"title": "IncidentRelatedItem - Data API",
"description": "Represents a junction object that relates an Incident to an Asset or Product. This object is available in API version 53.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"AssetId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "The Asset ID that's linked to the Incident. This field is a relationship field.",
"relationship_name": "Asset",
"relationship_type": "Lookup",
"refers_to": "Asset"
},
"Comment": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "A description of the incident as it relates to the item."
},
"ImpactLevel": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
"description": "The related items impact on the incident. Possible values are: High Low Medium The default value is High."
},
"ImpactType": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The effect of the related item on business operations. Possible values are: Business-Blocking Not Business-Blocking Partially Business-Blocking The default value is Business-Blocking."
},
"IncidentId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The Incident ID that's linked to the Asset. This field is a relationship field.",
"relationship_name": "Incident",
"relationship_type": "Lookup",
"refers_to": "Incident"
},
"Name": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "The auto-generated ID of the incident-related item."
},
"Product2Id": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "The product (Product2) ID that's linked to the Incident.. This field is a relationship field.",
"relationship_name": "Product2",
"relationship_type": "Lookup",
"refers_to": "Product2"
}
},
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **IncidentRelatedItemChangeEvent**: Change events are available for the object.\n- **IncidentRelatedItemFeed**: Feed tracking is available for the object.\n- **IncidentRelatedItemHistory**: History is available for tracked fields of the object.",
"field_reference": {
"AssetId": {
"field_label": "Asset ID",
"type": "reference",
"length": "18"
},
"Comment": {
"field_label": "Comment",
"type": "textarea",
"length": "32000"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Id": {
"field_label": "Incident Related Item ID",
"type": "id",
"length": "18"
},
"ImpactLevel": {
"field_label": "Impact Level",
"type": "picklist",
"length": "40"
},
"ImpactType": {
"field_label": "Impact Type",
"type": "picklist",
"length": "40"
},
"IncidentId": {
"field_label": "Incident ID",
"type": "reference",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"Name": {
"field_label": "Incident Related Item Number",
"type": "string",
"length": "255"
},
"Product2Id": {
"field_label": "Product ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}