/ConsoleConfiguration/config POST

Overview

Saves configuration changes in the database.

Request Arguments

This endpoint does not accept any request arguments.

URL Example

  /rest/v11_9/ConsoleConfiguration/config

Request Payload Example

  {
   "is_setup":true,
   "enabled_modules":{
  	"c108bb4a-775a-11e9-b570-f218983a1c3e":[
     	    "Cases"
  	],
  	"da438c86-df5e-11e9-9801-3c15c2c53980":[
     	    "Accounts",
     	    "Opportunities"
  	]
   },
   "order_by_primary":{
  	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
     	    "Cases":"follow_up_datetime:asc"
  	},
  	"da438c86-df5e-11e9-9801-3c15c2c53980":{
     	    "Accounts":"next_renewal_date:asc",
     	    "Opportunities":"date_closed:asc"
  	}
   },
   "order_by_secondary":{
  	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
     	    "Cases":""
  	},
  	"da438c86-df5e-11e9-9801-3c15c2c53980":{
     	    "Accounts":"",
     	"Opportunities":""
  	}
   },
   "filter_def":{
  	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
     	    "Cases":[
        	        {
           	            "status":{
              	    "$not_in":[
                 	        "Closed",
                 	        "Rejected",
                 	        "Duplicate"
              	    ]
           	            }
        	        },
        	        {
           	"$owner":""
        	        }
     	    ]
  	},
  	"da438c86-df5e-11e9-9801-3c15c2c53980":{
     "Accounts":[
        	{
           	    "$owner":""
        	}
     ],
     "Opportunities":[
        	{
           	    "sales_status":{
              	"$not_in":[
                 	    "Closed Won",
                 	    "Closed Lost"
              	]
           	    }
        	},
        	{
           	"$owner":""
        	}
     ]
  	}
   },
   "defaults":{
  	"is_setup":0,
  	"enabled_modules":{
     	"c108bb4a-775a-11e9-b570-f218983a1c3e":[
        	    "Cases"
     		],
     	"da438c86-df5e-11e9-9801-3c15c2c53980":[
        	    "Accounts",
        	    "Opportunities"
     	]
  	},
  	"order_by_primary":{
     	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
        	    "Cases":"follow_up_datetime:asc"
     	},
     	"da438c86-df5e-11e9-9801-3c15c2c53980":{
        	    "Accounts":"next_renewal_date:asc",
        	    "Opportunities":"date_closed:asc"
     	}
  	},
  	"order_by_secondary":{
     	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
        	    "Cases":""
     	},
     	"da438c86-df5e-11e9-9801-3c15c2c53980":{
        	    "Accounts":"",
        	    "Opportunities":""
     	}
  	},
  	"filter_def":{
     	    "c108bb4a-775a-11e9-b570-f218983a1c3e":{
        	"Cases":[
           	    {
              	"status":{
                 	    "$not_in":[
                    	        "Closed",
                    	        "Rejected",
                    	        "Duplicate"
                 	    ]
              	}
           	    },
           	    {
              	"$owner":""
           	    }
        	]
     	    },
     	    "da438c86-df5e-11e9-9801-3c15c2c53980":{
        	        "Accounts":[
           	            {
              	    "$owner":""
           	            }
        	        ],
        	        "Opportunities":[
           	            {
              	    "sales_status":{
                 	        "$not_in":[
                    	            "Closed Won",
                    	            "Closed Lost"
                 	        ]
              	    }
           	            },
           	            {
              	    "$owner":""
           	            }
        	        ]
     	    }
          }
   },
   "labels":{
  	"Cases":[
     	    {
        	"label":"LBL_LIST_PRIORITY/LBL_STATUS",
        	"labelValue":"Priority/Status"
     	    },
     	    {
        	        "label":"LBL_LIST_SUBJECT/LBL_SERVICE_LEVEL",
        	        "labelValue":"Subject/Service Level"
     	    }
  	]
   },
   "viewdefs":{
      "Cases":{
     	"base":{
        	    "view":{
           	        "multi-line-list":{
              	"panels":[
                 	    {
                    	        "label":"LBL_LABEL_1",
                    	        "fields":[
                       	            {
                          	    "name":"case_number",
                          	    "label":"LBL_AGENT_WORKBENCH_NUMBER",
                          	    "subfields":[
                             	        {
                                	            "default":true,
                                	            "enabled":true,
                                      	"name":"case_number",
                                    	"label":"LBL_AGENT_WORKBENCH_NUMBER"
                             	        }
                          	    ]
                       	            },
                       	            {
                          	    "name":"Priority/Status",
                          	    "label":"LBL_LIST_PRIORITY/LBL_STATUS",
                          	    "subfields":[
                             	        {
                                	            "default":true,
                                	            "enabled":true,
                                	            "name":"priority",
                                	            "label":"LBL_LIST_PRIORITY",
                                	            "type":"enum"
                             	        },
                             	        {
                                	            "default":true,
                                	            "enabled":true,
                                	            "name":"status",
                                	            "label":"LBL_STATUS",
                                	            "type":"case-status",
                                	            "widget_name":"widget_status"
                             	        }
                          	    ]
                       	            },
                       	            {
                          	    "name":"Subject/Service Level",
                          	    "label":"LBL_LIST_SUBJECT/LBL_SERVICE_LEVEL",
                          	    "subfields":[
                             	        {
                                	            "default":true,
                                	            "enabled":true,
                                	            "name":"name",
                                	            "label":"LBL_LIST_SUBJECT",
                                	            "link":false
                             	        },
                             	        {
                                	            "default":true,
                                	            "enabled":true,
                                	            "name":"service_level",
                                	            "label":"LBL_SERVICE_LEVEL",
                                	            "type":"enum",
                                	            "enum_module":"Accounts",
                                	            "link":false
                             	        }
                          	    ]
                       	            }
                    	    ]
                       }
                    ],
                    "collectionOptions":{
                 	"limit":100,
                 	"params":{
                    	    "max_num":100,
                    	    "order_by":"follow_up_datetime",
                    	    "nulls_last":true
                 	}
                    },
                    "filterDef":[
                 	{
                    	    "status":{
                       	        "$not_in":[
                          	"Closed",
                          	"Rejected",
                          	"Duplicate"
                       	        ]
                    	    },
                    	    "$owner":""
                 	}
                    ]
           	      }
        	   }
     	}
      }
   }
}

Response Arguments

Response

  {
   "is_setup":1,
   "enabled_modules":{
  	"c108bb4a-775a-11e9-b570-f218983a1c3e":[
     	"Cases"
  	],
  	"da438c86-df5e-11e9-9801-3c15c2c53980":[
     	"Accounts",
     	"Opportunities"
  	]
   },
   "order_by_primary":{
  	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
     	"Cases":"follow_up_datetime:asc"
  	},
  	"da438c86-df5e-11e9-9801-3c15c2c53980":{
     	"Accounts":"next_renewal_date:asc",
     	"Opportunities":"date_closed:asc"
  	}
   },
   "order_by_secondary":{
  	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
     	"Cases":""
  	},
  	"da438c86-df5e-11e9-9801-3c15c2c53980":{
     	"Accounts":"",
     	"Opportunities":""
  	}
   },
   "filter_def":{
  	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
     	"Cases":[
        	{
           	"status":{
              	"$not_in":[
                 	"Closed",
                 	"Rejected",
                 	"Duplicate"
              	]
           	}
        	},
        	{
           	"$owner":""
        	}
     	]
  	},
  	"da438c86-df5e-11e9-9801-3c15c2c53980":{
     	"Accounts":[
        	{
           	"$owner":""
        	}
     	],
     	"Opportunities":[
        	{
           	"sales_status":{
              	"$not_in":[
                 	"Closed Won",
                 	"Closed Lost"
              	]
           	}
        	},
        	{
           	"$owner":""
        	}
     	]
  	}
   },
   "defaults":{
  	"is_setup":0,
  	"enabled_modules":{
     	"c108bb4a-775a-11e9-b570-f218983a1c3e":[
        	"Cases"
     	],
     	"da438c86-df5e-11e9-9801-3c15c2c53980":[
        	"Accounts",
        	"Opportunities"
     	]
  	},
  	"order_by_primary":{
     	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
        	"Cases":"follow_up_datetime:asc"
     	},
     	"da438c86-df5e-11e9-9801-3c15c2c53980":{
        	"Accounts":"next_renewal_date:asc",
        	"Opportunities":"date_closed:asc"
     	}
  	},
  	"order_by_secondary":{
     	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
        	"Cases":""
     	},
     	"da438c86-df5e-11e9-9801-3c15c2c53980":{
        	"Accounts":"",
        	"Opportunities":""
     	}
  	},
  	"filter_def":{
     	"c108bb4a-775a-11e9-b570-f218983a1c3e":{
        	"Cases":[
           	{
              	"status":{
                 	"$not_in":[
                    	"Closed",
                    	"Rejected",
                    	"Duplicate"
                 	]
              	}
           	},
           	{
              	"$owner":""
           	}
        	]
     	},
     	"da438c86-df5e-11e9-9801-3c15c2c53980":{
        	"Accounts":[
           	{
              	"$owner":""
           	}
        	],
        	"Opportunities":[
           	{
              	"sales_status":{
                 	"$not_in":[
                    	"Closed Won",
                    	"Closed Lost"
                 	]
              	}
           	},
           	{
              	"$owner":""
           	}
        	]
     	}
  	}
   }
}

Response Codes and Error Messages

This API does not return new errors other than the ones that may be returned by its parent API - ConfigModule API. The following error responses are possible:

• 403 (SugarAPIExceptionNotAuthorized) : Sent if the user attempts to access a module that they are forbidden to access.

Change Log