Efecte Query Language ( EQL ) används för att fråga data från Efecte. Webb- API kan användas för att integrera Efecte med andra system och det här dokumentet syftar till att ge exempel på webb- API -tjänster.

Efecte Query Language

Efecte Query Language ( EQL ) är ett SQL -liknande strukturerat språk för att fråga Efecte via webb API . Det möjliggör kraftfulla och flexibla sökningar mot Efectes datamodell.

För att kunna använda EQL effektivt behöver man känna till några grundläggande begrepp om den underliggande datamodellen. De element i datamodellen som oftast används med EQL är " entity ", " entitydata ", " template " och " folder ".

Nedan följer enkla exempel som illustrerar användningen av EQL . Tabellerna ger referensinformation om de viktigaste klasserna och egenskaperna i Efecte-datamodellen.

Sökbara klasser:

Pro för klassentiteten (com.efecte.datamodel.Entity):

Pro hos klassmallen

Pro för klassmall (com.efecte.datamodel.Template):

Pro för klassmappen

Pro för klassen Folder (com.efecte.datamodel.Folder):

Datummakron och tidsuttryck

EQL frågor tillåter användning av datummakron och tidsuttryck med datummakron. Dessa två kan kombineras som nu+6h eller start_månad-1M.

Datummakron:

Tidsuttryck:

EQL exempel

Få räkning på alla datakort i hela Efecte-systemet

Räkna alla datakort i hela Efecte-systemet. Detta är ett bra sätt att testa att webb- API fungerar korrekt.

SELECT count(id) FROM entity

Sök specifika data från ett datakort

Sök efter datakortets namn, mallens namn och mappens namn för enheter som har ett specifikt värdnamn och finns i mallen "arbetsstation".

SELECT name, template.name, folder.name FROM entity WHERE $host_name$= 'falco' AND template.code = 'workstation'

Sök alla datakort för en enskild modul

Sök efter alla datakort för en enskild modul:

SELECT entity FROM entity WHERE template.systemCode = 'beq'

eller använda delfråga

SELECT entity FROM entity WHERE templateId IN (SELECT id FROM template WHERE systemCode = 'beq')

eller använda exists-frågan:

SELECT entity FROM entity WHERE EXISTS (SELECT id FROM template WHERE id = entity.templateId AND template.systemCode = 'beq')

Sök efter alla incidentdatakort som inte finns i Borttagna eller Dolda

Sök bland alla datakort som inte är dolda eller raderade:

SELECT entity FROM entity WHERE template.code='incident' AND entity.deleted=0 AND entity.hidden=0

Sök datakort och välj givna attribut i mappen

Välj givna attribut för datakort i mallen. Returnerar attributen efecte_id, subject och status:

SELECT $efecte_id$, $subject$, $status$ FROM entity WHERE entity.template.code = 'incident'

Sök datakort som har skapats mellan datum

Det är möjligt att använda datummakron i EQL . Nedan är ett exempel som hämtar alla incidenter som har skapats mellan två månader sedan och aktuellt datum och tid (nu):

SELECT entity FROM entity WHERE template.code='incident' AND $created$>'start_month-2M' AND $created$<'NOW'

Sök efter distinkta datakort

Hitta distinkta datakort

SELECT DISTINCT entity.referenceData.target FROM entity WHERE template.code = 'invoice_row'

Sök datakort med hjälp av referensvärde

Hitta arbetsstation som ägs av användaren med fullständigt namn

SELECT entity FROM entity WHERE template.code='workstation' AND $user:full_name$='user test'