Get Product Details

{ "tab" "examples", "url" "/api/v4/product details", "name" "/api/v4/product details", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "required", "name" "product", "type" "string", "children" \[], "description" "product short code" }, { "name" "include latest version", "kind" "optional", "type" "boolean", "description" "includes details on latest installation file (default false)", "children" \[] }, { "name" "include custom fields", "kind" "optional", "type" "boolean", "description" " include product custom fields definition (default false)", "children" \[] }, { "name" "env", "kind" "optional", "type" "string", "description" "filter products by environment string (as defined by installation file \\"environment\\")", "children" \[] } ], "headerparameters" \[ { "kind" "required", "name" "date", "type" "string", "children" \[], "description" "in rfc7231 format (see \\"license api authorization\\"), eg thu, 17 nov 2022 20 51 35 gmt" }, { "kind" "required", "name" "authorization", "type" "string", "children" \[], "description" "see \\"license api authorization\\" article" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "qlx3ifr3fpkeqnnhkuaxk", "code" "{\n \\"product id\\" 1683881296184003,\n \\"product name\\" \\"p\\",\n \\"short code\\" \\"p\\",\n \\"allow trial\\" false,\n \\"trial days\\" 0,\n \\"authorization method\\" \\"license key\\",\n \\"allow overages\\" false,\n \\"max overages\\" 0,\n \\"prevent vm\\" false,\n \\"floating timeout\\" 5,\n \\"metadata\\" {}\n}", "language" "200", "customlabel" "" }, { "id" "r7pnangflvc8rz1icgrv8", "code" "{\n \\"unknown product\\" \\"provided product code x was not found \\"\n \\"missing headers\\" \\"must have required property 'authorization'\\"\n \\"missing parameters\\" \\"missing parameters\\"\n }", "language" "404", "customlabel" "" } ], "selectedlanguageid" "qlx3ifr3fpkeqnnhkuaxk" }, "examples" { "languages" \[ { "id" "746pimyzys67xztczunvc", "language" "curl", "code" "curl location request get '/api/v4/product details?product=string' \\\\\n header 'accept application/json' \\\\\n header 'date string' \\\\\n header 'authorization string'", "customlabel" "" }, { "id" "k8bciwtmatn4gt61dmq0e", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' '/api/v4/product details?product=string',\n 'headers' {\n 'accept' 'application/json',\n 'date' 'string',\n 'authorization' 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "oc5yc zt4ro cm dazyo ", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"date\\", \\"string\\");\nmyheaders append(\\"authorization\\", \\"string\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"/api/v4/product details?product=string\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "kk fnent8xusln2ijnvbr", "language" "python", "code" "import requests\n\nurl = \\"/api/v4/product details?product=string\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json',\n 'date' 'string',\n 'authorization' 'string'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "6mws64fzwnja50ddenot7", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"/api/v4/product details?product=string\\")\n\nhttp = net http new(url host, url port);\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"date\\"] = \\"string\\"\nrequest\[\\"authorization\\"] = \\"string\\"\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "kk fnent8xusln2ijnvbr" }, "description" "returns all metadata for a product", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } schema request query parameters type productdetailsrequestparameters = { // required parameters product string, // required for key based products license key string // required for user based products username string // optional parameters license id? string | undefined, include latest version? boolean | undefined, include custom fields? boolean | undefined, } json schema response body type productdetailsresponsebody = { product id number; product name string; short code string; authorization method "license key" | "user"; floating timeout number; max overages number; trial days number; allow overages boolean; allow trial boolean; prevent vm boolean; metadata json; // this property is only present if "include custom fields" query param is true custom fields? { id number; name string; default value string; }\[] | undefined; // this property is only present if "include latest version" query param is true latest version? { version string | null; environment string | null; hash md5 string | null; eula link string | null; release notes link string | null; size string | null; requires version string | null; channel string | null; release date string | null; id number; product id number; enabled boolean; full link string | null; filename string | null; created at string; // date string in full iso 8601 format, e g "2024 09 27t23 30 48 016z" updated at string; // date string in full iso 8601 format, e g "2024 09 27t23 30 48 016z" } | undefined; } json schema if product does not have a version defined, it will return null if product does not have any custom fields defined, it will return an empty array errors if an error occurs, the response will have an http status code of 400 or higher, and the response body will contain an error description in the following format { status number, code string, message string } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "properties" { "status" { "type" "number" }, "code" { "type" "string" }, "message" { "type" "string" } }, "required" \[ "status", "code", "message" ], "additionalproperties" false } list of exceptions