Provide input parameters to make a valid API call, test the connection, and receive a sample response.

Before you begin

For all templates, you can select the information icon (lower case letter i for more information ) to learn more about each parameter. You can use the API samples provided with each template. After you define your input parameters, you must test your connection.

Roles required:

  • sn_sec_spc_core.developer
  • sn_spc_cxf.admin - required for advanced scripting

Procedure

  1. Fill in the fields.
    Note: If you change any input parameters after testing the connection, you must test the connection again before you can continue on to Map API response to SPC attributes.
    Field Description Example
    Object list path Path to the list of assets in the response payload. An example: $.list
    API endpoint relative path This is the path to the API without the host URL. An example: /r2
    API query parameters Key-value pairs that are appended to the API URL for filtering. Values can be strings, scripts, or references to fields in the credential table.

    An example:

    Name [name of query parameter]

    Value type [Static values]

    Value [a string]
    Pagination parameters Dynamic parameters used to retrieve subsequent pages of API data. Specify the parameter name, its location in the request (Query, Header, or Body), the path to extract its next value from the API response, and an optional default value.

    An example of pagination type Offset:

    Offset

    Parameter name [start]

    Location in API request [Query parameters]

    Default value [0]

    Limit

    Parameter name [count]

    Location in API request [Query parameters]

    Default value [5]
    (Optional) Add parameter Add custom parameters Select Add parameter to define your own parameters.

    For example, you might want to determine if there are additional pages of data that are included in the API response.

    Parameter name [hasMore]

    Path in API response [$.hasMore]

    Location in API request [Header parameters]

    Default value [1]
  2. When you’re satisfied with your API input, select Get sample response.
    After a few moments, a message is displayed if the connection was successful.

    If you entered your parameters manually for this step, the data imported from the connection test that is rendered in the sample response is authentic and you can use it in the next step to help you map parameters.

  3. Select Save and continue to save your edits.
    You must save your changes before you can continue.