Sign in
source_definition_specification

Get specification for a SourceDefinition.

Changed on
post/v1/source_definition_specifications/get

Request

  • Base URL: http://localhost:8000/api
  • URL: http://localhost:8000/api/v1/source_definition_specifications/get
  • Auth: none required

Request body

sourceDefinitionIdstring uuid required
workspaceIdstring uuid required

Response

Successful operation

sourceDefinitionIdstring uuid required
documentationUrlstring
connectionSpecificationSourceDefinitionSpecification

The specification for what values are required to configure the sourceDefinition.

Example response

{
  "connectionSpecification": {
    "user": {
      "type": "string"
    }
  },
  "authSpecification": {
    "oauth2Specification": {
      "rootObject": [
        "path",
        1
      ]
    }
  }
}

Changes