Jump to

• Request
• Response

V3.0

get

/ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms/rules

Retrieves item rules for forms on a visit. Use the latest supported version of this endpoint in v17.0 for current behavior and metadata.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

• visitid(required): string(uuid)
  Visit ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  9F4A6C7E1B8F4D56A23C9F3A0C7D4E77

Query Parameters

• formId: string(uuid)
  Form identifier (UUID, 32-character uppercase hexadecimal string). Optional.

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

• itemId: string(uuid)
  Item identifier (UUID, 32-character uppercase hexadecimal string). Optional.

  Example:

  6D3A9B2E5C1F4A77B22D5E9F1A8C3344

• property: string
  Rule lookup property (`item` or `visitStartDate`). Optional.

  Default Value: item

  Example:

  item

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 FormItemRuleDto v1.0
  Title: FormItemRuleDto v1.0

  Form item rule information.

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

Nested Schema : FormItemRuleDto v1.0

Type: object

Title: FormItemRuleDto v1.0

Form item rule information.

Show Source

• actions: array actions
• assocId: string (uuid)
  Association GUID
• formId: string (uuid)
  Form GUID
• itemId: string (uuid)
  Item GUID
• ruleId: string (uuid)
  Rule GUID
• ruleJSExpression: string
  Rule JSON expression

  Example: 1.0.0.3
• ruleOrder: integer (int32)
  Rule order

  Example: 1
• ruleRefName: string
  Rule reference name

  Example: AGE
• smartItemId: string (uuid)
  Smart item GUID
• studyEventId: string (uuid)
  Study event GUID
• studyId: string (uuid)
  Study GUID
• studyVersion: string
  Study version

  Example: 1.0.0.3
• versionStart: string (date-time)
  Version Start date

{
    "title":"FormItemRuleDto v1.0",
    "type":"object",
    "properties":{
        "assocId":{
            "type":"string",
            "description":"Association GUID",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.3"
        },
        "studyEventId":{
            "type":"string",
            "description":"Study event GUID",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item GUID",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Item GUID",
            "format":"uuid"
        },
        "ruleId":{
            "type":"string",
            "description":"Rule GUID",
            "format":"uuid"
        },
        "ruleRefName":{
            "type":"string",
            "description":"Rule reference name",
            "example":"AGE"
        },
        "ruleJSExpression":{
            "type":"string",
            "description":"Rule JSON expression",
            "example":"1.0.0.3"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time"
        },
        "ruleOrder":{
            "type":"integer",
            "description":"Rule order",
            "format":"int32",
            "example":1
        },
        "actions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemRuleActionDtoV1"
            }
        }
    },
    "description":"Form item rule information."
}

Nested Schema : actions

Type: array

Show Source

• Array of: object FormItemRuleActionDto v1.0
  Title: FormItemRuleActionDto v1.0

  Form item rule action information.

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

Nested Schema : FormItemRuleActionDto v1.0

Type: object

Title: FormItemRuleActionDto v1.0

Form item rule action information.

Show Source

• actionId: string (uuid)
  Action GUID
• actionOrder: integer (int32)
  Action order

  Example: 1
• actionTarget: string
  Action target

  Example: 474A369C4A3E491F8207A7F8A59B8CA6.1CDE8BFA451948DEBEAC408E8CFBFCDA
• actionType: string
  Action type

  Example: Calculated Value
• assocId: string (uuid)
  Association GUID
• formId: string (uuid)
  Form GUID
• itemId: string (uuid)
  Item GUID
• ruleId: string (uuid)
  Rule GUID
• smartItemId: string (uuid)
  Smart item GUID
• studyEventId: string (uuid)
  Study event GUID
• studyId: string (uuid)
  Study GUID
• studyVersion: string
  Study version

  Example: 1.0.0.3

{
    "title":"FormItemRuleActionDto v1.0",
    "type":"object",
    "properties":{
        "assocId":{
            "type":"string",
            "description":"Association GUID",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.3"
        },
        "studyEventId":{
            "type":"string",
            "description":"Study event GUID",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item GUID",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Item GUID",
            "format":"uuid"
        },
        "ruleId":{
            "type":"string",
            "description":"Rule GUID",
            "format":"uuid"
        },
        "actionId":{
            "type":"string",
            "description":"Action GUID",
            "format":"uuid"
        },
        "actionType":{
            "type":"string",
            "description":"Action type",
            "example":"Calculated Value"
        },
        "actionTarget":{
            "type":"string",
            "description":"Action target",
            "example":"474A369C4A3E491F8207A7F8A59B8CA6.1CDE8BFA451948DEBEAC408E8CFBFCDA"
        },
        "actionOrder":{
            "type":"integer",
            "description":"Action order",
            "format":"int32",
            "example":1
        }
    },
    "description":"Form item rule action information."
}

Examples

Select an example successResponse

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