Lists the approval processes configured for an object, in the order the engine evaluates them. Supply either objectType or recordId; when recordId is supplied the object is derived from it and only processes applicable to that record are returned.
The response is the standard approvals envelope: status is SUCCESS or FAILURE, data carries the typed payload, and warnings and errors carry coded messages. Validation and engine failures are reported as coded errors on the envelope rather than as exceptions.
Object to list processes for, e.g. Quote. Required unless recordId is supplied.
Record to derive the object from. Required unless objectType is supplied.
SUCCESS or FAILURE.
A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] }, { "name": "errors", "kind": "optional", "type": "array", "description": "A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] } ], "modelRef": "#/components/schemas/ApprovalProcessesResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Missing or invalid parameter.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Envelope returned by the approval action verbs.", "customType": "ApprovalActionResponse", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "SUCCESS or FAILURE.
A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] }, { "name": "errors", "kind": "optional", "type": "array", "description": "A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] } ], "modelRef": "#/components/schemas/ApprovalActionResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Authentication failed or the Salesforce session is unavailable.", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Record not found.", "jsonExample": "", "isExpanded": true }, { "statusCode": "429", "description": "Salesforce limit exceeded.", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Unexpected or upstream failure.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "Zb6b_Yo4OKKHd1578fZ-b", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/cpq/approval-processes \\\n --header 'accept: application/json'" }, { "id": "j2RM5JAddMfD98wWG25ip", "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/approval-processes\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "HorMww6eF0PpR_-Khl9LU", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/cpq/approval-processes\")\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": "tYZF92YMIxJ6OJavxvTpJ", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/cpq/approval-processes\"\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": "Zb6b_Yo4OKKHd1578fZ-b" }, "results": { "languages": [ { "id": "CDEOLpRZPZcNOJro9j-XG", "language": "200", "code": "// Approval processes returned.\n{\n \"status\": \"\",\n \"data\": {\n \"objectType\": \"\",\n \"processes\": [\n {\n \"processName\": \"\",\n \"objectType\": \"\",\n \"versionNumber\": 0,\n \"isActive\": false,\n \"processOrder\": 0,\n \"appliesWhen\": \"\",\n \"description\": \"\"\n }\n ]\n },\n \"warnings\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"errors\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "id": "BZl3EduSavxlzbt670SWC", "language": "400", "code": "// Missing or invalid parameter.\n{\n \"status\": \"\",\n \"data\": {\n \"requestId\": \"\",\n \"recordId\": \"\",\n \"status\": \"\",\n \"isLocked\": false,\n \"approvers\": [\n {\n \"approvalId\": \"\",\n \"stepName\": \"\",\n \"stepStatus\": \"\",\n \"approverUserId\": \"\",\n \"originalApproverUserId\": \"\",\n \"reassignedFromApprovalId\": \"\",\n \"rejectionMessage\": \"\"\n }\n ],\n \"approvals\": [\n {\n \"approvalId\": \"\",\n \"stepName\": \"\",\n \"stepStatus\": \"\",\n \"approverUserId\": \"\",\n \"originalApproverUserId\": \"\",\n \"reassignedFromApprovalId\": \"\",\n \"rejectionMessage\": \"\"\n }\n ]\n },\n \"warnings\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"errors\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "id": "X4hNu7reQmYo5ty1W14uy", "language": "401", "code": "// Authentication failed or the Salesforce session is unavailable.\n" }, { "id": "0L9giEK-c7zpvy7Ase9ta", "language": "404", "code": "// Record not found.\n" }, { "id": "nsiSm6tWSbQPVW8qbF785", "language": "429", "code": "// Salesforce limit exceeded.\n" }, { "id": "LZhhfrXnvDpeum9TmUhXk", "language": "500", "code": "// Unexpected or upstream failure.\n" } ], "selectedLanguageId": "CDEOLpRZPZcNOJro9j-XG" } }, "children": [ { "text": "" } ] }