Jump to

• Request
• Response

V19.0

delete

/ec-designer-edc-svc/rest/v19.0/studies/{studyId}/versions/{version}/forms/{formId}

Deletes a form from the requested study version. Provide the form ID; the response returns a deletion confirmation message. Compared with v18.0, this version returns the v19 deletion message as a plain string.

Request

Path Parameters

• formId(required): string(uuid)
  Form ID (UUID, 32-character uppercase hexadecimal string). Required.
• studyId(required): string
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.
• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Form deleted successfully.

Body ()

Root Schema : schema

Type: string

Examples

Select an example deleteFormResponseV19

500 Response

Unexpected server error while deleting form.

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example serverError

Back to Top