crm.documentgenerator.template.list

crm.documentgenerator.template.list(select = ['*'], filter = [], order = [], start = 0)

The method returns list of templates by the filter.

Parameters

Parameter	Description
select	array of fields for display. Displays all template fields by default, except for users and entityTypeId. To display them, add the additional the `['*', 'entityTypeId', 'users']`.
order	array to specify the display sequence `{"id": "desc"}`.
filter	array for filtration.
start	offset for pagewise navigation.

Filter examples

filter: {
  "code": "%_EN",
  "numeratorId": "2",
  "region": "by",
  "active": "Y"
}

Filter can pass an entity ID by the key entityTypeId. Deal code must be passed with filter parameters for order directions. However, if templates associated with any deal direction must be returned, filter can pass them as well.

filter: {
  "entityTypeId": "2%"
}

The method returns list of templates with their fields.

Example

templates: {
   115: {
        "id": "115"
        "active": "Y"
        "name": "Act (Poland)"
        "code": "ACT_PL"
        "region": "pl"
        "sort": "100"
        "createTime": "2018-06-05T13:07:12+02:00"
        "updateTime": "2018-09-06T14:26:24+02:00"
        "moduleId": "crm"
        "numeratorId": "29"
        "withStamps": "N"
        "isDeleted": "N"
        "entityTypeId": [
            "0": "4",
            "1": "3",
            "2": "2_category_0",
            "3": "2_category_1",
            "4": "5",
            "5": "1",
            "6": "14",
            "7": "7"
        ],
        "users" [
          "0": "PL"
        ]
    }
}