Fautore API: osaAppPullCfg
Return configuration data specific to requesting application.
Overview
Message Structure
The OCE function data structure is constructed of encoded JSON passed within the "Adjunct":"Data" portion of the master OSA message being used to pass the data to the OCE.
Function: osaAppPullCfg
{ "msgType" : "oceOp", "Visibility" : "2", "Source" : { "Member" : "Bonnie", "Coterie" : "1", "AppKey" : "41T3007T8+HLKMQNOWQSUSH9A7-OI?!QCR56", "AppId" : "Test:jsontest" } "Adjunct" : { "Type" : "oce/func", "Desc" : "An example osaAppPullCfg call" "Data" : "{\n \"Func\" : \"osaAppPullCfg\"\n}\n", }, }
{ "Func" : "osaAppPullCfg" }
The response returned is a 4 field JSON structure:
The number of API call responses being provided. This will always be "1" unless multiple API calls were sent at once.
MsgId:
An alpha numeric representing the message being returned.
The string "REQPROC" (for "Request Processed") is the expected response for success.
MsgNum
An integer value representing the message being returned.
- Positive numbers indicate success
- Negative numbers indicate an error has occurred
The number "7" is the expected response for success.
Mesg:
When successful, an array of hashes with values defined as follows, otherwise the message tied to the received error.
- Field
- The application configuration field provided a value by the OCE member at configuration time.
- Value
- The application configuration value provided to the field by the OCE member at configuration time.
- Member
- The member to which the field and value apply ("Default" if not member specific)
- AppKey
- The application key for the application to which this value applies.
{ "respCount" : 1, "MsgNum" : "7", "MsgId" : "REQPROC", "Mesg" : [ { "Field" : "Catalog", "Value" : "Spring", "AppKey" : "41T3007T8+HLKMQNOWQSUSH9A7-OI?!QCR56", "Member" : "Default" }, { "AppKey" : "41T3007T8+HLKMQNOWQSUSH9A7-OI?!QCR56", "Field" : "PersKey", "Value" : "ajhdfyuqw487qqweiaisfg6480403er", "Member" : "Default" } ] }