Jump to

• Request
• Response

Generate a report based on the direct report payload

post

/ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports/direct

Generates a report based on the given DirectReportPayload parameter provided during an SSL call. For example, a Kit Order. Right: ReportingPost.

Request

Path Parameters

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

Query Parameters

• format: string
  Report format
• reportid: string
  Report ID

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Show Source

• reportSection: array reportSection

{
    "type":"object",
    "properties":{
        "reportSection":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DirectReportSection"
            }
        }
    }
}

Nested Schema : reportSection

Type: array

Show Source

• Array of: object DirectReportSection

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DirectReportSection"
    }
}

Nested Schema : DirectReportSection

Type: object

Show Source

• result: object SectionData
• rptName: string
• rptSeq: integer (int32)
• sectiondata: object SectionData

{
    "type":"object",
    "properties":{
        "rptName":{
            "type":"string"
        },
        "rptSeq":{
            "type":"integer",
            "format":"int32"
        },
        "result":{
            "$ref":"#/components/schemas/SectionData"
        },
        "sectiondata":{
            "$ref":"#/components/schemas/SectionData"
        }
    }
}

Nested Schema : SectionData

Type: object

Show Source

• columns: array columns
• count: integer (int32)
• data: array data
• headers: object headers
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "columns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

Nested Schema : columns

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: array items

{
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: object

Back to Top

Response

Supported Media Types

• text/html
• application/json

202 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

500 Response

Empty payload

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