Přejmenovat atribut

POST

attributes

{key}

rename

Rename an Attribute key and dependent data

curl --request POST \
  --url https://app.productlasso.com/api/v1/attributes/{key}/rename \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_key": "material_name"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({new_key: 'material_name'})
};

fetch('https://app.productlasso.com/api/v1/attributes/{key}/rename', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.productlasso.com/api/v1/attributes/{key}/rename"

payload = { "new_key": "material_name" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "partial": false,
  "old_key": "<string>",
  "new_key": "<string>",
  "updated_count": 1,
  "error_count": 0,
  "attribute": {
    "id": "11111111-1111-4111-8111-111111111111",
    "key": "product_name",
    "label": "Product name",
    "type": "text",
    "format_output_type": null,
    "enum_values": null,
    "tags_values": null,
    "allow_custom_values": true,
    "boolean_config": null,
    "number_config": null,
    "relation_config": null,
    "description": "Public product title",
    "validation": null,
    "language": "en",
    "image_config": null,
    "status": "active",
    "archived_at": null,
    "is_reviewed": true,
    "source_id": null,
    "external_id": null,
    "source_synced_at": null,
    "created_at": "2026-07-01T00:00:00.000Z",
    "updated_at": "2026-07-14T10:00:00.000Z"
  },
  "results": {}
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

Atomické chování

Handler nejprve vyhodnotí dotčené zdroje a potom provede změnu klíče a podporované závislé migrace v jedné databázové operaci.

200 znamená, že atomické přejmenování proběhlo. Úspěšné části results mají code: "ok", error_count: 0 a prázdné pole errors.
409 znamená, že se neprovedla žádná částečná migrace. Detailní kódy zahrnují konflikt klíče, rename_busy, blokující závislosti a stale_preview.
Při opakování požadavku s nejistým výsledkem předejte attribute_id. Handler tak najde stejný Attribute i po změně klíče.
Většina klientů má expected_impact_revision vynechat. Zastaralá hodnota vrátí 409 stale_preview.

Autorizace

Authorization

string

header

povinné

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parametry cesty

key

string

povinné

Existing canonical Attribute key.

Tělo

application/json

new_key

string

povinné

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_/]*$

attribute_id

string<uuid>

Stable Attribute ID for retrying an uncertain rename outcome after the key may have changed.

expected_impact_revision

string

Optional optimistic-concurrency token. Most API clients should omit it; an outdated value returns 409 stale_preview.

Odpověď

Atomic rename and all dependent migrations completed

success

boolean

povinné

partial

boolean

povinné

old_key

string

povinné

new_key

string

povinné

updated_count

integer

povinné

Požadovaný rozsah: x >= 0

error_count

integer

povinné

attribute

object

povinné

Show child attributes

Příklad:

{
  "id": "11111111-1111-4111-8111-111111111111",
  "key": "product_name",
  "label": "Product name",
  "type": "text",
  "format_output_type": null,
  "enum_values": null,
  "tags_values": null,
  "allow_custom_values": true,
  "boolean_config": null,
  "number_config": null,
  "relation_config": null,
  "description": "Public product title",
  "validation": null,
  "language": "en",
  "image_config": null,
  "status": "active",
  "archived_at": null,
  "is_reviewed": true,
  "source_id": null,
  "external_id": null,
  "source_synced_at": null,
  "created_at": "2026-07-01T00:00:00.000Z",
  "updated_at": "2026-07-14T10:00:00.000Z"
}

results

object

povinné

Show child attributes

Rename an Attribute key and dependent data

curl --request POST \
  --url https://app.productlasso.com/api/v1/attributes/{key}/rename \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_key": "material_name"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({new_key: 'material_name'})
};

fetch('https://app.productlasso.com/api/v1/attributes/{key}/rename', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.productlasso.com/api/v1/attributes/{key}/rename"

payload = { "new_key": "material_name" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "partial": false,
  "old_key": "<string>",
  "new_key": "<string>",
  "updated_count": 1,
  "error_count": 0,
  "attribute": {
    "id": "11111111-1111-4111-8111-111111111111",
    "key": "product_name",
    "label": "Product name",
    "type": "text",
    "format_output_type": null,
    "enum_values": null,
    "tags_values": null,
    "allow_custom_values": true,
    "boolean_config": null,
    "number_config": null,
    "relation_config": null,
    "description": "Public product title",
    "validation": null,
    "language": "en",
    "image_config": null,
    "status": "active",
    "archived_at": null,
    "is_reviewed": true,
    "source_id": null,
    "external_id": null,
    "source_synced_at": null,
    "created_at": "2026-07-01T00:00:00.000Z",
    "updated_at": "2026-07-14T10:00:00.000Z"
  },
  "results": {}
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

Přehled

Vyhledávání

Obohacení dat

Tabulky

Řádky

Obohacení

Schémata

Atributy

Soubory

Slovník

Kredity

Produktová analytika

Katalog

Webhooky katalogu

Přejmenovat atribut

Atomické chování

Autorizace

Parametry cesty

Tělo

Odpověď

​Atomické chování

Autorizace

Parametry cesty

Tělo

Odpověď

Atomické chování