Phone model templates for autoprovision (ap_templates)
Overview
Provides access to template files for autoprovisioning.
The directory is located in the category of automatically synchronized directories :SYNC.
During the autoprovision service, a private configuration is created based on a template (by phone model or phone brand)). This catalog is where the templates are located. The search is done in the following order: <Brand Model>.cfg, <brand Model>.cfg, <Brand>.cfg, <brand>.cfg. There can be mutual references within the templates. The substitution of parameters into a template is done in depth until the result is a complete configuration format. It is important to avoid loops.
Each time the ap role is restarted, sample configurations are copied to the directory if the corresponding files are not present in the directory at the moment.
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Pouring a group of files
Uploading to the collection is done by Content-Type: multipart/formdata.
There can be one or more files in the request.
The files are placed under the names specified in the Content-Disposition headers of each part.
If a file with the specified name already exists, it is not saved and returns an error. Depending on the Content-Type and the presence of successfully placed files, the request may return a failed HTTP response, or failure information in the body of the HTTP response 200 OK.
Request
POST /rest/v1/fs/targets/ap_templates HTTP/1.1
Content-Type: multipart/form-data; boundary=-----------boundary_69df8120352a996e
-----------boundary_69df8120352a996e
Content-Type: application/octet-stream
Content-Disposition: form-data; name="filename"; filename="Yealink SIP-T30P.cfg"
Content-Transfer-Encoding: binary
BINARY BODY OF 'Yealink SIP-T30P.cfg'
-----------boundary_69df8120352a996e--Getting a list of files
Request
| Name | Type | Description |
|---|---|---|
|
|
Filter by field values. |
|
|
List of fields to output. Available fields for output: name, size, last_modified. |
|
|
Offset in the list of files to be issued. |
|
|
Maximum number of files in the list. |
|
|
The sort order of the files in the list. |
GET /rest/v1/fs/targets/ap_templates HTTP/1.1File download
Request
| Name | Type | Description |
|---|---|---|
|
|
Issuance Type. Default
|
GET /rest/v1/fs/targets/ap_templates/Yealink SIP-T30P.cfg?attachment=true HTTP/1.1Reloading an existing file
Performs a file replacement.
A single file is uploaded either with Content-Type: multipart/formdata,
or with an arbitrary Content-Type that is not multipart.
If the download is done with Content-Type: multipart/formdata,
then only the first file will be saved (the first part with the filename field in the header)
Content-Disposition), and the file name itself will be ignored.
Request
PUT /rest/v1/fs/targets/ap_templates/Yealink SIP-T30P.cfg HTTP/1.1
Content-Type: application/octet-stream
BINARY BODY OF 'Yealink SIP-T30P.cfg'PUT /rest/v1/fs/targets/ap_templates/Yealink SIP-T30P.cfg HTTP/1.1
Content-Type: multipart/form-data; boundary=-----------boundary_69df8120352a996e
-----------boundary_69df8120352a996e
Content-Type: application/octet-stream
Content-Disposition: form-data; name="Yealink SIP-T30P.cfg"; filename="Yealink SIP-T30P.cfg"
Content-Transfer-Encoding: binary
BINARY BODY OF 'Yealink SIP-T30P.cfg'
-----------boundary_69df8120352a996e--Getting meta-information about a file
Returns meta-information about the file, including the size in the header Content-Length.
Features
-
HTTP-the response does not contain a body, despite the presence of a header
Content-Length.
Request
| Name | Type | Description |
|---|---|---|
|
|
Issuance Type. Default
|
HEAD /rest/v1/fs/targets/ap_templates/Yealink SIP-T30P.cfg?attachment=true HTTP/1.1See also
-
Ready-made configuration files ap_configurations
-
Site constants files ap_constants
-
role ap
-
Essence sipuser