Jump to

• Request
• Response

Push data into ClinicalOne via real-time integration configured in Digital Gateway

post

/ib/ib-ext-svc/rest/v1.0/integrationdata

This web service allows you to send data and trigger the corresponding integration configured in Digital Gateway to import this data into ClinicalOne.

Request

There are no request parameters for this operation.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Show Source

• classifier: string
• comment: string
• ibIntegrationType: string
  Allowed Values: [ "IbIvrsIntegration" ]

  Integration types supported by Digital Gateway Builder for real-time integration

  Example: IbIvrsIntegration
• id: string (uuid)
• inputData: string
• inputQualifier: string
• integrationType: string
• namespace: string
• reason: string
• secretKey: string
  Name of the secret key configured in the secret store
• studyMode: string
  Mode of the study for which the integration is configured in Digital Gateway
• studyName: string
• timeQualifier: string (date-time)
• userName: string
  Username corresponding to the secret key
• vendorName: string
  Name of the Vendor calling this webservice. This value must match with the vendor name used for the integration configured in Digital Gateway

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "inputData":{
            "type":"string"
        },
        "timeQualifier":{
            "type":"string",
            "format":"date-time"
        },
        "studyName":{
            "type":"string"
        },
        "integrationType":{
            "type":"string"
        },
        "classifier":{
            "type":"string"
        },
        "inputQualifier":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "ibIntegrationType":{
            "type":"string",
            "description":"Integration types supported by Digital Gateway Builder for real-time integration",
            "example":"IbIvrsIntegration",
            "enum":[
                "IbIvrsIntegration"
            ]
        },
        "vendorName":{
            "type":"string",
            "description":"Name of the Vendor calling this webservice. This value must match with the vendor name used for the integration configured in Digital Gateway"
        },
        "studyMode":{
            "type":"string",
            "description":"Mode of the study for which the integration is configured in Digital Gateway"
        },
        "secretKey":{
            "type":"string",
            "description":"Name of the secret key configured in the secret store"
        },
        "userName":{
            "type":"string",
            "description":"Username corresponding to the secret key"
        },
        "namespace":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Integration input data successfully stored

Body ()

Root Schema : RTIntDetailsDto

Type: object

Show Source

• inputId: string
  Identifier for the record in the database corresponding to the data being sent, this will be used for tracking purposes only
• jobId: string
  Identifier of the job responsible for processing the data sent to Digital Gateway through the web service request
• message: string
• realTimeId: string
  Configuration identifier of the integration in Digital Gateway responsible for processing the data sent through the web service request

  Example: IbIvrsIntegration

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Identifier of the job responsible for processing the data sent to Digital Gateway through the web service request"
        },
        "inputId":{
            "type":"string",
            "description":"Identifier for the record in the database corresponding to the data being sent, this will be used for tracking purposes only"
        },
        "realTimeId":{
            "type":"string",
            "description":"Configuration identifier of the integration in Digital Gateway responsible for processing the data sent through the web service request",
            "example":"IbIvrsIntegration"
        },
        "message":{
            "type":"string"
        }
    }
}

400 Response

Integration type is invalid

Body ()

Root Schema : DGErrorResponseData

Type: object

Show Source

• correlationId: string
• correlationName: string
• details: object details
• errorCode: string
• errorMessage: string
• remediation: string
• siteId: string (uuid)
• siteName: string
• studyTitle: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        },
        "remediation":{
            "type":"string"
        },
        "studyTitle":{
            "type":"string"
        },
        "siteId":{
            "type":"string",
            "format":"uuid"
        },
        "siteName":{
            "type":"string"
        },
        "correlationId":{
            "type":"string"
        },
        "correlationName":{
            "type":"string"
        }
    }
}

Nested Schema : details

Type: object

404 Response

Study name is missing

Body ()

Root Schema : DGErrorResponseData

Type: object

Show Source

• correlationId: string
• correlationName: string
• details: object details
• errorCode: string
• errorMessage: string
• remediation: string
• siteId: string (uuid)
• siteName: string
• studyTitle: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        },
        "remediation":{
            "type":"string"
        },
        "studyTitle":{
            "type":"string"
        },
        "siteId":{
            "type":"string",
            "format":"uuid"
        },
        "siteName":{
            "type":"string"
        },
        "correlationId":{
            "type":"string"
        },
        "correlationName":{
            "type":"string"
        }
    }
}

Nested Schema : details

Type: object

500 Response

Error occured while storing data in the DB. Please contact Oracle Support

Body ()

Root Schema : DGErrorResponseData

Type: object

Show Source

• correlationId: string
• correlationName: string
• details: object details
• errorCode: string
• errorMessage: string
• remediation: string
• siteId: string (uuid)
• siteName: string
• studyTitle: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        },
        "remediation":{
            "type":"string"
        },
        "studyTitle":{
            "type":"string"
        },
        "siteId":{
            "type":"string",
            "format":"uuid"
        },
        "siteName":{
            "type":"string"
        },
        "correlationId":{
            "type":"string"
        },
        "correlationName":{
            "type":"string"
        }
    }
}

Nested Schema : details

Type: object

Back to Top