Jump to

• Request
• Response

Get questions history for a form

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/itemhistory

Retrieves history of questions associated with a specific form.

Request

Path Parameters

• formId(required): string(uuid)
• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object FormHistoryDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormHistoryDto"
    }
}

Nested Schema : FormHistoryDto

Type: object

Show Source

• id(required): string (uuid)
  Form GUID
• items: array items
  Form items

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "items":{
            "type":"array",
            "description":"Form items",
            "items":{
                "$ref":"#/components/schemas/FormItemHistoryDto"
            }
        }
    }
}

Nested Schema : items

Type: array

Form items

Show Source

• Array of: object FormItemHistoryDto
  Form items

{
    "type":"array",
    "description":"Form items",
    "items":{
        "$ref":"#/components/schemas/FormItemHistoryDto"
    }
}

Nested Schema : FormItemHistoryDto

Type: object

Form items

Show Source

• id: string (uuid)
  Form GUID
• itemsHistory: array itemsHistory
  Form items history

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "itemsHistory":{
            "type":"array",
            "description":"Form items history",
            "items":{
                "$ref":"#/components/schemas/FormItemHistoryEventDto"
            }
        }
    },
    "description":"Form items"
}

Nested Schema : itemsHistory

Type: array

Form items history

Show Source

• Array of: object FormItemHistoryEventDto
  Form items history

{
    "type":"array",
    "description":"Form items history",
    "items":{
        "$ref":"#/components/schemas/FormItemHistoryEventDto"
    }
}

Nested Schema : FormItemHistoryEventDto

Type: object

Form items history

Show Source

• createVersion: string
  form item creation version

  Example: 1.0.0.1
• lastUpdate: string (date-time)
  form item create/last update date

  Example: 2017-10-12T18:16:55.346Z
• sourceVersion: string
  form item IPR source version

  Example: 1.0.0.1
• targetVersion: string
  form item IPR targeted version

  Example: 1.0.0.1

{
    "type":"object",
    "properties":{
        "createVersion":{
            "type":"string",
            "description":"form item creation version",
            "example":"1.0.0.1"
        },
        "sourceVersion":{
            "type":"string",
            "description":"form item IPR source version",
            "example":"1.0.0.1"
        },
        "targetVersion":{
            "type":"string",
            "description":"form item IPR targeted  version",
            "example":"1.0.0.1"
        },
        "lastUpdate":{
            "type":"string",
            "description":"form item create/last update date",
            "format":"date-time",
            "example":"2017-10-12T18:16:55.346Z"
        }
    },
    "description":"Form items history"
}

500 Response

Error

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