Ezen az oldalon
> erőforrások > dokumentáció > api > API referencia: szervezetek

API-referencia: szervezetek

warning

A bérlő törlése véglegesen eltávolítja az összes folyamatát, adatkészletét és felhasználói hozzárendelését. A művelet nem vonható vissza. A hitelesítéshez használt bérlő nem törölhető.

warning

Ha eltávolít egy felhasználót a szervezetből, megszűnik a hozzáférése a szervezet összes bérlőjéhez.

A szervezetek egyetlen egységbe fogják össze a több bérlőt.

A bérlő szervezetének lekérése

Bérlőhöz kötött API-kulccsal olvasható, de szervezethez kötött kulcs is használható.

Végpont: GET /v1/tenant/{tenantId}/organization

Hitelesítés: Bérlőhöz vagy szervezethez kötött API-kulcs · read jogosultság

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid

Válasz (200):

Szervezeti adatok

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"contactEmail": "string",
	"isActive": true,
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"createdBy": "00000000-0000-0000-0000-000000000000"
}
Mező Típus Kötelező Leírás
id string Igen Formátum: uuid
displayName string Igen Alapértelmezett: ""
Maximális hossz: 128
createdAt string Igen Formátum: date-time
contactEmail string Igen Formátum: email
isActive boolean Igen Alapértelmezett: true
allowedLogins object Igen
createdBy string Igen Formátum: uuid

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

A szervezet licenckapacitásának és automatikus szinkronizálási szabályának lekérése

Visszaadja a szervezet szintjén megvásárolt és használatban lévő licencek számát szintenként (Process Foundation, Process Architecture, Process Intelligence), az ingyenes Viewer-keretet, az automatikus szinkronizálás célértékét, a licenceltérések magyarázatát (mit és mikor tesz a rendszer), a számlázási időszakot, valamint az externalApiSeatPolicy értékét. Bérlőhöz kötött API-kulccsal olvasható. A {tenantId} útvonalparaméter a kontextusbérlőt jelöli (a szervezethez kötött kulcs szervezetét), nem a művelet célpontját.

Végpont: GET /v1/tenant/{tenantId}/organization/billing/seats

Hitelesítés: Bérlőhöz vagy szervezethez kötött API-kulcs · read jogosultság

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid

Válasz (200):

Licenckapacitás

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"inUseDashboardViewers": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"dashboardViewerAllowance": 0,
	"dashboardViewerOverAllowance": 0,
	"fixedOverage": 0,
	"target": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"drift": [
		{
			"rung": "foundation",
			"paid": 0,
			"actual": 0,
			"state": "equal",
			"buffer": 0
		}
	],
	"interval": "month",
	"nextBilledAt": "string",
	"externalApiSeatPolicy": "autoBill"
}
Mező Típus Kötelező Leírás
contractType free | selfServe | fixed | unlimited Igen Engedélyezett értékek: free, selfServe, fixed, unlimited
isTrial boolean Igen
purchased object Igen
inUseBillable object Igen
inUseFree number Igen
inUseDashboardViewers number Igen
totalBillable number Igen
freeViewerAllowance number Igen
freeViewerOverAllowance number Igen
dashboardViewerAllowance number Igen
dashboardViewerOverAllowance number Igen
fixedOverage number Igen
target object Igen
drift object[] Igen
interval month | year Igen Engedélyezett értékek: month, year
nextBilledAt string Igen
externalApiSeatPolicy autoBill | requireCapacity Igen Engedélyezett értékek: autoBill, requireCapacity

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

A szervezet egészére vonatkozó statisztikák lekérése

A {tenantId} útvonalparaméter a kontextusbérlőt jelöli (a szervezethez kötött kulcs szervezetét), nem a művelet célpontját.

Végpont: GET /v1/tenant/{tenantId}/organization/statistics

Hitelesítés: Szervezethez kötött API-kulcs · read jogosultság

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid

Válasz (200):

Szervezeti statisztikák

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}
Mező Típus Kötelező Leírás
userCount number Igen
tenantCount number Igen
tenantStatistics object[] Igen

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs

A szervezet összes bérlőjének listázása

A {tenantId} útvonalparaméter a kontextusbérlőt jelöli (a szervezethez kötött kulcs szervezetét), nem a művelet célpontját.

Végpont: GET /v1/tenant/{tenantId}/organization/tenants

Hitelesítés: Szervezethez kötött API-kulcs · read jogosultság

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
limit integer lekérdezés Nem A visszaadandó elemek maximális száma
offset integer lekérdezés Nem Kihagyandó elemek száma

Válasz (200):

Bérlők listája

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"createdBy": "00000000-0000-0000-0000-000000000000",
		"createdAt": "2024-03-15T16:30:00Z",
		"displayName": "string",
		"contactEmail": "string",
		"isActive": true,
		"shortName": "string",
		"useOrganizationTheme": true,
		"description": "string",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"allowedLogins": {
			"Microsoft": true,
			"Google": true,
			"LinkedIn": true
		},
		"tenantType": "normal",
		"url": "string"
	}
]

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs

Új bérlő létrehozása a szervezetben (szervezethez kötött API-kulcs szükséges)

A {tenantId} útvonalparaméter a kontextusbérlőt jelöli (a szervezethez kötött kulcs szervezetét), nem a művelet célpontját.

Végpont: POST /v1/tenant/{tenantId}/organization/tenants

Hitelesítés: Szervezethez kötött API-kulcs · write jogosultság

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}
Mező Típus Kötelező Leírás
displayName string Nem Maximális hossz: 128
shortName string Igen
description string Nem Maximális hossz: 200
timezone string Nem Maximális hossz: 64
tenantType normal | sandbox | demo Nem Engedélyezett értékek: normal, sandbox, demo

Válasz (201):

Bérlő létrehozva

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}
Mező Típus Kötelező Leírás
id string Igen Formátum: uuid
createdBy string Igen Formátum: uuid
createdAt string Igen Formátum: date-time
displayName string Igen Alapértelmezett: ""
Maximális hossz: 128
contactEmail string Igen Formátum: email
isActive boolean Igen Alapértelmezett: true
shortName string Igen
useOrganizationTheme boolean Igen Alapértelmezett: true
description string Igen Maximális hossz: 200
organizationId string Igen Formátum: uuid
allowedLogins object Igen
tenantType normal | sandbox | demo Igen Engedélyezett értékek: normal, sandbox, demo
Alapértelmezett: normal
url string Igen Formátum: uri

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs nem rendelkezik a szükséges jogosultsággal vagy szervezeti hozzáféréssel, a bérlő inaktív, vagy az előfizetési csomag nem engedélyezi a fájltípust
  • 406 Az érték nem fogadható el (például mert a rövid név foglalt vagy már létezik)

Bérlő logikai törlése a szervezetben (szervezethez kötött API-kulcs szükséges)

A bérlő API-hozzáférése azonnal megszűnik. A törlés biztonsági időszaka alatt a bérlő és az adatai megmaradnak, majd az automatizált végleges törlés eltávolítja őket. Az éppen használt bérlő (a kontextusbérlő) nem törölhető.

Végpont: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

Hitelesítés: Szervezethez kötött API-kulcs · write jogosultság

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
targetId string útvonal Igen Formátum: uuid

Válasz (200):

Bérlő törölve

{
	"success": true,
	"message": "string"
}
Mező Típus Kötelező Leírás
success boolean Igen
message string Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs nem rendelkezik a szükséges jogosultsággal vagy szervezeti hozzáféréssel, a bérlő inaktív, vagy az előfizetési csomag nem engedélyezi a fájltípust
  • 404 Az erőforrás nem található

Logikailag törölt bérlő visszaállítása a szervezetben (szervezethez kötött API-kulcs szükséges)

A logikai törlés visszavonható a törlés biztonsági időszakán belül: a bérlő és az adatai változatlanul visszaállnak, az API-hozzáférés pedig újra működik. A {tenantId} útvonalparaméter a kontextusbérlőt jelöli (a szervezethez kötött kulcs szervezetét), nem a művelet célpontját.

Végpont: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

Hitelesítés: Szervezethez kötött API-kulcs · write jogosultság

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
targetId string útvonal Igen Formátum: uuid

Válasz (200):

Bérlő visszaállítva

{
	"success": true,
	"message": "string"
}
Mező Típus Kötelező Leírás
success boolean Igen
message string Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs nem rendelkezik a szükséges jogosultsággal vagy szervezeti hozzáféréssel, a bérlő inaktív, vagy az előfizetési csomag nem engedélyezi a fájltípust
  • 404 Az erőforrás nem található

A szervezet összes felhasználójának listázása

A {tenantId} útvonalparaméter a kontextusbérlőt jelöli (a szervezethez kötött kulcs szervezetét), nem a művelet célpontját.

Végpont: GET /v1/tenant/{tenantId}/organization/users

Hitelesítés: Szervezethez kötött API-kulcs · read jogosultság

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
limit integer lekérdezés Nem A visszaadandó elemek maximális száma
offset integer lekérdezés Nem Kihagyandó elemek száma

Válasz (200):

A szervezet felhasználóinak listája

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs

Szervezeti felhasználó beállításainak módosítása (szervezethez kötött API-kulcs szükséges)

A kérés törzsében megadott szerepkörjelzők (isAdminInOrganization, isActiveInOrganization) változtatás nélkül érvényesülnek. Szervezethez kötött kulcsot csak a szervezet adminisztrátorainak adjon ki. A {tenantId} útvonalparaméter a kontextusbérlőt jelöli (a szervezethez kötött kulcs szervezetét), nem a művelet célpontját.

Végpont: PUT /v1/tenant/{tenantId}/organization/users/{userId}

Hitelesítés: Szervezethez kötött API-kulcs · write jogosultság

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
userId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}
Mező Típus Kötelező Leírás
isActiveInOrganization boolean Nem Azt jelzi, hogy a felhasználó aktív-e a szervezetben
isAdminInOrganization boolean Nem Szervezeti adminisztrátori jogosultságok (változtatás nélkül érvényesülnek: szervezethez kötött kulcsot csak a szervezet adminisztrátorainak adjon ki)

Válasz (200):

Módosítva

{
	"message": "string"
}
Mező Típus Kötelező Leírás
message string Igen

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs nem rendelkezik a szükséges jogosultsággal vagy szervezeti hozzáféréssel, a bérlő inaktív, vagy az előfizetési csomag nem engedélyezi a fájltípust
  • 404 Az erőforrás nem található

Felhasználó eltávolítása a szervezetből (szervezethez kötött API-kulcs szükséges)

A {tenantId} útvonalparaméter a kontextusbérlőt jelöli (a szervezethez kötött kulcs szervezetét), nem a művelet célpontját.

Végpont: DELETE /v1/tenant/{tenantId}/organization/users/{userId}

Hitelesítés: Szervezethez kötött API-kulcs · write jogosultság

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
userId string útvonal Igen Formátum: uuid

Válasz (200):

Felhasználó eltávolítva

{
	"message": "string"
}
Mező Típus Kötelező Leírás
message string Igen

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs nem rendelkezik a szükséges jogosultsággal vagy szervezeti hozzáféréssel, a bérlő inaktív, vagy az előfizetési csomag nem engedélyezi a fájltípust
  • 404 Az erőforrás nem található

Kapcsolódó dokumentáció

Tervezzen jobb folyamatokat. Építsen összekapcsolt architektúrát. Tartsa kézben a működést.

Azonnal hozzáférhet, bankkártya és várakozás nélkül. Alakítsa szervezete működését világos, összekapcsolt folyamatmodellekké.

Építse fel folyamatarchitektúráját, határozza meg a felelősségi köröket és az ellenőrzéseket, és hangolja össze a szerepeket minden szinten.

Indítsa el az ingyenes próbaverziót, és teremtsen megbízható alapot folyamatainak irányításához, kezeléséhez és folyamatos fejlesztéséhez.

Indítsa el ingyenes próbaverzióját