Virtual Proxy: Link

Note: LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method

PUT

Path

/qrs/proxyservice/{id}

Description

Link a virtual proxy to a proxy service. A virtual proxy must be linked to a proxy service before the virtual proxy is available for use.

To prevent conflicts when updating entities:

  1. Retrieve the entity that you want to update.

  2. Modify the specific properties that you want to change.
  3. Perform an update, including the entire entity in the body of the request.

You must always include the entity ID and modifiedDate when performing an update. The entity ID of the body and of the URL must match.

To link a virtual proxy to a proxy service:

  1. Get the ID of the virtual proxy that you want to link to a proxy service: GET qrs/virtualproxyconfig

    Response:

  2. Get the full configuration details of the proxy service: GET qrs/proxyservice/{id}
  3. Copy the configuration details of the proxy service and paste it into the body of the PUT qrs/proxyservice/{id} request.
  4. Add the virtual proxy ID to the proxy service details on a new line below "virtualProxies": [.

  5. Link the virtual proxy to the proxy service: PUT qrs/proxyservice/{id}

Return value

Optional parameters

-

Did this information help you?

Can you tell us why it did not help you and how we can improve it?