Associate query parameters with a resource

  • Release version: Yokohama
  • Updated January 30, 2025
  • 1 minute to read

    • Associate scripted REST API query parameters with a resource.

    Before you begin

    Role required: web_service_admin

    About this task

    The following procedure describes the process for manually associating a query parameter with a resource. For details about automatically generating query parameters for requests in non-production instances, see Automatically generate API request definitions.

    Procedure

    1. Navigate to All > System Web Services > Scripted REST APIs.
    2. Select a scripted REST API record.
    3. In the Resources related list, select New
    4. In the API query parameter, select or enter the query parameter to associate with the resource.
    5. In the API resource, select or enter the scripted REST API resource to associate with the query parameter.
    6. Select Submit.

    What to do next

    After associating the parameters with a scripted REST resource, configure any required ACLs for the API or endpoint. For details, see Configure a scripted REST API resource to require an ACL.