Documentation

crm.deal.details.configuration.get

The method gets configuration for deal details. Reads personal configuration for specified user details or general configuration for all users.

Note that configuration for deal details within different pipelines (or funnels) can vary. The dealCategoryId parameter is used to switch between deal details configurations for different pipelines.

Parameters

.
Parameter Description Available from version
scope Configuration scope of application. Available values:
  • P - personal configuration,
  • C - general configuration
userId User ID. Indicates current ID if not set. Only required when getting personal configuration.
extras Extra parameters. dealCategoryId parameter for deals can be specified here.

Example

//--
//Get personal configuration for deal details for user with identifier 1 within general pipeline.
BX24.callMethod(
    "crm.deal.details.configuration.get",
    {
        scope: "P",
        userId: 1
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
//Get general configuration for deal details within general pipeline.
BX24.callMethod(
    "crm.deal.details.configuration.get",
    {
        scope: "C"
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
//Get general configuration for deal details within pipeline with identifier 1.
BX24.callMethod(
    "crm.deal.details.configuration.get",
    {
        scope: "C",
        extras: { dealCategoryId: 1 }
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
//--


User Comments

User comments are not part of official documentation. Use information provided by other users in the comments at your own risk.

The User Comments section is not to be used as a feature discussion board. Only registered users can post comments. Your comment will be visible once it has been approved by the moderator.
© «Bitrix Inc.», 2001-2019, «Bitrix Inc.», 2019