Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Distinct URI specification for service REST rules

Updated on November 23, 2022

Different service REST rules are specified for different resource URIs. This functionality provides different processing options, request handling, and response handling for each distinct resource URI. Additionally, it eliminates the need to maintain complex logic used to handle all possible resource URI paths.

By using URI templates, you can define different service REST rules for distinct resource URIs. You define these fields when you create a new REST service rule. The resource URI includes the following components:

  • The service package – A data instance that is used to support the deployment of services. For more information about service packages, see About Service Package data instances.
  • The service version – The version number of a service rule.
  • A URI template – A template that supports literal and variable path parameters. With this component, you can map a resource URI to a service REST rule. For information about formatting requirements of the parameters in a URI template, see URI template component requirements.

The following list contains examples of distinct resource URIs that you can map to different service REST rules:

  • api/vi/cases
  • api/v1/cases/C_100
  • api/v1/cases/C_100/attachments
  • api/v1/cases/C_100/attachments/A_100

For each resource URI, api indicates the service package, v1 indicates the service version, and the text after v1/ indicates URI templates. Because each resource URI tcontains a distinct URI template, each resource URI tis mapped to a different service REST rule.

  • URI template component requirements

    The variable and literal components of a URI template require specific formatting. Apply these requirements to URI templates when you define different service REST rules for distinct resource URIs.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us