Custom variables Resource

GET /{tenantGuid}/api/v1/customVariables

Available Since:

12.13.0

Get custom variables.

Samples

Sample request

Get custom variables.

 GET /SRP00000/api/v1/customVariables
 

Sample response body

 

 {
   "customVaribles" :
   [
     {
       "name":"%custom1%",
       "label":"custom variable",
       "encrypted":false
     },
     {
       "name":"%custom2%",
       "label":"%custom2%",
       "encrypted":false
     },
     {
       "name":"%custom3%",
       "label":"%custom3%",
       "encrypted":false
     },
     {
       "name":"%custom4%",
       "label":"%custom4%",
       "encrypted":false
     },
     {
       "name":"%custom5%",
       "label":"%custom5%",
       "encrypted":false
     },
     {
       "name":"%custom_pswd1%",
       "label":"custom password variable",
       "encrypted":true
     },
     {
       "name":"%custom_pswd2%",
       "label":"%custom_pswd2%",
       "encrypted":true
     },
     {
       "name":"%custom_pswd3%",
       "label":"%custom_pswd3%",
       "encrypted":true
     },
     {
       "name":"%custom_pswd4%",
       "label":"%custom_pswd4%",
       "encrypted":true
     },
     {
       "name":"%custom_pswd5%",
       "label":"%custom_pswd5%",
       "encrypted":true
     }
   ],
   "showInCreateEditUser":false
 }
 
 

Response Codes

Code	Condition	Data type
200	OK.	User custom variables (JSON)

Response Body

Media type	Data type	Description
application/vnd.blackberry.usercustomvariables-v1+json	User custom variables (JSON)