Jump to

• Request
• Response

V1.0

get

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/properties/{id}

Retrieves the Data Capture properties.

Request

Path Parameters

• id(required): string
  Unique Identfier (UUID, 32-character uppercase hexadecimal string) of DC properties

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  active

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : PropertyDto1

Type: object

Property Dto having fields which specify the unique property Id

Show Source

• comment: string
  Additional comments for the property update.

  Example: Configured during study setup
• id: string
  Unique identifier for the property record.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• objectVersionNumber: number
  Object version number used for concurrency control.

  Example: 1
• operationType: string
  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: MODIFIED
• propertyAttr: string
  Additional attribute or data type for the property.

  Example: {}
• propertyKey: string
  Unique key name of the property.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• propertyStatus: string
  Status of the property.

  Example: 1
• propertyType: string
  Type/category of the property.

  Example: CODING_PROPERTY
• propertyValue: string
  Value configured for the property.

  Example: UTC
• reason: string
  Reason for the change in property value.

  Example: Initial configuration
• softwareVersionNumber: number
  Software version number used when the record was generated.

  Example: 300
• userId: string
  Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user

  Example: 699EF3745FC545589F186D2198F3C65E
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.

  Example: 2023-01-01T10:00:00Z
• versionStart: string (date-time)
  Record version start timestamp.

  Example: 2023-01-01T09:00:00Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for the property record.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"Record version start timestamp.",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "propertyType":{
            "type":"string",
            "description":"Type/category of the property.",
            "example":"CODING_PROPERTY"
        },
        "propertyKey":{
            "type":"string",
            "description":"Unique key name of the property.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "propertyValue":{
            "type":"string",
            "description":"Value configured for the property.",
            "example":"UTC"
        },
        "propertyAttr":{
            "type":"string",
            "description":"Additional attribute or data type for the property.",
            "example":"{}"
        },
        "propertyStatus":{
            "type":"string",
            "description":" Status of the property.",
            "example":"1"
        },
        "reason":{
            "type":"string",
            "description":"Reason for the change in property value.",
            "example":"Initial configuration"
        },
        "comment":{
            "type":"string",
            "description":"Additional comments for the property update.",
            "example":"Configured during study setup"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time",
            "example":"2023-01-01T10:00:00Z"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"MODIFIED"
        },
        "userId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user",
            "example":"699EF3745FC545589F186D2198F3C65E"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number used for concurrency control.",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number used when the record was generated.",
            "example":300
        }
    },
    "description":"Property Dto having fields which specify the unique property Id "
}

Examples

Select an example PropertyDtoResponse

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top