(DEPRECATED) This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.
", "scheme": "bearer" }, { "id": "ApiKeyAccess", "name": "X-Upstart-Api-Key", "kind": "optional", "type": "apiKey", "description": "Api key based authorization.", "in": "header" }, { "id": "SessionIdAccess", "name": "X-Upstart-Session-Id", "kind": "optional", "type": "apiKey", "description": "Session based authorization. This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.
", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Configuration with given Key returned successfully.", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "Allow", "description": "" }, { "kind": "optional", "name": "ETag", "description": "" }, { "kind": "optional", "name": "Cache-Control", "description": "" }, { "kind": "optional", "name": "Content-Type", "description": "" }, { "kind": "optional", "name": "Location", "description": "" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "PreviewConfiguration.json", "schema": [], "modelRef": "schemas/Preview/PreviewConfiguration.json", "isExpanded": true } ] }, { "statusCode": "304", "description": "This is used to indicate that the client's cached copy of a resource is not yet modified. Resource is valid and can be used instead of requesting a new copy from the server.", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ValidationErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "403", "description": "User's roles are insufficient for this endpoint.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "405", "description": "This is to indicate that the server has received a request with an HTTP method that is not supported for the requested resource.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "406", "description": "This is to indicate that the resource requested by the client cannot be provided in a format that is acceptable according to the Accept headers sent in the request.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] }, { "statusCode": "default", "description": "This is the default internal server error. System was not able to process this request.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse.json", "schema": [], "modelRef": "RestAPI/GeneralRestResponse/ErrorResponse.json", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "yL8Vt0a_ST2oPMHY_lSp9", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.upstartcommerce.com/pim/preview/{key}/configuration \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --header 'x-upstart-site: string'" }, { "id": "nAqmero_qzE2yCCskiETc", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\nmyHeaders.append(\"x-upstart-site\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/pim/preview/{key}/configuration\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "dpkYG4uiJMxLGNo50gHb1", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/pim/preview/{key}/configuration\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest[\"x-upstart-site\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "KsvNWhbi1Piyaaa2Yl7I5", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/pim/preview/{key}/configuration\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string',\n 'x-upstart-site': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "yL8Vt0a_ST2oPMHY_lSp9" }, "results": { "languages": [ { "id": "rC87W-8kinMgXVB97d3J7", "language": "200", "code": "// Configuration with given Key returned successfully.\n{}" }, { "id": "riwqcRtbvTbXHWdpBSCLK", "language": "304", "code": "// This is used to indicate that the client's cached copy of a resource is not yet modified. Resource is valid and can be used instead of requesting a new copy from the server.\n" }, { "id": "FjF372jHCRQ61cTfuE29p", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{}" }, { "id": "rHBHswayHdv5yibIM7ORZ", "language": "401", "code": "// The provided credentials were not valid for this endpoint.\n{}" }, { "id": "3i7O4Bf9mq4DpYZC8Pnw4", "language": "403", "code": "// User's roles are insufficient for this endpoint.\n{}" }, { "id": "AAYqCIBuz_cqkIwfPOIBH", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{}" }, { "id": "gvBvkdCInppk7_fQRrGEW", "language": "405", "code": "// This is to indicate that the server has received a request with an HTTP method that is not supported for the requested resource.\n{}" }, { "id": "hfnIfN471bzdZnGbOsBK_", "language": "406", "code": "// This is to indicate that the resource requested by the client cannot be provided in a format that is acceptable according to the Accept headers sent in the request.\n{}" }, { "id": "8QlK6QOTHLjiDcN7knVAU", "language": "default", "code": "// This is the default internal server error. System was not able to process this request.\n{}" } ], "selectedLanguageId": "rC87W-8kinMgXVB97d3J7" } }, "children": [ { "text": "" } ] }