Skip to content

Latest commit

 

History

History
88 lines (68 loc) · 3.24 KB

README.md

File metadata and controls

88 lines (68 loc) · 3.24 KB
Raw

Create Task with Document

This example will show you how to create new Document, new Task and link them with basic relation.

Create Task

We will create a Task by using method $connector->saveTask() supplied with array of parameters. In the parameters we have $user_guid which we got from method $connector->searchUsers() with FileAs of the user as parameter.

// Get user GUID
$user_guid = $connector->searchUsers(array('FileAs' => 'Api-Tester, Robot'))->Data[0]->ItemGUID;

// This will be our Task
$task = array(
   		'StartDate' => '2019-02-01 20:00:00Z',
   		'DueDate' => '2019-02-02 04:00:00Z',
   		'Subject' => 'TASK: Do the task',
   		'FileAs' => 'TASK: Do the task',
   		'Users_TaskDelegatorGuid' => $user_guid,
   		'Users_TaskSolverGuid' => $user_guid
   );

// Save the task
$task_result = $connector->saveTask($task);

Output

As an output, you should see the Task appear in Outlook application. example output

Create Document

Now we create our Document. First we upload binary of the file by $connector->saveBinaryAttachment() with path to the file as first parameter and empty variable for GUID of our document (we can supply it with our own GUID of choice, but remember to put it in parameters of the document too) and then, similarly to saving task, we have an array of parameters and supply it to the $connector->saveDocument() method.

// Save binary of the Document
$connector->saveBinaryAttachment('Picture.PNG', $GUID);

// This will be our Document
$document = array(
   		'ItemGUID' => $GUID,
   		'FileAs' => 'Picture',
   		'DocName' => 'Picture',
   		'DocSize' => filesize('Picture.PNG'),
   		'Extension' => 'PNG'
                 );

// Save the Document
$document_result = $connector->saveDocument($document);

Output

As an output, you should see the Document appear in Outlook application. example output

Link items together

All there is left now, is to link both items together. Again we prepare our array with parameters with GUIDS of both items, their folder names (Tasks and Documents) and type of the relation (GENERAL in our case). Then we supply the array as a parameter of method $connector->saveRelation() and we are ready to go.

// Specifications of our relation
$relation = array(
   'ItemGUID1'     => $task_result->Guid,
   'ItemGUID2'     => $document_result->Guid,
   'FolderName1'   => 'Tasks',
   'FolderName2'   => 'Documents',
   'RelationType'  => 'GENERAL'
   			);

// Save the relation
$output = $connector->saveRelation($relation);

Output

As an output, you should see the Document appear in the Task form as a linked item. example output

Download a Document

If you want to download the document's binary data back or just download another file, use the method getBinaryAttachment. This function downloads binary content of a document (specified revision or the latest one) and saves it into a file.

// Download the picture back
$connector->getBinaryAttachment($GUID, 'Picture2.PNG');

Sample code

To see the whole sample code click here

Folder name

To ease understanding folder names, look here.