Release Floating Feature

{ "tab" "examples", "url" "/api/v4/floating/feature release", "name" "/api/v4/floating/feature release", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "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" \[ { "kind" "required", "name" "hardware id", "type" "string", "children" \[], "description" "unique hardware id generated for the client device" }, { "kind" "required", "name" "product", "type" "string", "children" \[], "description" "product short code" }, { "name" "feature", "kind" "required", "type" "string", "description" "feature code", "children" \[] }, { "kind" "optional", "name" "license key", "type" "string", "children" \[], "description" "required if product is key based (see section below)" }, { "kind" "optional", "name" "username", "type" "string", "children" \[], "description" "required if product is user based (see section below)" }, { "name" "license id", "kind" "optional", "type" "number", "description" "ensures that the action affects only the license with the specified id this is useful if e g you have multiple licenses for the same product assigned to the same user for obtaining a list of licenses assigned to a user, see \\"user licenses\\"", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "es8g1cukjmbnpiivt9vof", "code" "", "language" "200", "customlabel" "" }, { "id" "7eyilksv2qgjcowesdz 2", "code" "{\n \\"unknown product\\" \\"provided product was not found\\",\n \\"license not found\\" \\"license with the provided license user not found\\",\n \\"license not enabled\\" \\"the license is not enabled\\",\n \\"blacklisted\\" \\"this device is blacklisted\\",\n \\"device not found\\" \\"an active device matching the hardware id not found \\",\n\n \n", "language" "400", "customlabel" "" } ], "selectedlanguageid" "es8g1cukjmbnpiivt9vof" }, "examples" { "languages" \[ { "id" "gkoknmhsn2llagztjoloh", "language" "curl", "code" "curl location request post '/api/v4/floating/feature release' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data raw '{\\"hardware id\\" \\"string\\",\\"product\\" \\"string\\",\\"feature\\" \\"string\\",\\"license key\\" \\"string\\",\\"username\\" \\"string\\"}'", "customlabel" "" }, { "id" "bbny8xi6g1lpxedqmv 3g", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' '/api/v4/floating/feature release',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"hardware id\\" \\"string\\",\n \\"product\\" \\"string\\",\n \\"feature\\" \\"string\\",\n \\"license key\\" \\"string\\",\n \\"username\\" \\"string\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "4dd 4o k5iuxwm6gacj6i", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"hardware id\\" \\"string\\",\n \\"product\\" \\"string\\",\n \\"feature\\" \\"string\\",\n \\"license key\\" \\"string\\",\n \\"username\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"/api/v4/floating/feature release\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "nk2b0fgo8l4qkgsvwwreo", "language" "python", "code" "import requests\nimport json\n\nurl = \\"/api/v4/floating/feature release\\"\n\npayload = json dumps({\n \\"hardware id\\" \\"string\\",\n \\"product\\" \\"string\\",\n \\"feature\\" \\"string\\",\n \\"license key\\" \\"string\\",\n \\"username\\" \\"string\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "e2vpkyujwq488crzlsip ", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"/api/v4/floating/feature release\\")\n\nhttp = net http new(url host, url port);\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"hardware id\\" \\"string\\",\n \\"product\\" \\"string\\",\n \\"feature\\" \\"string\\",\n \\"license key\\" \\"string\\",\n \\"username\\" \\"string\\"\n})\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "gkoknmhsn2llagztjoloh" }, "description" "releases a floating license feature which is currently being borrowed by a license device", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } schema request body type releaseflotingfeaturerequestbody = { // required parameters product string, hardware id string, feature string, // required for key based products license key string, // required for user based products username string, // optional parameters license id? string | undefined, } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "allof" \[ { "oneof" \[ { "type" "object", "properties" { "license key" { "type" "string" } }, "required" \["license key"], "additionalproperties" false }, { "type" "object", "properties" { "username" { "type" "string" } }, "required" \["username"], "additionalproperties" false } ] }, { "type" "object", "properties" { "hardware id" { "type" "string" }, "product" { "type" "string" }, "feature" { "type" "string" }, "license id" { "type" \["number", "null"] } }, "required" \["hardware id", "product", "feature"], "additionalproperties" false } ] } response body type releaseflotingfeatureresponsebody = '' json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "string", } license authorization method there are two types of product licenses based on how the client application authorizes itself to interact with a license key based product licenses client interactions with the license have to be authorized using a license key user based product licenses the license has a corresponding "license user" instead of a license key client interactions with the license have to be authorized using a username 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 }{ "$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 unknown product (400) provided product was not found license not found (400) license with the provided license user not found license not active (400) the license is not active license not enabled (400) the license is not enabled device not found (400) an active device matching the hardware id not found blacklisted (400) this device is blacklisted floating feature device not in use (400) floating feature device is not in use invalid license feature code (400) license feature code ' + param + ' is invalid or not assigned to the license feature not floating (400) license feature is not floating cloud feature