Update an existing schema by either adding new columns or updating the Identifier Name.
\nThe request differs based on whether adding new columns or updating Identifier Name\nMust only supply either fields or named_identifier (but not both) in the params body.\nResponse will return either fields or named_identifier, depending on which was supplied.
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "schema-name", "type": "string", "description": "The name of the Schema." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "meta", "data" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "example": "{\"name\":\"catalog\",\"type\":\"event\",\"fields\":{\"new_field\":{\"data_type\":\"STRING\"}}}", "description": "Within a Schema, fields must have unique names.
\nColumns passed in the fields property are added to the schema.
", "customType": "SchemaPatch", "schema": [ { "name": "fields", "kind": "required", "type": "map", "description": "The fields that define the structure of this Schema.", "example": "", "customType": "mapThe Monetate Data API uses Token Authentication, so requests to the Data API must include a valid, active authentication token. Include an Authorization header with the value Token [token_string] with every request. See Auth API for information on obtaining the token_string.
Within a Schema, fields must have unique names.
\nColumns passed in the fields property are added to the schema.
", "example": "{\"name\":\"catalog\",\"type\":\"event\",\"fields\":{\"new_field\":{\"data_type\":\"STRING\"}}}", "modelRef": "#/components/schemas/SchemaPatch", "customType": "SchemaPatch", "schema": [ { "name": "fields", "kind": "required", "type": "map", "description": "The fields that define the structure of this Schema.", "example": "", "customType": "mapValidation error.
\nOne or more values being sent was not in the correct format, or a required value was missing.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Response", "schema": [ { "name": "meta", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseMeta", "customType": "ResponseMeta", "schema": [ { "name": "code", "kind": "required", "type": "integer", "description": "The http response code for this response.", "example": 200 }, { "name": "warnings", "kind": "optional", "type": "array", "description": "A list of warnings associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of errors associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseAnyData", "customType": "ResponseAnyData", "schema": [] } ], "modelRef": "#/components/schemas/Response", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized.
\nThe request did not include a token, or the token provided was invalid. Please ensure that your token is correct and that the Authorization header is properly formatted.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Response", "schema": [ { "name": "meta", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseMeta", "customType": "ResponseMeta", "schema": [ { "name": "code", "kind": "required", "type": "integer", "description": "The http response code for this response.", "example": 200 }, { "name": "warnings", "kind": "optional", "type": "array", "description": "A list of warnings associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of errors associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseAnyData", "customType": "ResponseAnyData", "schema": [] } ], "modelRef": "#/components/schemas/Response", "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden.\n\nThe request included a token that has been revoked. Please contact your account administrator to generate a new token.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Response", "schema": [ { "name": "meta", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseMeta", "customType": "ResponseMeta", "schema": [ { "name": "code", "kind": "required", "type": "integer", "description": "The http response code for this response.", "example": 200 }, { "name": "warnings", "kind": "optional", "type": "array", "description": "A list of warnings associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of errors associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseAnyData", "customType": "ResponseAnyData", "schema": [] } ], "modelRef": "#/components/schemas/Response", "isExpanded": true } ] }, { "statusCode": "500", "description": "Unknown error.\n\nPlease try again or contact your account manager for more information.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Response", "schema": [ { "name": "meta", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseMeta", "customType": "ResponseMeta", "schema": [ { "name": "code", "kind": "required", "type": "integer", "description": "The http response code for this response.", "example": 200 }, { "name": "warnings", "kind": "optional", "type": "array", "description": "A list of warnings associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of errors associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseAnyData", "customType": "ResponseAnyData", "schema": [] } ], "modelRef": "#/components/schemas/Response", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "6rrn6Xhk61HhoMklLvtHg", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://api.monetate.net/api/data/v1/{retailerShortname}/production/schema/{schema-name}/ \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"fields\": \"\"\n }'" }, { "id": "M9EeSwZeZL_J8qy-zvumh", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"fields\": \"\"\n});\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.monetate.net/api/data/v1/{retailerShortname}/production/schema/{schema-name}/\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "o7Z-LT8pf9dqMnKJmxRdb", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.monetate.net/api/data/v1/{retailerShortname}/production/schema/{schema-name}/\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"fields\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "mgUnq3Azs4tvg7OeNnLyf", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.monetate.net/api/data/v1/{retailerShortname}/production/schema/{schema-name}/\"\n\npayload = json.dumps({\n \"fields\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "6rrn6Xhk61HhoMklLvtHg" }, "results": { "languages": [ { "id": "oaphxph2Dgv3i_LKV5bWY", "language": "200", "code": "// Schema patched. Content is the definition of the modified Schema.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {\n \"fields\": \"\"\n }\n}" }, { "id": "DLc4b1VAqWOC12H1Uv7MR", "language": "400", "code": "// Validation error.\nOne or more values being sent was not in the correct format, or a required value was missing.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}" }, { "id": "oB3HMHqmshoT_krLhzSlP", "language": "401", "code": "// Unauthorized.\nThe request did not include a token, or the token provided was invalid. Please ensure that your token is correct and that the Authorization header is properly formatted.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}" }, { "id": "83DG6XY8Q85v2jN5RRXey", "language": "403", "code": "// Forbidden.\n\nThe request included a token that has been revoked. Please contact your account administrator to generate a new token.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}" }, { "id": "vvoaav2i8ko5hfn_xtINZ", "language": "500", "code": "// Unknown error.\n\nPlease try again or contact your account manager for more information.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}" } ], "selectedLanguageId": "oaphxph2Dgv3i_LKV5bWY" } }, "children": [ { "text": "" } ] }