Omni-Gen™ API Services Reference Guide > Source Management Services > Create an Integration Point

Create an Integration Point

Topics:

Use the following REST call to create an integration point. This REST call is available as of Version 3.11.

POST: /api/v1/sourcesystem/integration/create

Topics:

Parameters (body): Integration Point Entity

Content type: application/json

Do not include the ID in the integration point entity when creating a new integration point. A unique ID will be generated.

Example:

POST https://localhost:9500/api/v1/sourcesystem/integration/create

Content-Type: application/json

{
  "earliestStartTime": {
    "hour": 11,
    "minute": 0
  },
  "expectedDuration": "1 hour",
  "expectedSize": "1000 rows",
  "integrationDirection": "TargetRequest",
  "integrationFrequency": "daily",
  "integrationScope": "PROD",
  "latestEndTime": {
    "hour": 1,
    "minute": 0
  },
  "sourceId": "4e5b765f-b807-483b-8c56-1fcc683b0b98",
  "sourceLocation": {
    "domain": "acme.com",
    "hostName": "ahost",
    "password": "secret",
    "port": "8080",
    "protocol": "jdbc",
    "resourceLocation": "/customers",
    "userName": "user"
  },
  "sourceLocationType": "database",
  "targetId": "a8be97a2-1688-4855-8d76-92f86095e292",
  "targetLocation": {
    "domain": "amalgamated.com",
    "hostName": "omniprod",
    "password": "secret",
    "port": "9500",
    "protocol": "http",
    "userName": "user"
  },
  "targetLocationType": "omni",
}

-- response --

{
  "status": "CREATED",
  "code": 0,
  "message": null,
  "developerMessage": null,
  "responseType": "com.ibi.omni.controller.services.sourcesystem.IntegrationPointDto",
  "response": {
    "id": "6cb6d742-3f23-4095-a9d1-deaeb88edeaf",
    "sourceId": "4e5b765f-b807-483b-8c56-1fcc683b0b98",
    "sourceLocationType": "database",
    "sourceLocation": {
      "protocol": "jdbc",
      "hostName": "ahost",
      "domain": "acme.com",
      "port": null,
      "userName": "user",
      "password": "secret",
      "resourceLocation": "/customers",
      "resourceName": null
    },
    "sourceResourceType": null,
    "targetId": "a8be97a2-1688-4855-8d76-92f86095e292",
    "targetLocationType": "omni",
    "targetLocation": {
      "protocol": "http",
      "hostName": "omniprod",
      "domain": "amalgamated.com",
      "port": null,
      "userName": "user",
      "password": "secret",
      "resourceLocation": null,
      "resourceName": null
    },
"targetResourceType": null,
    "integrationScope": "PROD",
    "integrationDirection": "TargetRequest",
    "integrationFrequency": "daily",
    "integrationDaysOfWeek": null,
    "integrationDaysOfMonth": null,
    "earliestStartTime": {
      "hour": 11,
      "minute": 0
    },
    "latestEndTime": {
      "hour": 1,
      "minute": 0
    },
    "expectedDuration": "1 hour",
    "expectedSize": "1000 rows",
    "omniProcessingPolicy": null
  },
  "exception": null
}