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

117 lines
3.2 KiB
JSON

{
"sections": [
"title",
"description",
"fields",
"associated_objects",
"field_reference"
],
"title": "SurveyEngagementContext - Data API",
"description": "Represents the context based on which a survey invitation was sent or a survey response was received. This object is available in API version 49.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"ContextType": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Context type based on which the survey invitation was sent or the response was received."
},
"ContextValue": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Context based on which the survey invitation was sent or the response was received."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "Name of the record."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "ID of the record's owner."
},
"SurveyInvitationId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "ID of the survey invitation."
},
"SurveyResponseId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "ID of the survey response."
}
},
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **SurveyEngagementContextShare**: Sharing is available for the object.",
"field_reference": {
"ContextType": {
"field_label": "Context Type",
"type": "string",
"length": "250"
},
"ContextValue": {
"field_label": "Context Value",
"type": "string",
"length": "250"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Id": {
"field_label": "Survey Engagement Context ID",
"type": "id",
"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": "Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"SurveyInvitationId": {
"field_label": "Survey Invitation ID",
"type": "reference",
"length": "18"
},
"SurveyResponseId": {
"field_label": "Survey Response ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}