Edit Draft App
POST {{base_url}}/v1/adp/apps/draft/:app_id/version/:version
The app icon and lua script values should be in Base64 Format. Use any online tools to convert app icon and lua script to Base64
For example:
icon
: {
data
: iVBORw0KGgoAAAA...dCLHxvZy1MO
,
name
: icon_name.jpg
,
url
: ""
}
lua_script
: {
data
: ZnVuY3Rpb24gZGVjb2RlKGFk...ICBlbmQKZW5k
,
name
: ,
"file_id":
}
Request Body
{"app_support"=>"<string>", "author_website"=>"<string>", "description"=>"<string>", "icon"=>{"data"=>"<string>", "name"=>"<string>", "url"=>"<string>"}, "minimum_sdk_version"=>"<string>", "name"=>"<string>", "summary"=>"<string>", "supported_platforms"=>["LEGACY_AP", "DATA_COLLECTOR"], "allowed_external_urls"=>["<string>", "<string>"], "app_allowed_device_class_classification"=>["<string>", "<string>"], "app_ap_permission"=>"BLOCK", "app_beacon_permission"=>"READ_WRITE", "app_device_class_permissions"=>[{"ble_gatt_operations"=>"READ_ONLY", "ble_script_access"=>"READ_WRITE", "device_class"=>"<string>", "device_context_access"=>"READ_WRITE", "serial_access"=>"READ_ONLY", "zigbee_access"=>"BLOCK"}, {"ble_gatt_operations"=>"READ_ONLY", "ble_script_access"=>"READ_WRITE", "device_class"=>"<string>", "device_context_access"=>"READ_WRITE", "serial_access"=>"READ_WRITE", "zigbee_access"=>"BLOCK"}], "app_features"=>["feature_usb", "feature_usb"], "app_radio_permission"=>"BLOCK", "categories"=>[{"id"=>"<string>", "name"=>"<string>"}, {"id"=>"<string>", "name"=>"<string>"}], "container_ap_image_uuid"=>"<string>", "container_cpu_ap"=>"<string>", "container_cpu_medium_dc"=>"<string>", "container_cpu_mini_dc"=>"<string>", "container_cpu_small_dc"=>"<string>", "container_image_uuid"=>"<string>", "container_mem_ap"=>"<string>", "container_mem_medium_dc"=>"<string>", "container_mem_mini_dc"=>"<string>", "container_mem_small_dc"=>"<string>", "container_required_environment_variables"=>[{"description"=>"<string>", "name"=>"<string>", "default"=>"<string>", "placeholder"=>"<string>", "required"=>"<boolean>", "supported_values"=>["<string>", "<string>"], "validation"=>"<string>"}, {"description"=>"<string>", "name"=>"<string>", "default"=>"<string>", "placeholder"=>"<string>", "required"=>"<boolean>", "supported_values"=>["<string>", "<string>"], "validation"=>"<string>"}], "container_subscription_list"=>[{"match_type"=>"LOCAL_NAME", "match_value"=>"<string>"}, {"match_type"=>"DEVICE_CLASS", "match_value"=>"<string>"}], "license_agreement_url"=>"<string>", "lua_script"=>{"data"=>"<string>", "file_id"=>"<string>", "name"=>"<string>"}, "lua_subscription_list"=>[{"match_type"=>"DEVICE_CLASS", "match_value"=>"<string>"}, {"match_type"=>"UUID", "match_value"=>"<string>"}], "platform_url"=>"<string>", "privacy_policy_url"=>"<string>", "release_notes"=>"<string>", "required_user_ca_certificates"=>"<boolean>", "required_user_outbound_firewall_permission"=>"<boolean>", "required_user_permission"=>"<boolean>", "required_user_subscription"=>"<boolean>", "usb_config"=>[{"descriptors"=>[{"device_revision"=>"9.7", "manufacture"=>"<string>", "product_description"=>"<string>", "product_id"=>"77DC", "usb_version"=>"09.41", "vendor_id"=>"Fed5"}], "device_class"=>"<string>", "interfaces"=>[{"device_driver_name"=>"<string>", "number"=>"<integer>", "baudrate"=>"<string>", "lua_script"=>{"data"=>"<string>", "file_id"=>"<string>", "name"=>"<string>"}}], "name"=>"<string>", "serial_data"=>"<boolean>"}, {"descriptors"=>[{"device_revision"=>"57.2", "manufacture"=>"<string>", "product_description"=>"<string>", "product_id"=>"94eE", "usb_version"=>"5.9", "vendor_id"=>"d27F"}], "device_class"=>"<string>", "interfaces"=>[{"device_driver_name"=>"<string>", "number"=>"<integer>", "baudrate"=>"<string>", "lua_script"=>{"data"=>"<string>", "file_id"=>"<string>", "name"=>"<string>"}}], "name"=>"<string>", "serial_data"=>"<boolean>"}], "zigbee_config"=>[{"aps_ack"=>"<boolean>", "cluster_id"=>"<string>", "config_type"=>"NORTH_BOUND", "dest_endpoint"=>"<integer>", "profile_id"=>"<string>", "src_endpoint"=>"<integer>"}, {"aps_ack"=>"<boolean>", "cluster_id"=>"<string>", "config_type"=>"NORTH_BOUND", "dest_endpoint"=>"<integer>", "profile_id"=>"<string>", "src_endpoint"=>"<integer>"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"app_id":"\u003cstring\u003e","image":"\u003cstring\u003e","name":"\u003cstring\u003e","status":"\u003cstring\u003e","status_reason":"\u003cstring\u003e","summary":"\u003cstring\u003e","total_views":"\u003cinteger\u003e","version":"\u003cinteger\u003e"}