Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.
  • Madrid
  • London
  • Kingston
  • Jakarta
  • Istanbul
  • Helsinki
  • Geneva
  • Store

URL schema

Log in to subscribe to topics and get notified when content changes.

URL schema

Users can navigate to a record or module directly by using a URL. This topic explains the URL schema by which the system renders pages.

The basic schema for a system URL is:

https://<base URL>/<page name>.do?sys_id=<sys_id>&<page parameters>

The URL schema consists of the following elements.
  • base URL: Unique, secure web address for each instance. The default format is: https://<instancename>

    To display a custom base URL in email notifications, you can set the property. For more information, see Additional email properties.

  • (optional): Loads the page in the standard interface, with the banner frame on top and the application navigator on the left.
  • <page name>.do?: Where the page name is the form, list, UI page, or other page to open. To view a list, use <table name>
  • sys_id=<sys_id> (optional): Where <sys_id> is the sys_id of the record to open in form view. To create a new record, specify a sys_id of -1.
  • <page parameters> (optional): May specify a query, view, redirection page, and more. The following are some of the sample parameters.
    • sysparm_view=ess: Specifies a view (ess).
    • sysparm_query=number=INC00040: Specifies a query (number is INC00040).
    • sysparm_query=priority=2^active=true: Specifies a complex query with two terms (priority is 2 and active is true).
    • sysparm_query=priority=2^active=true^EQ^GROUPBYcategory: Groups query results (by category).
    • sysparm_order=number: Specifies the field by which to sort (number).
    • sysparm_order_direction=desc: Specifies a sort order (descending).
    • sysparm_force_row_count=5: Limits the maximum number of results (five records).
    • sysparm_result_view=viewname: Specifies the view for search results.
  • CSV: Specifies a file format, can be CSV, XML, PDF, or UNL (Unload).
  • &: Separates page parameters.
  • ^(carat): Builds multiple term queries or specifies multiple field values.

Forms vs. lists (sysparm_query)

The sysparm_query page parameter behaves differently for a list versus a form.
  • List: returns records that match the query conditions.
  • Form (with sys_id=-1 specified): applies the values to the new record.
Note: If you are using the default table templates where the template name matches the table name, such as change_request or incident, using sysparm_query for that form does not work.