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

266 lines
8.7 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",
"field_reference"
],
"title": "MobileDeviceAppRegistration - Data API",
"description": "Represents the details provided in a mobile device registration event from an app that uses the Engagement Mobile SDK. This object is available in API version 65.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"DatetimeInDevice": {
"type": "dateTime",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The date and time of the registration event, based on values provided by the device."
},
"DeviceModel": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The model of the device thats being registered, such as iPhone 17 or Google Pixel."
},
"DevicePlatform": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The operating system of the mobile device, such as iPhone OS or Android."
},
"DeviceSystemToken": {
"type": "string",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "A unique token that represents the mobile device. The push notification service (such as Apple Push Notification service or Firebase Cloud Messaging) uses this token to deliver messages to the device."
},
"DeviceSystemTokenHash": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A hash of the device token."
},
"DeviceTimezone": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The time zone that the device is located in when the registration event occurs."
},
"DeviceVersion": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The version or model number of the device."
},
"Deviceid": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A unique identifier for the mobile device."
},
"Eventid": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A unique identifier for the registration event."
},
"IsBackgroundRefreshEnabled": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the device gives permission for the app to receive updates while its in the background. The default value is false."
},
"IsBluetoothEnabled": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether Bluetooth is enabled on the device. The default value is false."
},
"IsDst": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the devices locale observes daylight saving time (DST). The default value is false."
},
"IsLocationEnabled": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the device has location services enabled for the app. The default value is false."
},
"IsPushEnabled": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the device has push notifications enabled for the app. The default value is false."
},
"Locale": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The locale string for the device, such as en_US or ja_JP."
},
"MobileAppName": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The name of the mobile app, as configured in Setup."
},
"MobileAppVersion": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The version number of the mobile app that generated the registration event."
},
"MobileAppid": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A unique ID that represents the mobile app."
},
"PartyIdentificationName": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The name of the party identifier for identity resolution rules."
},
"PartyIdentificationNumber": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID used for identity resolution comparisons."
},
"PartyIdentificationType": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A string that provides additional information about the type of party identifier used, such as Driver License or SSN."
},
"RegistrationDatetime": {
"type": "dateTime",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The date and time when the registration event occurred."
},
"Registrationid": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A unique ID for the registration event."
},
"SdkVersion": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The version of the Mobile Engagement SDK that the app uses."
}
},
"field_reference": {
"DatetimeInDevice": {
"field_label": "Date Time In Device",
"type": "datetime"
},
"DeviceModel": {
"field_label": "Device Model",
"type": "string",
"length": "100"
},
"DevicePlatform": {
"field_label": "Device Platform",
"type": "string",
"length": "100"
},
"DeviceSystemToken": {
"field_label": "Device System Token",
"type": "string",
"length": "4000"
},
"DeviceSystemTokenHash": {
"field_label": "Device System Token Hash",
"type": "string",
"length": "255"
},
"DeviceTimezone": {
"field_label": "Device Time zone",
"type": "string",
"length": "50"
},
"DeviceVersion": {
"field_label": "Device Version",
"type": "string",
"length": "100"
},
"Deviceid": {
"field_label": "Device ID",
"type": "string",
"length": "200"
},
"Eventid": {
"field_label": "Event ID",
"type": "string",
"length": "200"
},
"Id": {
"field_label": "MobileDeviceAppRegistration ID",
"type": "id",
"length": "18"
},
"IsBackgroundRefreshEnabled": {
"field_label": "Background Refresh Enabled",
"type": "boolean"
},
"IsBluetoothEnabled": {
"field_label": "Bluetooth Enabled",
"type": "boolean"
},
"IsDst": {
"field_label": "Daylight Savings Time",
"type": "boolean"
},
"IsLocationEnabled": {
"field_label": "Location Enabled",
"type": "boolean"
},
"IsPushEnabled": {
"field_label": "Push Enabled",
"type": "boolean"
},
"Locale": {
"field_label": "Locale",
"type": "string",
"length": "55"
},
"MobileAppName": {
"field_label": "Mobile App Name",
"type": "string",
"length": "200"
},
"MobileAppVersion": {
"field_label": "Mobile App Version",
"type": "string",
"length": "100"
},
"MobileAppid": {
"field_label": "Mobile App ID",
"type": "string",
"length": "200"
},
"PartyIdentificationName": {
"field_label": "Party Identification Name",
"type": "string",
"length": "255"
},
"PartyIdentificationNumber": {
"field_label": "Party Identification Number",
"type": "string",
"length": "255"
},
"PartyIdentificationType": {
"field_label": "Party Identification Type",
"type": "string",
"length": "255"
},
"RegistrationDatetime": {
"field_label": "Registration Datetime In Service",
"type": "datetime"
},
"Registrationid": {
"field_label": "Registration ID",
"type": "string",
"length": "200"
},
"SdkVersion": {
"field_label": "SDK Version",
"type": "string",
"length": "100"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}