метод REST
scope: sale
sale.status.getFields
Получить доступные поля статусов
Описание
Метод sale.status.getFields возвращает доступные поля статусов.
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.status.getfields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.status.getfields
// 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
type FieldInfo = {
isImmutable: boolean
isReadOnly: boolean
isRequired: boolean
type: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type StatusFieldsResult = {
status: Record<string, FieldInfo>
}
try {
const response = await $b24.actions.v2.call.make<StatusFieldsResult>({
method: 'sale.status.getfields',
params: {},
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('Status fields:', Object.keys(result.status))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 getStatusFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.status.getfields',
params: {},
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('Status fields:', Object.keys(result.status))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getStatusFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.status.get_fields().response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'sale.status.getfields',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Info: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting sale status fields: ' . $e->getMessage();
}
BX24.callMethod(
"sale.status.getfields", {},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call('sale.status.getfields', []);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.status.getfields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.status.getfields: %w", err)
}
// Метод заворачивает ответ в объект с ключом "status".
raw, ok := b24.Unwrap(res.Result, "status")
if !ok {
return fmt.Errorf("в ответе нет ключа status")
}
fmt.Printf("%s\n", raw)
Ответ
HTTP-статус: 200
{
"result":{
"status":{
"color":{
"isImmutable":false,
"isReadOnly":false,
"isRequired":false,
"type":"string"
},
"id":{
"isImmutable":true,
"isReadOnly":false,
"isRequired":true,
"type":"string"
},
"notify":{
"isImmutable":false,
"isReadOnly":false,
"isRequired":false,
"type":"string"
},
"sort":{
"isImmutable":false,
"isReadOnly":false,
"isRequired":false,
"type":"integer"
},
"type":{
"isImmutable":false,
"isReadOnly":false,
"isRequired":true,
"type":"char"
},
"xmlId":{
"isImmutable":false,
"isReadOnly":false,
"isRequired":false,
"type":"string"
}
}
},
"time":{
"start":1712147353.206979,
"finish":1712147353.46492,
"duration":0.25794100761413574,
"processing":0.005347013473510742,
"date_start":"2024-04-03T15:29:13+03:00",
"date_finish":"2024-04-03T15:29:13+03:00"
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
status
object
Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field — идентификатор поля объекта sale_status, а value — объект типа rest_field_description
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
| Код | Описание | Значение |
|---|---|---|
200040300010 |
Недостаточно прав для чтения доступных полей статусов | |
0 |
Другие ошибки (например, фатальные ошибки) |

