Jump to

• Request
• Response

[Deprecated]: v1.0

post

/ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property

Deprecated in v1: use the latest SDF API version.

Request

Path Parameters

• mode(required): string
  Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).

  Example:

  test

• sdfId(required): string
  Required path parameter. SDF identifier to update. Accepted length: 32 to 36 characters.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• studyId(required): string(uuid)
  Study identifier as a 32-character uppercase hexadecimal UUID string.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : SDFCreatePropertyRequest v1.0

Type: object

Title: SDFCreatePropertyRequest v1.0

Request payload that wraps multiple SDF properties.

Show Source

• sdfPropertyList: object SDFPropertyDto v1.0
  Title: SDFPropertyDto v1.0

  Property metadata attached to an SDF.

{
    "title":"SDFCreatePropertyRequest v1.0",
    "type":"object",
    "properties":{
        "sdfPropertyList":{
            "title":"SDFPropertyDto v1.0",
            "required":[
                "propertyName",
                "propertyValue"
            ],
            "type":"object",
            "properties":{
                "reason":{
                    "title":"Reason",
                    "maxLength":255,
                    "minLength":0,
                    "type":"string",
                    "description":"Reason provided for the audited update.",
                    "example":"Protocol update requested by study operations."
                },
                "comment":{
                    "title":"Comment",
                    "maxLength":2048,
                    "minLength":0,
                    "type":"string",
                    "description":"Additional comment captured for the audited update.",
                    "example":"Association adjusted after data reconciliation."
                },
                "id":{
                    "title":"SDF Property ID",
                    "type":"string",
                    "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the property entry.",
                    "format":"uuid"
                },
                "versionStart":{
                    "type":"string",
                    "format":"date-time"
                },
                "sdfId":{
                    "title":"SDF ID",
                    "type":"string",
                    "description":"Identifier of the SDF the property belongs to.",
                    "format":"uuid"
                },
                "propertyName":{
                    "title":"Property Name",
                    "maxLength":100,
                    "minLength":0,
                    "type":"string",
                    "description":"Key identifying the property.",
                    "example":"PRIMARY_CONTACT"
                },
                "propertyValue":{
                    "title":"Property Value",
                    "maxLength":100,
                    "minLength":0,
                    "type":"string",
                    "description":"Value stored for the property.",
                    "example":"ACTIVE"
                }
            },
            "description":"Property metadata attached to an SDF.",
            "example":[
                {
                    "propertyName":"PRIMARY_CONTACT",
                    "propertyValue":"ACTIVE"
                }
            ]
        }
    },
    "description":"Request payload that wraps multiple SDF properties."
}

Nested Schema : SDFPropertyDto v1.0

Type: object

Title: SDFPropertyDto v1.0

Property metadata attached to an SDF.

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• id: string (uuid)
  Title: SDF Property ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the property entry.
• propertyName(required): string
  Title: Property Name

  Minimum Length: 0

  Maximum Length: 100

  Key identifying the property.

  Example: PRIMARY_CONTACT
• propertyValue(required): string
  Title: Property Value

  Minimum Length: 0

  Maximum Length: 100

  Value stored for the property.

  Example: ACTIVE
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• sdfId: string (uuid)
  Title: SDF ID

  Identifier of the SDF the property belongs to.
• versionStart: string (date-time)

{
    "title":"SDFPropertyDto v1.0",
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "title":"SDF Property ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the property entry.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "title":"SDF ID",
            "type":"string",
            "description":"Identifier of the SDF the property belongs to.",
            "format":"uuid"
        },
        "propertyName":{
            "title":"Property Name",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Key identifying the property.",
            "example":"PRIMARY_CONTACT"
        },
        "propertyValue":{
            "title":"Property Value",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Value stored for the property.",
            "example":"ACTIVE"
        }
    },
    "description":"Property metadata attached to an SDF.",
    "example":[
        {
            "propertyName":"PRIMARY_CONTACT",
            "propertyValue":"ACTIVE"
        }
    ]
}

Example:

[
    {
        "propertyName":"PRIMARY_CONTACT",
        "propertyValue":"ACTIVE"
    }
]

Examples

Select an example Create SDF Property Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

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

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example Success Response

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

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

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example Bad Request Response

Back to Top