Jump to

• Request
• Response

v1.0

put

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/extendedPropertiesByFilter

Creates or updates extended properties for all Sites filtered by the passed parameters.Based on a flag, API chooses between site IDs passed and site IDs fetched via filter. The API sets the same property values for all relevant sites

Request

Path Parameters

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

  Example:

  test

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Query Parameters

• countryId: string
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[A-F0-9]{32}$

  Country identifier as a 32-character uppercase hexadecimal UUID string.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• name: string
  Minimum Length: 1

  Maximum Length: 255

  Name search filter for site.

  Example:

  Site A

• statusId: string
  SDF status filter. Allowed values: ACTIVE (available), NEW (newly created), RESTRICTED (limited use), DISBARRED (blocked), DECEASED (closed), RETIRED (inactive).

  Allowed Values: [ "ACTIVE", "NEW", "RESTRICTED", "DISBARRED", "DECEASED", "RETIRED" ]

  Example:

  ACTIVE

• studyVersion: string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: ^[0-9]+$

  Study version filter for sites or depots. Accepts non-negative integer version numbers.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• extendedProperties: array extendedProperties
  Collection of extended properties for update operations.

{
    "type":"object",
    "properties":{
        "extendedProperties":{
            "type":"array",
            "description":"Collection of extended properties for update operations.",
            "example":[
                {
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        }
    }
}

Nested Schema : extendedProperties

Type: array

Collection of extended properties for update operations.

Show Source

• Array of: object SDFsPropertyDto

{
    "type":"array",
    "description":"Collection of extended properties for update operations.",
    "example":[
        {
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFsPropertyDto"
    }
}

Example:

[
    {
    }
]

Nested Schema : SDFsPropertyDto

Type: object

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)
  Unique identifier for this record.
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Name of the property.

  Example: timezone
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 2048

  Value of the property.

  Example: UTC
• 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)
  Identifier of the related SDF record.
• versionStart: string (date-time)

{
    "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":{
            "type":"string",
            "description":"Unique identifier for this record.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "description":"Identifier of the related SDF record.",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Name of the property.",
            "example":"timezone"
        },
        "propertyValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Value of the property.",
            "example":"UTC"
        }
    }
}

Examples

Select an example Request Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : SDFExtendedPropertiesListResponse

Type: object

Show Source

• sdfExtendedPropertiesList: array sdfExtendedPropertiesList

{
    "type":"object",
    "properties":{
        "sdfExtendedPropertiesList":{
            "type":"array",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFPropertyListDto"
            }
        }
    }
}

Nested Schema : sdfExtendedPropertiesList

Type: array

Show Source

• Array of: object SDFPropertyListDto

{
    "type":"array",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFPropertyListDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : SDFPropertyListDto

Type: object

Show Source

• sdfId: string (uuid)
• sdfPropertyList: array sdfPropertyList

{
    "type":"object",
    "properties":{
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfPropertyList":{
            "type":"array",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        }
    },
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ]
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : sdfPropertyList

Type: array

Show Source

• Array of: object SDFsPropertyDto

{
    "type":"array",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFsPropertyDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : SDFsPropertyDto

Type: object

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)
  Unique identifier for this record.
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Name of the property.

  Example: timezone
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 2048

  Value of the property.

  Example: UTC
• 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)
  Identifier of the related SDF record.
• versionStart: string (date-time)

{
    "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":{
            "type":"string",
            "description":"Unique identifier for this record.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "description":"Identifier of the related SDF record.",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Name of the property.",
            "example":"timezone"
        },
        "propertyValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Value of the property.",
            "example":"UTC"
        }
    }
}

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