Displays

methods allow you to get a complete list or a specific display in eyrene, view information about them, update all fields, or only select display fields also, you can delete the display by id \get\ /displays retrieve a list of displays { "tab" "request", "url" "https //instance name/api/v1 5/displays/", "name" "request example", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "limit", "type" "string", "description" "number of results to return per page " }, { "kind" "optional", "name" "offset", "type" "string", "description" "the initial index from which to return the results " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "1rlklko5jlhtk3s80ce0g", "code" "{\n \\"count\\" 2,\n \\"next\\" \\"http //example com\\",\n \\"previous\\"\ null,\n \\"results\\" \[\n {\n \\"id\\" 29,\n \\"name\\" \\"windmill , sia, veikals\\",\n \\"musthavelist\\"\ null\n },\n {\n \\"id\\" 4,\n \\"name\\" \\"spartan lv\\",\n \\"musthavelist\\" 6\n },\n {\n \\"id\\" 3,\n \\"name\\" \\"riela latvia\\",\n \\"musthavelist\\" 5\n },\n {\n \\"id\\" 37,\n \\"name\\" \\"hermess\\",\n \\"musthavelist\\"\ null\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "1rlklko5jlhtk3s80ce0g" }, "examples" { "languages" \[ { "id" "cu1xhlxz5phaulfx iif1", "code" "curl –i –x get\r\n https //test eyrene com/api/v1 5/displays/\r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ \r\n –f \\"limit=2\\" \\\\\r\n –f \\"offset=0\\" ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "get /displays", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "autogeneratedanchorslug" "request example", "legacyhash" "pmbc5rutypcr7hqiqwnhk" } response parameters https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands#response definitions count integer the number \\ of displays next string (uri) \nullable\ next page previous string (uri) \nullable\ previous page results a rray of objects \\ an array of objects with information about displays id string unique id name string human readable name planogram string planogram id optional musthavelist string must have list id optional \post\ /displays сreate a new display { "tab" "request", "url" "https //instance name/api/v1 5/displays/", "name" "request example", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "id", "type" "string", "description" "unique id " }, { "kind" "optional", "name" "name", "type" "string", "description" "human readable name " }, { "kind" "optional", "name" "planogram", "type" "string", "description" "planogram id " }, { "kind" "optional", "name" "musthavelist", "type" "string", "description" "must have list id " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "xcvqafq2rcx iopukqj43", "code" "{\n \\"result\\" \\"created\\"\n}", "language" "201", "customlabel" "" } ], "selectedlanguageid" "xcvqafq2rcx iopukqj43" }, "examples" { "languages" \[ { "id" "cu1xhlxz5phaulfx iif1", "code" "curl –i –x post\r\n https //test eyrene com/api/v1 5/displays/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ \r\n f \\"id=458\\" \\\\\r\n f \\"name=hermess\\" \\\\\r\n f \\"planogram=45\\" \\\\\r\n f \\"musthavelist=5\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "post /displays", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "autogeneratedanchorslug" "request example 1", "legacyhash" "wwlon9zt7fv9anndwf5qq" } \get\ /displays/{id} retrieve detailed information about the display by id { "tab" "request", "url" "https //instance name/api/data/v1 5/displays/{id}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "display id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bcmdi d9um v1lp9epj4i", "code" "{\n \\"id\\" 69,\n \\"name\\" \\"hermess\\",\n \\"planogram\\" 5,\n \\"musthavelist\\" 4\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "bcmdi d9um v1lp9epj4i" }, "examples" { "languages" \[ { "id" "cu1xhlxz5phaulfx iif1", "code" "curl –i –x get\r\n https //test eyrene com/api/v1 5/displays/69/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "get /displays/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "autogeneratedanchorslug" "request example 2", "legacyhash" "6pzyk9 vtv8h2f6898w1z" } response parameters id string unique id name string human readable name planogram string planogram id musthavelist string must have list id https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions \put\ /displays/{id} update all fields of the display { "tab" "request", "url" "https //instance name/api/v1 5/displays/{id}", "name" "request example", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "display id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "id", "type" "string", "description" "unique id " }, { "kind" "optional", "name" "name", "type" "string", "description" "human readable name " }, { "kind" "optional", "name" "planogram", "type" "string", "description" "planogram id " }, { "kind" "optional", "name" "musthavelist", "type" "string", "description" "must have list id " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "l7odtgv1iy14re9xv3axq", "code" "{\n \\"id\\" 101,\n \\"name\\" \\"hermess\\",\n \\"planogram\\" 15,\n \\"musthavelist\\" 3\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "l7odtgv1iy14re9xv3axq" }, "examples" { "languages" \[ { "id" "gbxujakfuej3yazlqwoid", "code" "curl –i –x put\n https //test inspector cloud com/api/v1 5/displays/69/ \n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ \n f \\"id=101\\" \\\\\n f \\"name\\"=\\"hermess\\" \\\\\n f \\"planogram\\"=\\"15\\" \\\\\n f \\"musthavelist\\"=\\"3\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "gbxujakfuej3yazlqwoid" }, "description" "put /displays/{id}", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "autogeneratedanchorslug" "request example 3", "legacyhash" "ykxwagyeodgze0sp6jtrl" } https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions 1 response parameters id string unique id name string human readable name planogram string planogram id musthavelist string must have list id \patch\ /displays/{id} update some of the fields in the display { "tab" "request", "url" "https //instance name/api/v1 5/displays/{id}", "name" "request example", "method" "patch", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "display id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "id", "type" "string", "description" "unique id " }, { "kind" "optional", "name" "name", "type" "string", "description" "human readable name " }, { "kind" "optional", "name" "planogram", "type" "string", "description" "planogram id " }, { "kind" "optional", "name" "musthavelist", "type" "string", "description" "must have list id " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bcmdi d9um v1lp9epj4i", "code" "{\n \\"id\\" 69,\n \\"name\\" \\"hermess\\",\n \\"planogram\\" 15,\n \\"musthavelist\\" 4\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "bcmdi d9um v1lp9epj4i" }, "examples" { "languages" \[ { "id" "cu1xhlxz5phaulfx iif1", "code" "curl –i –x patch\r\n https //test eyrene com/api/v1 5/displays/69/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’\r\n f \\"name\\"=\\"hermess\\" \\\\\r\n f \\"planogram\\"=\\"15\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "patch /displays/{id}", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "autogeneratedanchorslug" "request example 4", "legacyhash" "rv4tthvbcmd3peva9depo" } response parameters https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions 1 id string unique id name string human readable name planogram string planogram id musthavelist string must have list id \\ \delete\ /displays/{id} delete display by id { "tab" "request", "url" "https //instance name/api/v1 5/displays/{id}", "name" "request example", "method" "delete", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "display id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "du9xr9j8bu4jftmv8bpry", "code" "{\n \\"result\\" \\"ok\\"\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "du9xr9j8bu4jftmv8bpry" }, "examples" { "languages" \[ { "id" "n8qhhtsdo9fbqybtrcldg", "code" "curl –i –x delete\n https //test eyrene com/api/v1 5/displays/69/\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "n8qhhtsdo9fbqybtrcldg" }, "description" "delete /displays/{id}", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" }, "autogeneratedanchorslug" "request example 5", "legacyhash" "joz7xxpksnna6lnmfrvaj" }