Skip to main content

Organizasyon Parametreleri

Add organisation:

Request Body Şeması:

Parametre Gerekli Veri Türü Açıklama Örnek
name - string Kuruluşun adı "XYZ Company"
date_created - string Oluşturulma tarihi "2024-04-12"
date_modified - string Değiştirilme tarihi "2024-04-12"
description - string Kuruluşun açıklaması "A software company specialized in AI"
type - string Kuruluşun türü "Private"
nationality - string Kuruluşun ulusal kimliği "US"
sector - string Kuruluşun sektörü "Technology"
created_by - string Oluşturan kullanıcının sayısal kimliği (ID) "12345"
uuid - string Kuruluşun benzersiz tanımlayıcısı (UUID) "550e8400-e29b-41d4-a716-446655440000"
contacts - string İletişim bilgileri "[email protected]"
local - boolean Yerel mi? true
restricted_to_domain - Dizi Alan adına sınırlı mı? ["xyz.com"]
landingpage - string Kuruluşun web sayfası "www.xyz.com"
user_count - string Kullanıcı sayısı "100"
created_by_email - string Oluşturan kullanıcının e-posta adresi "[email protected]"

Edit organisation:

Path Parametreleri:

Parametre Gerekli Veri Türü Açıklama Örnek
organisationId - string Kuruluşun benzersiz kimliği (OrganisationId) veya tanımlayıcısı (UUID) "12345" veya "550e8400-e29b-41d4-a716-446655440000"

Request Body Şeması:

Parametre Gerekli Veri Türü Açıklama Örnek
name - string (OrganisationName) <= 255 karakter Kuruluşun adı "ABC Company"
type - string or null (OrganisationType) <= 255 karakter Kuruluşun türü "Public"
nationality - string or null Kuruluşun ülkesi "USA"
sector - string or null Kuruluşun sektörü "Technology"
contacts - string or null Kuruluşun iletişim bilgileri "[email protected]"
description - string or null Kuruluşun açıklaması "Global technology company"
local - boolean or null Kuruluşun yerel olup olmadığı true
uuid - string or null <uuid> Kuruluşun benzersiz kimliği (UUID) "550e8400-e29b-41d4-a716-446655440000"
restricted_to_domain - Array of strings or null <hostname> Kuruluşun alan adına kısıtlı olduğu durumlar ["example.com", "subdomain.example.com"]

Delete organisation:

Path Parameters:

Parametre Gerekli Veri Türü Açıklama Örnek
organisationId Evet string (OrganisationId) veya UUID (string) Kuruluşun benzersiz kimliği (UUID) veya sayısal ID "123456" veya "550e8400-e29b-41d4-a716-446655440000"

Get organisation by ID:

Path Parametreleri:

Parametre Gerekli Veri Türü Açıklama Örnek
organisationId Evet string (OrganisationId) veya UUID (string) Kuruluşun benzersiz kimliği (UUID) veya sayısal ID "123456" veya "550e8400-e29b-41d4-a716-446655440000"