Jump to

• Request
• Response

Submit request for sending notifications

post

/ec-reporting-svc/rest/v1.0/notification/{notificationType}

Submits a request for sending notification on the given input, using the QueryParams parameter. Right: ReportingPost.

Request

Path Parameters

• notificationType(required): string
  Notification type.

Query Parameters

• mode: string
  Mode of the study. Accepts test, active, or training.
• studyId: string
  ID of the study for which you want to download report. Tenant reports such as HSL report etc can be downloaded by making study id as null.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• notificationPayloadMap: object notificationPayloadMap
  Additional Properties Allowed: NotificationPayload
• notificationPayloads: array notificationPayloads

{
    "type":"object",
    "properties":{
        "notificationPayloadMap":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/NotificationPayload"
            }
        },
        "notificationPayloads":{
            "type":"array",
            "writeOnly":true,
            "items":{
                "$ref":"#/components/schemas/NotificationPayload"
            }
        }
    }
}

Nested Schema : notificationPayloadMap

Type: object

Additional Properties Allowed

Show Source

• object NotificationPayload

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/NotificationPayload"
    }
}

Nested Schema : notificationPayloads

Type: array

Show Source

• Array of: object NotificationPayload

{
    "type":"array",
    "writeOnly":true,
    "items":{
        "$ref":"#/components/schemas/NotificationPayload"
    }
}

Nested Schema : NotificationPayload

Type: object

Show Source

• fieldKey: string
• fieldName: string
• fieldValue: string

{
    "type":"object",
    "properties":{
        "fieldKey":{
            "type":"string"
        },
        "fieldName":{
            "type":"string"
        },
        "fieldValue":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• */*

200 Response

Success

Body ()

Root Schema : ExecutionLog

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 4000
• currSearchSpec: string
  Minimum Length: 0

  Maximum Length: 32000
• currSortSpec: string
  Minimum Length: 0

  Maximum Length: 512
• fileStorageId: string (uuid)
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 0

  Maximum Length: 1024
• reason: string
  Minimum Length: 0

  Maximum Length: 4000
• recCount: integer (int32)
• rptFormat: string
  Minimum Length: 0

  Maximum Length: 255
• rptId: string (uuid)
• rptKickoffDatetime(required): string (date-time)
• rptName: string
  Minimum Length: 0

  Maximum Length: 255
• rptStatCd: string
  Minimum Length: 0

  Maximum Length: 255
• runDuration: integer
• softwareVersionNumber: number
• userId(required): string (uuid)
• versionEnd(required): string (date-time)
• versionStart(required): string (date-time)

{
    "required":[
        "rptKickoffDatetime",
        "userId",
        "versionEnd",
        "versionStart"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "rptId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "runDuration":{
            "type":"integer"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string"
        },
        "reason":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string"
        },
        "rptKickoffDatetime":{
            "type":"string",
            "format":"date-time"
        },
        "rptName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "rptStatCd":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "rptFormat":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "recCount":{
            "type":"integer",
            "format":"int32"
        },
        "currSearchSpec":{
            "maxLength":"32000",
            "minLength":"0",
            "type":"string"
        },
        "currSortSpec":{
            "maxLength":"512",
            "minLength":"0",
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "fileStorageId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

400 Response

Bad request

Body ()

Root Schema : BaseResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

401 Response

Unauthorized user

Body ()

Root Schema : BaseResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top