Tömeges műveletek

Az entitásokon lehet tömeges műveleteket végrehajtani, ezekkel egyszerűsíteni lehet a klienst, és kevesebb API hívással megvalósítani bizonyos műveleteket.

Kommunikáció

Minden tömeges művelet egy azonosító listát vár a Request Body-ban. A rendszer minden elemere külön-külöün elvégzi a műveletet, és válaszként az adott művelet eredményét adja vissza elemenként egy listában.

Emiatt előfordulhat, hogy egyszerre van sikeres, és sikertelen módosítás eredmény is a listában, például, ha a felhasználónak nincs joga egy vagy több bejegyzést módosítania. Ebben az esetben azok a bejegyzések módosítva lesznek, amikre sikeres eremdényt adott az API, a többi az eredeti állapotában marad, azaz részleges módosítás is történhet.

Bár a rendszer nem korlátozza az egyszerre beküldhető azonosítók számát, érdemes egyszerrem maximum 20-25 elemet módosítani, és ha ettől többet kell, akkor azt külön tömeges API hívásokra szétvágni.

PATCH /projects/PROJECTID/tomeges-muvelet-url

{
  "ids": [
    "id_111111",
    "id_222222",
    "id_333333"
  ]
}

A válasz:

[
  ResultStructure #1,
  ResultStructure #2,
  ResultStructure #3
]

ahol a ResultStructure a művelet által visszaadott struktúra.

Operations

PATCH /projects/PROJECTID/ENTITY/batch/operation/OPERATION

{
  "ids": []
}

Minden operation típusú módosítás elérhető tömeges műveletként:

• lock
• unlock
• activate
• archive
• trash
• recalculateUsageCount