PUT /apis/{apiId}/versions/{apiVersionId}/{entityType}/{entityId}/syncWithSchema

This call allows you to keep the relation in sync with the API schema.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Servers

Path parameters

Name Type Required Description
apiId String Yes

Id of the API

entityId String Yes

Relation id

entityType String Yes

Relation type (e.g documentation, contracttest, integrationtest, testsuite, mock, monitor)

apiVersionId String Yes

Id of the API version

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.