JSON API » patternmenus » patternmenus/patterns/import
Imports patterns from a CSV file.
Input parameters
Requires authentication and the user role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
csv | String | The contents of the CSV file. | Yes | |
patternmenu | Integer | ID of pattern menu. | Yes | |
delete | Integer | 1 to delete all patterns in pattern menu first, 0 not to. | No | 0 |
overwrite | Integer | 1 to allow overwriting of existing patterns, 0 not to. | No | 0 |
Responses
Code | Description |
---|---|
200 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
403 | Your rate plan does not allow this. |
404 | The pattern menu does not exist, or you do not have permission to view it. |
500 | An internal error occurred. Check the key and message fields for more details. |
Data returned
The number of patterns created.
Example: With required parameters (csv field omitted for brevity)
http://enswitch.example.com/api/json/patternmenus/patterns/import/?auth_username=user;auth_password=password;patternmenu=1;csv=...{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":123 } }
Change history
Version | Changes |
---|---|
3.13 | Function added. |