Informatica · Schema

ConnectionCreateRequest

Request body for creating a new connection.

Address VerificationB2B GatewayCloud ServicesData GovernanceData IntegrationData ProfilingData QualityEnterprise SoftwareETLIDMCIICSMaster Data ManagementReference Data Management

Properties

Name Type Description
@type string The resource type identifier. Must be set to "connection".
name string The name for the new connection.
description string A description of the connection.
type string The connection type.
runtimeEnvironmentId string The runtime environment ID for the connection.
host string The hostname or IP address.
port integer The port number.
database string The database name or service name.
schema string The database schema.
username string The username for authentication.
password string The password for authentication.
authenticationType string The authentication method.
serviceUrl string The service endpoint URL.
codepage string The character encoding.
connParams object Additional connection-type-specific parameters.
View JSON Schema on GitHub

JSON Schema

informatica-platform-rest-connection-create-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ConnectionCreateRequest",
  "type": "object",
  "description": "Request body for creating a new connection.",
  "properties": {
    "@type": {
      "type": "string",
      "description": "The resource type identifier. Must be set to \"connection\"."
    },
    "name": {
      "type": "string",
      "description": "The name for the new connection."
    },
    "description": {
      "type": "string",
      "description": "A description of the connection."
    },
    "type": {
      "type": "string",
      "description": "The connection type."
    },
    "runtimeEnvironmentId": {
      "type": "string",
      "description": "The runtime environment ID for the connection."
    },
    "host": {
      "type": "string",
      "description": "The hostname or IP address."
    },
    "port": {
      "type": "integer",
      "description": "The port number."
    },
    "database": {
      "type": "string",
      "description": "The database name or service name."
    },
    "schema": {
      "type": "string",
      "description": "The database schema."
    },
    "username": {
      "type": "string",
      "description": "The username for authentication."
    },
    "password": {
      "type": "string",
      "description": "The password for authentication."
    },
    "authenticationType": {
      "type": "string",
      "description": "The authentication method."
    },
    "serviceUrl": {
      "type": "string",
      "description": "The service endpoint URL."
    },
    "codepage": {
      "type": "string",
      "description": "The character encoding."
    },
    "connParams": {
      "type": "object",
      "description": "Additional connection-type-specific parameters."
    }
  }
}