sale.propertyvalue.getfields
Получить доступные поля значения свойства
Описание
Метод sale.propertyvalue.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.propertyvalue.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.propertyvalue.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 FieldDescription = {
isImmutable: boolean
isReadOnly: boolean
isRequired: boolean
type: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type PropertyValueGetFieldsResult = {
propertyValue: Record<string, FieldDescription>
}
try {
const response = await $b24.actions.v2.call.make<PropertyValueGetFieldsResult>({
method: 'sale.propertyvalue.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('Property value fields:', Object.keys(result.propertyValue))
}
} 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 getPropertyValueFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.propertyvalue.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('Property value fields:', Object.keys(result.propertyValue))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getPropertyValueFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.propertyvalue.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.propertyvalue.getFields',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting sale property fields: ' . $e->getMessage();
}
BX24.callMethod(
"sale.propertyvalue.getFields", {},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.propertyvalue.getFields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.propertyvalue.getFields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.propertyvalue.getFields: %w", err)
}
// Метод заворачивает ответ в объект с ключом "propertyValue".
raw, ok := b24.Unwrap(res.Result, "propertyValue")
if !ok {
return fmt.Errorf("в ответе нет ключа propertyValue")
}
fmt.Printf("%s\n", raw)
Ответ
HTTP-статус: 200
{
"result":{
"propertyValue":{
"code":{
"isImmutable":false,
"isReadOnly":false,
"isRequired":false,
"type":"string"
},
"id":{
"isImmutable":true,
"isReadOnly":true,
"isRequired":false,
"type":"integer"
},
"name":{
"isImmutable":false,
"isReadOnly":false,
"isRequired":false,
"type":"string"
},
"orderId":{
"isImmutable":true,
"isReadOnly":false,
"isRequired":true,
"type":"integer"
},
"orderPropsId":{
"isImmutable":false,
"isReadOnly":false,
"isRequired":true,
"type":"integer"
},
"orderPropsXmlId":{
"isImmutable":false,
"isReadOnly":true,
"isRequired":false,
"type":"string"
},
"value":{
"isImmutable":false,
"isReadOnly":false,
"isRequired":true,
"type":"any"
}
}
},
"time":{
"start":1712057516.862786,
"finish":1712057517.152171,
"duration":0.2893848419189453,
"processing":0.0048639774322509766,
"date_start":"2024-04-02T14:31:56+03:00",
"date_finish":"2024-04-02T14:31:57+03:00"
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
propertyValue
object
Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field — идентификатор поля объекта sale_order_property_value, а value — объект типа rest_field_description
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
| Код | Описание | Значение |
|---|---|---|
200040300020 |
Недостаточно прав для чтения доступных полей значений свойств | |
0 |
Другие ошибки (например, фатальные ошибки) |

