The field sets defined on a Nue-supported object. Field sets are not uniform across the Nue object model - \"Fields Expose to Nue\" exists on every supported object, \"Nue Custom Fields\" on only some and \"Plugin Price Calculation Fields\" on fewer still - so read this before offering a choice of field sets, rather than assuming a fixed list.
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "objectName", "type": "string", "example": "", "description": "The Nue object to read field sets for, e.g. QuoteLineItem
" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "*/*" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "The field sets defined on the object", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "", "description": "A field set defined on a Nue-supported object.
", "customType": "FieldSetResponse", "schema": [ { "name": "apiName", "kind": "optional", "type": "string", "description": "Fully-qualified api name, including the namespace of the package that owns the field set. Pass this value back to reference the field set.
", "example": "Ruby__NueAvailableFields" }, { "name": "label", "kind": "optional", "type": "string", "description": "Label shown in Salesforce.", "example": "Nue Custom Fields" }, { "name": "description", "kind": "optional", "type": "string", "description": "What the field set controls, as described in Salesforce.
", "example": "" }, { "name": "requiredForNue", "kind": "optional", "type": "boolean", "description": "True for the field set that makes a custom field visible to Nue at all. It is added by field creation unconditionally, so a caller never has to ask about it.
", "example": "" } ], "modelRef": "#/components/schemas/FieldSetResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "The object is not one Nue synchronizes custom fields for", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true }, { "statusCode": "501", "description": "The tenant is not Salesforce-integrated
", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "q9G2KqQBxG94QwN0v2RRh", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/cpq/objects/{objectName}/field-sets \\\n --header 'accept: application/json'" }, { "id": "z1PIORxkX0OBzV8QaoZTC", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/cpq/objects/{objectName}/field-sets\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "2xCoMMX9-OXvkuzqtNYEa", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/cpq/objects/{objectName}/field-sets\")\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\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "qZx-GubeXmg3L-Wn3GSVA", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/cpq/objects/{objectName}/field-sets\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "q9G2KqQBxG94QwN0v2RRh" }, "results": { "languages": [ { "id": "KzAjbvoDgrEK0B6y8Ca6G", "language": "200", "code": "// The field sets defined on the object\n{\n \"apiName\": \"Ruby__NueAvailableFields\",\n \"label\": \"Nue Custom Fields\",\n \"description\": \"\",\n \"requiredForNue\": false\n}" }, { "id": "yGmzgTSKyRwg3ATLt36Y9", "language": "400", "code": "// The object is not one Nue synchronizes custom fields for\n" }, { "id": "fZ5hVaWbbt4bmr2N9C6B0", "language": "404", "code": "// Not Found\n" }, { "id": "uM4ckVx426m_q58CKy-79", "language": "501", "code": "// The tenant is not Salesforce-integrated\n" } ], "selectedLanguageId": "KzAjbvoDgrEK0B6y8Ca6G" } }, "children": [ { "text": "" } ] }