Skip to content

placement-list.md

Latest commit

 

History

History
336 lines (272 loc) · 9.61 KB

placement-list.md

File metadata and controls

336 lines (272 loc) · 9.61 KB
Raw

Get Placements Available to the Application placement.list

{% note tip "" %}

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

{% endnote %}

Scope: placement

Who can execute the method: a user authorized in the application

The method placement.list returns the placements available to the application.

{% note info "" %}

The method works only in the context of the application.

{% endnote %}

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || SCOPE string | Limits the list to a specific application scope.

If the parameter is provided and not empty, the method returns placements only for the specified scope. || || FULL boolean | Flag to retrieve the full list of placements.

If the parameter is not provided or is set to false, the method returns placements for the current application's scope and global placements.

If the parameter is set to true, the method returns placements for all service scopes.

The parameter is considered only if SCOPE is not provided. || |#

Code Examples

{% include Examples Note %}

Example of retrieving the placements available to the application, where:

  • SCOPE — the application's scope for which placements are needed.

{% list tabs %}

  • cURL (OAuth)

    curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "SCOPE": "crm",
    "auth": "**put_access_token_here**"
  }' \
  "https://**put.your-domain-here**/rest/placement.list.json"

  • JS (TS)

    // This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  // placement.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<string[]>({
    method: 'placement.list',
    params: {
      SCOPE: 'crm',
      start: 0,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Placement codes:', result, 'Count:', result.length)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

  • JS (UMD)

    <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getPlacementList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // placement.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'placement.list',
        params: {
          SCOPE: 'crm',
          start: 0,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Placement codes:', result, 'Count:', result.length)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getPlacementList)
</script>

  • Python

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.placement.list(
        scope="crm",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Bitrix API error",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Bitrix SDK error: {error.message}")
except Exception as error:
    print(f"Unexpected error: {error}")

  • PHP

    try {
    $response = $b24Service
        ->core
        ->call(
            'placement.list',
            [
                'SCOPE' => 'crm',
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting placement list: ' . $e->getMessage();
}

  • BX24.js

    BX24.callMethod(
    'placement.list',
    {
        SCOPE: 'crm'
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);

  • PHP CRest

    $result = CRest::call(
    'placement.list',
    [
        'SCOPE' => 'crm',
    ]
);

echo '<pre>';
print_r($result);
echo '</pre>';

  • Go

    // client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "placement.list", b24.Params{
	"SCOPE": "crm",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("placement.list: %w", err)
}

var items []string
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("parse response: %w", err)
}
fmt.Println("received:", len(items))

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": [
        "CRM_DEAL_LIST_TOOLBAR",
        "CRM_LEAD_LIST_TOOLBAR",
        "CRM_CONTACT_LIST_TOOLBAR",
        "CRM_COMPANY_LIST_TOOLBAR",
        "CRM_INVOICE_LIST_TOOLBAR",
        "CRM_QUOTE_LIST_TOOLBAR",
        "CRM_ORDER_LIST_TOOLBAR",
        "CRM_DYNAMIC_136_LIST_TOOLBAR",
        "CRM_DYNAMIC_1038_LIST_TOOLBAR",
        "CRM_SMART_INVOICE_LIST_TOOLBAR",
        "CRM_DEAL_DETAIL_TOOLBAR",
        "CRM_LEAD_DETAIL_TOOLBAR",
        "CRM_CONTACT_DETAIL_TOOLBAR",
        "CRM_COMPANY_DETAIL_TOOLBAR",
        "CRM_INVOICE_DETAIL_TOOLBAR",
        "CRM_QUOTE_DETAIL_TOOLBAR",
        "CRM_DYNAMIC_136_DETAIL_TOOLBAR",
        "CRM_DYNAMIC_1038_DETAIL_TOOLBAR",
        "CRM_SMART_INVOICE_DETAIL_TOOLBAR",
        "CRM_DEAL_ACTIVITY_TIMELINE_MENU",
        "CRM_LEAD_ACTIVITY_TIMELINE_MENU",
        "CRM_QUOTE_ACTIVITY_TIMELINE_MENU"
    ],
    "time": {
        "start": 1712132792.910734,
        "finish": 1712132793.530359,
        "duration": 0.6196250915527344,
        "processing": 0.032338857650756836,
        "date_start": "2024-04-03T10:26:32+02:00",
        "date_finish": "2024-04-03T10:26:33+02:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

Returned Data

#| || Name type | Description || || result string[] | A list of codes of the placements available to the application.

Each element of the array is a placement code. || || time time | Information about the execution time of the request. || |#

Error Handling

HTTP Status: 403

{
    "error": "WRONG_AUTH_TYPE",
    "error_description": "Current authorization type is denied for this method Application context required"
}

{% include notitle error handling %}

Possible Error Codes

#| || Status | Code | Description | Value || || 403 | WRONG_AUTH_TYPE | Current authorization type is denied for this method Application context required | Method call not from application context. || |#

{% include system errors %}

Continue Learning