SOFiE
API docs by Redocly

SOFiE HTTP API (2.0.0)

Download OpenAPI specification:

SOFiE HTTP API slouží pro správu zásilek a uživatelů v aplikaci SOFiE aplikacemi třetích stran. Veškeré funkce jsou vykonávány z pohledu existujícího uživatele nebo administrátora aplikace.

API je popsáno pomocí OpenAPI 3.1. Aktuální specifikaci ve formátu YAML je možné stáhnout zde.

Základní cesta všech volání je /api/v2/user.

Pro přístup je potřeba API token vytvořený v administraci aplikace. Ten je potřeba poslat v každém požadavku v HTTP hlavičce Authorization jako Bearer token:

Authorization: Bearer <token>

API token je svázán s konkrétním uživatelem nebo administrátorem.

Pokud je API token svázán s administrátorem, je možné pomocí hlavičky X-Sofie-Impersonate-UserId nebo X-Sofie-Impersonate-Username určit uživatele pod kterým mají operace proběhnout. V požadavku je možné použít jen jednu z hlaviček:

X-Sofie-Impersonate-UserId: 1b31dd01-c272-4025-94a8-7bd1da484b22
// nebo
X-Sofie-Impersonate-Username: document-exchange

Některé operace API mohou být provedeny pouze běžným uživatelem nebo pouze administrátorem. U některých operací je na typu uživatele závislá dostupnost konkrétních atributů. Podmínky a rozdíly jsou vždy popsány u jednotlivých operací.

HTTP hlavička Content-Type musí být v každém požadavku nastavena na application/json:

Content-Type: application/json

Veškeré časové údaje jsou ve formátu "date-time" podle RFC 3339.

Pokud je požadavek zamítnut, je důvod zamítnutí zpravidla uveden v hlavičce X-Sofie-Response-Reason (např. překročení limitu, neuvedení hesla k zásilce apod.).

Filtrování dat

U volání která vracejí seznam položek je většinou možné omezit množinu vrácených záznamů pomocí uživatelem definovaného filtru.

Tento filtr je ve formátu JSON a vychází z jazyka JsonLogic. Podporované operátory a atributy jsou uvedeny u každé operace. Operátory !, and a or jsou podporovány vždy.

API podporuje obecně tyto operátory:

  • !: negace obsaženého výrazu, např.:

    {"!":
   {"==": [{"var":"name"}, "Project X"]}
}

  • and: konjunkce, např.:

    {"and":[
  {"contains": [{"var":"workflowState"}, "ACTIVE"]},
  {"contains": [{"var":"checkState"}, "CLEAN"]}
]}

  • or: disjunkce, např.:

    {"or":[
  {"==": [{"var":"name"}, "Project X"]},
  {"==": [{"var":"name"}, "Project Y"]}
]}

  • ==: rovnost, např.:

    {"==":[{"var":"name"},"Project X"]}

  • contains: hledání podřetězce s ohledem na velikost písmen, např.:

    {"contains":[{"var":"name"},"Project"]}

  • icontains: hledání podřetězce bez ohledu na velikost písmen, např.:

    {"icontains":[{"var":"name"},"project"]}

  • in: hledání prvku v poli, např.:

    {"in":["task:done",{"var":"tags"}]}

Filtr se v rámci požadavku posílá v URL parametru $filter, např.:

/packages/inbox?$filter={"eq": [{"var": "name"}, "Project summary"]}

Nahrání nové zásilky

Postup při nahrávání nové zásilky je následující:

  1. Požadavkem POST na cestu /packages je vytvořena nová prázdná zásilka. Odpověď obsahuje unikátní ID zásilky (packageId) a unikátní ID kořenové složky (rootFolderId).
  2. Ve vytvořené zásilce je v případě potřeby možné vytvářet další složky požadavkem POST na cestu /packages/{packageId}/folders.
  3. Soubory se nahrávají vícekrokově:
    1. nejprve se vytvoří záznam o souboru pomocí požadavku POST na cestu /packages/{packageId}/folders/{folderId}/files; v odpovědi je vráceno unikátní ID souboru (fileId)
    2. poté se nahraje obsah souboru pomocí volání PUT na cestu /packages/{packageId}/files/{fileId}/content
    3. nakonec se potvrdí ukončení nahrávání obsahu souboru voláním PUT na cestu /packages/{packageId}/files/{fileId}/state

Správa zásilek

Operace pro správu zásilek.

Vytváří novou zásilku

Vytváří na serveru novou zásilku včetně kořenové složky a vrací ID zásilky a ID kořenové složky. Zásilka je po vytvoření ve stavu aktivní.

Operaci může volat pouze běžný uživatel.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Definice atributů zásilky

name
string <= 100 characters

Název zásilky

note
string <= 10000 characters

Poznámka

downloadPassword
string <= 30 characters

Heslo ke stažení zásilky

encryptDataWithPassword
boolean
Default: false

Šifrování dat zásilky heslem ke stažení

downloadExpiration
integer

Doba platnosti zásilky (ve dnech)

persistent
boolean
Default: false

Trvalá zásilka (s neomezenou dobou platnosti)

Tento atribut je dostupný pouze uživateli s patřičným právem nebo administrátorovi.

accessType
required
string
Enum: "PUBLIC" "PRIVATE" "INTERNAL"

Přístupnost zásilky.

Možné hodnoty:

  • PUBLIC - veřejná
  • PRIVATE - soukromá
  • INTERNAL - interní
Array of objects (Recipient)

Příjemci zásilky

limitAccessCount
number

Maximální počet přístupů k zásilce

sendEmailNotifications
boolean
Default: true

Určuje, zda se po vytvoření zásilky odešlou e-mailová upozornění příjemcům.

Dostupné od verze 2.5.0.

tags
Array of strings[ items <= 100 characters ]

Štítky zásilky

Responses

Request samples

Content type
application/json
{
  • "name": "Fotodokumentace objektu",
  • "note": "Foceno mobilním telefonem",
  • "downloadPassword": "heslo123",
  • "encryptDataWithPassword": false,
  • "downloadExpiration": 7,
  • "persistent": true,
  • "accessType": "PUBLIC",
  • "recipients": [],
  • "limitAccessCount": 10,
  • "sendEmailNotifications": false,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "packageId": "28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4",
  • "rootFolderId": "b4148092-ddcf-417c-8c91-64848521ca15"
}

Vrací seznam přijatých zásilek

Vrací seznam přijatých zásilek uživatele.

Bez uvedení parametru $top je vráceno 100 záznamů, maximální hodnota parametru $top a tím i počet vrácených záznamů je 5000.

Podporovány jsou následující operátory a atributy pro URL parametr $filter (viz. sekce Filtrování dat):

  • ==: name, workflowState, checkState
  • contains: name
  • icontains: name
  • in: tags, workflowState, checkState

Příklad filtru (název musí být "Project summary" a štítky musí obsahovat štítek "done"):

{
  "and": [
    {
      "==": [
        {
          "var": "name"
        },
        "Project summary"
      ]
    },
    {
      "in": [
        "done",
        {
          "var": "tags"
        }
      ]
    }
  ]
}

Příklad v kompaktní podobě:

{"and":[{"==":[{"var":"name"},"Project summary"]},{"in":["done",{"var":"tags"}]}]}

Operaci může volat pouze běžný uživatel.

Authorizations:
bearerAuth
query Parameters
$top
integer
Example: $top=100

Maximální počet záznamů které se mají vrátit (použitelné pro stránkování).

$skip
integer
Example: $skip=100

Počet záznamů které se mají přeskočit (použitelné pro stránkování).

$filter
string
Example: $filter={"and":[{"==":[{"var":"name"},"Project summary"]},{"in":["done",{"var":"tags"}]}]}

JSON výraz filtru ve formátu JsonLogic (odesílaný jako URL-enkódovaný řetězec). Podporované operátory a atributy jsou uvedeny u jednotlivých operací.

Responses

Response samples

Content type
application/json
{
  • "count": 100,
  • "total": 5660,
  • "data": [
    ]
}

Vrací seznam odeslaných zásilek

Vrací seznam odeslaných zásilek uživatele.

Bez uvedení parametru $top je vráceno 100 záznamů, maximální hodnota parametru $top a tím i počet vrácených záznamů je 5000.

Podporovány jsou následující operátory a atributy pro URL parametr $filter (viz. sekce Filtrování dat):

  • ==: name, workflowState, checkState
  • contains: name
  • icontains: name
  • in: tags, workflowState, checkState

Příklad filtru (název musí být "Project summary" a štítky musí obsahovat štítek "done"):

{
  "and": [
    {
      "==": [
        {
          "var": "name"
        },
        "Project summary"
      ]
    },
    {
      "in": [
        "done",
        {
          "var": "tags"
        }
      ]
    }
  ]
}

Příklad v kompaktní podobě:

{"and":[{"==":[{"var":"name"},"Project summary"]},{"in":["done",{"var":"tags"}]}]}

Operaci může volat pouze běžný uživatel.

Authorizations:
bearerAuth
query Parameters
$top
integer
Example: $top=100

Maximální počet záznamů které se mají vrátit (použitelné pro stránkování).

$skip
integer
Example: $skip=100

Počet záznamů které se mají přeskočit (použitelné pro stránkování).

$filter
string
Example: $filter={"and":[{"==":[{"var":"name"},"Project summary"]},{"in":["done",{"var":"tags"}]}]}

JSON výraz filtru ve formátu JsonLogic (odesílaný jako URL-enkódovaný řetězec). Podporované operátory a atributy jsou uvedeny u jednotlivých operací.

Responses

Response samples

Content type
application/json
{
  • "count": 100,
  • "total": 5660,
  • "data": [
    ]
}

Vrací informace o zásilce

Vrací detailní informace o zásilce packageId.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

header Parameters
X-Sofie-Download-Password
string <= 100 characters
Example: heslo123

Heslo ke stažení zásilky (pokud je stažení zásilky chráněné heslem)

X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Responses

Response samples

Content type
application/json
{
  • "workflowState": "ACTIVE",
  • "checkState": "QUARANTINED",
  • "recheckInProgress": true,
  • "created": "2019-05-16T07:31:07.398Z",
  • "uploaded": "2019-05-16T07:31:07.338Z",
  • "name": "Fotodokumentace objektu",
  • "note": "Foceno mobilním telefonem",
  • "downloadPasswordProtected": true,
  • "size": 892612,
  • "recipients": [
    ],
  • "flags": [
    ],
  • "accessType": "PUBLIC",
  • "encryptionStatus": "NOT_ENCRYPTED",
  • "encryptionType": "NONE",
  • "dataIntegrity": "UNKNOWN",
  • "approveRequired": true,
  • "approved": "2019-05-16T07:31:07.398Z",
  • "disapproved": "2019-05-16T07:31:07.398Z",
  • "limitAccessCount": 0,
  • "accessCount": 0,
  • "tags": [
    ],
  • "rootFolderId": "0b17c541-206d-4bbc-b6e9-dc3d312ff54d",
  • "passwordToken": {
    }
}

Upravuje atributy zásilky

Upravuje atributy zásilky packageId. Upraveny jsou jen údaje zaslané v požadavku, ostatní zůstávají beze změny.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/json
required
name
string <= 100 characters

Název zásilky

note
string <= 10000 characters

Poznámka

accessType
string
Enum: "PUBLIC" "PRIVATE" "INTERNAL"

Přístupnost zásilky.

Možné hodnoty:

  • PUBLIC - veřejná
  • PRIVATE - soukromá
  • INTERNAL - interní

Tento atribut je dostupný pouze administrátorovi.

downloadPassword
string <= 30 characters

Heslo ke stažení zásilky. Heslo není možné změnit pokud je aktivní šifrování dat heslem zásilky.

downloadExpiration
string <date-time>

Doba konce platnosti zásilky (datum a čas)

persistent
boolean
Default: false

Trvalá zásilka (s neomezenou dobou platnosti).

Tento atribut je dostupný pouze uživateli s patřičným právem nebo administrátorovi.

Responses

Request samples

Content type
application/json
{
  • "name": "Fotodokumentace objektu",
  • "note": "Foceno mobilním telefonem",
  • "accessType": "PUBLIC",
  • "downloadPassword": "heslo123",
  • "downloadExpiration": "2023-06-01T00:00:00+02:00",
  • "persistent": true
}

Maže zásilku

Maže zásilku packageId včetně všech složek a souborů.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Responses

Vrací seznam štítků zásilky

Vrací seznam štítku zásilky.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Responses

Response samples

Content type
application/json
[
  • "task:completed"
]

Přidává štítky k zásilce

Přidává štítky k zásilce (pokud ještě u zásilky neexistují).

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/json
required
Array
string <= 100 characters

Responses

Request samples

Content type
application/json
[
  • "task:completed"
]

Nastavuje štítky na zásilce

Nastavuje štítky na zásilce (přepisuje stávající stav).

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/json
required
Array
string <= 100 characters

Responses

Request samples

Content type
application/json
[
  • "task:completed"
]

Odebírá štítky ze zásilky

Odebírá uvedené štítky ze zásilky (pokud u zásilky jsou).

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/json
required
Array
string <= 100 characters

Responses

Request samples

Content type
application/json
[
  • "task:completed"
]

Vytváří nový token pro přístup k zásilce chráněné heslem

Vytváří nový časově omezený passwordToken pro přístup k zásilce chráněné heslem.

Token musí být v následujících požadavcích přítomen v HTTP hlavičce X-Sofie-Password-Token.

Operaci může volat běžný uživatel a administrátor.

Dostupné od verze 2.5.0.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

Request Body schema: application/json
required
password
required
string <= 100 characters

Heslo zásilky

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "passwordToken": "eyJ...w5c",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Vytváří nový token pro přístup k zásilce s omezeným počtem přístupů

Vytváří nový časově omezený limitAccessToken pro přístup k zásilce s omezeným počtem přístupů.

Vytvořením nového tokenu dojde k využití jednoho povoleného přístupu.

Token musí být v následujících požadavcích přítomen v HTTP hlavičce X-Sofie-Limit-Access-Token.

Operaci může volat pouze běžný uživatel.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem

Responses

Response samples

Content type
application/json
{
  • "limitAccessToken": "eyJ...w5c",
  • "expiresAt": "2025-03-15T12:34:56Z"
}

Skartuje (trvale maže) zásilku

Skartuje (trvale maže) zásilku packageId a veškerý její obsah.

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

Responses

Přidává nové příjemce

Přidává nové příjemce zásilky packageId. Nové příjemce je možné získat jen do aktivní zásilky která není v karanténě.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/json
required
Array
type
required
string
Enum: "REGULAR" "BLIND" "CONTRIBUTOR"

Typ příjemce

email
required
string <email> <= 100 characters

E-mail příjemce

Responses

Request samples

Content type
application/json
[]

Odebírá příjemce

Odebírá příjemce recipientId ze zásilky packageId. Odebrat je možné jen interní příjemce.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

recipientId
required
string <uuid>
Example: c1252659-01b2-4b71-8ef1-e65c86aba002

ID příjemce

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Responses

Správa složek

Operace pro správu složek v zásilkách.

Vytváří novou složku

Vytváří novou složku v zásilce packageId.

Operaci může volat pouze běžný uživatel.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/json
required
parentId
required
string <uuid>

ID nadřazené složky ve které se má nová složka vytvořit

name
required
string <= 255 characters

Název složky

conflictResolution
string (ConflictResolutionFolderName)
Enum: "REPLACE" "RENAME_NEW" "RENAME_EXISTING" "DENY"

Požadované chování při konfliktu názvu složky.

Možné hodnoty:

  • REPLACE - nahrazení (smazání) stávající položky
  • RENAME_NEW - automatické přejmenování nové položky (na konec názvu složky je umístěna přípona s čítačem)
  • RENAME_EXISTING - automatické přejmenování existující položky (na konec názvu položky je umístěna přípona s čítačem)
  • DENY - v případě konfliktu názvu je akce zamítnuta

Výchozí hodnota je RENAME_NEW.

Responses

Request samples

Content type
application/json
{
  • "parentId": "0584e5fb-9545-4538-a1fe-57b14194d11b",
  • "name": "Nová složka",
  • "conflictResolution": "RENAME_NEW"
}

Response samples

Content type
application/json
{
  • "id": "f7dfcb3b-a9cf-414a-9253-02489c21aa3f",
  • "renamedFolders": [
    ],
  • "renamedFiles": [
    ],
  • "replacedFolders": [
    ],
  • "replacedFiles": [
    ],
  • "name": "string"
}

Maže složku

Maže složku folderId zásilky packageId a veškerý její obsah.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

folderId
required
string <uuid>
Example: ccdd4a54-df58-4bf9-ae6a-cd8173de8732

ID složky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Responses

Skartuje (trvale maže) složku

Skartuje (trvale maže) složku folderId zásilky packageId a veškerý její obsah.

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

folderId
required
string <uuid>
Example: ccdd4a54-df58-4bf9-ae6a-cd8173de8732

ID složky vrácené serverem při jejím založení

Responses

Mění název složky

Mění název složky folderId zásilky packageId.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

folderId
required
string <uuid>
Example: ccdd4a54-df58-4bf9-ae6a-cd8173de8732

ID složky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/json
required
name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "Upravená složka"
}

Vrací obsah složky

Vrací obsah složky folderId zásilky packageId.

Operaci může volat běžný uživatel a administrátor. Skartované položky vidí pouze administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

folderId
required
string <uuid>
Example: ccdd4a54-df58-4bf9-ae6a-cd8173de8732

ID složky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Responses

Response samples

Content type
application/json
{
  • "folders": [
    ],
  • "files": [
    ]
}

Správa souborů

Operace pro správu souborů ve složkách zásilek.

Vytváří nový soubor

Vytváří metadata nového souboru ve složce folderId zásilky packageId pro následné nahrání obsahu. Soubor je po vytvoření ve stavu UPLOADING.

Operaci může volat pouze běžný uživatel.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

folderId
required
string <uuid>
Example: ccdd4a54-df58-4bf9-ae6a-cd8173de8732

ID složky vrácené serverem při jejím založení

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/json
required
name
required
string <= 255 characters

Název souboru

conflictResolution
string (ConflictResolutionFileName)
Enum: "REPLACE" "RENAME_NEW" "RENAME_EXISTING" "DENY"

Požadované chování při konfliktu názvu souboru.

Možné hodnoty:

  • REPLACE - nahrazení (smazání) stávajícího položky
  • RENAME_NEW - automatické přejmenování nové položky (na konec názvu souboru je umístěna přípona s čítačem)
  • RENAME_EXISTING - automatické přejmenování existující položky (na konec názvu položky je umístěna přípona s čítačem)
  • DENY - v případě konfliktu názvu je akce zamítnuta

Výchozí hodnota je RENAME_NEW.

size
required
number

Velikost souboru v bajtech

mimeType
string <= 100 characters
Default: "application/octet-stream"

MIME typ souboru

hash
string <= 64 characters

SHA-256 hash obsahu souboru. Pokud je tento nepovinný atribut v požadavku přítomen, jsou na serveru hledány existující soubory se stejným názvem a hashem. Pokud je nalezen existující soubor, je namísto založení nového souboru vrácen seznam existujících souborů se stejným názvem a hashem.

Responses

Request samples

Content type
application/json
{
  • "name": "WP_20151010_001.jpg",
  • "conflictResolution": "RENAME_NEW",
  • "size": 1605184,
  • "mimeType": "image/jpeg",
  • "hash": "06326674220464174b719f7ecc3a465ad4d3a52a765bb866ddd451a1a51d0b88"
}

Response samples

Content type
application/json
{
  • "id": "0e665ed0-3914-4744-ba54-4f3eb110ffeb",
  • "renamedFolders": [
    ],
  • "renamedFiles": [
    ],
  • "replacedFolders": [
    ],
  • "replacedFiles": [
    ],
  • "name": "string"
}

Vrací informace o souboru

Vrací detailní informace o souboru fileId zásilky packageId.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

fileId
required
string <uuid>
Example: 0e665ed0-3914-4744-ba54-4f3eb110ffeb

ID souboru vrácené serverem při založení souboru

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Responses

Response samples

Content type
application/json
{
  • "id": "0f6a621a-e59f-4f52-ac17-68b38e17c2f6",
  • "name": "WP_20151010_001.jpg",
  • "path": "/Složka/Vnořená složka/WP_20151010_001.jpg",
  • "size": 1605184,
  • "hash": "06326674220464174b719f7ecc3a465ad4d3a52a765bb866ddd451a1a51d0b88",
  • "mimeType": "image/jpeg",
  • "state": "CLEAN",
  • "recheckInProgress": true,
  • "created": "2019-05-16T07:31:07.338Z",
  • "uploaded": "2019-05-16T07:31:07.338Z",
  • "deleted": "2019-05-16T07:31:07.338Z",
  • "contentDeleted": "2019-05-16T07:31:07.338Z",
  • "checks": [],
  • "flags": [
    ]
}

Maže soubor

Maže soubor fileId zásilky packageId. Operaci je možné volat pouze u souborů ve stavu CLEAN a UNCLEAN.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

fileId
required
string <uuid>
Example: 0e665ed0-3914-4744-ba54-4f3eb110ffeb

ID souboru vrácené serverem při založení souboru

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Responses

Mění název souboru

Mění název souboru fileId zásilky packageId.

Operaci může volat běžný uživatel a administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

fileId
required
string <uuid>
Example: 0e665ed0-3914-4744-ba54-4f3eb110ffeb

ID souboru vrácené serverem při založení souboru

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/json
required
name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "Nová název souboru"
}

Stahuje obsah souboru

Stahuje obsah souboru fileId zásilky packageId. Operaci je možné volat pouze u souborů ve stavu CLEAN.

Operaci může volat běžný uživatel a administrátor.

V odpovědi je HTTP hlavička Content-Type nastavena na skutečný MIME typ souboru (např. image/jpeg).

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

fileId
required
string <uuid>
Example: 0e665ed0-3914-4744-ba54-4f3eb110ffeb

ID souboru vrácené serverem při založení souboru

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Responses

Ukládá obsah souboru

Ukládá obsah souboru fileId zásilky packageId. Tělo požadavku je v binární podobě. Operaci je možné volat pouze u souborů ve stavu UPLOADING.

Operaci může volat pouze běžný uživatel.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

fileId
required
string <uuid>
Example: 0e665ed0-3914-4744-ba54-4f3eb110ffeb

ID souboru vrácené serverem při založení souboru

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/octet-stream
required
string <binary>

Responses

Skartuje (trvale maže) soubor

Skartuje (trvale maže) soubor fileId zásilky packageId.

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

fileId
required
string <uuid>
Example: 0e665ed0-3914-4744-ba54-4f3eb110ffeb

ID souboru vrácené serverem při založení souboru

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Responses

Potvrzuje nebo ruší nahrání obsahu souboru

Potvrzuje nebo ruší nahrání obsahu souboru fileId zásilky packageId. Typ operace je určen hodnotou atributu state v těle požadavku. Operaci je možné volat pouze u souborů ve stavu UPLOADING.

Operaci může volat pouze běžný uživatel.

Authorizations:
bearerAuth
path Parameters
packageId
required
string <uuid>
Example: 28ec36f3-9c1f-4e3a-b907-f42e85ffcdd4

ID zásilky vrácené serverem při jejím založení

fileId
required
string <uuid>
Example: 0e665ed0-3914-4744-ba54-4f3eb110ffeb

ID souboru vrácené serverem při založení souboru

header Parameters
X-Sofie-Password-Token
string <= 1000 characters

Token pro přístup k zásilce chráněné heslem.

Token je možné získat:

  • voláním POST /packages/{packageId}/password-token s heslem zásilky, nebo
  • jako součástí odpovědi GET /packages/{packageId}, pokud je v požadavku uvedena hlavička X-Sofie-Download-Password s platným heslem
X-Sofie-Limit-Access-Token
string <= 1000 characters
Example: eyJ...w5c

Token pro přístup k zásilce s omezeným počtem přístupů.

Request Body schema: application/json
required
state
required
string
Enum: "UPLOADED" "CANCELED"

Požadovaný stav souboru.

Možné hodnoty:

  • UPLOADED - nahrání obsahu souboru bylo dokončeno
  • CANCELED - nahrání obsahu souboru bylo zrušeno (stav souboru se změní na UPLOAD_CANCELED)
hash
string

SHA-256 hash souboru.

Pokud tento hash nesouhlasí s hashem souboru na serveru, je vrácen HTTP kód 412 a stav souboru na serveru zůstává beze změny.

Responses

Request samples

Content type
application/json
{
  • "state": "UPLOADED",
  • "hash": "06326674220464174b719f7ecc3a465ad4d3a52a765bb866ddd451a1a51d0b88"
}

Správa uživatelů

Operace pro správu uživatelů. Veškeré operace může provádět pouze administrátor.

Vrací seznam uživatelů

Vrací seznam uživatelů.

Bez uvedení parametru $top je vráceno 100 záznamů, maximální hodnota parametru $top a tím i počet vrácených záznamů je 5000.

Podporovány jsou následující operátory a atributy pro URL parametr $filter (viz. sekce Filtrování dat):

  • ==: username
  • contains: username
  • icontains: username

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
query Parameters
$top
integer
Example: $top=100

Maximální počet záznamů které se mají vrátit (použitelné pro stránkování).

$skip
integer
Example: $skip=100

Počet záznamů které se mají přeskočit (použitelné pro stránkování).

$filter
string
Example: $filter={"and":[{"==":[{"var":"name"},"Project summary"]},{"in":["done",{"var":"tags"}]}]}

JSON výraz filtru ve formátu JsonLogic (odesílaný jako URL-enkódovaný řetězec). Podporované operátory a atributy jsou uvedeny u jednotlivých operací.

Responses

Response samples

Content type
application/json
{
  • "total": 5660,
  • "count": 100,
  • "data": [
    ]
}

Vytváří nového uživatele

Vytváří nového místního uživatele.

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
Request Body schema: application/json
username
required
string <= 50 characters

Uživatelské jméno

firstName
string <= 50 characters

Jméno

lastName
string <= 50 characters

Příjmení

email
required
string <email> <= 100 characters

E-mail

company
string <= 200 characters

Společnost

phoneNumber
string <= 50 characters

Telefonní číslo

ipRanges
string <= 10000 characters

Seznam povolených IP rozsahů ve formátu CIDR oddělený čárkou

language
string
Enum: "EN" "CS" "SK" "HU"

Preferovaný jazyk

expireAt
string <date-time>

Datum automatického smazání uživatele

sshPublicKeys
string

Seznam veřejných SSH klíčů ve formátu OpenSSH souboru authorized_keys (např. "ssh-rsa AAAAB3NzaC1y..."). Na každém řádku může být jen jeden klíč.

defaultSftpPackage
string <uuid>

Zásilka která bude zpřístupněna přes SFTP v případě že ID zásilky není přítomné v uživatelském jméně (např. "document-exchange@sofie.cloud#4f23f924-e08b-404e-b7b1-806364763126").

enabled
boolean

Pokud je true, je uživatel aktivní a může se přihlásit.

password
string

Heslo.

sendResetPasswordToken
boolean

Odeslat odkaz na nastavení hesla. Povinné pokud není nastaven atribut password.

Responses

Request samples

Content type
application/json
{
  • "username": "document-exchange",
  • "firstName": "Document",
  • "lastName": "Exchange",
  • "email": "[email protected]",
  • "company": "SOFiE",
  • "phoneNumber": "123 456 798",
  • "ipRanges": "10.0.0.0/24, 192.168.0.0/16",
  • "language": "EN",
  • "expireAt": "2023-06-01T00:00:00Z",
  • "sshPublicKeys": "ssh-rsa AAA...knQ== [email protected]\nssh-ed25519 AAA...Py5 [email protected]\n",
  • "defaultSftpPackage": "4f23f924-e08b-404e-b7b1-806364763126",
  • "enabled": true,
  • "password": "password123",
  • "sendResetPasswordToken": false
}

Response samples

Content type
application/json
{
  • "id": "6cfb02e8-fa59-4ed6-ae14-547100ed9413"
}

Vrací informace o uživateli

Vrací informace o uživateli userId.

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
path Parameters
userId
required
string <uuid>
Example: 9af903c5-8f4a-4024-84d2-7907ce9a0fd1

ID uživatele

Responses

Response samples

Content type
application/json
{
  • "id": "079f1218-8b65-447d-9371-9f753fd1d841",
  • "username": "document-exchange",
  • "firstName": "Document",
  • "lastName": "Exchange",
  • "email": "[email protected]",
  • "company": "SOFiE",
  • "phoneNumber": "123 456 798",
  • "ipRanges": "10.0.0.0/24, 192.168.0.0/16",
  • "language": "EN",
  • "expireAt": "2023-06-01T00:00:00Z",
  • "sshPublicKeys": "ssh-rsa AAA...knQ== [email protected]\nssh-ed25519 AAA...Py5 [email protected]\n",
  • "defaultSftpPackage": "4f23f924-e08b-404e-b7b1-806364763126",
  • "enabled": true,
  • "userGroups": [
    ]
}

Upravuje atributy uživatele

Upravuje atributy uživatele userId. Upraveny jsou jen údaje zaslané v požadavku, ostatní zůstávají beze změny.

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
path Parameters
userId
required
string <uuid>
Example: 9af903c5-8f4a-4024-84d2-7907ce9a0fd1

ID uživatele

Request Body schema: application/json
username
string <= 50 characters

Uživatelské jméno

firstName
string <= 50 characters

Jméno

lastName
string <= 50 characters

Příjmení

email
string <email> <= 100 characters

E-mail

company
string <= 200 characters

Společnost

phoneNumber
string <= 50 characters

Telefonní číslo

ipRanges
string <= 10000 characters

Seznam povolených IP rozsahů ve formátu CIDR oddělený čárkou

language
string
Enum: "EN" "CS" "SK" "HU"

Preferovaný jazyk

expireAt
string <date-time>

Datum automatického smazání uživatele

sshPublicKeys
string

Seznam veřejných SSH klíčů ve formátu OpenSSH souboru authorized_keys (např. "ssh-rsa AAAAB3NzaC1y..."). Na každém řádku může být jen jeden klíč.

defaultSftpPackage
string <uuid>

Zásilka která bude zpřístupněna přes SFTP v případě že ID zásilky není přítomné v uživatelském jméně (např. "document-exchange@sofie.cloud#4f23f924-e08b-404e-b7b1-806364763126").

enabled
boolean

Pokud je true, je uživatel aktivní a může se přihlásit.

password
string

Heslo

clearExpireAt
boolean

Pokud je true, ruší datum automatického smazání uživatele

Responses

Request samples

Content type
application/json
{
  • "username": "document-exchange",
  • "firstName": "Document",
  • "lastName": "Exchange",
  • "email": "[email protected]",
  • "company": "SOFiE",
  • "phoneNumber": "123 456 798",
  • "ipRanges": "10.0.0.0/24, 192.168.0.0/16",
  • "language": "EN",
  • "expireAt": "2023-06-01T00:00:00Z",
  • "sshPublicKeys": "ssh-rsa AAA...knQ== [email protected]\nssh-ed25519 AAA...Py5 [email protected]\n",
  • "defaultSftpPackage": "4f23f924-e08b-404e-b7b1-806364763126",
  • "enabled": true,
  • "password": "password123",
  • "clearExpireAt": true
}

Maže uživatele

Maže uživatele userId.

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
path Parameters
userId
required
string <uuid>
Example: 9af903c5-8f4a-4024-84d2-7907ce9a0fd1

ID uživatele

Responses

Správa uživatelských skupin

Operace pro správu uživatelských skupin. Veškeré operace může provádět pouze administrátor.

Aplikace podporuje následující oprávnění u uživatelských skupin:

  • LOGIN - Přihlášení
  • RECEIVE_PACKAGE - Přijímat zásilky
  • SEND_PACKAGE__PUBLIC - Odesílat zásilky - veřejné
  • SEND_PACKAGE__INTERNAL - Odesílat zásilky - interní
  • SEND_PACKAGE__PRIVATE - Odesílat zásilky - soukromé
  • SEND_PACKAGE__BRIEFCASE - Používat aktovku
  • CREATE_ACCESS_LINK__PUBLIC - Sdílet zásilky - veřejně
  • CREATE_ACCESS_LINK__INTERNAL - Sdílet zásilky - interně
  • CREATE_ACCESS_LINK__PRIVATE - Sdílet zásilky - soukromě
  • ALLOW_DOWNLOAD_WITHOUT_LOGIN - Stahovat soubory bez přihlašovacího hesla
  • PASSWORD_ENCRYPTION - Šifrovat odesílané zásilky heslem
  • MFA_NOT_REQUIRED - Nevynucovat vícefaktorovou autentizaci
  • SEND_PACKAGE_WITHOUT_APPROVAL - Odesílat zásilky bez dodatečného schválení
  • APPROVE_SEND_PACKAGE - Schvalovat odeslání zásilek
  • ACCESS_ALL_PACKAGES_FOR_APPROVE - Přístup ke všem zásilkám vyžadujícím schválení (vyžaduje právo APPROVE_SEND_PACKAGE)
  • SEND_PACKAGE_TO_YOURSELF - Odesílat zásilky sám sobě
  • ALLOW_DOWNLOAD_SENT_FILES - Stahovat soubory ze svých odeslaných zásilek
  • FILE_CHECK_RESULT_DETAILS - Přístup k podrobným výsledkům kontrol
  • SET_APPROVER - Zvolit schvalovatele odesílaných zásilek
  • COOPERATIVE_PACKAGES - Vytvářet kooperativní zásilky
  • SET_PACKAGE_PERSISTENT - Nastavit zásilku jako trvalou
  • PERSISTENT_ACCOUNT - Trvalý učet
  • SFTP_ACCESS_ALLOWED - Přístup k zásilkám pomocí SFTP
  • ALLOW_ADD_AND_MANAGE_FILES_IN_QUARANTINE - Přidávat a spravovat soubory zásilek v karanténě
  • ALLOW_DELETE_FILES_IN_QUARANTINE - Mazat soubory v zásilkách v karanténě
  • LOG_ACCESS - Přístup k auditlogu
  • LOG_ACCESS_EXTENDED - Přístup k rozšířenému auditlogu (vyžaduje právo LOG_ACCESS)
  • PASSWORD_RECOVERY - Obnovovat heslo

Vrací seznam uživatelských skupin

Vrací seznam uživatelských skupin.

Bez uvedení parametru $top je vráceno 100 záznamů, maximální hodnota parametru $top a tím i počet vrácených záznamů je 5000.

Podporovány jsou následující operátory a atributy pro URL parametr $filter (viz. sekce Filtrování dat):

  • ==: name
  • contains: name
  • icontains: name
  • in: permissions

Operaci může volat pouze administrátor.

Dostupné od verze 2.5.0.

Authorizations:
bearerAuth
query Parameters
$top
integer
Example: $top=100

Maximální počet záznamů které se mají vrátit (použitelné pro stránkování).

$skip
integer
Example: $skip=100

Počet záznamů které se mají přeskočit (použitelné pro stránkování).

$filter
string
Example: $filter={"and":[{"==":[{"var":"name"},"Project summary"]},{"in":["done",{"var":"tags"}]}]}

JSON výraz filtru ve formátu JsonLogic (odesílaný jako URL-enkódovaný řetězec). Podporované operátory a atributy jsou uvedeny u jednotlivých operací.

Responses

Response samples

Content type
application/json
{
  • "total": 5660,
  • "count": 100,
  • "data": [
    ]
}

Vytváří novou uživatelskou skupinu

Vytváří novou uživatelskou skupinu.

Operaci může volat pouze administrátor.

Dostupné od verze 2.5.0.

Authorizations:
bearerAuth
Request Body schema: application/json
name
required
string <= 100 characters

Název skupiny

email
string <email> <= 100 characters

E-mail

distribution
boolean

True pokud jde o distribuční skupinu

administrative
boolean

True pokud jde o skupinu pro přiřazení přístupových práv

permissions
Array of strings (UserPermission)
Items Enum: "LOGIN" "RECEIVE_PACKAGE" "SEND_PACKAGE__PUBLIC" "SEND_PACKAGE__INTERNAL" "SEND_PACKAGE__PRIVATE" "SEND_PACKAGE__BRIEFCASE" "CREATE_ACCESS_LINK__PUBLIC" "CREATE_ACCESS_LINK__INTERNAL" "CREATE_ACCESS_LINK__PRIVATE" "ALLOW_DOWNLOAD_WITHOUT_LOGIN" "PASSWORD_ENCRYPTION" "MFA_NOT_REQUIRED" "SEND_PACKAGE_WITHOUT_APPROVAL" "APPROVE_SEND_PACKAGE" "ACCESS_ALL_PACKAGES_FOR_APPROVE" "SEND_PACKAGE_TO_YOURSELF" "ALLOW_DOWNLOAD_SENT_FILES" "FILE_CHECK_RESULT_DETAILS" "SET_APPROVER" "COOPERATIVE_PACKAGES" "SET_PACKAGE_PERSISTENT" "PERSISTENT_ACCOUNT" "SFTP_ACCESS_ALLOWED" "ALLOW_ADD_AND_MANAGE_FILES_IN_QUARANTINE" "ALLOW_DELETE_FILES_IN_QUARANTINE" "LOG_ACCESS" "LOG_ACCESS_EXTENDED" "PASSWORD_RECOVERY"

Oprávnění uživatelské skupiny v aplikaci.

accessibility
required
string
Enum: "PUBLIC" "GROUP_MEMBER"

Přístupnost distribuční skupiny uživatelům.

Možné hodnoty:

  • PUBLIC - skupina je dostupná všem uživatelům aplikace, i nepřihlášeným
  • GROUP_MEMBER - skupina je dostupná členům skupiny
defaultUserGroup
boolean

True pokud se má automaticky přiřadit nově vytvářeným uživatelům

Responses

Request samples

Content type
application/json
{
  • "name": "Users",
  • "email": "[email protected]",
  • "distribution": true,
  • "administrative": true,
  • "permissions": [
    ],
  • "accessibility": "PUBLIC",
  • "defaultUserGroup": true
}

Response samples

Content type
application/json
{
  • "id": "8216edb8-2fca-4391-a41c-64e9acf1c871"
}

Vrací informace o uživatelské skupině

Vrací informace o uživatelské skupině userGroupId.

Operaci může volat pouze administrátor.

Dostupné od verze 2.5.0.

Authorizations:
bearerAuth
path Parameters
userGroupId
required
string <uuid>
Example: a4d00b03-7de3-4e23-9779-20704ecc5ee0

ID uživatelské skupiny

Responses

Response samples

Content type
application/json
{
  • "id": "c3cddaf7-450a-4da1-bf8e-9d5e31048587",
  • "name": "Users",
  • "email": "[email protected]",
  • "distribution": true,
  • "administrative": true,
  • "permissions": [
    ],
  • "accessibility": "PUBLIC",
  • "defaultUserGroup": true,
  • "createdAt": "2023-06-01T00:00:00Z"
}

Upravuje atributy uživatelské skupiny

Upravuje atributy uživatelské skupiny userGroupId. Upraveny jsou jen údaje zaslané v požadavku, ostatní zůstávají beze změny.

Operaci může volat pouze administrátor.

Dostupné od verze 2.5.0.

Authorizations:
bearerAuth
path Parameters
userGroupId
required
string <uuid>
Example: a4d00b03-7de3-4e23-9779-20704ecc5ee0

ID uživatelské skupiny

Request Body schema: application/json
name
string <= 100 characters

Název skupiny

email
string <email> <= 100 characters

E-mail

distribution
boolean

True pokud jde o distribuční skupinu

administrative
boolean

True pokud jde o skupinu pro přiřazení přístupových práv

permissions
Array of strings (UserPermission)
Items Enum: "LOGIN" "RECEIVE_PACKAGE" "SEND_PACKAGE__PUBLIC" "SEND_PACKAGE__INTERNAL" "SEND_PACKAGE__PRIVATE" "SEND_PACKAGE__BRIEFCASE" "CREATE_ACCESS_LINK__PUBLIC" "CREATE_ACCESS_LINK__INTERNAL" "CREATE_ACCESS_LINK__PRIVATE" "ALLOW_DOWNLOAD_WITHOUT_LOGIN" "PASSWORD_ENCRYPTION" "MFA_NOT_REQUIRED" "SEND_PACKAGE_WITHOUT_APPROVAL" "APPROVE_SEND_PACKAGE" "ACCESS_ALL_PACKAGES_FOR_APPROVE" "SEND_PACKAGE_TO_YOURSELF" "ALLOW_DOWNLOAD_SENT_FILES" "FILE_CHECK_RESULT_DETAILS" "SET_APPROVER" "COOPERATIVE_PACKAGES" "SET_PACKAGE_PERSISTENT" "PERSISTENT_ACCOUNT" "SFTP_ACCESS_ALLOWED" "ALLOW_ADD_AND_MANAGE_FILES_IN_QUARANTINE" "ALLOW_DELETE_FILES_IN_QUARANTINE" "LOG_ACCESS" "LOG_ACCESS_EXTENDED" "PASSWORD_RECOVERY"

Oprávnění uživatelské skupiny v aplikaci.

accessibility
string
Enum: "PUBLIC" "GROUP_MEMBER"

Přístupnost distribuční skupiny uživatelům.

Možné hodnoty:

  • PUBLIC - skupina je dostupná všem uživatelům aplikace, i nepřihlášeným
  • GROUP_MEMBER - skupina je dostupná členům skupiny
defaultUserGroup
boolean

True pokud se má automaticky přiřadit nově vytvářeným uživatelům

Responses

Request samples

Content type
application/json
{
  • "name": "Users",
  • "email": "[email protected]",
  • "distribution": true,
  • "administrative": true,
  • "permissions": [
    ],
  • "accessibility": "PUBLIC",
  • "defaultUserGroup": true
}

Maže uživatelskou skupinu

Maže uživatelskou skupinu userGroupId.

Operaci může volat pouze administrátor.

Dostupné od verze 2.5.0.

Authorizations:
bearerAuth
path Parameters
userGroupId
required
string <uuid>
Example: a4d00b03-7de3-4e23-9779-20704ecc5ee0

ID uživatelské skupiny

Responses

Vrací seznam členů uživatelské skupiny

Vrací seznam členů uživatelské skupiny.

Bez uvedení parametru $top je vráceno 100 záznamů, maximální hodnota parametru $top a tím i počet vrácených záznamů je 5000.

Operaci může volat pouze administrátor.

Dostupné od verze 2.5.0.

Authorizations:
bearerAuth
path Parameters
userGroupId
required
string <uuid>
Example: a4d00b03-7de3-4e23-9779-20704ecc5ee0

ID uživatelské skupiny

query Parameters
$top
integer
Example: $top=100

Maximální počet záznamů které se mají vrátit (použitelné pro stránkování).

$skip
integer
Example: $skip=100

Počet záznamů které se mají přeskočit (použitelné pro stránkování).

Responses

Response samples

Content type
application/json
{
  • "total": 5660,
  • "count": 100,
  • "data": [
    ]
}

Přidává uživatele do skupiny

Přidává uživatele do skupiny (pokud v ní ještě nejsou).

Operaci může volat pouze administrátor.

Dostupné od verze 2.5.0.

Authorizations:
bearerAuth
path Parameters
userGroupId
required
string <uuid>
Example: a4d00b03-7de3-4e23-9779-20704ecc5ee0

ID uživatelské skupiny

Request Body schema: application/json
required

Seznam unikátních ID uživatelů

Array
string

Responses

Request samples

Content type
application/json
[
  • "bfe44611-f0d0-48af-9334-2026d9707ada"
]

Nastavuje uživatele ve skupině

Nastavuje uživatele ve skupině (přepisuje stávající stav).

Operaci může volat pouze administrátor.

Dostupné od verze 2.5.0.

Authorizations:
bearerAuth
path Parameters
userGroupId
required
string <uuid>
Example: a4d00b03-7de3-4e23-9779-20704ecc5ee0

ID uživatelské skupiny

Request Body schema: application/json
required

Seznam unikátních ID uživatelů

Array
string

Responses

Request samples

Content type
application/json
[
  • "bfe44611-f0d0-48af-9334-2026d9707ada"
]

Odstraňuje uživatele ze skupiny

Odstraňuje uživatele userId ze skupiny userGroupId (pokud v ní je).

Operaci může volat pouze administrátor.

Dostupné od verze 2.5.0.

Authorizations:
bearerAuth
path Parameters
userId
required
string <uuid>
Example: 9af903c5-8f4a-4024-84d2-7907ce9a0fd1

ID uživatele

userGroupId
required
string <uuid>
Example: a4d00b03-7de3-4e23-9779-20704ecc5ee0

ID uživatelské skupiny

Responses

Správa API tokenů

Operace pro správu API tokenů. Veškeré operace může provádět pouze administrátor.

Vrací seznam API tokenů

Vrací seznam všech API tokenů. Samotný JWT token použitelný pro autentizaci není součástí odpovědi (je dostupný pouze bezprostředně po vytvoření nového tokenu).

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Vytváří nový API token

Vytváří nový API token pro autentizaci v rámci HTTP API. API token musí být svázán s konkrétním uživatelem nebo administrátorem.

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
Request Body schema: application/json
One of
type
required
string
Value: "USER"

Typ API tokenu

userId
required
string

ID uživatele

name
required
string <= 100 characters

Název API tokenu

ipRanges
string <= 10000 characters

Seznam povolených IP rozsahů ve formátu CIDR oddělený čárkou

Responses

Request samples

Content type
application/json
{
  • "type": "ADMIN",
  • "adminId": "0a740457-2718-4f97-b12b-a52d69c2fae7",
  • "name": "API token",
  • "ipRanges": "10.0.0.0/24, 192.168.0.0/16"
}

Response samples

Content type
application/json
{
  • "id": "d6bd3332-dfa4-4670-a93d-3fa4b9845154",
  • "token": "eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJzb2ZpZS5jbG91ZCIsInN1YiI6ImRvY3VtZW50LWV4Y2hhbmdlIiwidWlkIjoiY2UwOGU4ZWMtMmVhZC00OGVmLWIxM2ItNmRmY2UwNjM4MDU1IiwiYXBpVG9rZW5JZCI6Ijc1ZDI4NmVmLWExNjgtNGZmMy1iNWM3LWNjZmRhYTdmODJjOSIsInJvbGUiOiJ1c2VyIiwiaXNzIjoic29maWUuY2xvdWQiLCJpYXQiOjE3MTgyODMyMjV9.97goxHPL61riLrvUBhHjltZgoQvPFM7sbaii_C6J7HU"
}

Vrací detail API tokenu

Vrací detail API tokenu apiTokenId. Samotný JWT token použitelný pro autentizaci není součástí odpovědi (je dostupný pouze bezprostředně po vytvoření nového tokenu).

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
path Parameters
apiTokenId
required
string <uuid>
Example: d5b02667-e64e-4d99-bb93-9aff35885348

ID API tokenu

Responses

Response samples

Content type
application/json
{
  • "adminId": "0a740457-2718-4f97-b12b-a52d69c2fae7",
  • "id": "d6bd3332-dfa4-4670-a93d-3fa4b9845154",
  • "name": "API token",
  • "type": "USER",
  • "ipRanges": "10.0.0.0/24, 192.168.0.0/16",
  • "token": "eyJhbGciOi...1A5rSq2-hk"
}

Maže API token

Maže API token apiTokenId.

Operaci může volat pouze administrátor.

Authorizations:
bearerAuth
path Parameters
apiTokenId
required
string <uuid>
Example: d5b02667-e64e-4d99-bb93-9aff35885348

ID API tokenu

Responses