List Service Template Profiles created by customer user on the account
| Property | Description |
| Resource URL | /customer/v1/{customer_id} /service_provisioning/serviceTemplates |
| Method | GET |
| Body | None |
Sample Request
|
1 2 3 4 |
GET /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/serviceTemplates HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":[ { "service_template_id":"config_profile_SmartDev_r22", "state":true, "description":"my smart buttons r0.22", "messaging_endpoint_profiles":[ "my_iot_application_instance_primary", "my_iot_application_instance_secondary" ], "delivery_burst":"concurrent_delivery", "device_delivery_encoding":"", "server_delivery_encoding":"", "managed_security":"", "tariff_profile_id":"5a393ea210e91806b7ef702d", "max_msg_per_wakeup":5, "service_access_point_permitted":[ ], "notify_on_msg_sent":false, "notify_on_msg_delivery":false, "notify_on_error":false, "notify_on_disconnect":false, "notify_on_connect":false, "notify_on_wakeup":false, "device_idle_threshold":16, "wakeup_duration":10, "init_new_socket_for_downlink":false, "device_assisted_ack":[ ], "create_time":"2015-02-19T16:30:26.897Z", "radius_auth_level":"", "radius_auth_username_type":"", "pki_auth_level":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "auto_capture_imei":false, "auto_capture_credentials":false, "imei_match_check":false, "radius_auth_password":"", "radius_auth_username":"", "radius_auth_RAT_allowed":[ ], "radius_auth_enabled":false, "radius_networklabel_check":false }, { "service_template_id":"config_profile_utililty_group1", "state":true, "description":"utility devices model vX1", "messaging_endpoint_profiles":[ "my_iot_application_instance_primary", "my_iot_application_instance_secondary" ], "delivery_burst":"wait_for_ack_delivery", "device_delivery_encoding":"binary", "server_delivery_encoding":"utf8", "managed_security":"", "tariff_profile_id":"5a393ea210e91806b7ef702d", "max_msg_per_wakeup":2, "service_access_point_permitted":[ "citymotive", "faniot" ], "notify_on_msg_sent":false, "notify_on_msg_delivery":false, "notify_on_error":false, "notify_on_disconnect":false, "notify_on_connect":false, "notify_on_wakeup":false, "device_idle_threshold":10, "wakeup_duration":45, "init_new_socket_for_downlink":false, "device_assisted_ack":[ { "protocol":"tcp", "ack_type":"uplink-length", "_id":"5a393ea210d91806b7ef7030", "ack_value":"", "custom_ack":true }, { "protocol":"udp", "ack_type":"message_id", "_id":"5a393ea210d91806b7ef702f", "ack_value":"", "custom_ack":true } ], "create_time":"2015-02-19T16:30:26.897Z", "radius_auth_level":"", "radius_auth_username_type":"", "pki_auth_level":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "auto_capture_imei":false, "auto_capture_credentials":false, "imei_match_check":false, "radius_auth_password":"", "radius_auth_username":"", "radius_auth_RAT_allowed":[ ], "radius_auth_enabled":false, "radius_networklabel_check":false }, { "service_template_id":"raspberry_pi_service_conf", "state":true, "description":"service config profile raspberry batch 150", "messaging_endpoint_profiles":[ "udp_upstream_instances_g1" ], "delivery_burst":"concurrent_delivery", "device_delivery_encoding":"hex", "server_delivery_encoding":"", "managed_security":"", "tariff_profile_id":"5a393ea210e91806b7ef702d", "max_msg_per_wakeup":5, "service_access_point_permitted":[ "doodle", "faniot" ], "notify_on_msg_sent":false, "notify_on_msg_delivery":false, "notify_on_error":false, "notify_on_disconnect":false, "notify_on_connect":false, "notify_on_wakeup":false, "device_idle_threshold":16, "wakeup_duration":10, "init_new_socket_for_downlink":false, "device_assisted_ack":[ { "protocol":"udp", "ack_type":"message_id", "_id":"5a393ea210d91806b7ef702f", "ack_value":"", "custom_ack":true } ], "create_time":"2015-02-19T16:30:26.897Z", "radius_auth_level":"", "radius_auth_username_type":"", "pki_auth_level":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "auto_capture_imei":false, "auto_capture_credentials":false, "imei_match_check":false, "radius_auth_password":"", "radius_auth_username":"", "radius_auth_RAT_allowed":[ ], "radius_auth_enabled":false, "radius_networklabel_check":false } ] } |
List a specific Service Template Profile created by customer user on the account
| Property | Description |
| Resource URL | /customer/v1/{customer_id}/service_provisioning/serviceTemplates/{service_template_id} |
| Method | GET |
| Body | None |
Sample Request
|
1 2 3 4 |
GET /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/serviceTemplates/config_profile_utililty_group1 HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":{ "service_template_id":"config_profile_utililty_group1", "state":true, "description":"utility devices model vX1", "messaging_endpoint_profiles":[ "my_iot_application_instance_primary", "my_iot_application_instance_secondary" ], "delivery_burst":"wait_for_ack_delivery", "device_delivery_encoding":"binary", "server_delivery_encoding":"utf8", "managed_security":"", "tariff_profile_id":"5a393ea210e91806b7ef702d", "max_msg_per_wakeup":2, "service_access_point_permitted":[ "citymotive", "faniot" ], "notify_on_msg_sent":false, "notify_on_msg_delivery":false, "notify_on_error":false, "notify_on_disconnect":false, "notify_on_connect":false, "notify_on_wakeup":false, "device_idle_threshold":10, "wakeup_duration":45, "init_new_socket_for_downlink":false, "device_assisted_ack":[ { "protocol":"tcp", "ack_type":"uplink-length", "_id":"5a393ea210d91806b7ef7030", "ack_value":"", "custom_ack":true }, { "protocol":"udp", "ack_type":"message_id", "_id":"5a393ea210d91806b7ef702f", "ack_value":"", "custom_ack":true } ], "create_time":"2015-02-19T16:30:26.897Z", "radius_auth_level":"", "radius_auth_username_type":"", "pki_auth_level":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "auto_capture_imei":false, "auto_capture_credentials":false, "imei_match_check":false, "radius_auth_password":"", "radius_auth_username":"", "radius_auth_RAT_allowed":[ ], "radius_auth_enabled":false, "radius_networklabel_check":false } } |
Create a Service Template Profile
| Property | Description |
| Resource URL | /customer/v1/{customer_id} /service_provisioning/serviceTemplates/ |
| Method | POST |
| Body | Service template object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/serviceTemplates HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":{ "service_template_id":"conf_automotive_iot", "state":true, "description":"automotive telemetry terminals X345 storage only no upstream forwarding", "messaging_endpoint_profiles":[ ], "max_msg_per_wakeup":10, "service_access_point_permitted":[ "citymotive" ], "device_idle_threshold":10, "wakeup_duration":20, "device_assisted_ack":[ { "protocol":"tcp", "ack_type":"message_id", "custom_ack":true } ] } } |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":{ "service_template_id":"conf_automotive_iot", "state":true, "description":"automotive telemetry terminals X345 storage only no upstream forwarding", "messaging_endpoint_profiles":[ ], "delivery_burst":"concurrent_delivery", "device_delivery_encoding":"", "server_delivery_encoding":"", "managed_security":"", "tariff_profile_id":"5a393ea210e91806b7ef702d", "max_msg_per_wakeup":10, "service_access_point_permitted":[ "citymotive" ], "notify_on_msg_sent":false, "notify_on_msg_delivery":false, "notify_on_error":false, "notify_on_disconnect":false, "notify_on_connect":false, "notify_on_wakeup":false, "device_idle_threshold":10, "wakeup_duration":45, "init_new_socket_for_downlink":false, "device_assisted_ack":[ { "protocol":"tcp", "ack_type":"uplink-length", "_id":"58bc0959ab93203b4c733be8", "ack_value":"", "custom_ack":true } ], "create_time":"2015-02-25T55:40:24.234Z", "radius_auth_level":"", "radius_auth_username_type":"", "pki_auth_level":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "auto_capture_imei":false, "auto_capture_credentials":false, "imei_match_check":false, "radius_auth_password":"", "radius_auth_username":"", "radius_auth_RAT_allowed":[ ], "radius_auth_enabled":false, "radius_networklabel_check":false } } |
Update a Service Template Profile
| Property | Description |
| Resource URL | /customer/v1/{customer_id} /service_provisioning/serviceTemplates/ |
| Method | PUT |
| Body | Service template object |
Sample Request
|
1 2 3 4 |
PUT /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/serviceTemplates HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
{ "request_id": "", "result_code": 0, "result_description": "Success", "response": { "service_template_id": "conf_automotive_iot", "state": true, "description": "automotive telemetry terminals X345 storage and upstream Rest API", "messaging_endpoint_profiles": [ "my_iot_application_instance_primary", "my_iot_application_instance_secondary" ], "delivery_burst": "concurrent_delivery", "device_delivery_encoding": "hex", "server_delivery_encoding": "binary", "managed_security": "", "tariff_profile_id": "5a393ea210e91806b7ef702d", "max_msg_per_wakeup": 55, "service_access_point_permitted": ["citymotive", "doodle"], "notify_on_msg_sent": true, "notify_on_msg_delivery": true, "notify_on_error": false, "notify_on_disconnect": false, "notify_on_connect": true, "notify_on_wakeup": false, "device_idle_threshold": 10, "wakeup_duration": 10, "init_new_socket_for_downlink": true, "device_assisted_ack": [ { "protocol": "tcp", "ack_type": "uplink-length", "custom_ack": true }, { "protocol": "udp", "ack_type": "string-content ", "ack_value": "200 Ok", "custom_ack": true } ], "create_time": "2015-02-25T55:40:24.234Z", "radius_auth_level": "", "radius_auth_username_type": "", "pki_auth_level": "", "pki_auth_pem_srv_key": "", "pki_auth_pem_srv_cert": "", "pki_auth_pem_dev_cert": "", "auto_capture_imei": false, "auto_capture_credentials": false, "imei_match_check": false, "radius_auth_password": "", "radius_auth_username": "", "radius_auth_RAT_allowed": [], "radius_auth_enabled": false, "radius_networklabel_check": false } } |
Note:
When the attribute service_access_point_permitted is configured with specific service access point, all device objects associated to the service template are restricted to using the specified service access point (SAP whitelist).
When the attribute service_access_point_permitted is configured with specific service access point, all device objects associated to the service template are restricted to using the specified service access point (SAP whitelist).