Na této stránce
> zdroje > dokumentace > api > Referenční příručka API: organizace

Referenční příručka API: organizace

warning

Smazáním tenantu trvale odstraníte všechny jeho procesy, datové sady a přiřazení uživatelů. Tuto akci nelze vrátit zpět. Tenant, který používáte k ověření, smazat nelze.

warning

Odebráním uživatele z organizace mu zrušíte přístup ke všem tenantům v této organizaci.

Organizace sdružují více tenantů pod jednu entitu.

Získání organizace tenantu

Pro čtení lze použít API key s oprávněním pro tenant. Přijímá se také API key s oprávněním pro organizaci.

Endpoint: GET /v1/tenant/{tenantId}/organization

Ověření: API key s oprávněním pro tenant nebo organizaci · oprávnění read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid

Odpověď (200):

Podrobnosti o organizaci

{
	"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"
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
displayName string Ano Výchozí hodnota: ""
Maximální délka: 128
createdAt string Ano Formát: date-time
contactEmail string Ano Formát: email
isActive boolean Ano Výchozí hodnota: true
allowedLogins object Ano
createdBy string Ano Formát: uuid

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 404 Zdroj nebyl nalezen

Získání kapacity licencí organizace a zásad automatické synchronizace

Vrací počet zakoupených a využívaných licencí v celé organizaci pro jednotlivé úrovně (Process Foundation, Process Architecture, Process Intelligence), limit bezplatných licencí Viewer, cíl automatické synchronizace, vysvětlení rozdílů v počtu licencí (co systém provede a kdy), fakturační interval a externalApiSeatPolicy. Pro čtení lze použít API key s oprávněním pro tenant. Parametr cesty {tenantId} označuje kontextový tenant, tedy organizaci, ke které patří API key s oprávněním pro organizaci. Neoznačuje cíl operace.

Endpoint: GET /v1/tenant/{tenantId}/organization/billing/seats

Ověření: API key s oprávněním pro tenant nebo organizaci · oprávnění read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid

Odpověď (200):

Kapacita licencí

{
	"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"
}
Pole Typ Povinné Popis
contractType free | selfServe | fixed | unlimited Ano Povolené hodnoty: free, selfServe, fixed, unlimited
isTrial boolean Ano
purchased object Ano
inUseBillable object Ano
inUseFree number Ano
inUseDashboardViewers number Ano
totalBillable number Ano
freeViewerAllowance number Ano
freeViewerOverAllowance number Ano
dashboardViewerAllowance number Ano
dashboardViewerOverAllowance number Ano
fixedOverage number Ano
target object Ano
drift object[] Ano
interval month | year Ano Povolené hodnoty: month, year
nextBilledAt string Ano
externalApiSeatPolicy autoBill | requireCapacity Ano Povolené hodnoty: autoBill, requireCapacity

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 404 Zdroj nebyl nalezen

Získání statistik za celou organizaci

Parametr cesty {tenantId} označuje kontextový tenant, tedy organizaci, ke které patří API key s oprávněním pro organizaci. Neoznačuje cíl operace.

Endpoint: GET /v1/tenant/{tenantId}/organization/statistics

Ověření: API key s oprávněním pro organizaci · oprávnění read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid

Odpověď (200):

Statistiky organizace

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}
Pole Typ Povinné Popis
userCount number Ano
tenantCount number Ano
tenantStatistics object[] Ano

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela

Výpis všech tenantů v organizaci

Parametr cesty {tenantId} označuje kontextový tenant, tedy organizaci, ke které patří API key s oprávněním pro organizaci. Neoznačuje cíl operace.

Endpoint: GET /v1/tenant/{tenantId}/organization/tenants

Ověření: API key s oprávněním pro organizaci · oprávnění read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
limit integer query Ne Maximální počet vrácených položek
offset integer query Ne Počet přeskočených položek

Odpověď (200):

Seznam tenantů

[
	{
		"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"
	}
]

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela

Vytvoření tenantu v organizaci (vyžaduje API key s oprávněním pro organizaci)

Parametr cesty {tenantId} označuje kontextový tenant, tedy organizaci, ke které patří API key s oprávněním pro organizaci. Neoznačuje cíl operace.

Endpoint: POST /v1/tenant/{tenantId}/organization/tenants

Ověření: API key s oprávněním pro organizaci · oprávnění write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid

Tělo požadavku:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}
Pole Typ Povinné Popis
displayName string Ne Maximální délka: 128
shortName string Ano
description string Ne Maximální délka: 200
timezone string Ne Maximální délka: 64
tenantType normal | sandbox | demo Ne Povolené hodnoty: normal, sandbox, demo

Odpověď (201):

Tenant vytvořen

{
	"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"
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
createdBy string Ano Formát: uuid
createdAt string Ano Formát: date-time
displayName string Ano Výchozí hodnota: ""
Maximální délka: 128
contactEmail string Ano Formát: email
isActive boolean Ano Výchozí hodnota: true
shortName string Ano
useOrganizationTheme boolean Ano Výchozí hodnota: true
description string Ano Maximální délka: 200
organizationId string Ano Formát: uuid
allowedLogins object Ano
tenantType normal | sandbox | demo Ano Povolené hodnoty: normal, sandbox, demo
Výchozí hodnota: normal
url string Ano Formát: uri

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 403 API key nemá požadované oprávnění ani přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 406 Hodnotu nelze přijmout, například jde o rezervovaný nebo duplicitní krátký název

Logické smazání tenantu v organizaci (vyžaduje API key s oprávněním pro organizaci)

Přístup k API pro tenant se okamžitě ukončí. Tenant a jeho data zůstanou zachovány po dobu ochranné lhůty pro smazání. Poté je automaticky trvale odstraníme. Tenant, který právě používáte (kontextový tenant), smazat nelze.

Endpoint: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

Ověření: API key s oprávněním pro organizaci · oprávnění write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
targetId string path Ano Formát: uuid

Odpověď (200):

Tenant smazán

{
	"success": true,
	"message": "string"
}
Pole Typ Povinné Popis
success boolean Ano
message string Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 403 API key nemá požadované oprávnění ani přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 404 Zdroj nebyl nalezen

Obnovení logicky smazaného tenantu v organizaci (vyžaduje API key s oprávněním pro organizaci)

Logické smazání můžete vrátit zpět během ochranné lhůty pro smazání. Tenant i jeho data se obnoví v původním stavu a přístup k API se znovu aktivuje. Parametr cesty {tenantId} označuje kontextový tenant, tedy organizaci, ke které patří API key s oprávněním pro organizaci. Neoznačuje cíl operace.

Endpoint: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

Ověření: API key s oprávněním pro organizaci · oprávnění write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
targetId string path Ano Formát: uuid

Odpověď (200):

Tenant obnoven

{
	"success": true,
	"message": "string"
}
Pole Typ Povinné Popis
success boolean Ano
message string Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 403 API key nemá požadované oprávnění ani přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 404 Zdroj nebyl nalezen

Výpis všech uživatelů v organizaci

Parametr cesty {tenantId} označuje kontextový tenant, tedy organizaci, ke které patří API key s oprávněním pro organizaci. Neoznačuje cíl operace.

Endpoint: GET /v1/tenant/{tenantId}/organization/users

Ověření: API key s oprávněním pro organizaci · oprávnění read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
limit integer query Ne Maximální počet vrácených položek
offset integer query Ne Počet přeskočených položek

Odpověď (200):

Seznam uživatelů organizace

[
	{
		"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
	}
]

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela

Úprava nastavení uživatele organizace (vyžaduje API key s oprávněním pro organizaci)

Příznaky role v těle požadavku (isAdminInOrganization, isActiveInOrganization) se použijí přesně podle zadaných hodnot. API key s oprávněním pro organizaci vydávejte pouze správcům organizace. Parametr cesty {tenantId} označuje kontextový tenant, tedy organizaci, ke které patří API key s oprávněním pro organizaci. Neoznačuje cíl operace.

Endpoint: PUT /v1/tenant/{tenantId}/organization/users/{userId}

Ověření: API key s oprávněním pro organizaci · oprávnění write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
userId string path Ano Formát: uuid

Tělo požadavku:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}
Pole Typ Povinné Popis
isActiveInOrganization boolean Ne Zda je uživatel v organizaci aktivní
isAdminInOrganization boolean Ne Oprávnění správce organizace (použije se přesně podle zadané hodnoty: API key s oprávněním pro organizaci vydávejte pouze správcům organizace)

Odpověď (200):

Aktualizováno

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 403 API key nemá požadované oprávnění ani přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 404 Zdroj nebyl nalezen

Odebrání uživatele z organizace (vyžaduje API key s oprávněním pro organizaci)

Parametr cesty {tenantId} označuje kontextový tenant, tedy organizaci, ke které patří API key s oprávněním pro organizaci. Neoznačuje cíl operace.

Endpoint: DELETE /v1/tenant/{tenantId}/organization/users/{userId}

Ověření: API key s oprávněním pro organizaci · oprávnění write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string path Ano Formát: uuid
userId string path Ano Formát: uuid

Odpověď (200):

Uživatel odebrán

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 401 Chybí API key, je neplatný, deaktivovaný nebo jeho platnost vypršela
  • 403 API key nemá požadované oprávnění ani přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 404 Zdroj nebyl nalezen

Související dokumentace

Navrhujte lepší procesy. Propojte je do společné architektury. Mějte vše pod kontrolou.

Získejte přístup ihned, bez čekání a bez platební karty. Převádějte způsob práce ve své organizaci do přehledných a propojených návrhů procesů.

Vytvořte architekturu procesů, určete vlastníky a kontrolní mechanismy a slaďte role a odpovědnosti na všech úrovních.

Spusťte zkušební verzi a vytvořte spolehlivý základ pro řízení, správu a průběžné zlepšování procesů.

Získejte zkušební verzi zdarma