Planning App APIs
Plan Settings
Update specific plan setting
1 min
code examples curl location globoff request put 'https //{tenantsubdomain}/tms/api/v1/planning/plan settings/{setting name}' \\ \ header 'accept application/json' \\ \ header 'content type application/json' \\ \ header 'x coreos request id string' \\ \ header 'x coreos tid string' \\ \ header 'x coreos access string' \\ \ header 'x coreos userinfo string'var myheaders = new headers(); myheaders append("accept", "application/json"); myheaders append("content type", "application/json"); myheaders append("x coreos request id", "string"); myheaders append("x coreos tid", "string"); myheaders append("x coreos access", "string"); myheaders append("x coreos userinfo", "string"); var requestoptions = { method 'put', headers myheaders, redirect 'follow' }; fetch("https //{tenantsubdomain}/tms/api/v1/planning/plan settings/{setting name}", requestoptions) then(response => response text()) then(result => console log(result)) catch(error => console log('error', error));require "uri" require "json" require "net/http" url = uri("https //{tenantsubdomain}/tms/api/v1/planning/plan settings/{setting name}") https = net http new(url host, url port) https use ssl = true request = net http put new(url) request\["accept"] = "application/json" request\["content type"] = "application/json" request\["x coreos request id"] = "string" request\["x coreos tid"] = "string" request\["x coreos access"] = "string" request\["x coreos userinfo"] = "string" response = https request(request) puts response read body import requests import json url = "https //{tenantsubdomain}/tms/api/v1/planning/plan settings/{setting name}" payload = {} headers = { 'accept' 'application/json', 'content type' 'application/json', 'x coreos request id' 'string', 'x coreos tid' 'string', 'x coreos access' 'string', 'x coreos userinfo' 'string' } response = requests request("put", url, headers=headers, data=payload) print(response text) responses // plan setting update response { "success" true, "data" { "request id" "", "id" "configs\ a6edb285 f29a 5f30 a02c ee558320ecaf", "request" { "uri" "/core/api/v2/entity/configs/configs\ a6edb285 f29a 5f30 a02c ee558320ecaf", "method" "put", "querystring" "{}", "body" { "properties" { "configdetails" { "minweightutilization" 1, "minvolumeutilization" 1, "maxstops" 2, "detourkms" 1, "customersplit" true, "ordersplit" true, "planltl" true, "consolidateltl" true, "replanexistingload" true } }, "callback" { "url" "https //os1devs sandbox getos1 com/tms/api/v1/configs/callback", "meta" {} } } } } }// plan setting update error { "success" false, "error" { "code" 400, "message" "error updating plan setting" } }// plan setting not found { "success" false, "error" { "code" 404, "message" "plan setting not found" } }// internal server error
