Jump to

• Request
• Response

V1.0

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/state

Retrieves the status of a study.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required. Example: F054C951EB74443C93716CA714AB686E

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : StudyStateDto v1.0

Type: object

Title: StudyStateDto v1.0

Information about the state of a study for UI consumption.

Show Source

• id: string (uuid)
• previousState: string
  Allowed Values: [ "settings", "active", "design", "test", "training" ]

  Previous state of a study for UI consumption

  Example: training
• studyState: string
  Allowed Values: [ "settings", "active", "design", "test", "training" ]

  State of a study for UI consumption

  Example: active

{
    "title":"StudyStateDto v1.0",
    "type":"object",
    "properties":{
        "studyState":{
            "type":"string",
            "description":"State of a study for UI consumption",
            "example":"active",
            "enum":[
                "settings",
                "active",
                "design",
                "test",
                "training"
            ]
        },
        "previousState":{
            "type":"string",
            "description":"Previous state of a study for UI consumption",
            "example":"training",
            "enum":[
                "settings",
                "active",
                "design",
                "test",
                "training"
            ]
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Information about the state of a study for UI consumption."
}

Examples

Select an example successResponse

404 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root 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 : details

Type: object

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root 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 : details

Type: object

Back to Top