Práce s Úkoly prostřednictvím REST API ABRA Gen

Potřebujeme získat kolekci obsahující ID a názvy všech existujících úkolů.

GET http://localhost:699/data/tasks?select=id,summary

Výsledok spracovania požiadavky:

Status: 200 OK

[
	{
		"id": "1000000101",
		"summary": "Úkol 1"
	},
	{
		"id": "2000000101",
		"summary": "Úkol 2"
	}
]

Potřebujeme získat vlastnosti konkrétního úkolu (ID = 30B0000101).

GET http://localhost:699/data/tasks/30B0000101

Výsledok spracovania požiadavky:

Status: 200 OK

{
	"assignedto_id": "2300000101",
	"classid": "Q1ZMZREFXWC45CR2NGZYW3R5OO",
	"createdat$date": "2019-08-13T09:48:25.943Z",
	"deadline$date": null,
	"description": "Popis úkolu",
	"displayname": "Název úkolu",
	"id": "30B0000101",
	"objversion": 4,
	"owner_id": "1200000101",
	"pmstate_id": "4000000001",
	"ranking": 3652040,
	"startat$date": null,
	"summary": "Název úkolu",
	"tasklist_id": null
}

Popis vybraných vlastností:

assignedto_id - ID řešitele (vazba do číselníku uživatelů), classid - PackedGUID třídy Úkoly (konstanta), createdat$date - datum vytvoření, deadline$date - termín, description - popis úkolu, owner_id = ID zadavatele, pmstate_id = ID stavu (vazba do číselníku procesních stavů), ranking = pořadí pro řazení v dashboardu, summary = název úkolu, tasklist_id = ID seznamu úkolů (vazba do číselníku seznamů úkolů)

Potřebujeme vytvořit nový úkol s požadovanými vlastnostmi.

POST http://localhost:699/data/tasks?select=id

Telo požiadavky:

{
	"assignedto_id": "2300000101",
	"description": "Popis úkolu",
	"owner_id": "1200000101",
	"pmstate_id": "4000000001",
	"ranking": 3652040,
	"summary": "Název úkolu"
}

Výsledok spracovania požiadavky:

Status: 201 Created

{
	"id": "50C0000101"
}

Význam jednotlivých vlastností viz předchozí oddíl Získání informací o existujících úkolech. Povinné jsou pouze hodnoty Stav a Zadavatel, ostatní vlastnosti se v případě vynechání nastaví na výchozí (prázdné) hodnoty.

Potřebujeme změnit řešitele (ID úkolu 30B0000101, ID nového řešitele 1200000101).

PUT http://localhost:699/data/tasks/30B0000101?select=id,assignedto_id

Telo požiadavky:

{
	"assignedto_id": "1200000101"
}

Výsledok spracovania požiadavky:

Status: 200 OK

{
	"id": "30B0000101",
	"assignedto_id": "1200000101"
}

PUT http://localhost:699/data/tasks/30B0000101?select=id,tasklist_id

{
	"tasklist_id": "1010000101"
}

{
	"title": "Žádné záznamy",
	"description": "Nebyly nalezeny žádné záznamy odpovídající zadaným kritériím"
}

Mějme fakturu vydanou, ID = 1N00000101. Potřebujeme získat kolekci obsahující ID a názvy úkolů připojených k této faktuře. Znovu připomínáme, že vrácená kolekce nebude obsahovat úkoly zařazené do seznamů úkolů, ke kterým uživatel Web API nemá oprávnění.

GET http://localhost:699/data/taskrelations?select=task_id.id,task_id.summary&where=clsid+eq+'O3BDOKTWEFD13ACM03KIU0CLP4'+and+obj_id+eq+'1N00000101'

(O3BDOKTWEFD13ACM03KIU0CLP4 je PackedGUID třídy Faktury vydané.)

Výsledok spracovania požiadavky:

Status: 200 OK

[
	{
		"task_id.id": "1000000101",
		"task_id.summary": "Úkol 1"
	},
	{
		"task_id.id": "2000000101",
		"task_id.summary": "Úkol 2"
	}
]

Mějme fakturu vydanou s ID = 1N00000101. K této faktuře potřebujeme vytvořit úkol a fakturu s úkolem propojit vazbou.

Nejprve vytvoříme nový úkol, zatím na faktuře nezávislý, viz Vytvoření nového úkolu. V klauzuli select nezapomeneme uvést pole id - přidělené ID budeme potřebovat v dalším kroku. Předpokládejme, že nově vytvořenému úkolu bylo přiděleno ID = 50C0000101.

Následně vytvoříme vazbu mezi business objektem třídy faktury vydané a úkolem.

POST http://localhost:699/data/taskrelations

(O3BDOKTWEFD13ACM03KIU0CLP4 je PackedGUID třídy Faktury vydané.)

Telo požiadavky:

{
	"clsid": "O3BDOKTWEFD13ACM03KIU0CLP4",
	"obj_id": "1N00000101",
	"task_id": "50C0000101"
}

Výsledok spracovania požiadavky:

Status: 201 Created

{
	"classid": "0JWD5HQPL1IONCKMDVR3A4OZ2W",
	"clsid": "O3BDOKTWEFD13ACM03KIU0CLP4",
	"displayname": "1080000101",
	"id": "1080000101",
	"obj_id": "1N00000101",
	"objdisplayname": "FV-3/2018",
	"objversion": 1,
	"task_id": "50C0000101"
}

(0JWD5HQPL1IONCKMDVR3A4OZ2W je PackedGUID třídy Vazby úkolu na business objekt (TaskRelation).)

Mějme vytvořený úkol s ID = 60B0000101. K tomuto úkolu chceme přiložit obrázek ve formátu PNG.

1. Nejprve naimportujeme obsah přílohy.

   POST http://localhost:699/data/taskattachments/content?select=id

   V hlavičce požadavku specifikujeme typ - Content-Type: image/png. (V případě neuvedení typu se použije výchozí hodnota application/octet-stream.)

   Do těla požadavku vložíme samotný obrázek (binární data).

   Výsledok spracovania požiadavky:

   Status: 201 Created

   {
   	"id": "1070000101"
   }

2. Obdobným způsobem vložíme náhled přílohy. Tento krok je volitelný. Pokud k příloze existuje náhled, zobrazuje se ve webové aplikaci Úkoly na záložce Přílohy, v opačném případě se zobrazuje prázdná dlaždice s uvedením typu.

   POST http://localhost:699/data/taskattachments/preview?select=id

   V hlavičce požadavku opět specifikujeme typ Content-Type: image/png a do těla požadavku vložíme samotný náhled obrázku (binární data).

   Pokud je náhledem obrázek, z estetických důvodů je vhodné používat čtvercové náhledy o velikosti 200 × 200 pixelů (náhledy se při zobrazení ve webové aplikaci Úkoly roztahují na celou plochu dlaždice).

   Výsledok spracovania požiadavky:

   Status: 201 Created

   {
   	"id": "2070000101"
   }

3. V posledním kroku vytvoříme business objekt přílohy.

   POST http://localhost:699/data/taskattachments?select=id

   V těle tohoto požadavku specifikujeme název přílohy (souboru), vazbu na úkol, na obsah a volitelně také na náhled.

   {
   	"name": "picture.png",
   	"task_id": "60B0000101",
   	"content_id": "1070000101",
   	"preview_id": "2070000101"
   }

   Výsledok spracovania požiadavky:

   Status: 201 Created

   {
   	"id": "2040000101"
   }

Potřebujeme vypsat komentáře k úkolu s ID = 1000000101.

GET http://localhost:699/data/taskcomments?select=id,createdat$date,createdby_id.name,text&where=task_id+eq+'1000000101'

Výsledok spracovania požiadavky:

Status: 200 OK

[
	{
		"id": "1000000101",
		"createdat$date": "2019-08-13T07:23:43.583Z",
		"createdby_id.name": "Jaroslav Novák",
		"text": "Komentář #1"
	},
	{
		"id": "2000000101",
		"createdat$date": "2019-08-13T07:24:32.330Z",
		"createdby_id.name": "Václav Kuchta",
		"text": "Komentář #2"
	}
]

Potřebujeme přidat komentář k úkolu s ID = 1000000101.

POST http://localhost:699/data/taskcomments

Telo požiadavky:

{
	"task_id": "1000000101",
	"text": "Komentář 3"
}

Výsledok spracovania požiadavky:

Status: 200 OK

{
	"classid": "3ANM11UGRKC4FGBJXHY3DKB5FC",
	"createdat$date": "2020-01-07T12:56:31.397Z",
	"createdby_id": "1C00000101",
	"displayname": "2030000101",
	"id": "2030000101",
	"objversion": 1,
	"task_id": "1000000101",
	"text": "Komentář 3"
}