API hívások standard entitásokon

Minden standard entitás esetén a következő API hívások lehetségesek:

(ahol ENTITY az adott entitás neve többes számban, lowerCamelCase formában, pl Script esetén scripts)

Search

GET /projects/PROJECTID/ENTITY

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles
• operations

A data mező ilyenkor mindig egy entitás lista, amiben partially loaded entitások szerepelnek.

View

GET /projects/PROJECTID/ENTITY/ENTITYID

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor egy fully loaded entitás, feltéve, hogy létezik, és a user-nak van joga látni.

Ha nem létezik, akkor unaccessible error, ha nincs joga hozzá, akkor pedig missingRole error van.

Add

POST /projects/PROJECTID/ENTITY

Egy, az entitást leíró objektumot kell a request body-ban küldeni.

Ennek az adatmodellje azonos a View művelet által visszaadott érték data.entity mező adatmodelljével.

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor egy fully loaded entitás, feltéve, hogy a user-nak van joga létrehozni és látni.

Ha nincs joga hozzá, akkor missingRole error van.

Modify

PATCH /projects/PROJECTID/ENTITY/ENTITYID

Egy, az entitást leíró objektumot kell a request body-ban küldeni.

Ennek az adatmodellje azonos a View művelet által visszaadott érték data.entity mező adatmodelljével.

Amennyiben a beküldött adatban egy konkrét mező nem szerepel, azt a mezőt nem módosítja a rendszer.

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor egy fully loaded entitás, feltéve, hogy létezik, és a user-nak van joga szerkeszteni.

Ha nem létezik, akkor unaccessible error, ha nincs joga hozzá, akkor pedig missingRole error van.

Ha egy olyan mezőt küld be a felhasználó, amit nem tud szerkeszteni, az adott mezőre warning jön vissza, és a megfelelő missingRole, azonban emiatt még a többi mező módosulása megtörténik.

Operation

PATCH /projects/PROJECTID/ENTITY/ENTITYID/operation/OPERATION

Nincs request body, az OPERATION a következő lehet:

• lock
  • zárolja a bejegyzést, hogy ne lehessen véletlenül szerkeszteni
• unlock
  • megnyitja a bejegyzést, hogy lehessen szerkeszteni
• activate
  • újra aktív státuszba rakja a bejegyzést, ha archiválva vna, bvagy a kukába rakva
• archive
  • archiválja a bejegyzést
• trash
  • a kukába rakja a bejegyzést
• recalculateUsageCount
  • újra számolja, hogy hány tartalomban van felhasználva az aktuális bejegyzés

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor egy fully loaded entitás, feltéve, hogy létezik, és a user-nak van joga az adott művelethez.

Ha nem létezik, akkor unaccessible error, ha nincs joga hozzá, akkor missingRole error, ha pedig nem létező művelet lett megadva, akkor missingOperation error van.

ChangeLogSearch

GET /projects/PROJECTID/ENTITY/ENTITYID/changeLogs

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor mindig egy entitás lista, amiben partially loaded entitások szerepelnek, feltéve, hogy van joga a changelog-okat látni.

ChangeLogView

GET /projects/PROJECTID/ENTITY/ENTITYID/changeLogs/CHANGELOGID

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor mindig egy fully loaded entitás, feltéve, hogy van joga a changelog-okat látni.

MilestoneSearch

GET /projects/PROJECTID/ENTITY/ENTITYID/milestones

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor mindig egy entitás lista, amiben partially loaded entitások szerepelnek, feltéve, hogy van joga a mérföldköveket látni.

MilestoneView

GET /projects/PROJECTID/ENTITY/ENTITYID/milestones/MILESTONEID

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor mindig egy fully loaded entitás, feltéve, hogy van joga a mérföldköveket látni.

MilestoneAdd

POST /projects/PROJECTID/ENTITY/ENTITYID/milestones

{
   "name": "asdf"
}

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor mindig egy fully loaded entitás, feltéve, hogy van joga mérföldkövet létrehozni.

MilestoneModify

PATCH /projects/PROJECTID/ENTITY/ENTITYID/milestones/MILESTONEID

{
   "name": "asdf"
}

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor mindig egy fully loaded entitás, feltéve, hogy van joga mérföldkövet létrehozni.

Restore

PATCH /projects/PROJECTID/ENTITY/ENTITYID/milestones/MILESTONEID/restore

Nincs request body.

A visszaadott válasz következő mezőket tartalmazza:

• result
• type
• data
• errors
• missingRoles

A data mező ilyenkor mindig egy fully loaded entitás, feltéve, hogy van joga visszaállni egy mérföldkőre.