JSON API » patternmenus » patternmenus/patterns/list

Gets the fields of all patterns in a pattern menu.

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
patternmenu	Integer	ID of pattern menu.	Yes

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The pattern menu does not exist, or you do not have permission to view it.

Data returned

An array of fields, corresponding to the rows of the patterns table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/patternmenus/patterns/list/?auth_username=user;auth_password=password;patternmenu=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "patternmenu":123, ... }, { "id":2, "patternmenu":123, ... } ] }

Change history

Version	Changes
3.13	Function added.