Try this API
Call this method on live data to see the API request and response. Need help with the API Explorer?
Request parameters
You have invalid or missing required parameter values above.
Execute
Orchestly Developers

Application Property

Data required to run an extension might not be defined at the time of initialization. Such additional data can be stored or retrieved using application properties.

store

This method helps you to store data corresponding to an extension.


  OrchestlyClient.then(function(App) { 
        OrchestlySDK.store(key,value).then(function(){
                //response Handling
            }).catch(function (err) {
                //error Handling
        });     
    });  

Arugment Name Data Type Description
key String A unique string against which the data is stored.
value JSONObject Data to be stored corresponding to the key.

Response:


{  
   "entity_id":"1",
   "app_id":"771000000141001",
   "value":"{\"value\":[],\"key\":\"fwqfwf\"}",
   "property_id":"771000000163223",
   "location_id":"771000000010001",
   "key":"duringchecklist_771000000163125_771000000163129"
}

retrieve

This method is used to fetch a specific data stored in the extension.


OrchestlyClient.then(function(App) { 
        OrchestlySDK.retrieve({"key":key_to_retrieve}).then(function (response) {
                //response Handling
            }).catch(function (err) {
                //error Handling
        })
    });

Arugment Name Data Type Description
key_to_retrieve String A unique string against which the data is stored.

Response:


{  
   "entity_id":"1",
   "app_id":"771000000141001",
   "value":"{\"value\":[{\"value\":\"dwefewfewfew\",\"isMan\":false}],
   \"key\":\"test\"}",
   "property_id":"771000000160037",
   "location_id":"771000000010001",
   "key":"duringchecklist_771000000000122_771000000000131"
}

retrieveAll

This method fetches all the data stored in the extension.


OrchestlyClient.then(function(App) { 
          OrchestlySDK.retrieveAll().then(function (response) {
				//response Handling
			}).catch(function (err) {
				//error Handling
            })
     });

Response:


[  
   {  
      "entity_id":"1",
      "app_id":"771000000141001",
      "value":"{\"value\":[{\"value\":\"dwefewfewfew\",\"isMan\":false}],
      \"key\":\"test\"}",
      "property_id":"771000000160037",
      "location_id":"771000000010001",
      "key":"duringchecklist_771000000000122_771000000000131"
   },
   {  
      "entity_id":"1",
      "app_id":"771000000141001",
      "value":"{\"value\":[{\"value\":\"dwefewfewfew\",\"isMan\":false}],
      \"key\":\"test\"}",
      "property_id":"771000000160037",
      "location_id":"771000000010001",
      "key":"duringchecklist_771000000000122_771000000000131"
   }
]