Jump to

• Request
• Response

Update signature configuration of a study

put

/ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration/{signConfigurationId}

Updates the signature configuration of a study in a particular mode.

Request

Path Parameters

• signConfigurationId(required): string
  ID of the Signature Configuration Entry.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Show Source

• signConfiguration: object SignatureConfigurationDTO

{
    "type":"object",
    "properties":{
        "signConfiguration":{
            "$ref":"#/components/schemas/SignatureConfigurationDTO"
        }
    }
}

Nested Schema : SignatureConfigurationDTO

Type: object

Show Source

• affidavitCodeValue: string
  Minimum Length: 0

  Maximum Length: 4000
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• configName: string
  Minimum Length: 0

  Maximum Length: 4000
• emailReminder: string
  Minimum Length: 0

  Maximum Length: 1
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• requiredBy: array requiredBy
  Minimum Number of Items: 0

  Maximum Number of Items: 4000
• requiredOn: string
  Minimum Length: 0

  Maximum Length: 16

  Allowed Values: [ "CASEBOOK", "VISIT", "FORM" ]
• requiredOnForms: array requiredOnForms
  Minimum Number of Items: 0

  Maximum Number of Items: 4000
• requiredOnVisits: array requiredOnVisits
  Minimum Number of Items: 0

  Maximum Number of Items: 4000
• softwareVersionNumber: number
• targetAfter: string
  Minimum Length: 0

  Maximum Length: 16

  Allowed Values: [ "COMPLETION", "START" ]
• targetDate: integer
• targetSet: string
  Minimum Length: 0

  Maximum Length: 1
• triggerAnswer: array triggerAnswer
  Minimum Number of Items: 0

  Maximum Number of Items: 4000
• triggerQuestion: string (uuid)
• 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"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "configName":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string"
        },
        "requiredOn":{
            "maxLength":"16",
            "minLength":"0",
            "type":"string",
            "enum":[
                "CASEBOOK",
                "VISIT",
                "FORM"
            ]
        },
        "affidavitCodeValue":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string"
        },
        "requiredBy":{
            "maxItems":"4000",
            "minItems":"0",
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "targetSet":{
            "maxLength":"1",
            "minLength":"0",
            "type":"string"
        },
        "targetDate":{
            "type":"integer"
        },
        "targetAfter":{
            "maxLength":"16",
            "minLength":"0",
            "type":"string",
            "enum":[
                "COMPLETION",
                "START"
            ]
        },
        "emailReminder":{
            "maxLength":"1",
            "minLength":"0",
            "type":"string"
        },
        "requiredOnForms":{
            "maxItems":"4000",
            "minItems":"0",
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "requiredOnVisits":{
            "maxItems":"4000",
            "minItems":"0",
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "triggerQuestion":{
            "type":"string",
            "format":"uuid"
        },
        "triggerAnswer":{
            "maxItems":"4000",
            "minItems":"0",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : requiredBy

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 4000

Show Source

• Array of: string(uuid)

{
    "maxItems":"4000",
    "minItems":"0",
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : requiredOnForms

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 4000

Show Source

• Array of: string(uuid)

{
    "maxItems":"4000",
    "minItems":"0",
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : requiredOnVisits

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 4000

Show Source

• Array of: string(uuid)

{
    "maxItems":"4000",
    "minItems":"0",
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : triggerAnswer

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 4000

Show Source

• Array of: string

{
    "maxItems":"4000",
    "minItems":"0",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: boolean

{
    "type":"array",
    "items":{
        "type":"boolean"
    }
}

400 Response

Bad_Request

Body ()

Root Schema : RestResponse

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