Jump to

• Request
• Response

Get audit history of a property

get

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

Retrieves the audit history of a property if the property ID is provided.

Request

Path Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : PropertyDto

Type: object

Show Source

• comment: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• propertyAttr: string
• propertyKey: string
• propertyStatus: string
• propertyType: string
• propertyValue: string
• reason: string
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "propertyType":{
            "type":"string"
        },
        "propertyKey":{
            "type":"string"
        },
        "propertyValue":{
            "type":"string"
        },
        "propertyAttr":{
            "type":"string"
        },
        "propertyStatus":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• 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

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