Jump to

• Request
• Response

[Deprecated]: Generate a user assignment report

post

/ec-auth-svc/rest/v1.0/{studyId}/{mode}/report/{reportName}

Deprecated: Use /v2/{studyId}/{mode}/report/{reportName} for improved filtering, error handling, and extended result structure. This endpoint generates a user assignment report for a study by the provided report name using v1 search criteria. Latest version uses stricter search specs validation and responds with updated DTO format.

Request

Path Parameters

• mode(required): string
  Operating mode (e.g. "test", "design").

  Example:

  test

• reportName(required): string
  Name of the report to be generated.

  Example:

  userAssignment

• studyId(required): string
  Study identifier.

  Example:

  98E0DFA1F1CA4F3B8C78C876021A0E96

Query Parameters

• sessionToken(required): string(uuid)
  Session authentication token.

  Example:

  123E4567E89B12D3A456426614174000

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : SearchSpecs

Type: object

Title: SearchSpecs

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

Show Source

• fieldSpecsList: array fieldSpecsList
  Field Specification List
• 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.

  Example: 5

{
    "title":"SearchSpecs",
    "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.",
            "format":"int32",
            "example":5
        },
        "fieldSpecsList":{
            "type":"array",
            "description":"Field Specification List",
            "items":{
                "$ref":"#/components/schemas/Field"
            }
        }
    },
    "description":"Request body passing search specs like limit, offset and list of fields"
}

Nested Schema : fieldSpecsList

Type: array

Field Specification List

Show Source

• Array of: object Field
  Contains field details.

{
    "type":"array",
    "description":"Field Specification List",
    "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. The acceptable values are : TENANTID, STUDYID, COUNTRY, SITEID, INVID, INVNAM, USUBJID, SCRNID, SUBJID, VISITNUM, VISIT, UNSCHED, SVSTDTC, DOMAIN, LAB ID, LAB NAME, REPEATNUMBER, SREPEATID, SREPEATNUMBER, ENTERED BY, ENTERED DATE, LAST CHANGED BY, LAST CHANGED DATE etc.

  Example: siteIds or dateRange
• fieldSequence: integer (int32)
  Sequence/order of the field.

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

  Maximum Length: 50

  Field type. The fields type can be : date-time, string, list, number etc.

  Example: list or date-time
• fieldValueList(required): array fieldValueList
  List of values for the Field

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Field name. The acceptable values are : TENANTID, STUDYID, COUNTRY, SITEID, INVID, INVNAM, USUBJID, SCRNID, SUBJID, VISITNUM, VISIT, UNSCHED, SVSTDTC, DOMAIN, LAB ID, LAB NAME, REPEATNUMBER, SREPEATID, SREPEATNUMBER, ENTERED BY, ENTERED DATE, LAST CHANGED BY, LAST CHANGED DATE etc. ",
            "example":"siteIds or dateRange"
        },
        "fieldType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Field type. The fields type can be : date-time, string, list, number etc.",
            "example":"list or date-time"
        },
        "fieldSequence":{
            "type":"integer",
            "description":"Sequence/order of the field.",
            "format":"int32",
            "example":1
        },
        "fieldValueList":{
            "type":"array",
            "description":"List of values for the Field",
            "example":[
                "D5E16DD550CB4AD1B330E0D09B4B8F3F",
                "A5E16DD550CB4AD1B330E0D09B4B8F3F"
            ],
            "items":{
                "type":"string",
                "description":"List of values for the Field",
                "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
            }
        }
    },
    "description":"Contains field details."
}

Nested Schema : fieldValueList

Type: array

List of values for the Field

Show Source

• Array of: string
  List of values for the Field

  Example: ["D5E16DD550CB4AD1B330E0D09B4B8F3F","A5E16DD550CB4AD1B330E0D09B4B8F3F"]

{
    "type":"array",
    "description":"List of values for the Field",
    "example":[
        "D5E16DD550CB4AD1B330E0D09B4B8F3F",
        "A5E16DD550CB4AD1B330E0D09B4B8F3F"
    ],
    "items":{
        "type":"string",
        "description":"List of values for the Field",
        "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
    }
}

Example:

[
    "D5E16DD550CB4AD1B330E0D09B4B8F3F",
    "A5E16DD550CB4AD1B330E0D09B4B8F3F"
]

Examples

Select an example User Assignment Report Request Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result data of the API response; actual type depends on the API
• status: string (none)
  Indicates request success ("success") or failure ("failure").

  Example: success
• version: integer (int32)
  Version of the response schema.

  Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

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

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@1466a41f

Nested Schema : details

Type: object

Examples

Select an example User Assignment Report Response

400 Response

Bad request

Body ()

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result data of the API response; actual type depends on the API
• status: string (none)
  Indicates request success ("success") or failure ("failure").

  Example: success
• version: integer (int32)
  Version of the response schema.

  Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

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

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@1466a41f

Nested Schema : details

Type: object

Examples

Select an example Error

Back to Top