| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\ntableName\n\n | \n\nName of the table that contains the server-side script, such as sys\\_script or sys\\_script\\_include.Data type: String\n\n |
| \n\nsysId\n\n | \n\nSys\\_id for the server-side script.Data type: String\n\n |
| \n\nfieldName\n\n | \n\nName of the field that contains the server-side script content.Data type: String\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\ncanWrite\n\n | \n\nFlag indicating whether the currently logged in user can set or modify breakpoints for the script.Possible values:\n\n- true: You can set or modify breakpoints.\n- false: You cannot set or modify breakpoints.\n\n Data type: Boolean\n\n |
| \n\ndebugpoints\n\n | \n\nList of all the breakpoints and logpoints in the script.```\n\"debugpoints\": {\n \"breakpoint\": {Object}\n \"logpoint\": {Object}\n}\n```\n\n Data type: Object\n\n |
| \n\ndebugpoints.breakpoint\n\n | \n\nList of all the breakpoints in the script, presented as key-value pairs. The key is the line number for the breakpoint. The value is an object containing the breakpoint's sys\\_id and text.```\n\"breakpoint\": {\n |
| \n\ndebugpoints.breakpoint.<line\\_number>\n\n | \n\nLine number for the breakpoint.```\n |
| \n\ndebugpoints.breakpoint.<line\\_number>.evaluationString\n\n | \n\nText of the breakpoint. If the breakpoint is conditional, the evaluationString contains the condition text. If the breakpoint is not conditional, the evaluationString is an empty string. Data type: String\n\n |
| \n\ndebugpoints.breakpoint.<line\\_number>.sysId\n\n | \n\nSys\\_id of the breakpoint.Data type: String\n\n |
| \n\ndebugpoints.logpoint\n\n | \n\nList of all the logpoints in the script, presented as key-value pairs. The key is the line number for the logpoint. The value is an object containing the logpoint's sys\\_id and text.```\n\"logpoint\": {\n |
| \n\ndebugpoints.logpoint.<line\\_number>\n\n | \n\nLine number for the logpoint.```\n |
| \n\ndebugpoints.logpoint.<line\\_number>.evaluationString\n\n | \n\nText of the logpoint. Contains the message being logged.Data type: String\n\n |
| \n\ndebugpoints.logpoint.<line\\_number>.sysId\n\n | \n\nSys\\_id of the logpoint.Data type: String\n\n |
| \n\nkey\n\n | \n\nObject providing details about the script being debugged. ```\n\"key\": {\n \"scriptField\": \"String\"\n \"scriptId\": \"String\"\n \"scriptType\": \"String\"\n \"value\": \"String\"\n}\n```\n\n Data type: Object\n\n |
| \n\nkey.scriptField\n\n | \n\nName of the field that contains the script.Data type: String\n\n |
| \n\nkey.scriptId\n\n | \n\nSys\\_id of the script.Data type: String\n\n |
| \n\nkey.scriptType\n\n | \n\nName of the table that contains the script.Data type: String\n\n |
| \n\nkey.value\n\n | \n\nThe path parameters used to make the request. Listed in the following order.- tableName\n- sysId\n- fieldName\n\n Data type: String\n\n |
| \n\nname\n\n | \n\nName of the script.Data type: String\n\n |
| \n\nscript\n\n | \n\nText displaying the script's code.Data type: String\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nfetchAll\n\n | \n\nWhen true, returns a list of all the breakpoints or logpoints added or updated by the user.Data type: Boolean\n\n Default: false\n\n |
| \n\nfetchAllFilter\n\n | \n\nReturns a filtered list of all the breakpoints or logpoints added or updated by the user.\n\n Valid values:\n\n- debugpointType. Set to either breakpoint or logpoint.\n- scriptId. Set to the sys\\_id of the script in which to search for debug points.\n- scope. Set to the name of the scope in which to search for debug points.\n\n Use the caret \\(^\\) symbol as a separator for multiple properties. For example, `fetchAllFilter=debugpointType=logpoint^scope=MyApp`\n\n Data type: String\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\ndebugpointType\n\n | \n\nRequired. Type of debug point to add, delete, or update.\n\n Valid values:\n\n- breakpoint\n- logpoint\n\n Data type: String\n\n |
| \n\nevaluationString\n\n | \n\nText for a logpoint or conditional breakpoint.\n\n For a logpoint, the **evaluationString** is the log message.\n\n For a conditional breakpoint, the **evaluationString** is the condition. For example, if you're looping through a list of user IDs and you want the debugger to pause only when the user ID is 38493, you can add a conditional breakpoint inside the loop with `userID == 38493` as the condition. The debugger will only pause at this breakpoint when the condition is true.\n\n If the breakpoint is not a conditional breakpoint, the **evaluationString** is an empty string.\n\n Data type: String\n\n |
| \n\nfieldName\n\n | \n\nRequired. Name of the field that contains the server-side script content.Data type: String\n\n |
| \n\nlineNumber\n\n | \n\nLine number in the server-side script specifying where to add, delete, or update the breakpoint or logpoint.Data type: Number\n\n |
| \n\noperation\n\n | \n\nRequired. Operation to perform for the breakpoint or logpoint.Valid values:\n\n- add\n- delete\n- update\n\n Data type: String\n\n |
| \n\nscriptId\n\n | \n\nRequired. Sys\\_id for the server-side script.Data type: String\n\n |
| \n\ntableName\n\n | \n\nRequired. Name of the table that contains the server-side script, such as sys\\_script or sys\\_script\\_include.Data type: String\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n |
| \n\nContent-Type\n\n | \n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nrequestedDebugpoints\n\n | \n\nList of the requested breakpoints and logpoints. Presented as an array of objects.```\n\"requestedDebugpoints\": [\n {\n \"scriptId\": \"String\",\n \"evaluationString\": \"String\",\n \"operation\": \"String\",\n \"tableName\": \"String\",\n \"fieldName\": \"String\",\n \"status\": \"String\",\n \"lineNumber\": Number,\n \"debugpointType\": \"String\"\n }\n]\n```\n\n Data type: Array\n\n |
| \n\nrequestedDebugpoints.ScriptId\n\n | \n\nSys\\_id for the server-side script.Data type: String\n\n |
| \n\nrequestedDebugpoints.evaluationString\n\n | \n\nText added for a logpoint or conditional breakpoint. For a logpoint, the **evaluationString** is the log message. For a conditional breakpoint, the **evaluationString** is the condition. Data type: String\n\n |
| \n\nrequestedDebugpoints.operation\n\n | \n\nOperation performed for the breakpoint or logpoint.\n\n Possible values:\n\n- add\n- delete\n- update\n\n Data type: String\n\n |
| \n\nrequestedDebugpoints.tableName\n\n | \n\nName of the table that contains the server-side script, such as sys\\_script or sys\\_script\\_include.Data type: String\n\n |
| \n\nrequestedDebugpoints.fieldName\n\n | \n\nName of the field that contains the server-side script content.Data type: String\n\n |
| \n\nrequestedDebugpoints.status\n\n | \n\nResult of the instruction to add, delete, or update a specific breakpoint or logpoint.\n\n Possible values:\n\n- failure\n- ignored\n- success\n\n A request to add, delete, or update a debug point is ignored in the following situations:\n\n- It requests to delete a breakpoint or logpoint that doesn't exist.\n- It requests to add a breakpoint or logpoint identical to one that already exists.\n\n Data type: String\n\n |
| \n\nrequestedDebugpoints.lineNumber\n\n | \n\nLine number in the server-side script specifying where the breakpoint or logpoint was added, deleted, or updated.Data type: Number\n\n |
| \n\nrequestedDebugpoints.debugpointType\n\n | \n\nType of debug point added, deleted, or updated.\n\n Possible values:\n\n- breakpoint\n- logpoint\n\n Data type: String\n\n |
| \n\nstatus\n\n | \n\nResult of the overall action. The status code for the HTTP call.Data type: Number\n\n |