Feedback API

Feedback API

Interact with Feedback records in ServiceNow through the ServiceNow Table API.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/servicenow/feedback

Version: v1

Schemes: https

Summary

Path Operation Description
/u_feedback* GET

returns a list of Feedback records
POST

creates a new Feedback record
/u_feedback/{sys_id}* GET

returns a single Feedback record
PUT

updates a single Feedback record

Paths

returns a list of Feedback records

GET /u_feedback*
sysparm_query

An encoded query string used to filter the results. To generate an encoded query for the results you want, go to the list view of the table in ServiceNow and create your filter. Then right click on the last filter in the breadcrumb style filter list and select 'Copy Query'. That is the query to use here. On most tables, passing 'active=true' will return only active records.

 query string
sysparm_display_value

Pass 'true' to return the display value of the record, pass 'false' to get the sys_id of the record, or pass 'all' to get both for reference fields.

 query string false
sysparm_exclude_reference_link

True to exclude Table API links for reference fields.

 query string
sysparm_suppress_pagination_header

True to supress pagination header.

 query string true
sysparm_fields

A comma-separated list of fields to return in the response. Defaults to a list that will just get form fields

 query string number,u_requester,state,assignment_group,assigned_to,short_description,description
sysparm_limit

The maximum number of results returned per page.

 query string 10,000
sysparm_view

Render the response according to the specified UI view (overridden by sysparm_fields).

 query string

application/json

200 OK

Success with response body.

result: object[]
object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

201 Created

Success with response body

result: object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

204 No Content

Success with no response body

400 Bad Request

The request URI does not match the APIs in the system, or the operation failed for unknown reasons. Invalid headers can also cause this error.

401 Unauthorized

The user is not authorized to use the API.

403 Forbidden

The requested operation is not permitted for the user. This error can also be caused by ACL failures, or business rule or data policy constraints.

404 Not Found

The requested resource was not found. This can be caused by an ACL constraint or if the resource does not exist.

405 Method Not Allowed

The HTTP action is not allowed for the requested REST API, or it is not supported by any API.

406 Not Acceptable

The endpoint does not support the response format specified in the request Accept header.

415 Unsupported Media Type

The endpoint does not support the format of the request body.

creates a new Feedback record

POST /u_feedback*

The body to pass or that is received in a response

{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form
sysparm_display_value

Pass 'true' to return the display value of the record, pass 'false' to get the sys_id of the record, or pass 'all' to get both for reference fields.

 query string false
sysparm_exclude_reference_link

True to exclude Table API links for reference fields.

 query string
sysparm_fields

A comma-separated list of fields to return in the response. Defaults to a list that will just get form fields

 query string number,u_requester,state,assignment_group,assigned_to,short_description,description
sysparm_view

Render the response according to the specified UI view (overridden by sysparm_fields).

 query string
sysparm_input_display_value

True to set raw value of input fields.

 query string false
sysparm_suppress_auto_sys_field

True to suppress auto generation of system fields.

 query string false

application/json

200 OK

Success with response body.

result: object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

201 Created

Success with response body

result: object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

204 No Content

Success with no response body

400 Bad Request

The request URI does not match the APIs in the system, or the operation failed for unknown reasons. Invalid headers can also cause this error.

401 Unauthorized

The user is not authorized to use the API.

403 Forbidden

The requested operation is not permitted for the user. This error can also be caused by ACL failures, or business rule or data policy constraints.

404 Not Found

The requested resource was not found. This can be caused by an ACL constraint or if the resource does not exist.

405 Method Not Allowed

The HTTP action is not allowed for the requested REST API, or it is not supported by any API.

406 Not Acceptable

The endpoint does not support the response format specified in the request Accept header.

415 Unsupported Media Type

The endpoint does not support the format of the request body.

returns a single Feedback record

GET /u_feedback/{sys_id}*
sysparm_display_value

Pass 'true' to return the display value of the record, pass 'false' to get the sys_id of the record, or pass 'all' to get both for reference fields.

 query string false
sysparm_exclude_reference_link

True to exclude Table API links for reference fields.

 query string
sysparm_fields

A comma-separated list of fields to return in the response. Defaults to a list that will just get form fields

 query string number,u_requester,state,assignment_group,assigned_to,short_description,description
sysparm_view

Render the response according to the specified UI view (overridden by sysparm_fields).

 query string
sysparm_input_display_value

True to set raw value of input fields.

 query string false
sysparm_suppress_auto_sys_field

True to suppress auto generation of system fields.

 query string false
sys_id

sys_id of the record you would like to delete from the table.

 path string

application/json

200 OK

Success with response body.

result: object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

201 Created

Success with response body

result: object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

204 No Content

Success with no response body

400 Bad Request

The request URI does not match the APIs in the system, or the operation failed for unknown reasons. Invalid headers can also cause this error.

401 Unauthorized

The user is not authorized to use the API.

403 Forbidden

The requested operation is not permitted for the user. This error can also be caused by ACL failures, or business rule or data policy constraints.

404 Not Found

The requested resource was not found. This can be caused by an ACL constraint or if the resource does not exist.

405 Method Not Allowed

The HTTP action is not allowed for the requested REST API, or it is not supported by any API.

406 Not Acceptable

The endpoint does not support the response format specified in the request Accept header.

415 Unsupported Media Type

The endpoint does not support the format of the request body.

updates a single Feedback record

PUT /u_feedback/{sys_id}*

The body to pass or that is received in a response

{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form
sysparm_display_value

Pass 'true' to return the display value of the record, pass 'false' to get the sys_id of the record, or pass 'all' to get both for reference fields.

 query string false
sysparm_exclude_reference_link

True to exclude Table API links for reference fields.

 query string
sysparm_fields

A comma-separated list of fields to return in the response. Defaults to a list that will just get form fields

 query string number,u_requester,state,assignment_group,assigned_to,short_description,description
sysparm_view

Render the response according to the specified UI view (overridden by sysparm_fields).

 query string
sysparm_input_display_value

True to set raw value of input fields.

 query string false
sysparm_suppress_auto_sys_field

True to suppress auto generation of system fields.

 query string false
sys_id

sys_id of the record you would like to delete from the table.

 path string

application/json

200 OK

Success with response body.

result: object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

201 Created

Success with response body

result: object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

204 No Content

Success with no response body

400 Bad Request

The request URI does not match the APIs in the system, or the operation failed for unknown reasons. Invalid headers can also cause this error.

401 Unauthorized

The user is not authorized to use the API.

403 Forbidden

The requested operation is not permitted for the user. This error can also be caused by ACL failures, or business rule or data policy constraints.

404 Not Found

The requested resource was not found. This can be caused by an ACL constraint or if the resource does not exist.

405 Method Not Allowed

The HTTP action is not allowed for the requested REST API, or it is not supported by any API.

406 Not Acceptable

The endpoint does not support the response format specified in the request Accept header.

415 Unsupported Media Type

The endpoint does not support the format of the request body.

Parameter definitions
sysparm_query sysparm_query

An encoded query string used to filter the results. To generate an encoded query for the results you want, go to the list view of the table in ServiceNow and create your filter. Then right click on the last filter in the breadcrumb style filter list and select 'Copy Query'. That is the query to use here. On most tables, passing 'active=true' will return only active records.

 query string
sysparm_display_value sysparm_display_value

Pass 'true' to return the display value of the record, pass 'false' to get the sys_id of the record, or pass 'all' to get both for reference fields.

 query string false
sysparm_exclude_reference_link sysparm_exclude_reference_link

True to exclude Table API links for reference fields.

 query string
sysparm_suppress_pagination_header sysparm_suppress_pagination_header

True to supress pagination header.

 query string true
sysparm_fields sysparm_fields

A comma-separated list of fields to return in the response. Defaults to a list that will just get form fields

 query string number,u_requester,state,assignment_group,assigned_to,short_description,description
sysparm_limit sysparm_limit

The maximum number of results returned per page.

 query string 10,000
sysparm_view sysparm_view

Render the response according to the specified UI view (overridden by sysparm_fields).

 query string
sysparm_input_display_value sysparm_input_display_value

True to set raw value of input fields.

 query string false
sysparm_suppress_auto_sys_field sysparm_suppress_auto_sys_field

True to suppress auto generation of system fields.

 query string false
sys_id sys_id

sys_id of the record you would like to delete from the table.

 path string

Response definitions

SuccessfullyRetrieved

Success with response body.

result: object[]
object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

Success

Success with response body.

result: object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

Created

Success with response body

result: object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

SuccessNoBody

Success with no response body

BadRequest

The request URI does not match the APIs in the system, or the operation failed for unknown reasons. Invalid headers can also cause this error.

Unauthorized

The user is not authorized to use the API.

Forbidden

The requested operation is not permitted for the user. This error can also be caused by ACL failures, or business rule or data policy constraints.

NotFound

The requested resource was not found. This can be caused by an ACL constraint or if the resource does not exist.

MethodNotAllowed

The HTTP action is not allowed for the requested REST API, or it is not supported by any API.

NotAcceptable

The endpoint does not support the response format specified in the request Accept header.

UnsupportedMediaType

The endpoint does not support the format of the request body.

Schema definitions

responseMany: object

result: object[]
object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

responseSingle: object

result: object 
{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

u_feedback: object 

{
    "assigned_to": "",
    "assignment_group": "SS-Operations and Support",
    "description": "But I had to use CTRL+F\r\n\r\nIt might be good for the user to be able to identify what group they are part of:\r\nStudent, Employee, CSR, Retiree - helps our people switch contexts on how to help faster. \r\nSee lib.byu.edu for an example.",
    "number": "FB0001001",
    "short_description": "I found the feedback button",
    "state": "Closed",
    "u_requester": "guest "
}
number: string

Number field from the u_feedback form

u_requester: string (32 to 32 chars)

Requester field from the u_feedback form

state: integer (int32)

State field from the u_feedback form

assignment_group: string (32 to 32 chars)

Assignment group field from the u_feedback form

assigned_to: string (32 to 32 chars)

Assigned To field from the u_feedback form

short_description: string

Short Description field from the u_feedback form

description: string

Description field from the u_feedback form

Service Path: 
/domains/servicenow/feedback
Domain or University API: 
/domains/servicenow/feedback
Tags: 
domains
servicenow
feedback

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access