Aracılığıyla paylaş


HighQ (Önizleme)

Bu bağlayıcı HighQ API'lerine güvenli ve kimliği doğrulanmış erişim sağlayarak işbirliği ve içerik yönetimi özelliklerinin özel iş akışları ve uygulamalarla sorunsuz bir şekilde tümleştirilmesine olanak tanır. Belge otomasyonunu, veri eşitlemeyi ve iş akışı düzenlemeyi destekler; yasal ve profesyonel hizmet ekiplerini operasyonları kolaylaştırmaya, el ile çalışmayı azaltmaya ve üretkenliği artırmaya teşvik eder.

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 Highq
URL https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
E-posta highq-support@thomsonreuters.com
Bağlayıcı Meta Verileri
Publisher Thomson Reuters Incorporated
Web sitesi https://legal.thomsonreuters.com/en/products/highq
Gizlilik ilkesi https://www.thomsonreuters.com/en/privacy-statement
Kategoriler Işbirliği; İçerik ve Dosyalar

HighQ

Genel Bakış

HighQ, HighQ API'lerine sorunsuz, güvenli, kimliği doğrulanmış erişim sağlar. Bu bağlayıcı ISheet Modülü, Belge Kaynağı API'leri, ISheet Yönetici API'si ve Kullanıcı işlemleri gibi çeşitli HighQ hizmetleriyle sorunsuz etkileşime olanak tanır. iSheet öğelerini alma ve oluşturma, belge dosyalarını yönetme ve kullanıcı hesaplarını yönetme gibi işlevler sunan HighQ Collaborate platformuyla tümleştirmeyi kolaylaştırmak için tasarlanmıştır.

  • Bağlayıcı Sürümü: 1.0.0
  • Başlık: HighQ
  • Açıklama: Bu bağlayıcı, HighQ API'lerine sorunsuz, güvenli ve kimliği doğrulanmış erişim sunar.
  • Temas:
    • Ad: Highq
    • Web Sitesi:HighQ Desteği
    • E-posta:highq-support@thomsonreuters.com

Authentication

Bağlayıcı, güvenli bağlantı için dinamik ortam değişkenlerinden yararlanıyor:

  • Konak: @environmentVariables("highqt_host")
  • Temel Yol: /@environmentVariables("highqt_instancename")/api
  • İstemci Kimliği:@environmentVariables("highqt_clientid")
  • gizli dizi:@environmentVariables("highqt_clientsecret")

Ayrıntılı kimlik doğrulama yordamları için lütfen HighQ Teknik Destek portalına bakın veya HighQ desteğine başvurun.

Bağlayıcı İşlemleri

ISheet Modülü

  • iSheet Öğelerini Alma
    GET /{version}/isheet/{isheetid}/items
    Belirtilen iSheet içindeki öğelerin listesini alır.

  • iSheet Öğeleri Oluşturma
    POST /{version}/isheet/{isheetid}/items
    Birden çok iSheet desteği ve aşamalı anahtarlar aracılığıyla durum izleme desteğiyle bir iSheet'e yeni öğeler ekler.

Belge Kaynağı API'leri

  • Dosya Bilgilerini Alma
    GET /{version}/files/{fileid}
    HighQ Collaborate platformunda belirli bir dosya hakkında ayrıntılı bilgileri alır.

  • Dosyayı Karşıya Yükleme
    POST /{version}/files/content
    Belirtilen bir klasöre dosya yükler ve üst bilgi sağlandığında Content-Range öbeklenmiş karşıya yüklemeleri destekler.

  • Klasör Listesini Al
    GET /{version}/folders/{folderid}/items
    Sıralama ve sayfalandırma desteğiyle belirtilen klasör içindeki klasörlerin listesini alır.

ISheet Admin API

  • iSheet Sütunlarını Alma
    GET /{version}/isheets/admin/{isheetid}/columns
    Belirli bir iSheet için sütun yapılandırmalarını alır.

Kullanıcı İşlemleri

  • Kullanıcıları Alma
    GET /{version}/users
    Filtreleme, sayfalandırma ve ayrıntılı kullanıcı rolleri desteğine sahip kullanıcıların listesini alır.

  • Yeni Kullanıcı Ekle
    POST /{version}/users
    Genişletilmiş öznitelikler ve doğrulama ile yeni bir kullanıcı hesabı oluşturur.

  • Bir Kullanıcıyı Arşivle
    DELETE /{version}/users/{userid}
    Mevcut bir kullanıcıyı sistemden arşivler.

Belge ve Site Yönetimi

  • Klasör Oluşturma
    POST /{version}/folders
    Belirtilen üst klasör altında yeni bir klasör oluşturur.

  • Belgeleri Taşı
    PUT /{version}/files/move
    Bir veya birden çok dosyayı aynı site içindeki bir klasörden diğerine taşır.

  • Site Yönetimi İşlemleri:

    • Mevcut Grubu Siteye Ekle: POST /{version}/sites/{siteid}/groups/{groupid}
    • Site Grubunu Güncelleştir: PUT /{version}/sites/{siteid}/groups/{groupid}
    • Yeni Site Ekle: POST /{version}/sites

Başlangıç Yapmak

  1. Yapılandırma:

    • Ortam değişkenlerini highqt_host ve highqt_instancename Power Platform ortamınızda tanımlama.
  2. Kimlik Doğrulaması:

    • API istekleri için güvenli kimlik doğrulamasını yapılandırmak için HighQ tarafından sağlanan yönergeleri izleyin.
  3. Kullanım:

    • HighQ'yi Power Platform örneğine aktarın.
    • Kullanılabilir işlemleri gerektiği gibi kullanabilirsiniz. Yönergeler için yukarıda verilen işlem özetlerine bakın.

Parametreler ve Ayarlar

  • Yol Parametreleri:
    , , version, isheetidfileidve folderid gibi useridgerekli parametreleri uygun şekilde ekleyin.

  • Sorgu Parametreleri:
    API yanıtlarını iyileştirmek için , sheetviewid, sortcolumnidve limit gibi offsetisteğe bağlı parametreler kullanılabilir.

  • Gövde Parametreleri:
    İstek gövdesi gerektiren işlemler için (örneğin, iSheet öğeleri veya kullanıcıları oluşturma), isteğin tanımlı şemalara (, veya isheetDBOgibiFolderDBOIntegrationUserDBO) uyduğunu denetleyin.

Sorun Giderme ve Sınırlamalar

  • Hata Kodları:
    Standart HTTP durum kodları işlemler arasında kullanılır:

    • 200 başarılı işlemler için
    • 401 yetkisiz erişim için
    • 403 yasak veya doğrulama hataları için
    • 405 geçersiz HTTP yöntemleri için
    • 500 iç sunucu hataları için
      Ayrıntılı hata açıklamaları için lütfen tek tek API belgelerine bakın.
  • Sınırlamalar:
    Bazı uç noktaların varsayılan sınırları (örneğin, varsayılan limit olarak 100 kayıt) olabilir. Büyük veri kümelerini sıralamak ve filtrelemek için ek parametreler gerekebilir.

Ek Kaynaklar

Daha ayrıntılı bilgi ve genişletilmiş belgeler için lütfen aşağıdakilere başvurun:

Lisanslama ve Destek

Lisans ayrıntıları ve teknik destek için:

Azaltma Sınırları

Name Çağrılar Yenileme Dönemi
Bağlantı başına API çağrıları 100 60 saniye

Eylemler

Belgeleri Taşı

Bu API, aynı site içindeki bir klasörden diğerine birden çok dosya taşır.

Dosya bilgilerini alma

Bu API çağrısı, HighQ Collaborate platformundan belirtilen bir dosyanın ayrıntılı bilgilerini alır.

Dosya yükle

Bu API çağrısı, HighQ Collaborate platformunda belirtilen bir klasöre dosya yükler. İçerik Aralığı üst bilgisi sağlandığında öbekli karşıya yüklemeleri destekler.

iSheet sütunlarını alma

Bu API çağrısı, belirtilen iSheet ile ilişkili sütunları alır. Bu işlev API sürüm 3 ve üzerinde desteklenir.

iSheet öğelerinin listesini alma

Bu API çağrısı, belirtilen iSheet içinde yer alan öğelerin listesini alır.

iSheet öğesini oluşturmak için

Bu API çağrısı, iSheet öğesi eklemek için kullanılır. Birden çok iSheet desteklenebilir.

Aşamalı anahtara dayalı bir iSheet öğesinin durumunu almak için API POST /api/3/progressivekeystatus/{progressive_key} çağrısı yapın

Örneğin POST /api/{version}/progressivekeystatus/{progressive_key}

İsimTürüDescription
progressive_keyString Eyleminizin durumunu denetlemek için anahtar.

Yanıt

<progressivekeyresponse>
 \t<öğeleri>
  \t\t<öğesi>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<durumu>BAŞARI</durum>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<ileti>Kaydı başarıyla< eklendi/ileti>
  \t\t</item>
  \t\t<öğesi>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<durumu>BAŞARI</durum>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<ileti>Kaydı başarıyla< eklendi/ileti>
  \t\t</item>
 \t</items>
</progressivekeyresponse>
Klasör bilgilerini alma

yöntemi, verilen klasör kimliğinin klasör ayrıntılarını sağlar.

Klasör listesini alma

Bu API çağrısı, belirtilen klasör içinde yer alan klasörlerin listesini alır. 'limit' parametresi döndürülecek en fazla öğe sayısını ayarlar ve 'offset' parametresi veri alımı için başlangıç konumunu belirtir. Bu parametreler atlanırsa varsayılan değerler uygulanır ve klasörler oluşturma tarihine göre artan sırada döndürülür.

Klasör Oluştur

Bu API, belirtilen site içinde yeni bir klasör oluşturur. Klasör ayrıntılarını sağlamanıza olanak tanır ve klasörün verilen üst klasör altında oluşturulmasını sağlar.

Kullanıcı Ekle

Bu API çağrısı sisteme yeni bir kullanıcı eklemek için kullanılır.
Not:
1. Aşağıdaki yeni alanlar için destek eklendi
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. API sürüm 4'te adres etiketi eklendi


1

Özet Başvuru Kodu (V4'e geçmeden önce) Başvuru Kodu (V4)

E-posta adresi gereklidir

101 101

Geçersiz e-posta adresi

104 104

Ad gereklidir

102 102

Ad için izin verilen karakter sayısı üst sınırı 1 ile 100 arasında olmalıdır

102 352

Sekreterin/asistanın e-posta adresi geçerli değil

104 353

Durum etkin veya etkin değil olmalıdır

116 116

Girilen bölüm 256 karakterden uzun olamaz

Mevcut Değil 354

Girilen ifpartner özniteliği geçersiz

Mevcut Değil 355

Girilen systemuser özniteliği geçersiz

Mevcut Değil 356

Girilen usertypeid özniteliği geçersiz

Mevcut Değil 357

Girilen langcode özniteliği geçersiz

Mevcut Değil 358

Girilen kaynak türü özniteliği geçersiz. Geçerli değerler System, Active Directory veya System default değerleridir.

Mevcut Değil 359

Lütfen geçerli telefon numarasını girin   

Mevcut Değil 360

Lütfen geçerli telefon numarasını {countrycode} ${areacode}  ${number} biçiminde girin.

Mevcut Değil 361

Lütfen geçerli cep telefonu numarasını {countrycode}${number} biçiminde girin.

Mevcut Değil 362

Geçerli bir ofis telefonu ülke kodu girin

Mevcut Değil 363

Ofis telefonu ülke kodu en fazla 4 basamak içerebilir

Mevcut Değil 364

Geçerli bir ofis telefonu alan kodu girin

Mevcut Değil 365

Ofis telefonu alan kodu en fazla 5 Basamak içerebilir

Mevcut Değil 366

Office telefon numarası en fazla 15 basamak içermelidir

Mevcut Değil 368

Geçerli bir cep telefonu ülke kodu girin

Mevcut Değil 369

Cep telefonu ülke kodu en fazla 4 Basamak içerebilir

Mevcut Değil 372

Lütfen geçerli bir cep telefonu numarası girin

Mevcut Değil 373

Cep telefonu numarası en fazla 20 basamaklı olmalıdır

Mevcut Değil 374

Etki alanı yok

105 105

E-posta sistemde zaten var

111 111

Kendi kendine kayıtlı etki alanı söz konusu olduğunda kuruluştan bahsetme   

187 187

Olağanüstü etki alanı söz konusu olduğunda kuruluştan bahsetme   

115 115

Kuruluş kimliği uygun biçimde değil   

112 112

Kuruluş yok

Kategori 106 Kategori 106

Etki alanı başka bir kuruluşta var

114 114

Girilen Adres Kimliği geçerli değil

Mevcut Değil 308

Sosyal bağlantı adı sistemde bulunamadı.

Mevcut Değil 375

Sosyal bağlantı adı gereklidir

Mevcut Değil 376

Sosyal bağlantı değeri gereklidir

Mevcut Değil 377

Sosyal bağlantı değeri için en fazla karakter sayısı 1 ile 500 arasında olmalıdır

Mevcut Değil 378

Özel bağlantının adını girin

Mevcut Değil 379

Gerekli özel bağlantı değeri

Mevcut Değil 380

Özel bağlantı adı için en fazla karakter sayısı 1 ile 500 arasında olmalıdır

Mevcut Değil 381

Özel bağlantı değeri için en fazla karakter sayısı 1 ile 500 arasında olmalıdır

Mevcut Değil 382

gerekli ileti bağlantısı adı

Mevcut Değil 383

İleti bağlantısı adı sistemde bulunamadı

Mevcut Değil 384

Gerekli ileti bağlantısı değeri   

Mevcut Değil 385

İleti bağlantı değeri için en fazla karakter sayısı 1 ile 500 arasında olmalıdır

Mevcut Değil 386

Sosyal bağlantı devre dışı

Mevcut Değil 408

İleti bağlantısı devre dışı

Mevcut Değil 409

Özel bağlantı devre dışı bırakıldı

Mevcut Değil 410

JIRA Bileti: https://dev.highq.com/jira/browse/COL-65685

Kullanıcı listesini alma

Kullanıcı Listesini Alma Bu API, sistemden bir kullanıcı listesi alır. ## Önemli Özellikler - Birden çok filtreleme seçeneğiyle kullanıcı ayrıntılarını getirme - ve limit ile offset sayfalandırmayı destekler - Son sürümlerde tanıtılan yeni sorgu parametreleri ve alanları - Kullanıcı rolleri ve öznitelikleriyle yapılandırılmış yanıt ## Yeni Sorgu Parametreleri (Version-Specific) - V12'de kullanıma sunuldu: - systemAdminSearch: olarak ayarlandığında1, yalnızca Sistem Yöneticisi rolüne sahip kullanıcıları döndürür. - V18'de kullanıma sunulmuştur: - userid: Virgülle ayrılmış değerleri (CSV) kabul eder. ## Yanıt Gövdesi Güncelleştirmeleri - Eklenen yeni alanlar: - emaildomain, org, invitationsentcreatedby, , createddate, modifiedby, modifieddate - ifpartnerlastlogindate, invalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddate, usertypeid, , avatar, practicegroup - langcode, publicprofile# dateOfBirth # Adres Biçimi Değişikliği (V11'den) - location Etiket, tutarlılık için olarak yeniden adlandırıldı.address - Örnek Yanıt: xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address> ## Kullanıcı Rolleri (API V11+'da tanıtıldı) - Örnek Yanıt: xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles> ## Sınırlar & Uzaklıklar - Sınır Davranışı: - Varsayılan: 100 değer sağlanmadıysa. - Tüm kayıtları döndürmek için kullanın -1 . - Değer değerinden -1küçükse, varsayılan olarak olur 100. - Uzaklık Davranışı: - Varsayılan: 0 değer sağlanmadıysa. - Uzaklık toplam kaydı aşarsa, varsayılan olarak değerine geri döner 0. ## Yeni Roller Tanıtıldı - V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Hata Kodları | Özet | Başvuru Kodu (V4'e Geçmeden Önce) | Başvuru Kodu (V4) | |---------|----------------------|--------------| | Kullanıcı durumu için geçersiz giriş (ETKİn, ARŞİV, ETKİn OLMAYAN) | 147 | 147 | | Kuruluş kimliği geçersiz | Yok | 260 | | Geçersiz neverinvited değer (true/false) | Yok | 387 | | Geçersiz neverlogin değer (true/false) | Yok | 388 | | Geçersiz groupids değer | Yok | 214 | | Geçersiz notingroup değer (true/false) | Yok | 389 | | Geçersiz ordertype (desteklenen: ad, kuruluş, durum vb.) | Yok | 289 | | Geçersiz orderby (desteklenen: asc, desc) | Yok | 290 | | Geçersiz offset değer | 138 | 138 | | Geçersiz limit değer | 137 | 137 | ## Notlar - V13'ten itibaren bu API tüm kullanıcılar için açıktır (daha önce Sistem Yöneticileriyle sınırlı). - V18'den itibaren, userregistered2FA alan kullanıcının 2FA'ya kaydolup kaydolmadığını gösterir. --- Bu açıklama Swagger 2.0 şema biçimlendirmesini izler ve Özel Bağlayıcı şemasındaki açıklama alanına yerleştirilmelidir.

Kullanıcıyı Arşivle

Bu API çağrısı, bir kullanıcıyı sistem içinde arşivlemek için kullanılır.

Hata Kodları

Özet Başvuru Kodu (V4'e geçmeden önce) Başvuru Kodu (V4)

Aşağıdaki kullanıcılar sistemde yok

110 110

Kullanıcı Kimliği gereklidir

109 109

Kullanıcı kimliği düzgün biçimde değil

113 113

Kullanıcının Kimlik uzunluğu 50 karakteri aşamaz

Mevcut Değil 304


JIRA Bileti: https://dev.highq.com/jira/browse/COL-67441

Site ekle

Yeni bir site oluşturmak için bu API'yi kullanın. Site nesnesi yalnızca site oluşturma arabiriminde görünen öznitelikleri destekler.

Bu API, yeni bir site oluşturmak için site adı (varsa ASP düzeyinde yapılandırılmış zorunlu alanlar) gerektirir.

"module" etiketi, istek özniteliklerinde gösterildiği gibi sitede yapılandırılan farklı modülü temsil eder.
"sitetemplateid" etiketini geçirerek şablondan site oluşturmak için
     - Sürüm 7'den küçük bir sürüm için, istekte herhangi bir modül verilmezse ("modül" etiketi geçirilmemişse), şablon modülü yapılandırması gerçekleşir. Modül etiketi yapılandırmayla birlikte sağlanırsa, istekte verilen şekilde (şablon modülü yapılandırmasını kullanmak yerine) bu etikete uygun ve yapılandırılır
     - Sürüm 7'den büyük bir sürüm için, istekte herhangi bir modül verilirse ("modül" etiketi geçirilir) veya verilmezse, şablon modülü yapılandırması gerçekleşir.

Bu yöntem bu çağrıda site görüntüsünün karşıya yüklenmesini desteklemez, site simgesi desteği ayrı bir çağrı olarak sağlanacaktır.
Yöntem çağrısı mevcut bir kategori kimliği bekler. Kategori kimliği, arama uygulaması tarafından Site kategorileri arabirimine yapılan önceki bir çağrıyla alınmalıdır. İstekte hiçbir kategori belirtilmemişse, varsayılan olarak hiçbir kategori (gerçek hiçbir kategori değil) eklenmez.

Site başlangıç ve bitiş tarihi 'dd MMM yy' biçiminde olmalı ve UTC DEĞİl olmalıdır. API istemcisi her zaman gerçek tarih isteyecektir.

"giriş sayfası", "dosyalar (kök klasör)" olarak varsayılan değere sahiptir.
"giriş sayfası", Dosya modülü için üç farklı ifade veya tanımlama bekler. Olası değerler şunlardır:
- dosyalar (kök klasör)
- dosyalar (son etkinlikler)
- dosyalar (gelişmiş arama)
Yöntem uygulaması artık (5.1'den itibaren) Çok Dilli site adını destekliyor. API sürüm 6 veya üzeri <site adı> , kullanıcı tercih sırasına göre istek gövdesinde temsil eder. API sürüm 5 veya daha eski <site adı> varsayılan birleşik krallık İngilizcesi'lerini temsil eder.
<sitenametranslations> her dildeki site adlarını temsil eder (5.1'den itibaren "Nesnenin kendisi API'sinde" ek etiket olacaktır) API sürüm 6 veya üzeri, istek gövdesinde hem site adı hem <de siteadıtranslations>< gibi her iki etiketi >de gönderiyorlar. Bu durumda, site adının< Kullanıcının dil tercihi açısından ilgili >çeviri< etiketiyle eşleşmesi gerektiği gibi >değerleri doğrulamamız gerekir. API 7 veya üzeri, şablondan oluşturulan site kaynak şablondaki modülleri izler ve istek gövdesinde gönderilen modül listesini yoksayar.

Yöntem uygulaması artık "sitetemplateid" etiketi (eski yaklaşım) sağlayarak şablondan site oluşturmayı destekliyor

Bu API'nin kullanıldığı şablondan site oluşturma desteğinin gelecekte kullanım dışı bırakılacağını lütfen unutmayın. Şablondan site oluşturmak için lütfen uzun bir yoklama API'si olan (uzun süre çalışan istekler için destek olan) şablondan site oluşturma (/sites/templates/{templateid}/site) api'sini kullanın

Bu yöntem, API sürüm 10'un ilerisinde kullanılarak siteye eklenecek birden çok madde numarasını destekler. "matternos" etiketi, salt okunur veya okunmayan birden çok madde numarasını gösterir. Eski sürüm (sürüm 10'dan küçük) tek madde numarası "matterno", sitede var olan birden çok madde numarasının ilk madde sayısını yansıtır.

Sürüm 18'e doğru: bir kategori (site amacı) gereklidir. Site amacı gizliyse, bir ileti görüntülenir; aksi takdirde, gizli site amaçları siteye eklenmez.

Sürüm 17'ye kadar: site sahibi oturum açmış kullanıcıdır; başka kullanıcı eklenemez.

Sürüm 18'e doğru: Site sahibi siteye başka kullanıcılar ekleyebilir.

API sürüm 19'dan itibaren giriş modülüyle sıkı bir şekilde birleştirilmiş 'customPages' adlı yeni bir modül kullanıma sunulmuştur. Bu nedenle, giriş modülü değeri True ise customPages true olur ve tersi de geçerlidir.

Site grubunu güncelleştirme

Bu API yöntemi, sitedeki mevcut bir grubun adını güncelleştirir.
Bu API, bir sitedeki mevcut temel kullanıcı grubunun adını güncelleştirmek için genişletilmiştir.

Siteyi güncelleştir

Mevcut bir sitenin ayrıntılarını güncelleştirmek için bu API uç noktasını kullanın. API, Site API'sini oluşturma bölümünde kullanılan alanları destekler.

Bu yöntem, API sürüm 10'un ilerisinde kullanılarak siteye eklenecek birden çok madde numarasını destekler. "matternos" etiketi, salt okunur veya okunmayan birden çok madde numarasını gösterir.

Sürüm 18'e doğru: bir kategori (site amacı) gereklidir. Site amacı gizliyse, bir ileti görüntülenir; aksi takdirde, gizli site amaçları siteye eklenmez.

Artık site sahibine başka kullanıcılar da atanabilir, ancak site katılımcıları olmaları ve site yöneticisinden daha yüksek bir role sahip olmaları gerekir.

Sürüm 18'e doğru: Site sahibi siteye başka kullanıcılar ekleyebilir.

API sürüm 19'dan itibaren customPages adlı, giriş modülüyle sıkı bir şekilde birleştirilmiş yeni bir modül kullanıma sunulmuştur. Giriş modülü değeri True ise customPages değerinin true olması ve tam tersi olması gerekir.

Lütfen site yanıtı alma içindeki tüm özelliklerin/öğelerin güncelleştirilebilir/eklenebilir olmadığını unutmayın. Hangilerinin salt okunur, güncelleştirilebilir veya eklenebilir olduğunu öğrenmek için aşağıdaki tabloya bakın.

Var olan grubu siteye ekleme

Bu API yöntemi siteye mevcut bir sistem grubu ekler.
Bu API, siteye mevcut sistem temel kullanıcı gruplarını (sistem / kuruluş türü) eklemek için genişletilmiştir.

Belgeleri Taşı

Bu API, aynı site içindeki bir klasörden diğerine birden çok dosya taşır.

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

API sürümünü belirtir.

Hedef Klasör Kimliği
targetfolder True string

Dosyaların taşınacağı hedef klasörün benzersiz tanımlayıcısı.

fileidCSV
fileidCSV string

Taşınacak dosya kimliklerinin virgülle ayrılmış listesi.

Dosya bilgilerini alma

Bu API çağrısı, HighQ Collaborate platformundan belirtilen bir dosyanın ayrıntılı bilgilerini alır.

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

Kullanılmakta olan API'nin sürümünü belirtir.

Dosya Kimliği
fileid True string

Dosyanın benzersiz kimliğini belirtir.

En Son DMS Bilgi Bayrağı
lastdmsinfo boolean

Belge Yönetim Sistemi'nden en son bilgilerin alınıp alınmayacağını gösterir.

Klasör Türü
foldertype string

Varsa klasör türünü belirtir.

Dosya Durumu Bilgilerini Ekle
statusinfo boolean

Paylaşılan durum, sık kullanılan durumu, görev sayısı ve beğenilen durum gibi ek dosya durumu bilgilerinin eklenip eklenmeyeceğini gösterir. Varsayılan değer yanlıştır.

E-posta Meta Verilerini Ekle
emailmetadata boolean

Gönderen, alıcılar ve zaman damgaları gibi e-posta meta verilerinin eklenip eklenmeyeceğini gösterir. Varsayılan değer yanlıştır.

Döndürülenler

Dosya yükle

Bu API çağrısı, HighQ Collaborate platformunda belirtilen bir klasöre dosya yükler. İçerik Aralığı üst bilgisi sağlandığında öbekli karşıya yüklemeleri destekler.

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

Kullanılmakta olan API'nin sürümünü belirtir.

Karşıya Yüklenecek Dosya
file True file

Karşıya yüklenecek dosyayı belirtir.

Üst Klasör Kimliği
parentfolderid True string

Dosyanın karşıya yüklendiği üst klasörün benzersiz kimliğini belirtir.

Yinelenen Bayrağı Geçersiz Kıl
overrideduplicate boolean

Yinelenen dosya yüklemelerinin geçersiz kılınıp kılınmayacağını gösterir.

Belge Adı
filename True string

Belgenin adını belirtir.

Sürüm Notu
versionnote string

Dosyanın sürümünü açıklayan bir not sağlar.

Aşamalı İşlem Anahtarı
progressiveoperkey string

Dosya karşıya yükleme sırasında aşamalı işlemler için kullanılan anahtarı belirtir.

DMS Veritabanı Adı
dmsdatabasename string

Belge Yönetim Sistemi veritabanının adını belirtir.

DMS Düzenleme Tarihi
dmseditdate string

Belge Yönetim Sistemi'ne kaydedilen düzenleme tarihini belirtir.

DMS Üst Klasör Kimliği
dmsparentfolderid string

Belge Yönetim Sistemi'ndeki üst klasörün benzersiz kimliğini belirtir.

DMS Belge Kimliği
dmsdocid string

Belge Yönetim Sistemi'nde belgenin benzersiz kimliğini belirtir.

DMS Belge Sürümü
dmsversion string

Belge Yönetim Sistemi'ne kaydedilen belgenin sürümünü belirtir.

Bildirim Ayrıntıları
notification string

Dosya karşıya yüklendikten sonra gönderilecek bildirimlerle ilgili ayrıntıları sağlar.

Toplu İş Kimliği
batchid string

Toplu işlemin benzersiz kimliğini belirtir.

Kök Klasör Kimliği
rootfolderid string

Kök klasörün benzersiz kimliğini belirtir.

iSheet sütunlarını alma

Bu API çağrısı, belirtilen iSheet ile ilişkili sütunları alır. Bu işlev API sürüm 3 ve üzerinde desteklenir.

Parametreler

Name Anahtar Gerekli Tür Description
iSheet Id
isheetid True integer

Sütunların gerekli olduğu iSheet'in benzersiz kimliğini belirtir.

API Sürümü
version True string

Kullanılmakta olan API'nin sürümünü belirtir.

iSheet Görünüm Kimliği
sheetviewid string

iSheet görünümünün kimliğini belirtir. Atlanırsa, tüm sütunlar döndürülür.

Silinen iSheet Sütunlarını Ekle
onlyForDeletedIsheet boolean

Silinen bir iSheet'ten sütunların eklenip eklenmeyeceğini gösterir. Varsayılan değer yanlıştır.

Döndürülenler

Body
columns

iSheet öğelerinin listesini alma

Bu API çağrısı, belirtilen iSheet içinde yer alan öğelerin listesini alır.

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

Kullanılmakta olan API'nin sürümünü belirtir.

iSheet Id
isheetid True integer

iSheet'in benzersiz kimliğini belirtir.

iSheet Görünüm Kimliği
sheetviewid integer

iSheet görünümünün kimliğini belirtir. Atlanırsa, varsayılan görünüm döndürülür.

Sütun Kimliğini Sırala
sortcolumnid integer

Sonuçları sıralamak için kullanılan sütunun kimliğini belirtir.

Sıralama Düzeni
sortorder integer

Sıralama düzenini belirtir. Örneğin artan düzen için 0 veya azalan düzen için başka bir değer kullanın.

Kayıt Sınırı
limit integer

Döndürülecek en fazla kayıt sayısını belirtir; belirtilmezse varsayılan değer 100'dür.

Kayıt Uzaklığı
offset integer

Kayıt alma işleminin başlangıç konumunu belirtir; belirtilmezse varsayılan değer 0'dır.

Tüm Sütunları Ekle
allColumnRequired boolean

Geçerli görünümden bağımsız olarak tüm sütun verilerinin dahil edilip edilmeyeceğini gösteren bayrak.

Görünüm Kısıtlamalarını Yoksay
isIgnoreView boolean

Öğe verileri alınırken görünüm kısıtlamalarının yoksayılıp yoksayılmayacağını gösteren bayrak.

Döndürülenler

Name Yol Tür Description
isheet
isheet array of object

iSheet öğelerinin listesi.

öğeKimliği
isheet.itemId string

Öğenin benzersiz kimliği.

veriler
isheet.data array of object

Öğenin ayrıntılı verileri.

sıra
isheet.data.sequence string

Verilerle ilişkili sıra numarası.

columnDisplayName
isheet.data.columnDisplayName string

Sütunun görünen adı.

value
isheet.data.value string

Sütunda yer alan değer.

iSheet öğesini oluşturmak için

Bu API çağrısı, iSheet öğesi eklemek için kullanılır. Birden çok iSheet desteklenebilir.

Aşamalı anahtara dayalı bir iSheet öğesinin durumunu almak için API POST /api/3/progressivekeystatus/{progressive_key} çağrısı yapın

Örneğin POST /api/{version}/progressivekeystatus/{progressive_key}

İsimTürüDescription
progressive_keyString Eyleminizin durumunu denetlemek için anahtar.

Yanıt

<progressivekeyresponse>
 \t<öğeleri>
  \t\t<öğesi>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<durumu>BAŞARI</durum>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<ileti>Kaydı başarıyla< eklendi/ileti>
  \t\t</item>
  \t\t<öğesi>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<durumu>BAŞARI</durum>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<ileti>Kaydı başarıyla< eklendi/ileti>
  \t\t</item>
 \t</items>
</progressivekeyresponse>

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

API'nin sürümü

iSheet Tanımlayıcısı
isheetid True integer

iSheet kimliği

Sayfa Görünümü Tanımlayıcısı
sheetviewid integer

iSheet görünümünün kimliği (İsteğe bağlı)

kimlik
id integer

Isheet tanımlayıcısı.

title
title string

Sayfanın başlığı.

açıklama
description string

Sayfanın açıklaması.

statü
status string

Sayfanın durumu.

accesstype
accesstype string

Sayfanın erişim türü.

type
type string

Sayfanın türü.

görünüm bağlantısı
viewlink string

Sayfayı görüntülemek için URL bağlantısı.

allowsections
allowsections string

Bölümlere izin verilip verilmediğini gösterir.

allowlookup
allowlookup string

Aramaya izin verilip izin verilmediğini gösterir.

displayisheet
displayisheet string

Görüntü sayfası.

searchasdefaultview
searchasdefaultview string

Aramayı varsayılan görünüm olarak ayarlar.

enableversion
enableversion string

Sürümü Etkinleştir'i seçin.

enablesheetalerter
enablesheetalerter string

Sayfa uyarılayıcıyı etkinleştirir.

alertercondition
alertercondition string

Uyarıları tetikleme koşulu.

overrideitemmodifieddate
overrideitemmodifieddate string

Over ride öğenin değiştirilme tarihidir.

enablebulkinsertupdate
enablebulkinsertupdate string

Toplu ekleme güncelleştirmesine izin ver.

fielddescriptions
fielddescriptions string

alanlar için açıklama.

enablerowlocking
enablerowlocking string

Satır kilitlemeyi etkinleştirir.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

Çok satırlı metin için karakter sınırı kesilmesini etkinleştirir.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

kesme için karakter sınırını ayarlar.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

Seçim listesi değerlerinin yeniden kullanılmasına izin verir.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

Puan listesi değerlerinin yeniden kullanılmasına izin verir.

allowIsheetComments
allowIsheetComments string

Sayfadaki açıklamalara izin verir.

shareRecordsLimit
shareRecordsLimit integer

Paylaşılan kayıtlarda sınır.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

Paylaşım kaydı sınırını etkinleştirin.

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

Kayıt ekleme formunun paylaşımını etkinleştirir.

allowViewBaseRendering
allowViewBaseRendering string

Görünümlerin temel işlenmesine izin verir.

sütun
column object
kayıt sayısı
recordcount string

Toplam kayıt sayısı.

viewId
viewId integer

Görünümün benzersiz tanımlayıcısı.

siteId
siteId integer

İlişkili sitenin tanımlayıcısı.

siteAdı
siteName string

Sitenin adı.

sheetName
sheetName string

Sayfanın adı.

viewName
viewName string

Görünümün adı.

sheetId
sheetId integer

Sayfanın tanımlayıcısı.

sıra
sequence string

Üst bilgi sütununun sıra numarası.

columnValue
columnValue string

Üst bilgi sütununun değeri.

columnTypeId
columnTypeId string

Sütun türünün tanımlayıcısı.

columnId
columnId string

Sütunun benzersiz tanımlayıcısı.

columnTypeAlias
columnTypeAlias string

Sütun türü için diğer ad.

itemsequence
itemsequence string

Öğenin sıra numarası.

itemid
itemid string

Öğenin benzersiz tanımlayıcısı.

externalid
externalid string

Öğeyle ilişkili dış tanımlayıcı.

columnid
columnid integer

Sütun için benzersiz tanımlayıcı

name
name string

Sütunun adı

type
type integer

Sütunun veri türü.

systemgeneratedtype
systemgeneratedtype string

Sistem tarafından oluşturulan tür bilgileri.

section
section integer

Sütunun bulunduğu bölüm numarası.

açıklama
description string

Sütunun ayrıntılı açıklaması.

addtodefaultview
addtodefaultview string

Sütunun varsayılan görünüme eklenip eklenmediğini gösterir.

columnconditionstate
columnconditionstate string

Sütunun koşulunun durumu.

satır kimliği
rowid integer

Satırın tanımlayıcısı.

columnid
columnid integer

Sütunun tanımlayıcısı.

operatorid
operatorid integer

İşlecin tanımlayıcısı.

oprand
oprand string

Filtrenin işlenen değeri.

mantıksal tür
logicaltype string

Filtrenin mantıksal türü.

sheetfiltervaluetypeid
sheetfiltervaluetypeid string

Sayfa filtresi değer türünün kimliği.

displaytype
displaytype string

Filtrenin görüntüleme türü.

sourceColumnId
sourceColumnId integer

Filtrenin kaynak sütun kimliği.

scoreConditionTypeid
scoreConditionTypeid integer

Puan koşulu türünün kimliği.

defaultvalue
defaultvalue string

Sütun için varsayılan değer.

columnwidth
columnwidth string

Sütunun genişliği.

sayfa adı
sheetname string

İlişkili sayfanın adı.

sitename
sitename string

Sitenin adı.

zorunlu
mandatory string

Sütunun zorunlu olup olmadığını gösterir.

allowsearch
allowsearch string

Aramaya izin verilip verilmediğini belirtir.

maxchars
maxchars integer

Karakter sayısı üst sınırı.

allowfieldfromanotherisheet
allowfieldfromanotherisheet string

Başka bir sayfadan alana izin verir.

allowrichhtmltext
allowrichhtmltext string

Zengin HTML metnine izin verilip verilmediğini belirtir.

numberoflines
numberoflines integer

Sütundaki satır sayısı.

displaymethod
displaymethod string

Sütunu görüntülemek için kullanılan yöntem.

includeotheroption
includeotheroption string

Bir 'Diğer' seçeneği içerir.

singleormultileselectioninsearch
singleormultileselectioninsearch string

Aramada seçim türünü belirtir.

kimlik
id string

Seçim için benzersiz tanımlayıcı."

label
label string

Seçimin etiketi.

Puan
score string

Seçimle ilişkili puan.

color
color string

Seçim için renk kodu.

imageid
imageid integer

İlişkili görüntünün kimliği.

includeinalertpreferences
includeinalertpreferences string

Uyarı tercihlerine ekler.

min
min string

Sütun için en düşük değer.

max
max string

Sütun için en büyük değer.

ondalık basamaklar
decimalplaces integer

Ondalık basamak sayısı.

showthousandseparators
showthousandseparators string

Binlik ayırıcıları görüntüler.

showaspercentage
showaspercentage string

Değeri yüzde olarak görüntüler.

biçim türü
formattype string

Sütunun biçim türünü belirtir.

tarih biçimi
dateformat string

Sütunun tarih biçimini tanımlar.

defaultdateandtime
defaultdateandtime string

Sütun için varsayılan tarih ve saat değerini ayarlar.

sheetlookup
sheetlookup string

Sütunun başka bir sayfaya yapılan bir arama olup olmadığını gösterir.

fielddisplay
fielddisplay string

Alanın nasıl görüntüleneceğini belirler.

allowmultipleusers
allowmultipleusers string

Alana birden çok kullanıcının erişip erişemediğini belirtir.

methodtype
methodtype string

Sütun için yöntem türünü tanımlar.

sheetids
sheetids string

Sütunla ilişkili sayfaların kimliklerini listeler.

allowuserstorenamelinks
allowuserstorenamelinks string

Kullanıcıların sütundaki bağlantıları yeniden adlandırabileceğini gösterir.

sayfa kimliği
sheetid integer

Sayfanın kimliğini belirtir.

columnids
columnids string

Sütunların kimliklerini listeler.

viewid
viewid integer

Görünümün kimliğini belirtir.

allowmultiplevalues
allowmultiplevalues string

Sütunda birden çok değere izin verilip verilmediğini gösterir.

restrictdelete
restrictdelete string

Silme işleminin sütun için kısıtlanmış olup olmadığını belirtir.

displaycolumnnameprefix
displaycolumnnameprefix string

Sütun adı görünümünün ön ekini ayarlar.

bağlantı adı
linkname string

Sütunla ilişkili bağlantının adını tanımlar.

donotcountweekendsonlycountmontofri
donotcountweekendsonlycountmontofri string

Hafta sonlarının saymada dışlandığını belirtir.

currentsheetcolumnid
currentsheetcolumnid integer

Geçerli sayfa sütununun kimliği.

targetsheetcolumnid
targetsheetcolumnid integer

Hedef sayfa sütununun kimliği.

formül
formula string

Sütuna uygulanan formülü belirtir.

startvalue
startvalue integer

Sütun için başlangıç değerini ayarlar.

prefix
prefix string

Sütun değerleri için ön eki tanımlar.

Sonek
postfix string

Sütun değerleri için son eki tanımlar.

minlength
minlength integer

Sütun değerlerinin en düşük uzunluğunu belirtir.

lookupglossarysheetid
lookupglossarysheetid integer

Arama sözlüğü sayfasının kimliğini belirtir.

lookupglossarysheetviewid
lookupglossarysheetviewid integer

Arama sözlüğü sayfasının görünüm kimliğini belirtir.

width
width integer

Sütunun genişliğini ayarlar.

otherscorevalue
otherscorevalue string

Sütun için diğer puan değerini tanımlar.

importdatafromexternalsource
importdatafromexternalsource string

Verilerin bir dış kaynaktan içeri aktarılıp aktarılamadığını gösterir.

analysisengine
analysisengine string

Sütun için kullanılan çözümleme altyapısını belirtir.

attachmentcustomfolderid
attachmentcustomfolderid integer

Ekler için özel klasör kimliğini belirtir.

isattachmentfoldercurrentsite
isattachmentfoldercurrentsite integer

Ek klasörünün geçerli sitede olup olmadığını gösterir.

singleLineEmailValidation
singleLineEmailValidation string

Tek satırlı e-posta doğrulamasının uygulanacağını belirtir.

salt okunur
readonly string

Sütunun salt okunur olup olmadığını gösterir.

virtualColumn
virtualColumn integer

Sütunun sanal olup olmadığını belirtir.

allowInlineEditing
allowInlineEditing string

Sütun için satır içi düzenlemeye izin verilip verilmediğini gösterir.

sıra
sequence string

Sütunun sıra numarası.

attributecolumnid
attributecolumnid string

Öznitelik sütun tanımlayıcısı.

value
value string

Ham verilerin değeri.

date
date string

ham verilerin tarihi.

time
time string

Ham verilerin zamanı.

linkdisplayname
linkdisplayname string

Bağlantı adını görüntüle.

linkdisplayurl
linkdisplayurl string

URL bağlantısını görüntüle.

kimlik
id string

Arama Kimliği

e-posta
email string

E-posta adresi.

userlookuptype
userlookuptype string

Kullanıcı arama türü.

folderid
folderid string

Klasör Kimliği.

docid
docid string

Belge Kimliği.

başlangıç tarihi
fromdate string

Başlangıç tarihi.

todate
todate string

Bugüne kadar.

file
file string

Dosya içeriği.

name
name string

Ekin adı.

order
order string

Ekin sırası.

kimlik
id integer

Ek için benzersiz tanımlayıcı.

genişletme
extension string

Dosya uzantısı.

parentfolderid
parentfolderid integer

Üst klasörün kimliği.

dosyahttplink
filehttplink string

Dosyaya erişmek için HTTP bağlantısı.

klasör yolu
folderpath string

Dosyayı içeren klasörün yolu.

klasörhttplink
folderhttplink string

Klasörün HTTP bağlantısı.

filesize
filesize integer

Dosyanın boyutu bayt cinsinden.

redactionStatus
redactionStatus boolean

Dosyanın yeniden işlenip yeniden işlenmediğini gösterir.

displayname
displayname string

Ekin görünen adı.

siteid
siteid integer

Ekle ilişkili sitenin kimliği.

Kayıt Kimliği
recordid string

Kayıt Kimliği.

bağlantı adı
linkname string

Bağlantı adı.

apilink
apilink string

API Bağlantısı.

httplink
httplink string

HTTP Bağlantısı.

colViewPosition
colViewPosition integer

Sütunun görünümdeki konumu.

columntype
columntype string

Sütunun türü.

oluşturulmaTarihi
createdDate date-time

Sütunun oluşturulduğu tarih ve saat.

modifiedDate
modifiedDate date-time

Sütunun en son değiştirildiği tarih ve saat.

injectReferenceColumn
injectReferenceColumn integer

Eklenen sütuna başvuru

parentColumnID
parentColumnID integer

Üst sütunun tanımlayıcısı.

reusecolumnidfromisheet
reusecolumnidfromisheet integer

Giriş sayfasından yeniden kullanılan sütun kimliği.

choicelistid
choicelistid integer

Sütunla ilişkili seçim listesinin tanımlayıcısı.

alerteroption
alerteroption string

Öğe için uyarı seçeneği ayarı.

sheettypeid
sheettypeid integer

Sayfa türünün tanımlayıcısı.

enableSmartForm
enableSmartForm string

Akıllı form özelliklerini etkinleştirir.

allowDeletedItemsView
allowDeletedItemsView string

Silinen öğelerin görüntülenmesine izin verir.

allowAllColumnsInCustomView
allowAllColumnsInCustomView string

Özel görünümlerdeki tüm sütunlara izin verir.

Döndürülenler

Klasör bilgilerini alma

yöntemi, verilen klasör kimliğinin klasör ayrıntılarını sağlar.

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

api sürümü

Klasör Kimliği
folderid True string

folderID

Durum Bilgileri
statusinfo boolean

statusinfo parametresi, klasör hakkında ek bilgilere erişmenizi sağlar. Mevcut bilgiler Arasında Paylaşılan Durum, Oturum açmış kullanıcının Sık Kullanılan Durumu

Döndürülenler

Klasör listesini alma

Bu API çağrısı, belirtilen klasör içinde yer alan klasörlerin listesini alır. 'limit' parametresi döndürülecek en fazla öğe sayısını ayarlar ve 'offset' parametresi veri alımı için başlangıç konumunu belirtir. Bu parametreler atlanırsa varsayılan değerler uygulanır ve klasörler oluşturma tarihine göre artan sırada döndürülür.

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

Kullanılmakta olan API'nin sürümünü belirtir.

Klasör Kimliği
folderid True string

Klasörün benzersiz kimliğini belirtir.

Öğe Sınırı
limit string

Döndürülecek en fazla öğe sayısını belirtir.

Öğe Uzaklığı
offset string

Döndürülen öğelerin başlangıç konumunu belirtir.

Sıralama Düzeni Yönü
orderby string

Öğeleri sıralamak için sıra yönünü belirtir. Artan düzen için 'asc' veya azalan düzen için 'desc' kullanın.

Sıralama Ölçütü
ordertype string

Ad, yazar veya son değiştirme tarihi gibi öğeleri sıralama ölçütlerini belirtir.

Klasör Durum Bilgilerini Ekle
statusinfo boolean

Ek klasör durum bilgilerinin eklenip eklenmeyeceğini gösterir. Varsayılan değer yanlıştır.

Akıllı Klasörleri Dahil Et
includesmartfolder boolean

Akıllı klasörlerin döndürülen listeye eklenip eklenmeyeceğini gösterir. Varsayılan değer yanlıştır.

Döndürülenler

Name Yol Tür Description
folder
folder array of object
items
folder object

Klasör Oluştur

Bu API, belirtilen site içinde yeni bir klasör oluşturur. Klasör ayrıntılarını sağlamanıza olanak tanır ve klasörün verilen üst klasör altında oluşturulmasını sağlar.

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

API sürümünü belirtir.

Toplu İş Tanımlayıcısı
batchid string

Toplu işlem için benzersiz bir tanımlayıcı.

Kök Klasör Kimliği
rootfolderid string

Kök klasörün benzersiz tanımlayıcısı.

Üst Klasör Kimliği
parentfolderid True string

Yeni klasörün oluşturulacağı üst klasörün benzersiz tanımlayıcısı.

Yinelenen Klasöre İzin Ver
allowduplicatefolder boolean

Belirtilen üst klasörde yinelenen klasörlere izin verilip verilmeyeceğini gösterir.

name
name True string

Klasörün adı.

açıklama
description string

Klasörün açıklaması.

accessInherited
accessInherited integer

Klasör erişiminin devralınmış olup olmadığını gösterir.

batchID
batchID string

İşlemin toplu iş tanımlayıcısı.

dmsfolderid
dmsfolderid string

DMS klasör tanımlayıcısı.

dmsParentFolderID
dmsParentFolderID string

DMS üst klasör tanımlayıcısı.

dmscreateddate
dmscreateddate date-time

DMS klasörünün oluşturulduğu tarih.

dmsmodifiedBy
dmsmodifiedBy string

DMS klasörünü son değiştiren kullanıcı.

dmsdatabasename
dmsdatabasename string

DMS veritabanının adı.

dmslink
dmslink boolean

DMS bağlantısının kullanılabilir olup olmadığını gösterir.

dmslinkby
dmslinkby string

DMS klasörünü ilişkilendiren kullanıcı.

emailmetadata
emailmetadata string

Klasörle ilişkilendirilmiş e-posta meta verileri.

Döndürülenler

Kullanıcı Ekle

Bu API çağrısı sisteme yeni bir kullanıcı eklemek için kullanılır.
Not:
1. Aşağıdaki yeni alanlar için destek eklendi
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. API sürüm 4'te adres etiketi eklendi


1

Özet Başvuru Kodu (V4'e geçmeden önce) Başvuru Kodu (V4)

E-posta adresi gereklidir

101 101

Geçersiz e-posta adresi

104 104

Ad gereklidir

102 102

Ad için izin verilen karakter sayısı üst sınırı 1 ile 100 arasında olmalıdır

102 352

Sekreterin/asistanın e-posta adresi geçerli değil

104 353

Durum etkin veya etkin değil olmalıdır

116 116

Girilen bölüm 256 karakterden uzun olamaz

Mevcut Değil 354

Girilen ifpartner özniteliği geçersiz

Mevcut Değil 355

Girilen systemuser özniteliği geçersiz

Mevcut Değil 356

Girilen usertypeid özniteliği geçersiz

Mevcut Değil 357

Girilen langcode özniteliği geçersiz

Mevcut Değil 358

Girilen kaynak türü özniteliği geçersiz. Geçerli değerler System, Active Directory veya System default değerleridir.

Mevcut Değil 359

Lütfen geçerli telefon numarasını girin   

Mevcut Değil 360

Lütfen geçerli telefon numarasını {countrycode} ${areacode}  ${number} biçiminde girin.

Mevcut Değil 361

Lütfen geçerli cep telefonu numarasını {countrycode}${number} biçiminde girin.

Mevcut Değil 362

Geçerli bir ofis telefonu ülke kodu girin

Mevcut Değil 363

Ofis telefonu ülke kodu en fazla 4 basamak içerebilir

Mevcut Değil 364

Geçerli bir ofis telefonu alan kodu girin

Mevcut Değil 365

Ofis telefonu alan kodu en fazla 5 Basamak içerebilir

Mevcut Değil 366

Office telefon numarası en fazla 15 basamak içermelidir

Mevcut Değil 368

Geçerli bir cep telefonu ülke kodu girin

Mevcut Değil 369

Cep telefonu ülke kodu en fazla 4 Basamak içerebilir

Mevcut Değil 372

Lütfen geçerli bir cep telefonu numarası girin

Mevcut Değil 373

Cep telefonu numarası en fazla 20 basamaklı olmalıdır

Mevcut Değil 374

Etki alanı yok

105 105

E-posta sistemde zaten var

111 111

Kendi kendine kayıtlı etki alanı söz konusu olduğunda kuruluştan bahsetme   

187 187

Olağanüstü etki alanı söz konusu olduğunda kuruluştan bahsetme   

115 115

Kuruluş kimliği uygun biçimde değil   

112 112

Kuruluş yok

Kategori 106 Kategori 106

Etki alanı başka bir kuruluşta var

114 114

Girilen Adres Kimliği geçerli değil

Mevcut Değil 308

Sosyal bağlantı adı sistemde bulunamadı.

Mevcut Değil 375

Sosyal bağlantı adı gereklidir

Mevcut Değil 376

Sosyal bağlantı değeri gereklidir

Mevcut Değil 377

Sosyal bağlantı değeri için en fazla karakter sayısı 1 ile 500 arasında olmalıdır

Mevcut Değil 378

Özel bağlantının adını girin

Mevcut Değil 379

Gerekli özel bağlantı değeri

Mevcut Değil 380

Özel bağlantı adı için en fazla karakter sayısı 1 ile 500 arasında olmalıdır

Mevcut Değil 381

Özel bağlantı değeri için en fazla karakter sayısı 1 ile 500 arasında olmalıdır

Mevcut Değil 382

gerekli ileti bağlantısı adı

Mevcut Değil 383

İleti bağlantısı adı sistemde bulunamadı

Mevcut Değil 384

Gerekli ileti bağlantısı değeri   

Mevcut Değil 385

İleti bağlantı değeri için en fazla karakter sayısı 1 ile 500 arasında olmalıdır

Mevcut Değil 386

Sosyal bağlantı devre dışı

Mevcut Değil 408

İleti bağlantısı devre dışı

Mevcut Değil 409

Özel bağlantı devre dışı bırakıldı

Mevcut Değil 410

JIRA Bileti: https://dev.highq.com/jira/browse/COL-65685

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

api sürümü

index
index integer

Kullanıcı için benzersiz dizin.

kullanıcı kimliği
userid integer

Kullanıcının benzersiz tanımlayıcısı.

isim
firstname string

Kullanıcının adı.

soyadı
lastname string

Kullanıcının soyadı.

practicegroup
practicegroup string

Kullanıcının ait olduğu alıştırma grubu.

langcode
langcode string

Kullanıcının dil kodu.

localeID
localeID string

Kullanıcının yerel ayar kimliği.

publicprofile
publicprofile string

Kullanıcının genel profili.

pwpid
pwpid string

Kullanıcının PWP kimliği.

usertypeid
usertypeid string

Kullanıcı türü kimliği.

systemuser
systemuser string

Sistem kullanıcı bayrağı.

e-posta
email string

Kullanıcının e-posta adresi.

phone
phone string

Kullanıcının telefon numarası.

mobile
mobile string

Kullanıcının cep telefonu numarası.

bölüm
department string

Kullanıcının bölümü.

Org
org string

Kullanıcının ait olduğu kuruluş.

adres çizgisi1
addressline1 string

Adresin ilk satırı.

adres çizgisi2
addressline2 string

Adresin ikinci satırı.

adres çizgisi3
addressline3 string

Adresin üçüncü satırı.

city
city string

Adresin bulunduğu şehir.

state
state string

Adresin durumu.

country
country string

Adresin ülkesi.

posta kodu
postcode string

Adresin posta kodu.

addressid
addressid string

Adresin benzersiz tanımlayıcısı.

adres çizgisi1
addressline1 string

Adresin ilk satırı.

adres çizgisi2
addressline2 string

Adresin ikinci satırı.

adres çizgisi3
addressline3 string

Adresin üçüncü satırı.

city
city string

Adresin bulunduğu şehir.

state
state string

Adresin durumu.

country
country string

Adresin ülkesi.

postCode
postCode string

Adresin posta kodu.

knownas
knownas string

Adres için alternatif ad veya takma ad.

deneyim
experience array of string
kimlik
id string

Bağlantı Kimliği

name
name string

Bağlantı Adı.

value
value string

Bağlantı Değeri.

kimlik
id string

Bağlantı Kimliği

name
name string

Bağlantı Adı.

value
value string

Bağlantı Değeri.

kimlik
id string

Bağlantı Kimliği

name
name string

Bağlantı Adı.

value
value string

Bağlantı Değeri.

img
img string
raporlara
reportsto string
metadataname
metadataname array of string
meta veri değeri
metadatavalue array of string
group
group array of string
externalid
externalid string

Kullanıcının dış kimliği.

iş başlığı
jobtitle string

Kullanıcının iş unvanı.

secretaryname
secretaryname string

Kullanıcının sekreterinin adı.

sekretermail
secretarymail string

Kullanıcının sekreterinin e-posta adresi.

Spesiyalite
specialities string

Kullanıcının uzmanlıkları.

title
title string

Kullanıcının başlığı.

goesby
goesby string

kullanıcının tercih edilen adı.

sonek
suffix string

Kullanıcı adının son eki.

atomlink
atomlink string

Kullanıcıyla ilişkili atom bağlantısı.

Biyo
bio string

Kullanıcının biyografisi.

dateOfBirth
dateOfBirth string

Kullanıcının doğum tarihi.

link
link string

Kullanıcıyla ilişkili bağlantı.

statü
status string

Kullanıcının durumu.

durumkodu
statuscode string

Kullanıcının durum kodu.

message
message string

Kullanıcıyla ilişkilendirilmiş ileti.

sourcetype
sourcetype string

Kullanıcının kaynak türü.

orgid
orgid string

Kuruluş Kimliği.

ifpartner
ifpartner string

İş ortağı bayrağı.

emaildomain
emaildomain string

Kullanıcının e-posta etki alanı.

davetler
invitationsent string

Davet gönderildi bayrağı.

Oluşturan
createdby string

Kaydı oluşturan kullanıcı.

oluşturma tarihi
createddate string

Kaydın oluşturulduğu tarih.

Değiştiren
modifiedby string

Kaydı değiştiren kullanıcı.

değiştirme tarihi
modifieddate string

Kaydın değiştirildiği tarih.

lastlogindate
lastlogindate string

Son oturum açma tarihi.

invalidlogins
invalidlogins string

Geçersiz oturum açma girişimlerinin sayısı.

publicwebsiteprofileid
publicwebsiteprofileid string

Genel web sitesi profil kimliği.

resetpassworddate
resetpassworddate string

Parolanın sıfırlandığı tarih.

avatar
avatar string

Avatar resmi URL'si.

followingcount
followingcount integer

Takip edilen kullanıcıların sayısı.

followercount
followercount integer

Takipçi sayısı.

ertesi
following boolean

İzleyen bayrak.

role
role string

Kullanıcının rolü.

isbasicuser
isbasicuser string

Temel kullanıcı bayrağı.

encryptedUserId
encryptedUserId string

Şifrelenmiş kullanıcı kimliği.

kendi kendine kayıtlı
selfregistered integer

Kendi kendine kaydedilen bayrak.

registeredWith2FA
registeredWith2FA string

İki öğeli kimlik doğrulaması kayıt bayrağı.

isInternal
isInternal integer

İç kullanıcı bayrağı.

orgName
orgName string

Kuruluşun adı.

Döndürülenler

Kullanıcı listesini alma

Kullanıcı Listesini Alma Bu API, sistemden bir kullanıcı listesi alır. ## Önemli Özellikler - Birden çok filtreleme seçeneğiyle kullanıcı ayrıntılarını getirme - ve limit ile offset sayfalandırmayı destekler - Son sürümlerde tanıtılan yeni sorgu parametreleri ve alanları - Kullanıcı rolleri ve öznitelikleriyle yapılandırılmış yanıt ## Yeni Sorgu Parametreleri (Version-Specific) - V12'de kullanıma sunuldu: - systemAdminSearch: olarak ayarlandığında1, yalnızca Sistem Yöneticisi rolüne sahip kullanıcıları döndürür. - V18'de kullanıma sunulmuştur: - userid: Virgülle ayrılmış değerleri (CSV) kabul eder. ## Yanıt Gövdesi Güncelleştirmeleri - Eklenen yeni alanlar: - emaildomain, org, invitationsentcreatedby, , createddate, modifiedby, modifieddate - ifpartnerlastlogindate, invalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddate, usertypeid, , avatar, practicegroup - langcode, publicprofile# dateOfBirth # Adres Biçimi Değişikliği (V11'den) - location Etiket, tutarlılık için olarak yeniden adlandırıldı.address - Örnek Yanıt: xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address> ## Kullanıcı Rolleri (API V11+'da tanıtıldı) - Örnek Yanıt: xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles> ## Sınırlar & Uzaklıklar - Sınır Davranışı: - Varsayılan: 100 değer sağlanmadıysa. - Tüm kayıtları döndürmek için kullanın -1 . - Değer değerinden -1küçükse, varsayılan olarak olur 100. - Uzaklık Davranışı: - Varsayılan: 0 değer sağlanmadıysa. - Uzaklık toplam kaydı aşarsa, varsayılan olarak değerine geri döner 0. ## Yeni Roller Tanıtıldı - V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Hata Kodları | Özet | Başvuru Kodu (V4'e Geçmeden Önce) | Başvuru Kodu (V4) | |---------|----------------------|--------------| | Kullanıcı durumu için geçersiz giriş (ETKİn, ARŞİV, ETKİn OLMAYAN) | 147 | 147 | | Kuruluş kimliği geçersiz | Yok | 260 | | Geçersiz neverinvited değer (true/false) | Yok | 387 | | Geçersiz neverlogin değer (true/false) | Yok | 388 | | Geçersiz groupids değer | Yok | 214 | | Geçersiz notingroup değer (true/false) | Yok | 389 | | Geçersiz ordertype (desteklenen: ad, kuruluş, durum vb.) | Yok | 289 | | Geçersiz orderby (desteklenen: asc, desc) | Yok | 290 | | Geçersiz offset değer | 138 | 138 | | Geçersiz limit değer | 137 | 137 | ## Notlar - V13'ten itibaren bu API tüm kullanıcılar için açıktır (daha önce Sistem Yöneticileriyle sınırlı). - V18'den itibaren, userregistered2FA alan kullanıcının 2FA'ya kaydolup kaydolmadığını gösterir. --- Bu açıklama Swagger 2.0 şema biçimlendirmesini izler ve Özel Bağlayıcı şemasındaki açıklama alanına yerleştirilmelidir.

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

API'nin sürümü.

Kullanıcı Durumu
status string

Kullanıcıları duruma göre filtreleyin: Etkin, Arşivlenmiş, Etkin Değil veya Kilitli.

Sayfalandırma Uzaklığı
offset string

Sayfalandırma için başlangıç konumu.

Sonuç Sınırı
limit string

İstek başına döndürülecek öğe sayısı.

Kuruluş Kimliği
orgid string

Kullanıcıları kuruluş kimliğine göre filtreleyin.

Hiçbir Zaman Davet Edilen Kullanıcılar
neverinvited string

Hiç davet edilmiş kullanıcıları alma.

Hiç Oturum Açmamış Kullanıcılar
neverlogin string

Hiç oturum açmamış kullanıcıları alın.

Kullanıcı kimliği
userid string

Kullanıcıları benzersiz kullanıcı kimliklerine göre filtreleyin.

Grup Kimliği
groupid string

Kullanıcıları grup kimliklerine göre filtreleyin.

Gruplarda Olmayan Kullanıcılar
notingroup string

Herhangi bir grupta yer almayan kullanıcıları alın.

Sıralama Düzeni Türü
ordertype string

Kullanıcıları ad, kuruluş veya durum gibi belirtilen bir alana göre sıralayın.

Sıralama Düzeni
orderby string

Sonuçları artan veya azalan düzende sıralayın.

Dış Kimlik
externalid string

Kullanıcıları dış kimliğine göre filtreleyin.

İlk İsim
firstname string

Kullanıcıları ada göre filtreleyin.

Soyadı
lastname string

Kullanıcıları soyadına göre filtreleyin.

E-posta Adresi
email string

Kullanıcıları e-posta adresine göre filtreleyin.

Kullanıcı Arama
search string

Ad, e-posta ve iş unvanı gibi çeşitli özniteliklere göre kullanıcıları arayın.

Alfabe Filtresi
alphabets string

Soyadı belirli bir harfle başlayan kullanıcıları filtreleyin.

İş unvanı
jobtitle string

Kullanıcıları iş unvanına göre filtreleyin.

Yer
locations string

Kullanıcıları şehre göre filtreleyin.

Departman
departments string

Kullanıcıları departmana göre filtreleyin.

Organizasyon Adı
organisations string

Kullanıcıları kuruluş adına göre filtreleyin.

Spesiyalite
specialities string

Kullanıcıları uzmanlıklarına göre filtreleyin.

Sistem Yöneticisi Araması
systemAdminSearch string

Sistem Yöneticisi rolüne sahip kullanıcıları alma.

Döndürülenler

Body
users

Kullanıcıyı Arşivle

Bu API çağrısı, bir kullanıcıyı sistem içinde arşivlemek için kullanılır.

Hata Kodları

Özet Başvuru Kodu (V4'e geçmeden önce) Başvuru Kodu (V4)

Aşağıdaki kullanıcılar sistemde yok

110 110

Kullanıcı Kimliği gereklidir

109 109

Kullanıcı kimliği düzgün biçimde değil

113 113

Kullanıcının Kimlik uzunluğu 50 karakteri aşamaz

Mevcut Değil 304


JIRA Bileti: https://dev.highq.com/jira/browse/COL-67441

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

api sürümü

Kullanıcı Kimliği
userid True string

kullanıcı kimliği

Site ekle

Yeni bir site oluşturmak için bu API'yi kullanın. Site nesnesi yalnızca site oluşturma arabiriminde görünen öznitelikleri destekler.

Bu API, yeni bir site oluşturmak için site adı (varsa ASP düzeyinde yapılandırılmış zorunlu alanlar) gerektirir.

"module" etiketi, istek özniteliklerinde gösterildiği gibi sitede yapılandırılan farklı modülü temsil eder.
"sitetemplateid" etiketini geçirerek şablondan site oluşturmak için
     - Sürüm 7'den küçük bir sürüm için, istekte herhangi bir modül verilmezse ("modül" etiketi geçirilmemişse), şablon modülü yapılandırması gerçekleşir. Modül etiketi yapılandırmayla birlikte sağlanırsa, istekte verilen şekilde (şablon modülü yapılandırmasını kullanmak yerine) bu etikete uygun ve yapılandırılır
     - Sürüm 7'den büyük bir sürüm için, istekte herhangi bir modül verilirse ("modül" etiketi geçirilir) veya verilmezse, şablon modülü yapılandırması gerçekleşir.

Bu yöntem bu çağrıda site görüntüsünün karşıya yüklenmesini desteklemez, site simgesi desteği ayrı bir çağrı olarak sağlanacaktır.
Yöntem çağrısı mevcut bir kategori kimliği bekler. Kategori kimliği, arama uygulaması tarafından Site kategorileri arabirimine yapılan önceki bir çağrıyla alınmalıdır. İstekte hiçbir kategori belirtilmemişse, varsayılan olarak hiçbir kategori (gerçek hiçbir kategori değil) eklenmez.

Site başlangıç ve bitiş tarihi 'dd MMM yy' biçiminde olmalı ve UTC DEĞİl olmalıdır. API istemcisi her zaman gerçek tarih isteyecektir.

"giriş sayfası", "dosyalar (kök klasör)" olarak varsayılan değere sahiptir.
"giriş sayfası", Dosya modülü için üç farklı ifade veya tanımlama bekler. Olası değerler şunlardır:
- dosyalar (kök klasör)
- dosyalar (son etkinlikler)
- dosyalar (gelişmiş arama)
Yöntem uygulaması artık (5.1'den itibaren) Çok Dilli site adını destekliyor. API sürüm 6 veya üzeri <site adı> , kullanıcı tercih sırasına göre istek gövdesinde temsil eder. API sürüm 5 veya daha eski <site adı> varsayılan birleşik krallık İngilizcesi'lerini temsil eder.
<sitenametranslations> her dildeki site adlarını temsil eder (5.1'den itibaren "Nesnenin kendisi API'sinde" ek etiket olacaktır) API sürüm 6 veya üzeri, istek gövdesinde hem site adı hem <de siteadıtranslations>< gibi her iki etiketi >de gönderiyorlar. Bu durumda, site adının< Kullanıcının dil tercihi açısından ilgili >çeviri< etiketiyle eşleşmesi gerektiği gibi >değerleri doğrulamamız gerekir. API 7 veya üzeri, şablondan oluşturulan site kaynak şablondaki modülleri izler ve istek gövdesinde gönderilen modül listesini yoksayar.

Yöntem uygulaması artık "sitetemplateid" etiketi (eski yaklaşım) sağlayarak şablondan site oluşturmayı destekliyor

Bu API'nin kullanıldığı şablondan site oluşturma desteğinin gelecekte kullanım dışı bırakılacağını lütfen unutmayın. Şablondan site oluşturmak için lütfen uzun bir yoklama API'si olan (uzun süre çalışan istekler için destek olan) şablondan site oluşturma (/sites/templates/{templateid}/site) api'sini kullanın

Bu yöntem, API sürüm 10'un ilerisinde kullanılarak siteye eklenecek birden çok madde numarasını destekler. "matternos" etiketi, salt okunur veya okunmayan birden çok madde numarasını gösterir. Eski sürüm (sürüm 10'dan küçük) tek madde numarası "matterno", sitede var olan birden çok madde numarasının ilk madde sayısını yansıtır.

Sürüm 18'e doğru: bir kategori (site amacı) gereklidir. Site amacı gizliyse, bir ileti görüntülenir; aksi takdirde, gizli site amaçları siteye eklenmez.

Sürüm 17'ye kadar: site sahibi oturum açmış kullanıcıdır; başka kullanıcı eklenemez.

Sürüm 18'e doğru: Site sahibi siteye başka kullanıcılar ekleyebilir.

API sürüm 19'dan itibaren giriş modülüyle sıkı bir şekilde birleştirilmiş 'customPages' adlı yeni bir modül kullanıma sunulmuştur. Bu nedenle, giriş modülü değeri True ise customPages true olur ve tersi de geçerlidir.

Parametreler

Name Anahtar Gerekli Tür Description
İstenen API sürümü
version True string

api sürümü

kimlik
id integer

Site tanımlayıcısı.

sitename
sitename string

Sitenin adı.

role
role string

Sitenin rolü.

sıyrı yazı
sitedescription string

Sitenin açıklaması.

enabledmodules
enabledmodules string

Site için etkinleştirilen modüllerin listesi.

sitefolderID
sitefolderID string

Site klasörünün tanımlayıcısı.

sitefolderpermission
sitefolderpermission string

Site klasörünün izin düzeyi.

enable
enable string

HomeDBO durumunu etkinleştirin.

enable
enable string

ActivityDBO durumunu etkinleştirin.

mikroblog
microblog string

ActivityDBO ile ilişkili mikroblog içeriği.

docid
docid string

Belge Kimliği.

blogTitle
blogTitle string

Blog gönderisinin başlığı.

blogContent
blogContent string

Blog gönderisinin içeriği.

showComment
showComment integer

açıklamayı gösterir.

etiket listesi
tagList array of string

Blogla ilişkilendirilmiş etiketlerin listesi.

statü
status integer

blog gönderisinin durumu.

siteID
siteID integer

İlişkili sitenin tanımlayıcısı.

yazar
author string

Blogun yazarı.

categoryList
categoryList array of string

Blog gönderisine atanan kategoriler.

notificationTypeID
notificationTypeID integer

Bildirim türünün tanımlayıcısı.

message
message string

Blogla ilgili ileti içeriği.

messageCode
messageCode integer

İletiyle ilişkili kod.

hariciKimlik
externalID string

Bloga bağlı dış tanımlayıcı.

yayınlama tarihi
publishDate string

Blogun yayın tarihi.

processtype
processtype string

Blog ile ilişkili işlem türü.

enable
enable string

BlogDBO için durumu etkinleştirin.

wikiid
wikiid integer

Wiki için benzersiz tanımlayıcı.

currentversionid
currentversionid integer

Wiki'nin geçerli sürümünün tanımlayıcısı

parentwikiid
parentwikiid integer

Üst wiki'nin tanımlayıcısı.

wikititle
wikititle string

Wiki'nin başlığı.

wikicontent
wikicontent string

Wiki'nin içeriği.

showcomment
showcomment integer

Açıklamaların etkinleştirilip etkinleştirilmediğini belirtir.

oluşturma tarihi
createddate string

Wiki'nin oluşturulma tarihi.

değiştirme tarihi
modifieddate string

Wiki'nin son değişiklik tarihi.

etiket listesi
taglist string

Wiki ile ilişkili etiketlerin virgülle ayrılmış listesi.

wikipath
wikipath string

Wiki'ye erişim yolu.

wikidraftid
wikidraftid integer

Wiki'nin taslak sürümünün tanımlayıcısı.

taslak türü
drafttype string

Wiki ile ilişkili taslak türü.

statü
status integer

Wiki'nin geçerli durumu.

wikiversionid
wikiversionid integer

Wiki'nin sürüm tanımlayıcısı.

index
index string

Görevin dizini veya tanımlayıcısı.

parenttaskid
parenttaskid integer

Üst görevin tanımlayıcısı.

görev kimliği
taskid integer

Görevin benzersiz tanımlayıcısı.

title
title string

Görevin başlığı.

açıklama
description string

Görevin ayrıntılı açıklaması.

duedate
duedate string

Görevin tamamlanması için son tarih.

başlangıç tarihi
startdate string

Görevin başlatıldığı başlangıç tarihi.

mattermaptaskid
mattermaptaskid string

Madde eşleme görevine bağlanan tanımlayıcı.

type
type string

Görevin türü veya kategorisi.

dependenton
dependenton string

Bu görevin bağlı olduğu görevler.

daysfromdependent
daysfromdependent string

Bağımlı görevdeki gün sayısı.

ignoreweekend
ignoreweekend integer

Hafta sonlarının zamanlamada yoksayılıp yoksayıldığını gösterir.

duration
duration integer

Görevi tamamlama süresi.

resource
resource string

Göreve atanan kaynaklar.

eventTitle
eventTitle string

Olayın başlığı.

eventContent
eventContent string

Olayın içeriği.

showComment
showComment integer

Olay için açıklamaların etkinleştirilip etkinleştirilmediğini belirtir.

etiket listesi
tagList array of string

Olayla ilişkili etiketlerin listesi.

statü
status integer

Olayın geçerli durumu.

siteID
siteID integer

Sitenin tanımlayıcısı.

ilgili kişi
contact string

Olayla ilgili iletişim bilgileri.

categoryList
categoryList array of string

Olayın altında listelendiği kategoriler.

notificationTypeID
notificationTypeID integer

Olayla ilgili bildirim türü.

message
message string

Olayın iletisi.

messageCode
messageCode integer

Olayın ileti kodu.

hariciKimlik
externalID string

Dış Tanımlayıcı.

startDate
startDate string

Olayın başlangıç tarihi.

Bitiş Tarihi
endDate string

Olayın bitiş tarihi.

startTime
startTime string

Olayın başlangıç saati.

endTime
endTime string

Olayın bitiş saati.

location
location string

Olayın konumu.

yazar
author string

Olayın yazarı.

processtype
processtype string

Olayın işlem süresi.

enable
enable string

Olay Etkinleştir'dir.

kimlik
id integer

iSheet için benzersiz tanımlayıcı.

title
title string

iSheet'in başlığı.

açıklama
description string

Isheet'in açıklaması.

statü
status string

Isheet'in durumu.

accesstype
accesstype string

Isheet'in erişim türü.

type
type string

Isheet türü.

görünüm bağlantısı
viewlink string

iSheet'i görüntülemek için bağlantı.

allowsections
allowsections string

Bölümlere izin verilip verilmeyeceği.

allowlookup
allowlookup string

Arama alanlarının etkinleştirilip etkinleştirilmediği.

displayisheet
displayisheet string

iSheet için görüntüleme seçenekleri.

searchasdefaultview
searchasdefaultview string

Aramanın varsayılan görünüm olup olmadığını gösterir.

enableversion
enableversion string

Sürüm oluşturma etkin bayrağı.

enablesheetalerter
enablesheetalerter string

Sayfa uyarılarını etkinleştirmek için bayrak ekleyin.

alertercondition
alertercondition string

Uyarıları tetikleme koşulları.

overrideitemmodifieddate
overrideitemmodifieddate string

Değiştirilen tarih bayrağını geçersiz kıl.

enablebulkinsertupdate
enablebulkinsertupdate string

Toplu ekleme/güncelleştirme özelliğini etkinleştirin.

fielddescriptions
fielddescriptions string

iSheet için alan açıklamaları.

enablerowlocking
enablerowlocking string

Satır düzeyi kilitlemeyi etkinleştirin.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

Çok satırlı metin bayrağını kes.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

Çok satırlı kesme için karakter sınırı.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

Seçim listesi değerlerinin yeniden kullanılmasına izin verin.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

Puan listesi değerlerinin yeniden kullanılmasına izin verin.

allowIsheetComments
allowIsheetComments string

iSheet'te açıklamalara izin ver.

shareRecordsLimit
shareRecordsLimit integer

Paylaşmasına izin verilen kayıtların sınırı.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

Etkin kayıt paylaşım sınırı.

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

Kayıt eklemek için form paylaşımını etkinleştirin.

kayıt sayısı
recordcount string

Geçerli kayıt sayısı.

sheettypeid
sheettypeid integer

iSheet'in Tür Kimliği

enable
enable string

Soru-Cevap işlevini etkinleştirin.

kullanıcı kimliği
userid integer

Kullanıcı kimliği.

e-posta
email string

e-posta adresi.

httpavatar
httpavatar string

Avatarın HTTP URL'si.

avatar
avatar string

Avatar resmi.

userlink
userlink string

Kullanıcı profili bağlantısı.

httplink
httplink string

Kullanıcı profiline HTTP bağlantısı.

phone
phone string

Telefon numarası.

mobile
mobile string

Cep Telefonu Numarası.

bölüm
department string

Kullanıcının departmanı.

enable
enable string

Contract Express tümleştirmesini etkinleştirin.

adminnote
adminnote string

Siteyle ilgili yönetim notları.

başlangıç tarihi
startdate string

Site işleminin başlangıç tarihi.

bitiş tarihi
enddate string

Site işleminin bitiş tarihi.

oluşturma tarihi
createddate string

Sitenin oluşturulduğu tarih.

archiveddate
archiveddate string

Sitenin arşivlendiği tarih.

clientno
clientno string

Siteyle ilişkili istemci numarası.

maddeno
matterno string

Siteyle ilişkili madde numarası.

giriş sayfası
landingpage string

Sitenin giriş sayfası URL'si.

link
link string

Siteyle ilgili bir bağlantı.

statü
status string

Sitenin geçerli durumu.

statusid
statusid integer

Sitenin durumunun tanımlayıcısı.

size
size string

Sitenin boyutu.

faturalama notları
billingnotes string

Sitenin faturalaması ile ilgili notlar.

billingnextinvoicate
billingnextinvoicedate string

Site için sonraki faturanın tarihi.

billinglastinvoicedate
billinglastinvoicedate string

Site için son faturanın tarihi.

filepagecount
filepagecount string

Sitedeki dosyaların toplam sayfa sayısı.

maxpagecount
maxpagecount string

Sitedeki dosyalar için izin verilen sayfa sayısı üst sınırı.

sitehttplink
sitehttplink string

Sitenin HTTP bağlantısı.

isSyncable
isSyncable integer

Sitenin eşitlenebilir olup olmadığını gösterir.

enforceusergroups
enforceusergroups string

Site için zorlanan kullanıcı grupları.

csvSiteCategory
csvSiteCategory string

Sitenin CSV biçimindeki kategorisi.

siteNameInDefaultLanguage
siteNameInDefaultLanguage string

Sitenin varsayılan dildeki adı.

Görünür
visible integer

Sitenin görünür olup olmadığını gösterir.

siteLogoName
siteLogoName string

Sitenin logo dosyasının adı.

siteLogoFileSize
siteLogoFileSize integer

Site logosunun dosya boyutu.

siteLogoHeight
siteLogoHeight integer

Site logosunun yüksekliği.

siteLogoWidth
siteLogoWidth integer

Site logosunun genişliği.

siteStatus
siteStatus integer

Sitenin durum kodu.

applySiteTerms
applySiteTerms integer

Site koşullarının uygulanacağını gösterir.

siteTerm
siteTerm string

Siteye uygulanan koşullar.

termType
termType integer

Siteye uygulanan terim türü.

nextLoginSiteTerms
nextLoginSiteTerms integer

Bir sonraki oturum açmada site koşullarının gerekli olup olmadığını gösterir.

defaultSiteTermsEnable
defaultSiteTermsEnable integer

Varsayılan site terimlerinin etkinleştirilip etkinleştirilmediğini gösterir.

advancedQAPermission
advancedQAPermission integer

Site için gelişmiş Soru-Cevap izin düzeyi.

isInternal
isInternal integer

Sitenin dahili olup olmadığını gösterir.

Psm
psm integer

Product Service Manager tanımlayıcısı.

siteLabelDisplay
siteLabelDisplay string

Sitenin görüntüleme etiketi.

allowSiteAdministration
allowSiteAdministration integer

Site yönetimine izin verilip verilmediğini belirtir.

siteLevelPasswordEnable
siteLevelPasswordEnable integer

Site düzeyinde parola korumasını etkinleştirmek için.

siteLevelPasscodeEnable
siteLevelPasscodeEnable integer

Site düzeyinde geçiş kodu korumasını etkinleştirmek için.

passcodeUsingAuthApp
passcodeUsingAuthApp integer

Geçiş kodu kimlik doğrulamasının bir kimlik doğrulama uygulaması kullanıp kullanmadiğini gösterir.

sitePassword
sitePassword string

Siteyle ilişkilendirilmiş parola.

ipRestrictionEnable
ipRestrictionEnable integer

Site erişimi için IP kısıtlamalarını etkinleştirmek için.

availableIP
availableIP string

Siteye erişmesine izin verilen IP adreslerinin virgülle ayrılmış listesi.

highqDrive
highqDrive integer

HighQ Drive tümleştirmenin etkinleştirilip etkinleştirilmediğini gösterir.

applySiteHomePage
applySiteHomePage integer

Site için özel bir giriş sayfası uygulamak için.

siteHomePage
siteHomePage string

Site için özel giriş sayfasının URL'si.

siteHomePageType
siteHomePageType integer

Giriş sayfasının türü.

nextLoginSiteHomePage
nextLoginSiteHomePage integer

Site giriş sayfasında bir sonraki oturum açmayı ayarlamak için.

applyDisplayContent
applyDisplayContent integer

Görüntü içeriği ayarlarını uygulamak için.

displayContent
displayContent string

Sitede görüntülenecek içerik.

rssSecurity
rssSecurity integer

RSS akışı güvenlik düzeyi.

şifreli şifre
encryptedPassword integer

Site parolasının şifrelenip şifrelenmediğini gösterir.

availableIPRangeCSV
availableIPRangeCSV string

Siteye erişmesine izin verilen IP adresi aralıklarının virgülle ayrılmış listesi.

siteModuleID
siteModuleID integer

Site modülünün tanımlayıcısı.

icalSecurity
icalSecurity integer

iCal akışı güvenlik düzeyi.

defaultDisplayContent
defaultDisplayContent string

Sitede görüntülenecek varsayılan içerik.

defaultEmailAlert
defaultEmailAlert integer

Varsayılan e-posta uyarılarını etkinleştirmek için.

excelReportFooter
excelReportFooter integer

Excel raporlarına bir alt bilgi ekler.

excelReportFooterText
excelReportFooterText string

Excel raporlarının alt bilgisinde görüntülenecek metin.

announcementMLJSON
announcementMLJSON string

Site için JSON biçimli duyurular.

şablon türü
templateType integer

Site için kullanılan şablon türü.

templateLicence
templateLicence integer

Site şablonunun lisans türü.

openChannelAppID
openChannelAppID string

Açık kanal tümleştirmesi için uygulama kimliği.

itemid
itemid integer

Siteyle ilişkili öğenin tanımlayıcısı.

sitemetadatasheetid
sitemetadatasheetid integer

Siteyle ilişkili meta veri sayfasının kimliği.

sitem
mysite boolean

Bunun kullanıcının kişisel sitesi olup olmadığını gösterir.

lastaccesseddate
lastaccesseddate string

Siteye en son erişildiği tarih ve saat.

defaultViewerMetaDataTab
defaultViewerMetaDataTab integer

Site görüntüleyicisi için varsayılan meta veri sekmesi.

documentMetadataViewId
documentMetadataViewId integer

görünüm tanımlayıcısı için belge meta verileri.

folderMetadataViewId
folderMetadataViewId integer

görünüm tanımlayıcısı için klasör meta verileri.

docSort
docSort integer

Belgelerin sıralama düzeni.

folderSort
folderSort integer

Klasörlerin sıralama düzeni.

defaultFolderRenderView
defaultFolderRenderView integer

Klasörler için varsayılan görünüm modunu belirler.

isTaskAttachmentDefault
isTaskAttachmentDefault integer

Görev ekleri için varsayılan konum.

taskAttachmentDefaultFolderId
taskAttachmentDefaultFolderId integer

Görev ekleri için varsayılan konum olarak belirlenen klasörün benzersiz tanımlayıcısı.

gözde
favourite string

sık kullanılan durumu.

enabledocumentredaction
enabledocumentredaction boolean

Site için belge yeniden eylem özelliğinin etkinleştirilip etkinleştirilmediğini belirtir.

bahsetme grupları
mentiongroups integer

Bahsedilen gruplar.

enablefilerelationships
enablefilerelationships boolean

Dosya ilişkilerinin etkinleştirilip etkinleştirilmediğini gösterir.

filerelationshipsitepermissionlevel
filerelationshipsitepermissionlevel integer

Dosya ilişkilerini yönetmek için gereken izin düzeyi.

Döndürülenler

Body
site

Site grubunu güncelleştirme

Bu API yöntemi, sitedeki mevcut bir grubun adını güncelleştirir.
Bu API, bir sitedeki mevcut temel kullanıcı grubunun adını güncelleştirmek için genişletilmiştir.

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

version

Sitenin kimliği
siteid True string

Sitenin kimliği.

API Sürümü
groupid True string
The ID of the site group.
name
name string
kimlik
id integer
copypermissionsfrom
copypermissionsfrom string
message
message string
typeID
typeID integer
type
type string
numberofusers
numberofusers string
Oluşturulan
created string
modified
modified string
systemGroupID
systemGroupID integer
açıklama
description string
basicusergroup
basicusergroup integer

Döndürülenler

Body
sitegroup

Siteyi güncelleştir

Mevcut bir sitenin ayrıntılarını güncelleştirmek için bu API uç noktasını kullanın. API, Site API'sini oluşturma bölümünde kullanılan alanları destekler.

Bu yöntem, API sürüm 10'un ilerisinde kullanılarak siteye eklenecek birden çok madde numarasını destekler. "matternos" etiketi, salt okunur veya okunmayan birden çok madde numarasını gösterir.

Sürüm 18'e doğru: bir kategori (site amacı) gereklidir. Site amacı gizliyse, bir ileti görüntülenir; aksi takdirde, gizli site amaçları siteye eklenmez.

Artık site sahibine başka kullanıcılar da atanabilir, ancak site katılımcıları olmaları ve site yöneticisinden daha yüksek bir role sahip olmaları gerekir.

Sürüm 18'e doğru: Site sahibi siteye başka kullanıcılar ekleyebilir.

API sürüm 19'dan itibaren customPages adlı, giriş modülüyle sıkı bir şekilde birleştirilmiş yeni bir modül kullanıma sunulmuştur. Giriş modülü değeri True ise customPages değerinin true olması ve tam tersi olması gerekir.

Lütfen site yanıtı alma içindeki tüm özelliklerin/öğelerin güncelleştirilebilir/eklenebilir olmadığını unutmayın. Hangilerinin salt okunur, güncelleştirilebilir veya eklenebilir olduğunu öğrenmek için aşağıdaki tabloya bakın.

Parametreler

Name Anahtar Gerekli Tür Description
İstenen API sürümü
version True string

api sürümü

Sitenin benzersiz tanımlayıcısı
siteid True string

Sitenin kimliği

kimlik
id integer

Site tanımlayıcısı.

sitename
sitename string

Sitenin adı.

role
role string

Sitenin rolü.

sıyrı yazı
sitedescription string

Sitenin açıklaması.

enabledmodules
enabledmodules string

Site için etkinleştirilen modüllerin listesi.

sitefolderID
sitefolderID string

Site klasörünün tanımlayıcısı.

sitefolderpermission
sitefolderpermission string

Site klasörünün izin düzeyi.

enable
enable string

HomeDBO durumunu etkinleştirin.

enable
enable string

ActivityDBO durumunu etkinleştirin.

mikroblog
microblog string

ActivityDBO ile ilişkili mikroblog içeriği.

docid
docid string

Belge Kimliği.

blogTitle
blogTitle string

Blog gönderisinin başlığı.

blogContent
blogContent string

Blog gönderisinin içeriği.

showComment
showComment integer

açıklamayı gösterir.

etiket listesi
tagList array of string

Blogla ilişkilendirilmiş etiketlerin listesi.

statü
status integer

blog gönderisinin durumu.

siteID
siteID integer

İlişkili sitenin tanımlayıcısı.

yazar
author string

Blogun yazarı.

categoryList
categoryList array of string

Blog gönderisine atanan kategoriler.

notificationTypeID
notificationTypeID integer

Bildirim türünün tanımlayıcısı.

message
message string

Blogla ilgili ileti içeriği.

messageCode
messageCode integer

İletiyle ilişkili kod.

hariciKimlik
externalID string

Bloga bağlı dış tanımlayıcı.

yayınlama tarihi
publishDate string

Blogun yayın tarihi.

processtype
processtype string

Blog ile ilişkili işlem türü.

enable
enable string

BlogDBO için durumu etkinleştirin.

wikiid
wikiid integer

Wiki için benzersiz tanımlayıcı.

currentversionid
currentversionid integer

Wiki'nin geçerli sürümünün tanımlayıcısı

parentwikiid
parentwikiid integer

Üst wiki'nin tanımlayıcısı.

wikititle
wikititle string

Wiki'nin başlığı.

wikicontent
wikicontent string

Wiki'nin içeriği.

showcomment
showcomment integer

Açıklamaların etkinleştirilip etkinleştirilmediğini belirtir.

oluşturma tarihi
createddate string

Wiki'nin oluşturulma tarihi.

değiştirme tarihi
modifieddate string

Wiki'nin son değişiklik tarihi.

etiket listesi
taglist string

Wiki ile ilişkili etiketlerin virgülle ayrılmış listesi.

wikipath
wikipath string

Wiki'ye erişim yolu.

wikidraftid
wikidraftid integer

Wiki'nin taslak sürümünün tanımlayıcısı.

taslak türü
drafttype string

Wiki ile ilişkili taslak türü.

statü
status integer

Wiki'nin geçerli durumu.

wikiversionid
wikiversionid integer

Wiki'nin sürüm tanımlayıcısı.

index
index string

Görevin dizini veya tanımlayıcısı.

parenttaskid
parenttaskid integer

Üst görevin tanımlayıcısı.

görev kimliği
taskid integer

Görevin benzersiz tanımlayıcısı.

title
title string

Görevin başlığı.

açıklama
description string

Görevin ayrıntılı açıklaması.

duedate
duedate string

Görevin tamamlanması için son tarih.

başlangıç tarihi
startdate string

Görevin başlatıldığı başlangıç tarihi.

mattermaptaskid
mattermaptaskid string

Madde eşleme görevine bağlanan tanımlayıcı.

type
type string

Görevin türü veya kategorisi.

dependenton
dependenton string

Bu görevin bağlı olduğu görevler.

daysfromdependent
daysfromdependent string

Bağımlı görevdeki gün sayısı.

ignoreweekend
ignoreweekend integer

Hafta sonlarının zamanlamada yoksayılıp yoksayıldığını gösterir.

duration
duration integer

Görevi tamamlama süresi.

resource
resource string

Göreve atanan kaynaklar.

eventTitle
eventTitle string

Olayın başlığı.

eventContent
eventContent string

Olayın içeriği.

showComment
showComment integer

Olay için açıklamaların etkinleştirilip etkinleştirilmediğini belirtir.

etiket listesi
tagList array of string

Olayla ilişkili etiketlerin listesi.

statü
status integer

Olayın geçerli durumu.

siteID
siteID integer

Sitenin tanımlayıcısı.

ilgili kişi
contact string

Olayla ilgili iletişim bilgileri.

categoryList
categoryList array of string

Olayın altında listelendiği kategoriler.

notificationTypeID
notificationTypeID integer

Olayla ilgili bildirim türü.

message
message string

Olayın iletisi.

messageCode
messageCode integer

Olayın ileti kodu.

hariciKimlik
externalID string

Dış Tanımlayıcı.

startDate
startDate string

Olayın başlangıç tarihi.

Bitiş Tarihi
endDate string

Olayın bitiş tarihi.

startTime
startTime string

Olayın başlangıç saati.

endTime
endTime string

Olayın bitiş saati.

location
location string

Olayın konumu.

yazar
author string

Olayın yazarı.

processtype
processtype string

Olayın işlem süresi.

enable
enable string

Olay Etkinleştir'dir.

kimlik
id integer

iSheet için benzersiz tanımlayıcı.

title
title string

iSheet'in başlığı.

açıklama
description string

Isheet'in açıklaması.

statü
status string

Isheet'in durumu.

accesstype
accesstype string

Isheet'in erişim türü.

type
type string

Isheet türü.

görünüm bağlantısı
viewlink string

iSheet'i görüntülemek için bağlantı.

allowsections
allowsections string

Bölümlere izin verilip verilmeyeceği.

allowlookup
allowlookup string

Arama alanlarının etkinleştirilip etkinleştirilmediği.

displayisheet
displayisheet string

iSheet için görüntüleme seçenekleri.

searchasdefaultview
searchasdefaultview string

Aramanın varsayılan görünüm olup olmadığını gösterir.

enableversion
enableversion string

Sürüm oluşturma etkin bayrağı.

enablesheetalerter
enablesheetalerter string

Sayfa uyarılarını etkinleştirmek için bayrak ekleyin.

alertercondition
alertercondition string

Uyarıları tetikleme koşulları.

overrideitemmodifieddate
overrideitemmodifieddate string

Değiştirilen tarih bayrağını geçersiz kıl.

enablebulkinsertupdate
enablebulkinsertupdate string

Toplu ekleme/güncelleştirme özelliğini etkinleştirin.

fielddescriptions
fielddescriptions string

iSheet için alan açıklamaları.

enablerowlocking
enablerowlocking string

Satır düzeyi kilitlemeyi etkinleştirin.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

Çok satırlı metin bayrağını kes.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

Çok satırlı kesme için karakter sınırı.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

Seçim listesi değerlerinin yeniden kullanılmasına izin verin.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

Puan listesi değerlerinin yeniden kullanılmasına izin verin.

allowIsheetComments
allowIsheetComments string

iSheet'te açıklamalara izin ver.

shareRecordsLimit
shareRecordsLimit integer

Paylaşmasına izin verilen kayıtların sınırı.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

Etkin kayıt paylaşım sınırı.

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

Kayıt eklemek için form paylaşımını etkinleştirin.

kayıt sayısı
recordcount string

Geçerli kayıt sayısı.

sheettypeid
sheettypeid integer

iSheet'in Tür Kimliği

enable
enable string

Soru-Cevap işlevini etkinleştirin.

kullanıcı kimliği
userid integer

Kullanıcı kimliği.

e-posta
email string

e-posta adresi.

httpavatar
httpavatar string

Avatarın HTTP URL'si.

avatar
avatar string

Avatar resmi.

userlink
userlink string

Kullanıcı profili bağlantısı.

httplink
httplink string

Kullanıcı profiline HTTP bağlantısı.

phone
phone string

Telefon numarası.

mobile
mobile string

Cep Telefonu Numarası.

bölüm
department string

Kullanıcının departmanı.

enable
enable string

Contract Express tümleştirmesini etkinleştirin.

adminnote
adminnote string

Siteyle ilgili yönetim notları.

başlangıç tarihi
startdate string

Site işleminin başlangıç tarihi.

bitiş tarihi
enddate string

Site işleminin bitiş tarihi.

oluşturma tarihi
createddate string

Sitenin oluşturulduğu tarih.

archiveddate
archiveddate string

Sitenin arşivlendiği tarih.

clientno
clientno string

Siteyle ilişkili istemci numarası.

maddeno
matterno string

Siteyle ilişkili madde numarası.

giriş sayfası
landingpage string

Sitenin giriş sayfası URL'si.

link
link string

Siteyle ilgili bir bağlantı.

statü
status string

Sitenin geçerli durumu.

statusid
statusid integer

Sitenin durumunun tanımlayıcısı.

size
size string

Sitenin boyutu.

faturalama notları
billingnotes string

Sitenin faturalaması ile ilgili notlar.

billingnextinvoicate
billingnextinvoicedate string

Site için sonraki faturanın tarihi.

billinglastinvoicedate
billinglastinvoicedate string

Site için son faturanın tarihi.

filepagecount
filepagecount string

Sitedeki dosyaların toplam sayfa sayısı.

maxpagecount
maxpagecount string

Sitedeki dosyalar için izin verilen sayfa sayısı üst sınırı.

sitehttplink
sitehttplink string

Sitenin HTTP bağlantısı.

isSyncable
isSyncable integer

Sitenin eşitlenebilir olup olmadığını gösterir.

enforceusergroups
enforceusergroups string

Site için zorlanan kullanıcı grupları.

csvSiteCategory
csvSiteCategory string

Sitenin CSV biçimindeki kategorisi.

siteNameInDefaultLanguage
siteNameInDefaultLanguage string

Sitenin varsayılan dildeki adı.

Görünür
visible integer

Sitenin görünür olup olmadığını gösterir.

siteLogoName
siteLogoName string

Sitenin logo dosyasının adı.

siteLogoFileSize
siteLogoFileSize integer

Site logosunun dosya boyutu.

siteLogoHeight
siteLogoHeight integer

Site logosunun yüksekliği.

siteLogoWidth
siteLogoWidth integer

Site logosunun genişliği.

siteStatus
siteStatus integer

Sitenin durum kodu.

applySiteTerms
applySiteTerms integer

Site koşullarının uygulanacağını gösterir.

siteTerm
siteTerm string

Siteye uygulanan koşullar.

termType
termType integer

Siteye uygulanan terim türü.

nextLoginSiteTerms
nextLoginSiteTerms integer

Bir sonraki oturum açmada site koşullarının gerekli olup olmadığını gösterir.

defaultSiteTermsEnable
defaultSiteTermsEnable integer

Varsayılan site terimlerinin etkinleştirilip etkinleştirilmediğini gösterir.

advancedQAPermission
advancedQAPermission integer

Site için gelişmiş Soru-Cevap izin düzeyi.

isInternal
isInternal integer

Sitenin dahili olup olmadığını gösterir.

Psm
psm integer

Product Service Manager tanımlayıcısı.

siteLabelDisplay
siteLabelDisplay string

Sitenin görüntüleme etiketi.

allowSiteAdministration
allowSiteAdministration integer

Site yönetimine izin verilip verilmediğini belirtir.

siteLevelPasswordEnable
siteLevelPasswordEnable integer

Site düzeyinde parola korumasını etkinleştirmek için.

siteLevelPasscodeEnable
siteLevelPasscodeEnable integer

Site düzeyinde geçiş kodu korumasını etkinleştirmek için.

passcodeUsingAuthApp
passcodeUsingAuthApp integer

Geçiş kodu kimlik doğrulamasının bir kimlik doğrulama uygulaması kullanıp kullanmadiğini gösterir.

sitePassword
sitePassword string

Siteyle ilişkilendirilmiş parola.

ipRestrictionEnable
ipRestrictionEnable integer

Site erişimi için IP kısıtlamalarını etkinleştirmek için.

availableIP
availableIP string

Siteye erişmesine izin verilen IP adreslerinin virgülle ayrılmış listesi.

highqDrive
highqDrive integer

HighQ Drive tümleştirmenin etkinleştirilip etkinleştirilmediğini gösterir.

applySiteHomePage
applySiteHomePage integer

Site için özel bir giriş sayfası uygulamak için.

siteHomePage
siteHomePage string

Site için özel giriş sayfasının URL'si.

siteHomePageType
siteHomePageType integer

Giriş sayfasının türü.

nextLoginSiteHomePage
nextLoginSiteHomePage integer

Site giriş sayfasında bir sonraki oturum açmayı ayarlamak için.

applyDisplayContent
applyDisplayContent integer

Görüntü içeriği ayarlarını uygulamak için.

displayContent
displayContent string

Sitede görüntülenecek içerik.

rssSecurity
rssSecurity integer

RSS akışı güvenlik düzeyi.

şifreli şifre
encryptedPassword integer

Site parolasının şifrelenip şifrelenmediğini gösterir.

availableIPRangeCSV
availableIPRangeCSV string

Siteye erişmesine izin verilen IP adresi aralıklarının virgülle ayrılmış listesi.

siteModuleID
siteModuleID integer

Site modülünün tanımlayıcısı.

icalSecurity
icalSecurity integer

iCal akışı güvenlik düzeyi.

defaultDisplayContent
defaultDisplayContent string

Sitede görüntülenecek varsayılan içerik.

defaultEmailAlert
defaultEmailAlert integer

Varsayılan e-posta uyarılarını etkinleştirmek için.

excelReportFooter
excelReportFooter integer

Excel raporlarına bir alt bilgi ekler.

excelReportFooterText
excelReportFooterText string

Excel raporlarının alt bilgisinde görüntülenecek metin.

announcementMLJSON
announcementMLJSON string

Site için JSON biçimli duyurular.

şablon türü
templateType integer

Site için kullanılan şablon türü.

templateLicence
templateLicence integer

Site şablonunun lisans türü.

openChannelAppID
openChannelAppID string

Açık kanal tümleştirmesi için uygulama kimliği.

itemid
itemid integer

Siteyle ilişkili öğenin tanımlayıcısı.

sitemetadatasheetid
sitemetadatasheetid integer

Siteyle ilişkili meta veri sayfasının kimliği.

sitem
mysite boolean

Bunun kullanıcının kişisel sitesi olup olmadığını gösterir.

lastaccesseddate
lastaccesseddate string

Siteye en son erişildiği tarih ve saat.

defaultViewerMetaDataTab
defaultViewerMetaDataTab integer

Site görüntüleyicisi için varsayılan meta veri sekmesi.

documentMetadataViewId
documentMetadataViewId integer

görünüm tanımlayıcısı için belge meta verileri.

folderMetadataViewId
folderMetadataViewId integer

görünüm tanımlayıcısı için klasör meta verileri.

docSort
docSort integer

Belgelerin sıralama düzeni.

folderSort
folderSort integer

Klasörlerin sıralama düzeni.

defaultFolderRenderView
defaultFolderRenderView integer

Klasörler için varsayılan görünüm modunu belirler.

isTaskAttachmentDefault
isTaskAttachmentDefault integer

Görev ekleri için varsayılan konum.

taskAttachmentDefaultFolderId
taskAttachmentDefaultFolderId integer

Görev ekleri için varsayılan konum olarak belirlenen klasörün benzersiz tanımlayıcısı.

gözde
favourite string

sık kullanılan durumu.

enabledocumentredaction
enabledocumentredaction boolean

Site için belge yeniden eylem özelliğinin etkinleştirilip etkinleştirilmediğini belirtir.

bahsetme grupları
mentiongroups integer

Bahsedilen gruplar.

enablefilerelationships
enablefilerelationships boolean

Dosya ilişkilerinin etkinleştirilip etkinleştirilmediğini gösterir.

filerelationshipsitepermissionlevel
filerelationshipsitepermissionlevel integer

Dosya ilişkilerini yönetmek için gereken izin düzeyi.

Var olan grubu siteye ekleme

Bu API yöntemi siteye mevcut bir sistem grubu ekler.
Bu API, siteye mevcut sistem temel kullanıcı gruplarını (sistem / kuruluş türü) eklemek için genişletilmiştir.

Parametreler

Name Anahtar Gerekli Tür Description
API Sürümü
version True string

version

Sitenin kimliği
siteid True string

Sitenin kimliği.

Sistem grubunun kimliği
groupid True string

Siteye eklenecek sistem grubunun kimliği.

Döndürülenler

Body
sitegroup

Tanımlar

ErrorDBO

Name Yol Tür Description
summary
summary string
Ref
ref string
link
link string

DocumentDBO

Name Yol Tür Description
docid
docid string

Belge Kimliği.

columns

Name Yol Tür Description
sütun
column array of object
items
column object

LocationDBO

Name Yol Tür Description
adres çizgisi1
addressline1 string

Adresin ilk satırı.

adres çizgisi2
addressline2 string

Adresin ikinci satırı.

adres çizgisi3
addressline3 string

Adresin üçüncü satırı.

city
city string

Adresin bulunduğu şehir.

state
state string

Adresin durumu.

country
country string

Adresin ülkesi.

posta kodu
postcode string

Adresin posta kodu.

Kullanıcı adı

Name Yol Tür Description
title
title string

Kullanıcının başlığı.

isim
firstname string

Kullanıcının adı.

soyadı
lastname string

Kullanıcının soyadı.

goesby
goesby string

kullanıcının tercih edilen adı.

MetadataListDBO

Name Yol Tür Description
metadataname
metadataname array of string
meta veri değeri
metadatavalue array of string
Name Yol Tür Description
kimlik
id string

Bağlantı Kimliği

name
name string

Bağlantı Adı.

value
value string

Bağlantı Değeri.

Name Yol Tür Description
link
link array of NameValueLink

DeneyimlerDBO

Name Yol Tür Description
deneyim
experience array of string

GroupsDBO

Name Yol Tür Description
group
group array of string

user

Name Yol Tür Description
kullanıcı kimliği
userid integer

Kullanıcı kimliği.

ertesi
following boolean

Ertesi.

e-posta
email string

E-posta Adresi.

name
name UserName
userlink
userlink string

Kullanıcı Bağlantısı.

httplink
httplink string

HTTP Bağlantısı.

httpavatar
httpavatar string

HTTP Avatarı.

avatar
avatar integer

Kullanıcının avatarı.

externalid
externalid string

Dış Kimlik.

dateofbirth
dateofbirth string

Doğum tarihi.

phone
phone string

Telefon numarası.

iş başlığı
jobtitle string

İş Unvanı.

mobile
mobile string

Cep Telefonu Numarası.

bölüm
department string

Ayrıştırma.

statü
status string

Durum.

Org
org string

Organizasyon.

orgName
orgName string

Kuruluş Adı.

location
location LocationDBO
img
img string

Resim.

Deneyim
experiences ExperiencesDBO
sosyal bağlantılar
sociallinks Link
özel bağlantı
customlink Link
mesajlaşma bağlantısı
messaginglink Link
secretaryname
secretaryname string

Sekreter Adı.

sekretermail
secretarymail string

Sekreter Mail.

Biyo
bio string

Kullanıcının biyografisi.

sourcetype
sourcetype string

Kaynak Türü.

Spesiyalite
specialities string

Spesiyalite.

raporlara
reportsto string

Geçerli kullanıcının rapor verdiği kullanıcı.

metadata
metadata MetadataListDBO
groups
groups GroupsDBO
sonek
suffix string

Kullanıcı adının son eki.

atomlink
atomlink string

Kullanıcıyla ilişkili atom bağlantısı.

link
link string

Kullanıcıyla ilişkili bağlantı.

loggeduserlike
loggeduserlike integer

Oturum açan kullanıcının beğeni sayısı.

kullanıcı adı
userName string

Kullanıcı Adı.

users

Name Yol Tür Description
user
user array of user

KlasörDBOV1

Name Yol Tür Description
folderid
folderid string

Oluşturulan klasörün benzersiz tanımlayıcısı.

DmsDBO

Name Yol Tür Description
dmsfolderid
dmsfolderid string

DMS klasör tanımlayıcısı.

dmsParentFolderID
dmsParentFolderID string

DMS üst klasör tanımlayıcısı.

dmscreateddate
dmscreateddate date-time

DMS klasörünün oluşturulduğu tarih.

dmsmodifiedBy
dmsmodifiedBy string

DMS klasörünü son değiştiren kullanıcı.

dmsdatabasename
dmsdatabasename string

DMS veritabanının adı.

dmslink
dmslink boolean

DMS bağlantısının kullanılabilir olup olmadığını gösterir.

dmslinkby
dmslinkby string

DMS klasörünü ilişkilendiren kullanıcı.

site grubu

Name Yol Tür Description
name
name string
kimlik
id integer
copypermissionsfrom
copypermissionsfrom string
message
message string
typeID
typeID integer
type
type string
numberofusers
numberofusers string
Oluşturulan
created string
modified
modified string
systemGroupID
systemGroupID integer
açıklama
description string
basicusergroup
basicusergroup integer

Adres

Name Yol Tür Description
addressid
addressid string

Adresin benzersiz tanımlayıcısı.

adres çizgisi1
addressline1 string

Adresin ilk satırı.

adres çizgisi2
addressline2 string

Adresin ikinci satırı.

adres çizgisi3
addressline3 string

Adresin üçüncü satırı.

city
city string

Adresin bulunduğu şehir.

state
state string

Adresin durumu.

country
country string

Adresin ülkesi.

postCode
postCode string

Adresin posta kodu.

knownas
knownas string

Adres için alternatif ad veya takma ad.

IntegrationUserDBO

Name Yol Tür Description
index
index integer

Kullanıcı için benzersiz dizin.

kullanıcı kimliği
userid integer

Kullanıcının benzersiz tanımlayıcısı.

isim
firstname string

Kullanıcının adı.

soyadı
lastname string

Kullanıcının soyadı.

practicegroup
practicegroup string

Kullanıcının ait olduğu alıştırma grubu.

langcode
langcode string

Kullanıcının dil kodu.

localeID
localeID string

Kullanıcının yerel ayar kimliği.

publicprofile
publicprofile string

Kullanıcının genel profili.

pwpid
pwpid string

Kullanıcının PWP kimliği.

usertypeid
usertypeid string

Kullanıcı türü kimliği.

systemuser
systemuser string

Sistem kullanıcı bayrağı.

e-posta
email string

Kullanıcının e-posta adresi.

phone
phone string

Kullanıcının telefon numarası.

mobile
mobile string

Kullanıcının cep telefonu numarası.

bölüm
department string

Kullanıcının bölümü.

Org
org string

Kullanıcının ait olduğu kuruluş.

location
location LocationDBO
address
address Address
Deneyim
experiences ExperiencesDBO
sosyal bağlantılar
sociallinks Link
mesajlaşma bağlantısı
messaginglink Link
özel bağlantı
customlink Link
img
img string
raporlara
reportsto string
metadata
metadata MetadataListDBO
groups
groups GroupsDBO
externalid
externalid string

Kullanıcının dış kimliği.

iş başlığı
jobtitle string

Kullanıcının iş unvanı.

secretaryname
secretaryname string

Kullanıcının sekreterinin adı.

sekretermail
secretarymail string

Kullanıcının sekreterinin e-posta adresi.

Spesiyalite
specialities string

Kullanıcının uzmanlıkları.

title
title string

Kullanıcının başlığı.

goesby
goesby string

kullanıcının tercih edilen adı.

sonek
suffix string

Kullanıcı adının son eki.

atomlink
atomlink string

Kullanıcıyla ilişkili atom bağlantısı.

Biyo
bio string

Kullanıcının biyografisi.

dateOfBirth
dateOfBirth string

Kullanıcının doğum tarihi.

link
link string

Kullanıcıyla ilişkili bağlantı.

statü
status string

Kullanıcının durumu.

durumkodu
statuscode string

Kullanıcının durum kodu.

message
message string

Kullanıcıyla ilişkilendirilmiş ileti.

sourcetype
sourcetype string

Kullanıcının kaynak türü.

orgid
orgid string

Kuruluş Kimliği.

ifpartner
ifpartner string

İş ortağı bayrağı.

emaildomain
emaildomain string

Kullanıcının e-posta etki alanı.

davetler
invitationsent string

Davet gönderildi bayrağı.

Oluşturan
createdby string

Kaydı oluşturan kullanıcı.

oluşturma tarihi
createddate string

Kaydın oluşturulduğu tarih.

Değiştiren
modifiedby string

Kaydı değiştiren kullanıcı.

değiştirme tarihi
modifieddate string

Kaydın değiştirildiği tarih.

lastlogindate
lastlogindate string

Son oturum açma tarihi.

invalidlogins
invalidlogins string

Geçersiz oturum açma girişimlerinin sayısı.

publicwebsiteprofileid
publicwebsiteprofileid string

Genel web sitesi profil kimliği.

resetpassworddate
resetpassworddate string

Parolanın sıfırlandığı tarih.

avatar
avatar string

Avatar resmi URL'si.

followingcount
followingcount integer

Takip edilen kullanıcıların sayısı.

followercount
followercount integer

Takipçi sayısı.

ertesi
following boolean

İzleyen bayrak.

role
role string

Kullanıcının rolü.

isbasicuser
isbasicuser string

Temel kullanıcı bayrağı.

encryptedUserId
encryptedUserId string

Şifrelenmiş kullanıcı kimliği.

kendi kendine kayıtlı
selfregistered integer

Kendi kendine kaydedilen bayrak.

registeredWith2FA
registeredWith2FA string

İki öğeli kimlik doğrulaması kayıt bayrağı.

isInternal
isInternal integer

İç kullanıcı bayrağı.

orgName
orgName string

Kuruluşun adı.

web sitesi

Name Yol Tür Description
kimlik
id integer

Site tanımlayıcısı.

sitename
sitename string

Sitenin adı.

role
role string

Sitenin rolü.

sıyrı yazı
sitedescription string

Sitenin açıklaması.

enabledmodules
enabledmodules string

Site için etkinleştirilen modüllerin listesi.

sitefolderID
sitefolderID string

Site klasörünün tanımlayıcısı.

sitefolderpermission
sitefolderpermission string

Site klasörünün izin düzeyi.

modül
module ModuleDBO
adminnote
adminnote string

Siteyle ilgili yönetim notları.

başlangıç tarihi
startdate string

Site işleminin başlangıç tarihi.

bitiş tarihi
enddate string

Site işleminin bitiş tarihi.

oluşturma tarihi
createddate string

Sitenin oluşturulduğu tarih.

archiveddate
archiveddate string

Sitenin arşivlendiği tarih.

clientno
clientno string

Siteyle ilişkili istemci numarası.

maddeno
matterno string

Siteyle ilişkili madde numarası.

giriş sayfası
landingpage string

Sitenin giriş sayfası URL'si.

link
link string

Siteyle ilgili bir bağlantı.

statü
status string

Sitenin geçerli durumu.

statusid
statusid integer

Sitenin durumunun tanımlayıcısı.

size
size string

Sitenin boyutu.

faturalama notları
billingnotes string

Sitenin faturalaması ile ilgili notlar.

billingnextinvoicate
billingnextinvoicedate string

Site için sonraki faturanın tarihi.

billinglastinvoicedate
billinglastinvoicedate string

Site için son faturanın tarihi.

filepagecount
filepagecount string

Sitedeki dosyaların toplam sayfa sayısı.

maxpagecount
maxpagecount string

Sitedeki dosyalar için izin verilen sayfa sayısı üst sınırı.

sitehttplink
sitehttplink string

Sitenin HTTP bağlantısı.

isSyncable
isSyncable integer

Sitenin eşitlenebilir olup olmadığını gösterir.

enforceusergroups
enforceusergroups string

Site için zorlanan kullanıcı grupları.

csvSiteCategory
csvSiteCategory string

Sitenin CSV biçimindeki kategorisi.

siteNameInDefaultLanguage
siteNameInDefaultLanguage string

Sitenin varsayılan dildeki adı.

Görünür
visible integer

Sitenin görünür olup olmadığını gösterir.

siteLogoName
siteLogoName string

Sitenin logo dosyasının adı.

siteLogoFileSize
siteLogoFileSize integer

Site logosunun dosya boyutu.

siteLogoHeight
siteLogoHeight integer

Site logosunun yüksekliği.

siteLogoWidth
siteLogoWidth integer

Site logosunun genişliği.

siteStatus
siteStatus integer

Sitenin durum kodu.

applySiteTerms
applySiteTerms integer

Site koşullarının uygulanacağını gösterir.

siteTerm
siteTerm string

Siteye uygulanan koşullar.

termType
termType integer

Siteye uygulanan terim türü.

nextLoginSiteTerms
nextLoginSiteTerms integer

Bir sonraki oturum açmada site koşullarının gerekli olup olmadığını gösterir.

defaultSiteTermsEnable
defaultSiteTermsEnable integer

Varsayılan site terimlerinin etkinleştirilip etkinleştirilmediğini gösterir.

advancedQAPermission
advancedQAPermission integer

Site için gelişmiş Soru-Cevap izin düzeyi.

isInternal
isInternal integer

Sitenin dahili olup olmadığını gösterir.

Psm
psm integer

Product Service Manager tanımlayıcısı.

siteLabelDisplay
siteLabelDisplay string

Sitenin görüntüleme etiketi.

allowSiteAdministration
allowSiteAdministration integer

Site yönetimine izin verilip verilmediğini belirtir.

siteLevelPasswordEnable
siteLevelPasswordEnable integer

Site düzeyinde parola korumasını etkinleştirmek için.

siteLevelPasscodeEnable
siteLevelPasscodeEnable integer

Site düzeyinde geçiş kodu korumasını etkinleştirmek için.

passcodeUsingAuthApp
passcodeUsingAuthApp integer

Geçiş kodu kimlik doğrulamasının bir kimlik doğrulama uygulaması kullanıp kullanmadiğini gösterir.

sitePassword
sitePassword string

Siteyle ilişkilendirilmiş parola.

ipRestrictionEnable
ipRestrictionEnable integer

Site erişimi için IP kısıtlamalarını etkinleştirmek için.

availableIP
availableIP string

Siteye erişmesine izin verilen IP adreslerinin virgülle ayrılmış listesi.

highqDrive
highqDrive integer

HighQ Drive tümleştirmenin etkinleştirilip etkinleştirilmediğini gösterir.

applySiteHomePage
applySiteHomePage integer

Site için özel bir giriş sayfası uygulamak için.

siteHomePage
siteHomePage string

Site için özel giriş sayfasının URL'si.

siteHomePageType
siteHomePageType integer

Giriş sayfasının türü.

nextLoginSiteHomePage
nextLoginSiteHomePage integer

Site giriş sayfasında bir sonraki oturum açmayı ayarlamak için.

applyDisplayContent
applyDisplayContent integer

Görüntü içeriği ayarlarını uygulamak için.

displayContent
displayContent string

Sitede görüntülenecek içerik.

rssSecurity
rssSecurity integer

RSS akışı güvenlik düzeyi.

şifreli şifre
encryptedPassword integer

Site parolasının şifrelenip şifrelenmediğini gösterir.

availableIPRangeCSV
availableIPRangeCSV string

Siteye erişmesine izin verilen IP adresi aralıklarının virgülle ayrılmış listesi.

siteModuleID
siteModuleID integer

Site modülünün tanımlayıcısı.

icalSecurity
icalSecurity integer

iCal akışı güvenlik düzeyi.

defaultDisplayContent
defaultDisplayContent string

Sitede görüntülenecek varsayılan içerik.

defaultEmailAlert
defaultEmailAlert integer

Varsayılan e-posta uyarılarını etkinleştirmek için.

excelReportFooter
excelReportFooter integer

Excel raporlarına bir alt bilgi ekler.

excelReportFooterText
excelReportFooterText string

Excel raporlarının alt bilgisinde görüntülenecek metin.

announcementMLJSON
announcementMLJSON string

Site için JSON biçimli duyurular.

şablon türü
templateType integer

Site için kullanılan şablon türü.

templateLicence
templateLicence integer

Site şablonunun lisans türü.

openChannelAppID
openChannelAppID string

Açık kanal tümleştirmesi için uygulama kimliği.

itemid
itemid integer

Siteyle ilişkili öğenin tanımlayıcısı.

sitemetadatasheetid
sitemetadatasheetid integer

Siteyle ilişkili meta veri sayfasının kimliği.

sitem
mysite boolean

Bunun kullanıcının kişisel sitesi olup olmadığını gösterir.

lastaccesseddate
lastaccesseddate string

Siteye en son erişildiği tarih ve saat.

defaultViewerMetaDataTab
defaultViewerMetaDataTab integer

Site görüntüleyicisi için varsayılan meta veri sekmesi.

documentMetadataViewId
documentMetadataViewId integer

görünüm tanımlayıcısı için belge meta verileri.

folderMetadataViewId
folderMetadataViewId integer

görünüm tanımlayıcısı için klasör meta verileri.

docSort
docSort integer

Belgelerin sıralama düzeni.

folderSort
folderSort integer

Klasörlerin sıralama düzeni.

defaultFolderRenderView
defaultFolderRenderView integer

Klasörler için varsayılan görünüm modunu belirler.

isTaskAttachmentDefault
isTaskAttachmentDefault integer

Görev ekleri için varsayılan konum.

taskAttachmentDefaultFolderId
taskAttachmentDefaultFolderId integer

Görev ekleri için varsayılan konum olarak belirlenen klasörün benzersiz tanımlayıcısı.

gözde
favourite string

sık kullanılan durumu.

enabledocumentredaction
enabledocumentredaction boolean

Site için belge yeniden eylem özelliğinin etkinleştirilip etkinleştirilmediğini belirtir.

bahsetme grupları
mentiongroups integer

Bahsedilen gruplar.

enablefilerelationships
enablefilerelationships boolean

Dosya ilişkilerinin etkinleştirilip etkinleştirilmediğini gösterir.

filerelationshipsitepermissionlevel
filerelationshipsitepermissionlevel integer

Dosya ilişkilerini yönetmek için gereken izin düzeyi.

ModuleDBO

Name Yol Tür Description
ev
home HomeDBO
etkinlik
activity ActivityDBO
belge
document DocumentDBO
blog
blog BlogDBO
wiki
wiki WikiDBO
görev
task TaskDBO
etkinlik
event EventDBO
isheet
isheet ISheetDBO
Qa
qa QaDBO
halk
people PeopleDBO
contractexpress
contractexpress ContractExpressDBO

HomeDBO

Name Yol Tür Description
enable
enable string

HomeDBO durumunu etkinleştirin.

ActivityDBO

Name Yol Tür Description
enable
enable string

ActivityDBO durumunu etkinleştirin.

mikroblog
microblog string

ActivityDBO ile ilişkili mikroblog içeriği.

BlogDBO

Name Yol Tür Description
blogTitle
blogTitle string

Blog gönderisinin başlığı.

blogContent
blogContent string

Blog gönderisinin içeriği.

showComment
showComment integer

açıklamayı gösterir.

etiket listesi
tagList array of string

Blogla ilişkilendirilmiş etiketlerin listesi.

statü
status integer

blog gönderisinin durumu.

siteID
siteID integer

İlişkili sitenin tanımlayıcısı.

yazar
author string

Blogun yazarı.

categoryList
categoryList array of string

Blog gönderisine atanan kategoriler.

notificationTypeID
notificationTypeID integer

Bildirim türünün tanımlayıcısı.

message
message string

Blogla ilgili ileti içeriği.

messageCode
messageCode integer

İletiyle ilişkili kod.

hariciKimlik
externalID string

Bloga bağlı dış tanımlayıcı.

yayınlama tarihi
publishDate string

Blogun yayın tarihi.

processtype
processtype string

Blog ile ilişkili işlem türü.

enable
enable string

BlogDBO için durumu etkinleştirin.

WikiDBO

Name Yol Tür Description
wikiid
wikiid integer

Wiki için benzersiz tanımlayıcı.

currentversionid
currentversionid integer

Wiki'nin geçerli sürümünün tanımlayıcısı

parentwikiid
parentwikiid integer

Üst wiki'nin tanımlayıcısı.

wikititle
wikititle string

Wiki'nin başlığı.

wikicontent
wikicontent string

Wiki'nin içeriği.

showcomment
showcomment integer

Açıklamaların etkinleştirilip etkinleştirilmediğini belirtir.

oluşturma tarihi
createddate string

Wiki'nin oluşturulma tarihi.

değiştirme tarihi
modifieddate string

Wiki'nin son değişiklik tarihi.

etiket listesi
taglist string

Wiki ile ilişkili etiketlerin virgülle ayrılmış listesi.

wikipath
wikipath string

Wiki'ye erişim yolu.

wikidraftid
wikidraftid integer

Wiki'nin taslak sürümünün tanımlayıcısı.

taslak türü
drafttype string

Wiki ile ilişkili taslak türü.

statü
status integer

Wiki'nin geçerli durumu.

wikiversionid
wikiversionid integer

Wiki'nin sürüm tanımlayıcısı.

TaskDBO

Name Yol Tür Description
index
index string

Görevin dizini veya tanımlayıcısı.

parenttaskid
parenttaskid integer

Üst görevin tanımlayıcısı.

görev kimliği
taskid integer

Görevin benzersiz tanımlayıcısı.

title
title string

Görevin başlığı.

açıklama
description string

Görevin ayrıntılı açıklaması.

duedate
duedate string

Görevin tamamlanması için son tarih.

başlangıç tarihi
startdate string

Görevin başlatıldığı başlangıç tarihi.

mattermaptaskid
mattermaptaskid string

Madde eşleme görevine bağlanan tanımlayıcı.

type
type string

Görevin türü veya kategorisi.

dependenton
dependenton string

Bu görevin bağlı olduğu görevler.

daysfromdependent
daysfromdependent string

Bağımlı görevdeki gün sayısı.

ignoreweekend
ignoreweekend integer

Hafta sonlarının zamanlamada yoksayılıp yoksayıldığını gösterir.

duration
duration integer

Görevi tamamlama süresi.

resource
resource string

Göreve atanan kaynaklar.

EventDBO

Name Yol Tür Description
eventTitle
eventTitle string

Olayın başlığı.

eventContent
eventContent string

Olayın içeriği.

showComment
showComment integer

Olay için açıklamaların etkinleştirilip etkinleştirilmediğini belirtir.

etiket listesi
tagList array of string

Olayla ilişkili etiketlerin listesi.

statü
status integer

Olayın geçerli durumu.

siteID
siteID integer

Sitenin tanımlayıcısı.

ilgili kişi
contact string

Olayla ilgili iletişim bilgileri.

categoryList
categoryList array of string

Olayın altında listelendiği kategoriler.

notificationTypeID
notificationTypeID integer

Olayla ilgili bildirim türü.

message
message string

Olayın iletisi.

messageCode
messageCode integer

Olayın ileti kodu.

hariciKimlik
externalID string

Dış Tanımlayıcı.

startDate
startDate string

Olayın başlangıç tarihi.

Bitiş Tarihi
endDate string

Olayın bitiş tarihi.

startTime
startTime string

Olayın başlangıç saati.

endTime
endTime string

Olayın bitiş saati.

location
location string

Olayın konumu.

yazar
author string

Olayın yazarı.

processtype
processtype string

Olayın işlem süresi.

enable
enable string

Olay Etkinleştir'dir.

ISheetDBO

Name Yol Tür Description
kimlik
id integer

iSheet için benzersiz tanımlayıcı.

title
title string

iSheet'in başlığı.

açıklama
description string

Isheet'in açıklaması.

statü
status string

Isheet'in durumu.

accesstype
accesstype string

Isheet'in erişim türü.

type
type string

Isheet türü.

görünüm bağlantısı
viewlink string

iSheet'i görüntülemek için bağlantı.

allowsections
allowsections string

Bölümlere izin verilip verilmeyeceği.

allowlookup
allowlookup string

Arama alanlarının etkinleştirilip etkinleştirilmediği.

displayisheet
displayisheet string

iSheet için görüntüleme seçenekleri.

searchasdefaultview
searchasdefaultview string

Aramanın varsayılan görünüm olup olmadığını gösterir.

enableversion
enableversion string

Sürüm oluşturma etkin bayrağı.

enablesheetalerter
enablesheetalerter string

Sayfa uyarılarını etkinleştirmek için bayrak ekleyin.

alertercondition
alertercondition string

Uyarıları tetikleme koşulları.

overrideitemmodifieddate
overrideitemmodifieddate string

Değiştirilen tarih bayrağını geçersiz kıl.

enablebulkinsertupdate
enablebulkinsertupdate string

Toplu ekleme/güncelleştirme özelliğini etkinleştirin.

fielddescriptions
fielddescriptions string

iSheet için alan açıklamaları.

enablerowlocking
enablerowlocking string

Satır düzeyi kilitlemeyi etkinleştirin.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

Çok satırlı metin bayrağını kes.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

Çok satırlı kesme için karakter sınırı.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

Seçim listesi değerlerinin yeniden kullanılmasına izin verin.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

Puan listesi değerlerinin yeniden kullanılmasına izin verin.

allowIsheetComments
allowIsheetComments string

iSheet'te açıklamalara izin ver.

shareRecordsLimit
shareRecordsLimit integer

Paylaşmasına izin verilen kayıtların sınırı.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

Etkin kayıt paylaşım sınırı.

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

Kayıt eklemek için form paylaşımını etkinleştirin.

kayıt sayısı
recordcount string

Geçerli kayıt sayısı.

sheettypeid
sheettypeid integer

iSheet'in Tür Kimliği

QaDBO

Name Yol Tür Description
enable
enable string

Soru-Cevap işlevini etkinleştirin.

PeopleDBO

Name Yol Tür Description
kişi
person array of PersonDBO

PersonDBO

Name Yol Tür Description
kullanıcı kimliği
userid integer

Kullanıcı kimliği.

e-posta
email string

e-posta adresi.

httpavatar
httpavatar string

Avatarın HTTP URL'si.

avatar
avatar string

Avatar resmi.

userlink
userlink string

Kullanıcı profili bağlantısı.

httplink
httplink string

Kullanıcı profiline HTTP bağlantısı.

phone
phone string

Telefon numarası.

mobile
mobile string

Cep Telefonu Numarası.

bölüm
department string

Kullanıcının departmanı.

ContractExpressDBO

Name Yol Tür Description
enable
enable string

Contract Express tümleştirmesini etkinleştirin.

KlasörDBOV2

Name Yol Tür Description
name
name string

Klasör adı.

açıklama
description string

Klasör açıklaması.

parentFolderID
parentFolderID integer

Üst klasör kimliği.

accessInherited
accessInherited integer

Erişim Devralma durumu.

batchID
batchID string

Toplu İş Tanımlayıcısı

DMS
dms DmsDBO
kimlik
id integer

Klasör Kimliği.

link
link string

Klasör Bağlantısı.

oluşturma tarihi
createddate string

Oluşturma tarihi.

değiştirme tarihi
modifieddate string

Değiştirme tarihi.

çocuk
child integer

Alt klasörler.

dosya sayısı
filecount integer

Dosya sayısı.

Oluşturan
createdby UserDBO
Değiştiren
modifiedby UserDBO
folderid
folderid integer

Klasör Kimliği.

dmsfolderid
dmsfolderid string

DMS klasör tanımlayıcısı.

siteid
siteid integer

Site Kimliği

location
location string

Klasör konumu.

izin
permission PermissionDBO
contentstatus
contentstatus integer

İçerik durumu.

otomatik numaralandırma
autonumbering string

Otomatik numaralandırma yapılandırması.

foldersize
foldersize string

Klasör boyutu.

sharedstatus
sharedstatus integer

Paylaşım durumu.

favouritestatus
favouritestatus integer

Sık kullanılan durumu.

klasör türü
foldertype string

Klasör türü.

öğeKimliği
itemId integer

Öğe Kimliği.

folderMetadataSheetId
folderMetadataSheetId integer

Sayfa kimliğinin klasör meta verileri.

UserDBO

Name Yol Tür Description
isim
firstname string

İsim.

soyadı
lastname string

Soyadı.

e-posta
email string

E-posta adresi.

kullanıcı kimliği
userid integer

Kullanıcı kimliği.

PermissionDBO

Name Yol Tür Description
view
view integer

görüntüleme izni.

edit
edit integer

düzenleme izni.

delete
delete integer

silme izni.

addEditAllFiles
addEditAllFiles integer

Tüm Dosyaları Ekleme/Düzenleme izni.

Admin
admin integer

Yönetici İzni.

viewAllFiles
viewAllFiles integer

Tüm dosyaları görüntüleme İzni.

disableSave
disableSave integer

kaydetme iznini devre dışı bırakın.

uploadFile
uploadFile integer

karşıya dosya yükleme izni.

updateFile
updateFile integer

dosya iznini güncelleştirin.

deleteFile
deleteFile integer

Dosya silme İzni.

ProgressiveKeyDBO

Name Yol Tür Description
progressivekey
progressivekey string

Aşamalı işlemler için anahtar.

siteid
siteid integer

Sitenin tanımlayıcısı.

progressivekeystatus
progressivekeystatus string

Aşamalı anahtarın durumu.

kullanıcı kimliği
userid integer

Kullanıcının tanımlayıcısı.

yanıt gövdesi
responsebody string

Yanıtın gövdesi.

message
message string

İleti içeriği.

ileti kodu
messagecode string

İletiyle ilişkili kod.

integrationResponseDBO
integrationResponseDBO IntegrationResponseDBO
columns
columns ColumnErrorsDBO
items
items ItemErrorsDBO
importisheettemplate
importisheettemplate importISheetTemplateDBO
hata
error ErrorDBO
içerik türü
contentType string

İçerik türü.

failedEntities
failedEntities integer

Başarısız varlık sayısı.

indirme bağlantısı
downloadlink string

İçerik indirme bağlantısı.

ek
attachment Attachment
link
link string

İlişkili bağlantı.

documentid
documentid integer

Belgenin tanımlayıcısı.

progresskey
progresskey string

İzleme için ilerleme anahtarı.

progresskeystatus
progresskeystatus string

İlerleme anahtarının durumu.

IntegrationResponseDBO

Name Yol Tür Description
integrationResponseUsersObject
integrationResponseUsersObject IntegrationResponseUsersObject
failedEntities
failedEntities integer

İşlemede başarısız olan varlık sayısı.

successEntities
successEntities integer

Başarıyla işlenen varlık sayısı.

IntegrationResponseUsersObject

Name Yol Tür Description
user
user array of IntegrationUserDBO

ColumnErrorsDBO

Name Yol Tür Description
sütun
column array of ColumnErrorDBO
failedEntities
failedEntities integer

Sütun hataları nedeniyle başarısız olan varlık sayısı.

successEntities
successEntities integer

Başarıyla işlenen varlık sayısı.

ColumnErrorDBO

Name Yol Tür Description
index
index integer

Hata içeren sütunun dizin konumu.

columnid
columnid integer

Hata içeren sütunun benzersiz tanımlayıcısı.

name
name string

Hata içeren sütunun adı.

statü
status string

Hata koşulunu gösteren durum.

durumkodu
statuscode string

Hata durumunu temsil eden kod.

message
message string

Ayrıntılı hata iletisi.

ItemErrorsDBO

Name Yol Tür Description
öğe
item array of ItemErrorDBO
failedEntities
failedEntities integer

Öğe hataları nedeniyle başarısız olan varlık sayısı.

successEntities
successEntities integer

Öğe hatalarıyla birlikte başarıyla işlenen varlık sayısı.

ItemErrorDBO

Name Yol Tür Description
index
index integer

Hata içeren öğenin dizin konumu.

columns
columns ColumnErrorsDBO
itemid
itemid string

Hata içeren öğenin benzersiz tanımlayıcısı.

externalid
externalid string

Öğeyle ilişkili dış tanımlayıcı.

kimlik
id string

Öğenin iç tanımlayıcısı.

name
name string

Hata içeren öğenin adı.

statü
status string

Hata koşulunu gösteren durum.

durumkodu
statuscode string

Hata durumunu temsil eden kod.

message
message string

Ayrıntılı hata iletisi.

successdeletedcount
successdeletedcount integer

Başarıyla silinen varlıkların sayısı.

failurecount
failurecount integer

İşlemede başarısız olan varlıkların sayısı.

failedEntities
failedEntities integer

Öğe hataları nedeniyle başarısız olan varlık sayısı.

successEntities
successEntities integer

Başarıyla işlenen varlık sayısı.

importISheetTemplateDBO

Name Yol Tür Description
linkedtemplateid
linkedtemplateid integer

Bağlı şablonun tanımlayıcısı.

diğer ad
aliasname string

Şablonun diğer adı.

linkedisheet
linkedisheet string

Bağlı giriş sayfasının tanımlayıcısı.

importdata
importdata string

Şablondan içeri aktarılacak veriler.

appendisheetname
appendisheetname string

Veri eklenecek sayfanın adı.

templateparametergroups
templateparametergroups ISheetTemplateParameterGroups
templateSheetIdMap
templateSheetIdMap object
şablonId
templateId integer

Şablonun tanımlayıcısı.

templateTitle
templateTitle string

Şablonun başlığı.

görünüm KIMLIKleri
viewIDs string

Görünüm kimliklerinin virgülle ayrılmış listesi.

ISheetTemplateParameterGroups

Name Yol Tür Description
templateparametergroup
templateparametergroup array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Name Yol Tür Description
templateruleid
templateruleid integer

Sayfa Şablonu Parametre Grubu.

templateparameter
templateparameter array of ISheetTemplateParameter

ISheetTemplateParameter

Name Yol Tür Description
kimlik
id integer

isheet şablon parametresinin tanımlayıcısı.

name
name string

Isheet şablonu parametresinin adı.

veriler
data string

isheet şablon parametresinin verileri.

Attachment

Name Yol Tür Description
file
file string

Dosya içeriği.

name
name string

Ekin adı.

order
order string

Ekin sırası.

kimlik
id integer

Ek için benzersiz tanımlayıcı.

genişletme
extension string

Dosya uzantısı.

parentfolderid
parentfolderid integer

Üst klasörün kimliği.

dosyahttplink
filehttplink string

Dosyaya erişmek için HTTP bağlantısı.

klasör yolu
folderpath string

Dosyayı içeren klasörün yolu.

klasörhttplink
folderhttplink string

Klasörün HTTP bağlantısı.

filesize
filesize integer

Dosyanın boyutu bayt cinsinden.

redactionStatus
redactionStatus boolean

Dosyanın yeniden işlenip yeniden işlenmediğini gösterir.

displayname
displayname string

Ekin görünen adı.

siteid
siteid integer

Ekle ilişkili sitenin kimliği.