Jump to

• Request
• Response

v1.0

put

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

Updates multiple site properties for managing sites.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : MultipleSitePropertyUpdateRequestDto v1.0

Type: object

Title: MultipleSitePropertyUpdateRequestDto v1.0

Payload used to apply property updates across multiple sites.

Show Source

• allSites: boolean
  Title: All Sites

  Flag signifying whether the update applies to every site.

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

  Property metadata attached to an SDF.
• siteIds: array Site IDs
  Title: Site IDs

  List of site identifiers targeted by the update.

{
    "title":"MultipleSitePropertyUpdateRequestDto v1.0",
    "type":"object",
    "properties":{
        "allSites":{
            "title":"All Sites",
            "type":"boolean",
            "description":"Flag signifying whether the update applies to every site.",
            "example":false
        },
        "siteIds":{
            "title":"Site IDs",
            "type":"array",
            "description":"List of site identifiers targeted by the update.",
            "example":[
                "3F2504E0-4F89-11D3-9A0C-0305E82C3301"
            ],
            "items":{
                "title":"Site IDs",
                "type":"string",
                "description":"List of site identifiers targeted by the update.",
                "format":"uuid"
            }
        },
        "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",
                    "propertyValue":"ACTIVE"
                }
            ]
        }
    },
    "description":"Payload used to apply property updates across multiple sites."
}

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",
            "propertyValue":"ACTIVE"
        }
    ]
}

Example:

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

Nested Schema : Site IDs

Type: array

Title: Site IDs

List of site identifiers targeted by the update.

Show Source

• Array of: string(uuid)
  Title: Site IDs

  List of site identifiers targeted by the update.

{
    "title":"Site IDs",
    "type":"array",
    "description":"List of site identifiers targeted by the update.",
    "example":[
        "3F2504E0-4F89-11D3-9A0C-0305E82C3301"
    ],
    "items":{
        "title":"Site IDs",
        "type":"string",
        "description":"List of site identifiers targeted by the update.",
        "format":"uuid"
    }
}

Example:

[
    "3F2504E0-4F89-11D3-9A0C-0305E82C3301"
]

Examples

Select an example Update Multiple Sites 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
  Title: ErrorResponseData

  Error Response Details Information
• 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

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 : 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 : Object

Type: object

Title: Object

Object with error details information.

Example:

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

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
  Title: ErrorResponseData

  Error Response Details Information
• 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

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 : 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 : Object

Type: object

Title: Object

Object with error details information.

Example:

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

Examples

Select an example Bad Request Response

Back to Top