JSON API » patternmenus » patternmenus/patterns/import

Imports patterns from a CSV file.

Input parameters

Requires authentication and the user role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
csvStringThe contents of the CSV file.Yes
patternmenuIntegerID of pattern menu.Yes
deleteInteger1 to delete all patterns in pattern menu first, 0 not to.No0
overwriteInteger1 to allow overwriting of existing patterns, 0 not to.No0

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your rate plan does not allow this.
404The pattern menu does not exist, or you do not have permission to view it.
500An 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

VersionChanges
3.13Function added.