Jump to

• Request
• Response

Generate Subject Queries report

post

/ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/report/{reportName}

Generates a new Subject Queries report by study ID and study mode (Testing, Training, or Production).

Request

Path Parameters

• mode(required): string
  Study mode.
• reportName(required): string
  reportName to create an subject query report.
• sessionToken(required): string(uuid)
  Session Token
• studyId(required): string
  Study ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request body passing search specs like limit, offset and list of fields

Show Source

• fieldSpecsList: array fieldSpecsList
• limit: integer (int32)
  Minimum Value: 1

  Maximum Value: 5000

  Maximum number of records to display per page.

  Example: 50
• offset: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter

  Example: 5

{
    "type":"object",
    "properties":{
        "limit":{
            "maximum":"5000",
            "minimum":"1",
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int32",
            "example":"50"
        },
        "offset":{
            "maximum":"2147483647",
            "minimum":"0",
            "type":"integer",
            "description":"An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter",
            "format":"int32",
            "example":"5"
        },
        "fieldSpecsList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Field"
            }
        }
    },
    "description":"Request body passing search specs like limit, offset and list of fields"
}

Nested Schema : fieldSpecsList

Type: array

Show Source

• Array of: object Field
  Contains field details.

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

Nested Schema : Field

Type: object

Contains field details.

Show Source

• fieldName(required): string
  Minimum Length: 0

  Maximum Length: 255

  Field name

  Example: siteIds
• fieldSequence: integer (int32)
  Minimum Value: 0

  Field sequence

  Example: 1
• fieldType(required): string
  Minimum Length: 0

  Maximum Length: 50

  Field type

  Example: list
• fieldValueList(required): array fieldValueList

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"Field name",
            "example":"siteIds"
        },
        "fieldType":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string",
            "description":"Field type",
            "example":"list"
        },
        "fieldSequence":{
            "minimum":"0",
            "type":"integer",
            "description":"Field sequence",
            "format":"int32",
            "example":"1"
        },
        "fieldValueList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Contains field details."
}

Nested Schema : fieldValueList

Type: array

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : Response DTO

Type: object

Response from Query APIs

Show Source

• errorData: object Error details DTO
  Read Only: true

  Error details from Query APIs
• result: object result
  Read Only: true

  Result Object
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status
• version: string
  Read Only: true

  Response version

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object",
            "readOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Response version",
            "readOnly":true
        }
    },
    "description":"Response from Query APIs"
}

Nested Schema : Error details DTO

Type: object

Read Only: true

Error details from Query APIs

Show Source

• details: object details
  Read Only: true

  Error Details
• errorCode: string
  Read Only: true

  Error Code
• errorMessage: string
  Read Only: true

  Error Message

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Query APIs",
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result Object

Nested Schema : details

Type: object

Read Only: true

Error Details

400 Response

Data is invalid.

Body ()

Root Schema : Response DTO

Type: object

Response from Query APIs

Show Source

• errorData: object Error details DTO
  Read Only: true

  Error details from Query APIs
• result: object result
  Read Only: true

  Result Object
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status
• version: string
  Read Only: true

  Response version

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object",
            "readOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Response version",
            "readOnly":true
        }
    },
    "description":"Response from Query APIs"
}

Nested Schema : Error details DTO

Type: object

Read Only: true

Error details from Query APIs

Show Source

• details: object details
  Read Only: true

  Error Details
• errorCode: string
  Read Only: true

  Error Code
• errorMessage: string
  Read Only: true

  Error Message

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Query APIs",
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result Object

Nested Schema : details

Type: object

Read Only: true

Error Details

Back to Top