JSON API » patternmenus » patternmenus/patterns/get

Gets the fields of a pattern.

Input parameters

Requires authentication and the user role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of pattern to get.Yes

Responses

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

Data returned

Fields of pattern.

Example: With required parameters

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

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

Change history

VersionChanges
3.13Function added.