Staffbase (Önizleme)
Staffbase Bağlayıcısı ile farklı araçlar ve sistemler arasında köprü kurar ve Staffbase platformunu otomatik iş akışlarınızla tümleştirirsiniz. İşlemleri otomatikleştirmek, görevleri zamanlamaya göre çalıştırmak veya olaylar gerçekleştiğinde kullanıcılara bildirmek için çalışan uygulamanızı veya intranetinizi içerir.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | Staffbase Desteği |
| URL | https://www.staffbase.com |
| E-posta | support@staffbase.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Staffbase GmbH |
| Web sitesi | https://www.staffbase.com |
| Gizlilik ilkesi | https://staffbase.com/en/privacy-policy/ |
| Kategoriler | İletişim; İnsan Kaynakları |
Staffbase bağlayıcısı
Power Automate için Staffbase bağlayıcısı ile farklı araçlar ve sistemler arasındaki boşluğu kapatır ve staffbase platformunu otomatik iş akışlarınıza eklersiniz. süreçleri otomatikleştirmek, görevleri zamanlamaya göre çalıştırmak veya olaylar gerçekleştikçe kullanıcıları bilgilendirmek için çalışan uygulamanızı veya intranetinizi içeren otomatik iş akışlarının gücünden yararlanın.
Önkoşullar
- Özel bağlayıcı özelliğine sahip bir Microsoft Power Apps veya Power Automate planı
- Kuruluşunuz için Staffbase lisansı
- Staffbase platformunda kuruluşunuzun yöneticisinin rolü
- Kimlik doğrulamasını yapılandırmak için API belirteci
- Uygulamanızın barındırıldığı Staffasbe altyapısı hakkında bilgi, daha fazla bilgi için ulaşabilirsiniz support@staffbase.com
Desteklenen İşlemler
ChannelsGetList
Haber kanallarının listesini alma
ChannelsGetPosts
Belirtilen kanaldaki gönderilerin listesini alma
ChannelsPostPost
Belirli bir kanala gönderi gönderme
AçıklamalarAlt
Staffbase örneğinizden tüm yorumları alma
MediaGet
Staffbase örneğinizden tüm medyayı alma
MediaGetByID
Kimliğine göre medya alma
MediaDelete
Kimliğine göre medyayı silme
NotificationPost
Kullanıcılara bildirim gönderir
PostGetAll
Gönderilerin listesini alma
PostGetByID
Kimliğine göre gönderi alma
GönderilerDelete
Gönderiyi kaldırır
PostsPut
Gönderiyi güncelleştirir
UserGetAll
Kullanıcı listesini alma
UserPost
Kullanıcıyı ad, soyadı ve e-posta ile davet etme
UserGetByID
Kullanıcı bilgilerini alma
User_delete
Kimliğine Göre Kullanıcıyı Sil
UserPut
Kullanıcı bilgilerini güncelleştirme
UserPostRecovery
Kurtarma e-postası gönderme
ProxyVersionGet
Yalnızca iç kullanım için, geçerli API proxy sürümünü denetlemek için
Kimlik Bilgilerini Alma
Staffbase platformunuz ile Power Automate'te oluşturulan iş akışı arasındaki temel kimlik doğrulaması için bir API belirteci gerekir. API belirtecini Staffbase Experience Studio'dan oluşturabilirsiniz.
Başlangıç Yapmak
Bağlayıcıyı temel kimlik doğrulaması ve barındırma URL'si ile yapılandırın.
- Power Automate'te Bağlayıcılar'a gidin.
- Staffbase bağlayıcısını arayın.
- Staffbase bağlayıcısı'na tıklayın. Bağlayıcıyı yapılandırmak için bir iletişim kutusu açılır.
- API Belirteci alanına aşağıdaki söz dizimini kullanarak API belirtecini ekleyin: Temel [API-Token]
Not: 'Temel' ile API belirteci arasına boş bir alan eklemeniz gerekir.
Konak Kimliği alanına Staffbase platformunuzun barındırıldığı altyapının tanımlayıcısını girin:
- Alman altyapısı: de1
- Uluslararası altyapı: us1
Ayrıntılı bilgi için Staffbase Destek Portalı'nı ziyaret edin.
Bilinen Sorunlar ve Sınırlamalar
Staffbase bağlayıcısı şu anda tüm Staffbase API özelliklerini desteklememektedir. Staffbase API'leri hakkında daha ayrıntılı bilgi için Staffbase Geliştirici Portalı'nı ziyaret edin.
Sık Sorulan Sorular
Staffbase bağlayıcısı kullanılarak hangi iş iş akışları otomatikleştirilebilir?
Staffbase bağlayıcısı kullanılarak birçok iş süreci otomatikleştirilebilir. Örneğin, diğer araçlarda eylemler gerçekleştiğinde çalışanlarınızı doğrudan çalışan uygulamasında veya intranetinde bilgilendirin. Bu tür iş kullanım örnekleri hakkında daha fazla bilgiyi burada bulabilirsiniz.
Staffbase bağlayıcısını kullanarak otomatik bir iş akışı kullanmaya başlamama yardımcı olacak öğreticiler var mı?
Staffbase, tesis yönetiminizi otomatikleştirmek için Forms eklentimizi ve Staffbase bağlayıcısını kullanan öğreticiler sunar. Bu bölümde nasıl ayarlanacağı hakkında her şeyi öğrenin.
Dağıtım Yönergeleri
Aşağıdaki komutları çalıştırın ve istemleri izleyin:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>
Bağlantı oluşturma
Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
| Varsayılan | Bağlantı oluşturmak için parametreler. | Tüm bölgeler | Paylaşılamaz |
Temerrüt
Geçerli: Tüm bölgeler
Bağlantı oluşturmak için parametreler.
Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.
| İsim | Türü | Description | Gerekli |
|---|---|---|---|
| API-Key | securestring | Staffbase örneği için "API-Key" | Doğru |
| Barındırma Kimliği | String | Barındırma kimliğinizi belirtin: hostingID | Doğru |
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Bildirim: Bildirim gönderir |
Belirtilen kullanıcılara bildirim gönderir. |
| Gönderiler: Gönderilerin listesini alma |
API belirteci için erişilebilir gönderilerin listesini alın. |
| Gönderiler: Gönderiyi güncelleştirir |
Gönderiyi güncelleştirir, yalnızca değiştirilen alanı (artımlı) güncelleştirir. |
| Gönderiler: Gönderiyi kaldırır |
Bir gönderiyi sistemden kaldırır. |
| Gönderiler: Kimliğine göre gönderi alma |
Bir açıklama kümesi de dahil olmak üzere belirtilen gönderileri istemektedir. |
| Gönderiler: Yorum alma |
Açıklamaların listesini alın. |
| Kanallar: Belirli bir kanala gönderi gönderme |
Belirli bir haber kanalına gönderi gönderin. |
| Kanallar: Belirtilen kanaldaki gönderilerin listesini alma |
Belirtilen kanaldaki gönderilerin listesini alın. |
| Kanallar: Haber kanallarının listesini alma |
Haber kanallarının listesini alın. |
| Kullanıcı: Kullanıcı bilgilerini alma |
Kullanıcı kimliğine göre belirli kullanıcı bilgilerini alın. |
| Kullanıcı: Kullanıcı bilgilerini güncelleştirme |
Kullanıcı bilgilerini güncelleştirin. |
| Kullanıcı: Kullanıcı listesini alma |
API erişim belirtecinin bağlı olduğu kullanıcıların listesini alın. |
| Kullanıcı: Kullanıcıyı davet et |
Kullanıcı kaydolmak için bir e-posta alır. |
| Kullanıcı: Kullanıcıyı Sil |
Belirtilen kullanıcıyı siler. |
| Kullanıcı: Kurtarma e-postası gönderme |
Belirtilen kullanıcıya bir kurtarma e-postası gönderir. |
| Medya: Kimliğine göre medya alma |
Tek medya için meta verileri kimliğine göre alın. |
| Medya: Medyayı silme |
Geçerli bağlamda belirtilen medyayı siler. |
| Medya: Tüm medyayı alma |
Geçerli bağlamda kullanılabilen tüm medyanın açıklamasını iste. |
| Proxy: Sürümü alma |
Geçerli proxy sürümünü döndürür. |
Bildirim: Bildirim gönderir
Belirtilen kullanıcılara bildirim gönderir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
accessorId'ler
|
accessorIds | array of string | ||
|
Yerel ayar
|
locale | string |
de_DE, en_US vb. gibi yerel ayar ekleyin. |
|
|
title
|
title | string |
Dile bağımlı başlık ekleyin. |
|
|
link
|
link | string |
En uygun: Buraya bağlantı ekleyin. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string |
Bu, bildirimin kimliğidir. |
|
accessorId'ler
|
recipients.accessorIds | array of string |
Bu, alıcı kimliklerinin listesidir. |
|
içerik
|
content | array of object | |
|
title
|
content.title | string |
Yerelleştirilmiş bildirimin başlığı. |
|
Yerel ayar
|
content.locale | string |
Bu, başlığın yerel ayarıdır. |
|
link
|
link | string |
Bu, bildirim bağlantısıdır. |
|
type
|
type | string |
Bildirim türü budur. |
|
createdAt
|
createdAt | string |
Bildirimin oluşturulma tarihi. |
|
Oluşturulan
|
created | string |
Bildirimin oluşturulma tarihi. |
Gönderiler: Gönderilerin listesini alma
API belirteci için erişilebilir gönderilerin listesini alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Query
|
query | string |
Gönderi içeriğinde arama için kullanılabilecek bir dize. |
|
|
Sınır
|
limit | integer |
Döndürülmesi gereken öğe miktarı (varsayılan ve en fazla 100). |
|
|
Ofset baskı
|
offset | integer |
Bu numaradan başlayarak öğeleri almak için bir uzaklık tanımlayın. |
|
|
Yönetilebilir
|
manageable | boolean |
Verilen gönderi içerik türleri için isteğe bağlı filtre. Varsayılan olarak filtrelenmez. |
|
|
İçerikTürü
|
contentType | string |
Verilen gönderi içerik türleri için isteğe bağlı filtre. (Varsayılan olarak filtrelenmez) |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
toplam
|
total | integer |
Bulunan gönderilerin toplam sayısı. |
|
limit
|
limit | integer |
Döndürülen öğe miktarı. |
|
offset
|
offset | integer |
Öğeleri bu numaradan başlatmak için geçerli tanımlı uzaklık. |
|
veriler
|
data | array of postData |
Gönderiler: Gönderiyi güncelleştirir
Gönderiyi güncelleştirir, yalnızca değiştirilen alanı (artımlı) güncelleştirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
PageID
|
pageID | True | string |
Bu, API tarafından tanımlanan posta kimliği veya post externalID ayarlı olabilir. |
|
hariciKimlik
|
externalID | string |
İsteğe bağlı: Buraya bir dış kimlik girin. |
|
|
Yerel ayar
|
locale | string |
de_DE, en_US vb. gibi yerel ayar ekleyin. |
|
|
içerik
|
content | string |
Haber içeriğini buraya girin. |
|
|
image
|
image | string |
Resmin bağlantısını buraya girin. |
|
|
Teaser
|
teaser | string |
Teaser'ınızı buraya girin. |
|
|
title
|
title | string |
Başlığınızı buraya girin. |
|
|
Yayımlanmış
|
published | string |
Yayımlama tarihinizi buraya girin. |
Gönderiler: Gönderiyi kaldırır
Bir gönderiyi sistemden kaldırır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
PageID
|
pageID | True | string |
Bu, API tarafından tanımlanan posta kimliği veya post externalID ayarlı olabilir. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Tanımlayıcı
|
identifier | integer |
Silme tanımlayıcısı. |
|
durum kodu
|
statusCode | integer |
Eylemin durum kodu. |
|
message
|
message | string |
Eylemin iletisi. |
|
type
|
type | string |
Eylemin türü. |
Gönderiler: Kimliğine göre gönderi alma
Bir açıklama kümesi de dahil olmak üzere belirtilen gönderileri istemektedir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
PageID
|
pageID | True | string |
Bu, gönderinin kimliğidir. |
Döndürülenler
- Body
- postData
Gönderiler: Yorum alma
Açıklamaların listesini alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Manage
|
manage | boolean |
True olduğunda ve belirteç rolü açıklamaları yönetmeye izin verdiğinde, yayımlanmış olmayan açıklamalar da listede gösterilir. |
|
|
Sınır
|
limit | integer |
Döndürülmesi gereken öğe miktarı (varsayılan ve en fazla 100). |
|
|
Ofset baskı
|
offset | integer |
Bu numaradan başlayarak öğeleri almak için bir uzaklık tanımlayın. |
|
|
Filter
|
filter | string |
Kısmi destekle SCIM2 biçiminde filtreleyin. Şimdilik yalnızca düz yapı (iç içe yan tümceleri yok) ve eq = "eşittir", gt = "büyüktür", ge = "büyüktür veya eşittir", lt = "küçüktür", le = "küçüktür veya eşittir" gibi karşılaştırma yan tümceleri desteklenir. Desteklenen açıklamalar için filtre alanları şunlardır: oluşturulur ve güncelleştirilir. Bu alanların değeri UTC DateTime dize temsili veya unix döneminin milisaniye cinsinden uzun sayısı ile sağlanabilir. Örnek 1: filter=updated ge "2020-11-26T10:14:48.947Z" ve "2020-11-26T10:14:48.947Z" olarak güncelleştirildi. Bu örnekte, Güncelleştirilmiş alana ge ve le karşılaştırma yan tümceleri ve boole yan tümcesi ile DateTime aralığı filtresi uygulanır. Örnek 2: filter=created gt "2020-11-26T10:14:48.947Z". İşaret edilen tarihten sonra oluşturulan tüm açıklamaları alın. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
toplam
|
total | integer |
Bulunan toplam açıklama sayısı. |
|
limit
|
limit | integer |
Döndürülen öğe miktarı. |
|
offset
|
offset | integer |
Öğeleri bu numaradan başlatmak için geçerli tanımlı uzaklık. |
|
veriler
|
data | array of object | |
|
kimlik
|
data.id | string |
Bu, açıklamanın kimliğidir. |
|
parentID
|
data.parentID | string |
Açıklamanın üst öğesinin kimliği bir gönderi veya açıklama olabilir. |
|
ebeveynTürü
|
data.parentType | string |
Üst tür bir gönderi veya açıklama olabilir. |
|
açıklama metni
|
data.text | string |
Bu, açıklama içeriğidir / kendini test eder. |
|
posta kimliği
|
data.rootID | string |
Bu, bu yorumun ilişkili olduğu gönderinin kimliğidir |
|
yazar
|
data.author | authorObject | |
|
toplam
|
data.likes.total | integer |
Bu, beğenen açıklama sayısıdır. |
|
isLiked
|
data.likes.isLiked | string |
Bu yorum beğenildi mi? |
|
Oluşturulan
|
data.created | string |
Açıklamanın oluşturulma tarihi. |
|
Güncel -leştirilmiş
|
data.updated | string |
Açıklamanın güncelleştirilmiş tarihi. |
|
image
|
data.image | imageObject |
Kanallar: Belirli bir kanala gönderi gönderme
Belirli bir haber kanalına gönderi gönderin.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
ChannelID
|
channelID | True | string |
Kanal kimliğini buraya ekleyin. |
|
hariciKimlik
|
externalID | string |
İsteğe bağlı: Buraya bir dış kimlik girin. |
|
|
Yerel ayar
|
locale | string |
de_DE, en_US vb. gibi yerel ayar ekleyin. |
|
|
içerik
|
content | string |
Haber içeriğini buraya girin. |
|
|
resim (bağlantı)
|
image | string |
Buraya resim bağlantısı girin. |
|
|
Teaser
|
teaser | string |
Teaser'ınızı buraya girin. |
|
|
title
|
title | string |
Başlığınızı buraya girin. |
|
|
Yayımlanmış
|
published | string |
Yayımlama tarihinizi buraya girin. |
Kanallar: Belirtilen kanaldaki gönderilerin listesini alma
Belirtilen kanaldaki gönderilerin listesini alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
ChannelID
|
channelID | True | string |
Kanal kimliğini buraya ekleyin; örneğin getChannels tarafından alınır. |
|
Sınır
|
limit | integer |
Döndürülmesi gereken öğe miktarı (varsayılan ve en fazla 100). |
|
|
Ofset baskı
|
offset | integer |
Bu numaradan başlayarak öğeleri almak için bir uzaklık tanımlayın. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
toplam
|
total | integer |
Bulunan gönderilerin toplam sayısı. |
|
limit
|
limit | integer |
Döndürülen öğe miktarı. |
|
offset
|
offset | integer |
Öğeleri bu numaradan başlatmak için geçerli tanımlı uzaklık. |
|
veriler
|
data | array of postData |
Kanallar: Haber kanallarının listesini alma
Haber kanallarının listesini alın.
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
toplam
|
total | integer |
Bulunan kanalların toplam sayısı. |
|
limit
|
limit | integer |
Döndürülen öğe miktarı. |
|
offset
|
offset | integer |
Öğeleri bu numaradan başlatmak için geçerli tanımlı uzaklık. |
|
veriler
|
data | array of object | |
|
kimlik
|
data.id | string |
Bu, kanalın kimliğidir. |
|
yerelleştirme
|
data.config.localization | array of object | |
|
title
|
data.config.localization.title | string |
Yerelleştirilmiş kanal başlığı. |
|
Yerel ayar
|
data.config.localization.locale | string |
Bu, kanal başlığının yerel ayarıdır. |
|
spaceID
|
data.spaceID | string |
Kanalın atandığı alanın kimliği. |
|
Oluşturulan
|
data.created | string |
Kanalın oluşturulma tarihi. |
|
Yayımlanmış
|
data.published | string |
Kanalın yayımlanma tarihi. |
|
Güncel -leştirilmiş
|
data.updated | string |
Kanalın güncelleştirilmiş tarihi. |
Kullanıcı: Kullanıcı bilgilerini alma
Kullanıcı kimliğine göre belirli kullanıcı bilgilerini alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kullanıcı Kimliği
|
userID | True | string |
Kimlik, Kullanıcı için ekleniyorsa Staffbase platformu tarafından otomatik olarak oluşturulan UserID'yi veya externalID'yi temel alabilir. |
Döndürülenler
- Body
- userData
Kullanıcı: Kullanıcı bilgilerini güncelleştirme
Kullanıcı bilgilerini güncelleştirin.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kullanıcı Kimliği
|
userID | True | string |
Kimlik, Kullanıcı için ekleniyorsa Staffbase platformu tarafından otomatik olarak oluşturulan UserID'yi veya externalID'yi temel alabilir. |
|
kimlik
|
id | string |
Kullanıcının kimliği |
|
|
hariciKimlik
|
externalID | string |
Kullanıcının dış kimliği |
|
|
ön ad
|
firstName | string |
Kullanıcının adı |
|
|
soyadı
|
lastName | string |
Kullanıcının soyadı |
|
|
publicEmailAddress
|
publicEmailAddress | string |
Kullanıcının genel e-posta adresi |
|
|
Yerel ayar
|
locale | string |
Kullanıcının yerel ayarı |
|
|
e-posta
|
value | string |
E-posta adresi |
|
|
birincil
|
primary | boolean |
Birincil e-posta mı? |
|
|
groupID'ler
|
groupIDs | array of string | ||
|
konum
|
position | string |
Kullanıcının konumu |
|
|
bölüm
|
department | string |
Kullanıcının bölümü |
|
|
location
|
location | string |
Kullanıcının konumu |
|
|
telefon numarası
|
phoneNumber | string |
Kullanıcının telefon numarası |
|
|
Oluşturulan
|
created | string |
Kullanıcının oluşturulma tarihi |
|
|
Güncel -leştirilmiş
|
updated | string |
Kullanıcının güncelleştirilmiş tarihi |
|
|
Aktif
|
activated | string |
Kullanıcı etkinleştirildi mi? |
Döndürülenler
- Body
- userData
Kullanıcı: Kullanıcı listesini alma
API erişim belirtecinin bağlı olduğu kullanıcıların listesini alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
SCIM gösterimi filtrelemek için kullanılabilir
|
filter | string |
SCIM gösterimi filtrelemek için kullanılabilir. |
|
|
Tam metin araması filtreyle birleştirilebilir
|
query | string |
Burada herhangi bir profil alanında serach yapabilirsiniz. |
Kullanıcı: Kullanıcıyı davet et
Kullanıcı kaydolmak için bir e-posta alır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
e-posta
|
string |
Bu, kullanıcının e-posta adresidir. |
||
|
ön ad
|
firstName | string |
Bu, kullanıcının adıdır. |
|
|
soyadı
|
lastName | string |
Bu, kullanıcının soyadıdır. |
Kullanıcı: Kullanıcıyı Sil
Belirtilen kullanıcıyı siler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kullanıcı Kimliği
|
userID | True | string |
Kimlik, Kullanıcı için ekleniyorsa Staffbase platformu tarafından otomatik olarak oluşturulan UserID'yi veya externalID'yi temel alabilir. |
Kullanıcı: Kurtarma e-postası gönderme
Belirtilen kullanıcıya bir kurtarma e-postası gönderir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kullanıcı Kimliği
|
userID | True | string |
Kimlik, Kullanıcı için ekleniyorsa Staffbase platformu tarafından otomatik olarak oluşturulan UserID'yi veya externalID'yi temel alabilir. |
Medya: Kimliğine göre medya alma
Tek medya için meta verileri kimliğine göre alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Orta Boy Kimliği
|
mediumID | True | string |
Belirli bir ortamla ilgili bilgi istemektedir. |
Döndürülenler
- Body
- mediaData
Medya: Medyayı silme
Geçerli bağlamda belirtilen medyayı siler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Orta Boy Kimliği
|
mediumID | True | string |
Ortamı kimliğine göre siler. Bu işlem kaynağı sunucularımızdan hemen kaldırır ancak CDN, CDN geçersiz kılınana kadar resourceInfo.url dosyasında belirtilen URL aracılığıyla içeriği yine de teslim edebilir. |
Medya: Tüm medyayı alma
Geçerli bağlamda kullanılabilen tüm medyanın açıklamasını iste.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sınır
|
limit | integer |
Buradaki öğe sayısını sınırlayın. |
|
|
Ofset baskı
|
offset | integer |
Sorgu için bir uzaklık ayarlayın. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
toplam
|
total | integer |
Bulunan varlıkların toplam sayısı. |
|
limit
|
limit | integer |
Döndürülen öğe miktarı. |
|
offset
|
offset | integer |
Öğeleri bu numaradan başlatmak için geçerli tanımlı uzaklık. |
|
veriler
|
data | array of mediaData |
Proxy: Sürümü alma
Geçerli proxy sürümünü döndürür.
Tanımlar
mediaData
| Name | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string |
Bu, varlığın kimliğidir. |
|
ownerID
|
ownerID | string |
Bu, bu varlığın sahibinin kimliğidir. |
|
parentID
|
parentID | string |
Bu, üst medya varlığının kimliğidir. |
|
publicID
|
publicID | string |
Bu, varlığa erişmek için genel kimliktir. |
|
type
|
resourceInfo.type | string |
Bu, varlık kaynak türüdür. |
|
bytes
|
resourceInfo.bytes | integer |
Bu, kaynak boyutudur (bayt cinsinden). |
|
width
|
resourceInfo.width | integer |
Bu, kaynak genişliğidir. |
|
height
|
resourceInfo.height | integer |
Bu, kaynak yüksekliğidir. |
|
url
|
resourceInfo.url | string |
Bu, kaynak URL'sidir. |
|
format
|
resourceInfo.format | string |
Bu, kaynak biçimidir. |
|
MIME türü
|
resourceInfo.mimeType | string |
Bu, kaynak MIME türüdür. |
|
fileName
|
fileName | string |
Bu, medya dosya adıdır. |
|
title
|
title | string |
Bu, medya başlığıdır. |
|
label
|
label | string |
Bu, medya etiketidir. |
|
Oluşturulan
|
created | string |
Varlığın oluşturulma tarihi. |
kullanıcı verileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string |
Kullanıcının kimliği |
|
hariciKimlik
|
externalID | string |
Kullanıcının dış kimliği |
|
ön ad
|
firstName | string |
Kullanıcının adı |
|
soyadı
|
lastName | string |
Kullanıcının soyadı |
|
publicEmailAddress
|
publicEmailAddress | string |
Kullanıcının genel e-posta adresi |
|
Yerel ayar
|
config.locale | string |
Kullanıcının yerel ayarı |
|
e-postalar
|
emails | array of object |
Kullanıcı e-posta bilgileri |
|
e-posta
|
emails.value | string |
E-posta adresi |
|
birincil
|
emails.primary | boolean |
Birincil e-posta mı? |
|
groupID'ler
|
groupIDs | array of string | |
|
konum
|
position | string |
Kullanıcının konumu |
|
bölüm
|
department | string |
Kullanıcının bölümü |
|
location
|
location | string |
Kullanıcının konumu |
|
telefon numarası
|
phoneNumber | string |
Kullanıcının telefon numarası |
|
Oluşturulan
|
created | string |
Kullanıcının oluşturulma tarihi |
|
Güncel -leştirilmiş
|
updated | string |
Kullanıcının güncelleştirilmiş tarihi |
|
Aktif
|
activated | string |
Kullanıcı etkinleştirildi mi? |
postData
| Name | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string |
Gönderinin kimliği. |
|
yazar
|
author | authorObject | |
|
contents
|
contents | array of object | |
|
içerik
|
contents.content | string |
Yerelleştirilmiş gönderi içeriği. |
|
image
|
contents.image | imageObject | |
|
Teaser
|
contents.teaser | string |
Yerelleştirilmiş post teaser. |
|
title
|
contents.title | string |
Yerelleştirilmiş gönderi başlığı. |
|
Yerel ayar
|
contents.locale | string |
Bu, öğenin yerel ayarıdır. |
|
kimlik
|
channel.id | string |
Bu, kanalın kimliğidir. |
|
yerelleştirme
|
channel.config.localization | array of object | |
|
title
|
channel.config.localization.title | string |
Bu, yerelleştirilmiş kanal başlığıdır. |
|
Yerel ayar
|
channel.config.localization.locale | string |
Bu, kanal başlığının yerel ayarıdır. |
|
Yayımlanmış
|
published | string |
Gönderinin yayımlanma tarihi. |
|
Oluşturulan
|
created | string |
Gönderinin oluşturulma tarihi. |
|
Güncel -leştirilmiş
|
updated | string |
Gönderinin güncelleştirilmiş tarihi. |
authorObject
| Name | Yol | Tür | Description |
|---|---|---|---|
|
ön ad
|
firstName | string |
Bu, yazarın adıdır. |
|
kimlik
|
id | string |
Bu, yazarın kimliğidir. |
|
soyadı
|
lastName | string |
Bu, yazarın soyadıdır. |
|
url
|
avatar.original.url | string |
Bu, yazar avatar resmi özgün URL'sidir. |
|
width
|
avatar.original.width | integer |
Bu, yazar avatar resmi özgün genişliğidir. |
|
height
|
avatar.original.height | integer |
Bu, yazar avatar resmi özgün yüksekliğidir. |
|
size
|
avatar.original.size | integer |
Bu, yazar avatar görüntüsü özgün sie'dir (bayt cinsinden). |
|
format
|
avatar.original.format | string |
Bu, yazar avatarı özgün biçimidir. |
|
MIME türü
|
avatar.original.mimeType | string |
Bu, athor avatar görüntüsü özgün mimeType'tır. |
|
Oluşturulan
|
avatar.original.created | string |
Bu, özgün oluşturma tarihi olan yazar avatarıdır. |
|
url
|
avatar.icon.url | string |
Bu, yazar avatar simgesi URL'sidir. |
|
width
|
avatar.icon.width | integer |
Bu, yazar avatar simgesi genişliğidir. |
|
height
|
avatar.icon.height | integer |
Bu, yazar avatar simgesi yüksekliğidir. |
|
format
|
avatar.icon.format | string |
Bu, yazar avatar simgesi biçimidir. |
|
MIME türü
|
avatar.icon.mimeType | string |
Bu, yazar avatar simgesi mimeType'tır. |
|
url
|
avatar.thumb.url | string |
Bu, yazar avatar başparmak URL'sidir. |
|
width
|
avatar.thumb.width | integer |
Bu, yazar avatar başparmak genişliğidir. |
|
height
|
avatar.thumb.height | integer |
Bu, yazar avatar başparmak yüksekliğidir. |
|
format
|
avatar.thumb.format | string |
Bu, yazar avatar başparmak biçimidir. |
|
MIME türü
|
avatar.thumb.mimeType | string |
Bu, athor avatar başparmak mimeType'tır. |
|
publicID
|
avatar.publicID | string |
Bu, yazar avatarı genel kimliğidir. |
imageObject
| Name | Yol | Tür | Description |
|---|---|---|---|
|
url
|
original.url | string |
Bu, görüntünün özgün URL'sidir. |
|
width
|
original.width | integer |
Bu, özgün görüntü genişliğidir. |
|
height
|
original.height | integer |
Bu, görüntünün özgün yüksekliğidir. |
|
size
|
original.size | integer |
Bu, görüntünün özgün boyutudur (bayt cinsinden). |
|
format
|
original.format | string |
Bu, özgün görüntü biçimidir. |
|
MIME türü
|
original.mimeType | string |
Bu, özgün mimeType görüntüsüdür. |
|
url
|
original_scaled.url | string |
Bu, görüntünün özgün URL'sidir. |
|
width
|
original_scaled.width | integer |
Bu, özgün görüntü genişliğidir. |
|
height
|
original_scaled.height | integer |
Bu, görüntünün özgün yüksekliğidir. |
|
format
|
original_scaled.format | string |
Bu, özgün görüntü biçimidir. |
|
MIME türü
|
original_scaled.mimeType | string |
Bu, özgün mimeType görüntüsüdür. |
|
url
|
compact.url | string |
Bu, resim sıkıştırma url'sidir. |
|
width
|
compact.width | integer |
Bu, resmin küçük genişliğidir. |
|
height
|
compact.height | integer |
Bu, görüntünün küçük yüksekliğidir. |
|
format
|
compact.format | string |
Bu, resim sıkıştırma biçimidir. |
|
MIME türü
|
compact.mimeType | string |
Bu, görüntü sıkıştırmalı mimeType'tır. |