Настроить раскладку полей документа контент-завода

Сохраняет порядок и набор полей на бланке. Нужен, чтобы человек заполнял важное, а не продирался через лишнее.

Scope

content_factory:write

Заголовки

Content-Type: application/json
X-Api-Key — ключ проекта
Idempotency-Key — для повторного запроса с тем же результатом

Настроить раскладку полей документа контент-завода

POST /v1/document-field-layouts/upsert. Scope content_factory:write.

Учебный пример магазина «Северная полка». Это не запись из вашей базы. Здесь раскладка документа: запрос и ответ на одном вызове.

Запрос

{
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "fields": [
      {
        "key": "occasion",
        "label": "Повод",
        "order": 1
      }
    ]
  }
}

Ответ (успех, 200)

{
  "success": true,
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "fields": [
      {
        "key": "occasion",
        "label": "Повод",
        "order": 1
      }
    ]
  }
}

Пример cURL

curl -X POST "https://api-external.brifly.online/v1/document-field-layouts/upsert" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: {{api_key}}" \
  -d '{"data": {"projectId": "11111111-1111-4111-8111-111111111111", "fields": [{"key": "occasion", "label": "Повод", "order": 1}]}}'

Ошибки

401 INVALID_API_KEY — нет ключа или ключ отозван.
403 FORBIDDEN_SCOPE — у ключа нет content_factory:write.
403 PROJECT_MISMATCH — в теле другой проект.
429 RATE_LIMIT_EXCEEDED — заголовок Retry-After.
400 VALIDATION_ERROR — не хватает поля в data.

Ограничения

Проект и пользователь берутся из ключа. Чужой data.projectId отвечает 403 PROJECT_MISMATCH.

Scope

Заголовки

Настроить раскладку полей документа контент-завода

Запрос

Ответ (успех, 200)

Пример cURL

Ошибки

Ограничения

См. также