Megosztás:

Blackbaud FENXT-lekérdezés (előzetes verzió)

A Blackbaud Financial Edge NXT egy átfogó felhőalapú könyvelési szoftvermegoldás, amely kifejezetten nonprofit szervezetek számára készült. Lekérdezések kezelése és végrehajtása a Lekérdezés összekötő használatával.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service Class Régiók
Copilot Studio prémium Az összes Power Automate-régió, kivéve a következőket:
     - USA kormánya (GCC)
     - Amerikai kormány (GCC High)
     - A 21Vianet által üzemeltetett China Cloud
     - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások Standard Az összes Logic Apps-régió , kivéve a következőket:
     - Azure Government-régiók
     - Azure China-régiók
     - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások prémium Az összes Power Apps-régió , kivéve a következőket:
     - USA kormánya (GCC)
     - Amerikai kormány (GCC High)
     - A 21Vianet által üzemeltetett China Cloud
     - Amerikai Védelmi Minisztérium (DoD)
Power Automate prémium Az összes Power Automate-régió, kivéve a következőket:
     - USA kormánya (GCC)
     - Amerikai kormány (GCC High)
     - A 21Vianet által üzemeltetett China Cloud
     - Amerikai Védelmi Minisztérium (DoD)
Érintkezés
Név Blackbaud-támogatás
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Összekötő metaadatai
Kiadó Blackbaud. Inc
Webhely https://www.blackbaud.com/products/blackbaud-financial-edge-nxt
Adatvédelmi irányelvek https://www.blackbaud.com/privacy-shield
Kategóriák Értékesítés és CRM; Termelékenység

A Financial Edge NXT egy teljes körű felhőalapú könyvelési megoldás, amelyet kifejezetten a nonprofit szervezetek és kormányzati szervezetek egyedi igényeinek kielégítésére terveztek.

Ez az összekötő a Blackbaud SKY API-jára épül, és műveleteket biztosít a Financial Edge NXT-ben található lekérdezések és kapcsolódó entitások kezeléséhez.

További információkért tekintse meg a dokumentációt.

Előfeltételek

Az összekötő használatához rendelkeznie kell egy Blackbaud-azonosító fiókkal, amely hozzáféréssel rendelkezik egy vagy több Blackbaud-környezethez.

Emellett a Blackbaud Marketplace-ről származó Microsoft Power Platform-alkalmazásnak csatlakoznia kell a környezethez. Ezekről az előfeltételekről további információt a kezdeti telepítési dokumentációban talál.

Hogyan szerezhet be hitelesítő adatokat?

A szervezet rendszergazdája meghívót küld a szervezet Financial Edge NXT-környezetére, és konfigurálja a felhasználói fiók engedélyeit a környezetben. Az összekötő használatához nincs szükség további hitelesítő adatokra.

Ismert problémák és korlátozások

Az összekötő a felhasználói fiók kontextusában fog működni, ezért a környezeten belüli felhasználói engedélyekre lesz szükség.

Szabályozási korlátok

Name Hívások Megújítási időszak
API-hívások kapcsolatonként 100 60 másodperc

Műveletek

Alkalmi lekérdezési feladat indítása

Elindít egy háttérfeladatot a megadott alkalmi lekérdezésdefiníció végrehajtásához.
Lekérdezések listázása

A lekérdezések listáját adja vissza.
Lekérdezési feladat indítása

Elindít egy háttérfeladatot a megadott lekérdezés végrehajtásához.
Lekérdezési feladat állapotának lekérése

Egy háttérbeli lekérdezés-végrehajtási feladat adatait adja vissza.
Statikus lekérdezési feladat frissítésének indítása

Elindít egy háttérfeladatot a megadott statikus lekérdezés mentett kulcsainak frissítéséhez.

Alkalmi lekérdezési feladat indítása

Műveletazonosító:
StartAdHocQueryExecutionJob

Elindít egy háttérfeladatot a megadott alkalmi lekérdezésdefiníció végrehajtásához.

Paraméterek

Name Kulcs Kötelező Típus Description
Modul
 module True string

A kérelem pénzügyi peremhálózati NXT modulja.
Lekérdezésdefiníció
 query True object

A lekérdezésdefiníció JSON-ábrázolása.
Kimeneti formátum
 output_format string

A lekérdezés eredményfájljának kimeneti formátumát jelzi.
Formázási mód
 formatting_mode string

Azt jelzi, hogy a formázást alkalmazni kell-e a lekérdezés eredményeire.
Filename
 results_file_name string

A letöltendő fájl neve a fájlkiterjesztés nélkül.

Válaszok

Elindított lekérdezési feladat

Törzs
QueryApi.ExecuteQueryResponse

Lekérdezések listázása

Műveletazonosító:
ListQueries

A lekérdezések listáját adja vissza.

Paraméterek

Name Kulcs Kötelező Típus Description
Modul
 module True string

A kérelem pénzügyi peremhálózati NXT modulja.
Típus
 query_type_id integer

A lekérdezések halmazának szűrése egy adott lekérdezéstípussal rendelkezőkre.
Kategória
 category integer

A lekérdezések halmazának szűrése egy adott kategóriával rendelkezőkre.
Formátum
 query_format string

Szűrje a lekérdezések készletét egy adott formátumúra.
Szöveg keresése
 search_text string

A névmező keresési szövege az eredmények szűréséhez.
Csak a kedvencek?
 my_fav_queries_only boolean

Csak a kedvenc lekérdezéseket tartalmazza?
Csak a lekérdezések?
 my_queries_only boolean

Csak az általam létrehozott lekérdezéseket tartalmazza?
Csak egyesített lekérdezések?
 merged_queries_only boolean

Csak egyesített lekérdezéseket tartalmaz?
Oszlop rendezése
 sort_column string

Rendezze az eredményeket a megadott oszlop szerint.
Hozzáadás be- vagy után
 date_added date-time

Szűrje az eredményeket a megadott dátumon vagy után létrehozott lekérdezésekre (pl. "2020-09-18T04:13:56Z").
Azonosító alapján hozzáadva
 added_by string

Szűrje az eredményeket a megadott felhasználói azonosító által hozzáadott lekérdezésekre.
Csökkenő rendezés?
 sort_descending boolean

Csökkenő sorrendbe rendezi az eredményeket?
Limit
 limit integer

A visszaadni kívánt rekordok számát jelöli. Az alapértelmezett érték 50. A maximális érték 200.
Kiegyenlít
 offset integer

A kihagyandó rekordok számát jelöli. Lapozáshoz.

Válaszok

Lekérdezések

Törzs
QueryApi.QuerySummaryCollection

Lekérdezési feladat indítása

Műveletazonosító:
StartQueryExecutionJob

Elindít egy háttérfeladatot a megadott lekérdezés végrehajtásához.

Paraméterek

Name Kulcs Kötelező Típus Description
Modul
 module True string

A kérelem pénzügyi peremhálózati NXT modulja.
Típus
 v_query_type_id True integer

A lekérdezések halmazának szűrése egy adott lekérdezéstípussal rendelkezőkre.
Query
 id True integer

A végrehajtandó lekérdezés.
Kimeneti formátum
 output_format string

A lekérdezés eredményfájljának kimeneti formátumát jelzi.
Formázási mód
 formatting_mode string

Azt jelzi, hogy a formázást alkalmazni kell-e a lekérdezés eredményeire.
SQL-létrehozási mód
 sql_generation_mode string

Azt jelzi, hogyan kell kezelni a lekérdezésválasztó mezőket. Ha a "Lekérdezés" ki van jelölve, a kimenet tartalmazza a lekérdezéshez definiált mezőket és a QRECID-et. Ha az "Exportálás" lehetőség van kiválasztva, a kimenet tartalmazza a CSAK lekérdezéshez definiált mezőket. A "Jelentés" kiválasztásakor a kimenet csak a QRECID-et tartalmazza.
Statikus lekérdezést használ?
 use_static_query_id_set boolean

Használja a statikus lekérdezést rekordok forrásaként (ha nem, akkor a lekérdezés dinamikusan lesz végrehajtva)?
Filename
 results_file_name string

A letöltendő fájl neve a fájlkiterjesztés nélkül.

Válaszok

Elindított lekérdezési feladat

Törzs
QueryApi.ExecuteQueryResponse

Lekérdezési feladat állapotának lekérése

Műveletazonosító:
GetQueryJobStatus

Egy háttérbeli lekérdezés-végrehajtási feladat adatait adja vissza.

Paraméterek

Name Kulcs Kötelező Típus Description
Modul
 module True string

A kérelem pénzügyi peremhálózati NXT modulja.
Feladat azonosítója
 job_id True string

A lekérdezés-végrehajtási feladat rendszerrekord-azonosítója.
Tartalmazza a találatOK URL-címét?
 include_read_url string

Belefoglalja a lekérdezés eredményfájljának URL-címét?
Tartalomeloszlás
 content_disposition string

A lekérdezés eredményeinek megtekintését jelzi.

Válaszok

Lekérdezés-végrehajtási feladat

Törzs
QueryApi.QueryExecutionJob

Statikus lekérdezési feladat frissítésének indítása

Műveletazonosító:
StartRefreshStaticQueryExecutionJob

Elindít egy háttérfeladatot a megadott statikus lekérdezés mentett kulcsainak frissítéséhez.

Paraméterek

Name Kulcs Kötelező Típus Description
Modul
 module True string

A kérelem pénzügyi peremhálózati NXT modulja.
Típus
 v_query_type_id True integer

A lekérdezések halmazának szűrése egy adott lekérdezéstípussal rendelkezőkre.
Query
 id True integer

A végrehajtandó lekérdezés.

Válaszok

Elindított lekérdezési feladat

Törzs
QueryApi.ExecuteQueryResponse

Definíciók

QueryApi.ExecuteQueryResponse

Elindított lekérdezési feladat

Name Elérési út Típus Description
Feladat azonosítója
 id string

A lekérdezési feladat azonosítója.
Státusz
 status string

Az eredményként kapott lekérdezési feladat állapota. "Függőben" – a feladat várólistára lett állítva, de még nem indult el. "Futtatás" – a feladat fut. "Befejezve" – a feladat sikeresen befejeződött. "Sikertelen" – a feladat meghiúsult. "Lemondás" – a feladat törlését kérték (de továbbra is sikeres lehet). "Megszakítva" – a feladat megszakadt. "Szabályozva" – a feladat szabályozva lett, és akkor fog futni, ha rendelkezésre áll a hely.
Message
 message string

A válaszhoz társított üzenet.

QueryApi.QueryExecutionJob

Lekérdezés-végrehajtási feladat

Name Elérési út Típus Description
Feladat azonosítója
 id string

A lekérdezési feladat azonosítója.
Státusz
 status string

Az eredményként kapott lekérdezési feladat állapota. "Függőben" – a feladat várólistára lett állítva, de még nem indult el. "Futtatás" – a feladat fut. "Befejezve" – a feladat sikeresen befejeződött. "Sikertelen" – a feladat meghiúsult. "Lemondás" – a feladat törlését kérték (de továbbra is sikeres lehet). "Megszakítva" – a feladat megszakadt. "Szabályozva" – a feladat szabályozva lett, és akkor fog futni, ha rendelkezésre áll a hely.
Sorok száma
 row_count integer

A lekérdezés rekordjainak száma.
Lekérdezési eredmények URI-ja
 sas_uri string

A lekérdezési eredmények eléréséhez használt URI. Ezt az URI-t biztonságos hitelesítő adatként kell kezelni a lekérdezési eredmények eléréséhez – az érték bizalmasnak minősül, és az URI 15 perc elteltével lejár.

QueryApi.QuerySummary

Query

Name Elérési út Típus Description
azonosító
 id integer

A lekérdezés rendszerrekord-azonosítója.
Név
 name string

A lekérdezés egyedi neve.
Description
 description string

A lekérdezés leírása.
Típus
 type string

A lekérdezés típusa.
Típusazonosító
 type_id integer

A lekérdezéstípus rendszerrekord-azonosítója.
Kategória
 category string

A lekérdezés kategóriája.
Kategóriaazonosító
 category_id integer

A lekérdezési kategória rendszerrekord-azonosítója.
Formátum
 format string

A lekérdezés formátuma.
Támogatott nézet?
 view_supported boolean

Megtekinthető a lekérdezés?
Támogatott szerkesztés?
 edit_supported boolean

Szerkeszthető a lekérdezés?
Kedvenc?
 favorite boolean

Kedvenc a lekérdezés?
Kérdezi a mezőket?
 has_ask_fields boolean

A lekérdezés tartalmaz szűrőmezőket a lekérdezési operátorral?
Lekérdezéssel hozza létre?
 created_by_query boolean

A lekérdezés a lekérdezési modulban lett létrehozva?
Támogatott végrehajtási módok
 supported_execution_modes string

A támogatott végrehajtási módok.
Módosítható?
 can_modify boolean

Módosíthatja a felhasználó a lekérdezést?
Végrehajtható?
 can_execute boolean

Végrehajthatja a felhasználó a lekérdezést?
Mások módosíthatják?
 others_can_modify boolean

Módosíthatják más felhasználók a lekérdezést?
Mások is végrehajthatják?
 others_can_execute boolean

Más felhasználók is végrehajthatják a lekérdezést?
Letiltja az ismétlődéseket?
 suppress_duplicates boolean

El vannak tiltva az ismétlődések a lekérdezés eredményei között?
Kiválasztás a lekérdezés nevéből
 select_from_query_name string

A lekérdezés alapjául szolgáló lekérdezés neve.
Kiválasztás lekérdezésazonosítóból
 select_from_query_id integer

A lekérdezés alapbeállításaként használt lekérdezés rendszerrekord-azonosítója.
Utolsó futtatás
 date_last_run date-time

A lekérdezés utolsó futtatásának dátuma.
Rekordok száma
 num_records integer

A lekérdezés legutóbbi futtatásakor talált rekordok száma.
Eltelt idő
 elapsed_ms integer

A lekérdezés utolsó futtatásakor eltelt idő (ezredmásodpercben).
Létrehozás dátuma
 date_added date-time

A lekérdezés létrehozásának dátuma.
Készítette:
 added_by string

A lekérdezést létrehozó felhasználó neve.
A dátum módosult
 date_changed date-time

A lekérdezés utolsó módosításának dátuma.
Módosította:
 last_changed_by string

Annak a felhasználónak a neve, aki legutóbb módosította a lekérdezést.

QueryApi.QuerySummaryCollection

Lekérdezések

Name Elérési út Típus Description
queries
 queries array of QueryApi.QuerySummary

A válaszban szereplő elemek készlete.