Create a scripted REST API resource

  • Freigeben Version: Australia
  • Aktualisiert 12. März 2026
  • 1 Minute Lesedauer

    • Create a scripted REST API resource to define the HTTP method, the processing script, and to override settings from the parent service.

    Vorbereitungen

    Create a scripted REST API. For more information, see Create a scripted REST API.

    Role required: web_service_admin

    Prozedur

    1. Navigate to All > System Web Services > Scripted REST APIs.
    2. Select a scripted REST API record.
    3. In the Resources related list, click New.
    4. Enter a Name.
      The resource name affects the URI for sending requests to the API.
    5. Select the HTTP method this resource implements, such as GET.
    6. In the Script field, define how the operation parses and responds to requests.
    7. Wahlweise: Override settings from the parent REST API as needed, such as by specifying different security settings or valid content types.
    8. Wahlweise: On the Documentation tab, provide a Short description explaining how to access the resource.
      This information appears when exploring this resource using the REST API Explorer.
    9. Click Submit.

    Nächste Maßnahme

    After creating the resource, you can associate headers and query parameters. For details, see Define scripted REST API headers and Define available query parameters.