Get a list of documents

Content

Resource URL

https://apps.ticketmatic.com/api/1/{accountname}/settings/communicationanddesign/documents

Example

Request

 1use Ticketmatic\Endpoints\Settings\Communicationanddesign\Documents;
 2
 3$result = Documents::getlist($client, array(
 4    "typeid" => 10001,
 5    "filter" => "select id from tm.document WHERE createdts > (now() - INTERVAL '30 days')",
 6    "lastupdatesince" => "2014-09-26 15:24:36",
 7));
 8
 9// The parameters array is optional, it can be omitted when empty.
10$result = Documents::getlist($client);

Response

 1object(Ticketmatic\Endpoints\Settings\Communicationanddesign\DocumentsList) (1) {
 2  ["data"]=>
 3  array(1) {
 4    [0]=>
 5    object(\Ticketmatic\Model\Document) (7) {
 6      ["id"]=>
 7      int(0)
 8      ["typeid"]=>
 9      int(0)
10      ["name"]=>
11      string(7) "Invoice"
12      ["description"]=>
13      string(16) "Invoice document"
14      ["enabled"]=>
15      bool(true)
16      ["createdts"]=>
17      object(\DateTime) (3) {
18        ["date"]=>
19        string(26) "2014-09-26 15:24:36.000000"
20        ["timezone_type"]=>
21        int(3)
22        ["timezone"]=>
23        string(3) "UTC"
24      }
25      ["lastupdatets"]=>
26      object(\DateTime) (3) {
27        ["date"]=>
28        string(26) "2014-09-26 15:24:36.000000"
29        ["timezone_type"]=>
30        int(3)
31        ["timezone"]=>
32        string(3) "UTC"
33      }
34    }
35  }
36}

Request

 1import (
 2    "github.com/ticketmatic/tm-go/ticketmatic"
 3    "github.com/ticketmatic/tm-go/ticketmatic/settings/communicationanddesign/documents"
 4)
 5
 6result, err := documents.Getlist(client, &ticketmatic.DocumentQuery{
 7    Typeid: 10001,
 8    Filter: "select id from tm.document WHERE createdts > (now() - INTERVAL '30 days')",
 9    Lastupdatesince: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
10})
11
12// The query object is optional, it can be omitted when empty.
13result, err := documents.Getlist(client, nil)

Response

 1result := documents.&List{
 2    Data: []*ticketmatic.Document{
 3        &ticketmatic.Document{
 4            Id: 123,
 5            Typeid: 10001,
 6            Name: "Invoice",
 7            Description: "Invoice document",
 8            Enabled: true,
 9            Createdts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
10            Lastupdatets: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
11        },
12    },
13}

Request

1GET /api/1/{accountname}/settings/communicationanddesign/documents HTTP/1.1

Response

 1HTTP/1.1 200 OK
 2Content-Type: application/json
 3
 4{
 5    "data": [
 6        {
 7            "id": 123,
 8            "typeid": 10001,
 9            "name": "Invoice",
10            "description": "Invoice document",
11            "enabled": true,
12            "createdts": "2014-09-26 15:24:36",
13            "lastupdatets": "2014-09-26 15:24:36"
14        }
15    ]
16}

Parameters

FieldDescription
typeid
required

Only return items with the given typeid.

Example value:10001
filter
        </td>
        <td class="description">
            <p>Filter the returned items by specifying a query on the public datamodel that returns the ids.</p> 
            <strong>Example value:</strong><code>&#34;select id from tm.document WHERE createdts &gt; (now() - INTERVAL &#39;30 days&#39;)&#34;</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">lastupdatesince</div>
            
        </td>
        <td class="description">
            <p>All items that were updated since this timestamp will be returned. Timestamp should be passed in <code>YYYY-MM-DD hh:mm:ss</code> format.</p> 
            <strong>Example value:</strong><code>&#34;2014-09-26 15:24:36&#34;</code>
        </td>
    </tr>
</tbody>

Type reference: DocumentQuery

Result fields

This call returns an object with an array of objects in the data field.

FieldDescription
id
int

Unique ID

Example value:123
typeid
int

Type ID

Example value:10001
name
mlstring

Name of the document

Example value:"Invoice"
description
mlstring

Description of the document

Example value:"Invoice document"
enabled
bool

Translations for the document template

Example value:true
createdts
timestamp

Created timestamp

Example value:"2014-09-26 15:24:36"
lastupdatets
timestamp

Last updated timestamp

Example value:"2014-09-26 15:24:36"

Type reference: Document[]