Objektit

PushDocument

Kentät

• external_idstringpakollinen

  Asiakirjan pysyvä tunnus järjestelmässäsi. Saman tunnuksen lähettäminen korvaa asiakirjan.

  length ≤ 512

• titlestringpakollinen

  length ≤ 500

• urlstring

  Linkki asiakirjaan järjestelmässäsi (http tai https).

• contentstring

  Sisältö (enintään 5 Mt).

• content_typestring

  Sallitut arvot: htmlmarkdowntext

  Oletus: "html"

• patharray of string | string

  Asiakirjan kansiot: nimien taulukko tai merkkijono, jossa erottimena on ”/” (enintään 10 tasoa).

• permissionsPushPermissions
• tagsarray of string

  items ≤ 50

• author_emailstring

  Tekijä. Tulee kortin omistajaksi, jos hän on Sursan käyttäjä.

• updated_atstring (date-time)

  Muokkausaika järjestelmässäsi (osa asiakirjan versiota).

• metadataMetadataPatch

  Asiakirjan kortin metadata (versiosta 1.62.0 alkaen): objekti korvaa kortin aiemmat metatiedot, {} poistaa kaikki parit; ilman metadata-kenttää kortin metatiedot eivät muutu.

• categorystring

  Kortin luokka: organisaation luokan avain (GET /v1/categories), versiosta 1.62.0 alkaen.

  length ≤ 64

• verifiersPushVerifiers
• verify_interval_daysinteger

  Kortin vahvistusväli päivinä (versiosta 1.62.0 alkaen); ilman sitä käytetään lähteen väliä.

  ≥ 1, ≤ 3650

• upload_idstring

  Asiakirjan tiedosto moniosaisesta latauksesta (upl_…, versiosta 1.62.0 alkaen) content-kentän sijaan. Latauksen voi käyttää kerran; saman asiakirjan lähettäminen uudelleen samalla upload_id-tunnuksella ei kuluta sitä. Niin kauan kuin moniosaiset lataukset eivät ole käytettävissä asennuksessa, asiakirja hylätään syyllä file_rejected.

  length ≤ 64

• attachmentsarray of string

  Asiakirjan liitteet moniosaisina latauksina (upl_…, versiosta 1.62.0 alkaen): kustakin tulee lähteen oma kortti, jolla on sama kansio, samat käyttöoikeudet ja samat kortin kentät. Liite, joka puuttuu asiakirjan uudesta versiosta, arkistoidaan.

  items ≤ 20

Käytössä

• POST/v1/push/sources/{source_id}/documentsLähetä asiakirja (luo tai korvaa)

Sisältyy

PushDocumentBatch