documentgenerator.document.list

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

The method returns list of documents by the filter.

Parameters

Parameter	Description
select	array of fields for display.
order	array to specify display order `{"id": "desc"}`.
filter	array for filtration.
start	offset for pagewise navigation.

Filter example

"filter": {
  "value": 5
}

The result will contain list of documents, formatted for external ID = 5.

Response

"documents": [
    "0": {
    "id": 1929, // document id
    "title": "Rest Template 1", // name
    "number": "1", // number 
    "createTime": "2018-06-05T16:04:40+02:00", // date of creation
    "updateTime": "2018-06-05T16:04:40+02:00", // date of modification
    "stampsEnabled": true // enables stamps and signatures
    "downloadUrl": "", // link to download docx file by user
    "downloadUrlMachine": "", // link to download docx file by app
    "imageUrl": "", // link to download image by user
    "imageUrlMachine": "", // link to download image by app
    "pdfUrl": "", //  link to download pdf by user
    "pdfUrlMachine": "", // link to download pdf by app
    "publicUrl": "" // public link (if available)
    "isTransformationError": false, // conversion error
    "templateId": "202", // template ID
    "provider": "Bitrix\DocumentGenerator\DataProvider\Rest", // provider code
    "value": "1", // external ID
    "values": { // field values
        "SomeDate": "2018-02-21T16:33:00+03:00",
        } 
    }
]