Retrieving the Connection Structure

This endpoint allows you to obtain the step structure required to form the credentialData object when installing a solution.

Query Parameters

To retrieve the structure, especially for nested steps, you may need to specify values for parent steps. This is done by passing parameters in the query string.

How to Add Parameters

For each selected step that has nested steps, you need to add a parameter to the request URL. The parameter format is as follows:

credentialData[step_id]=value_id

Where:

step_id: The identifier of the parent step you selected.
value_id: The identifier of the value you selected for this parent step.

Example

If you have a main step with step_id = s1, and you select a value with value_id = v1 for it, and this selection opens a nested step, your request to get the structure of the nested step will look like:

/solution/{id}/credentialists?credentialData[s1]=v1

If you have multiple levels of nesting, you add a parameter for each level. For example, if the first selection (s1=v1) opens a second step (s2), and you select a value (v2) for it, the request will be:

/solution/{id}/credentialists?credentialData[s1]=v1&credentialData[s2]=v2

This allows the API to return the correct subsequent steps based on your previous selections.

200Successful response