Jump to

• Request
• Response

Create or update extended properties for all sites

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
  Mode of the study. Accepts active, test, or training.
• studyId(required): string(uuid)
  The ID of the study.

Query Parameters

• countryId: string
  Country ID.
• name: string
  Name search filter for site
• statusId: string
  Site Status filter
• studyVersion: string
  Study version filter for site

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• extendedProperties: array extendedProperties

{
    "type":"object",
    "properties":{
        "extendedProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        }
    }
}

Nested Schema : extendedProperties

Type: array

Show Source

• Array of: object SDFsPropertyDto

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

Nested Schema : SDFsPropertyDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100
• propertyValue(required): string
  Minimum Length: 0

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

  Maximum Length: 255
• sdfId: string (uuid)
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "propertyValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        }
    }
}

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",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyListDto"
            }
        }
    }
}

Nested Schema : sdfExtendedPropertiesList

Type: array

Show Source

• Array of: object SDFPropertyListDto

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

Nested Schema : SDFPropertyListDto

Type: object

Show Source

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

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

Nested Schema : sdfPropertyList

Type: array

Show Source

• Array of: object SDFsPropertyDto

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

Nested Schema : SDFsPropertyDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100
• propertyValue(required): string
  Minimum Length: 0

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

  Maximum Length: 255
• sdfId: string (uuid)
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "propertyValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : SDFExtendedPropertiesListResponse

Type: object

Show Source

• sdfExtendedPropertiesList: array sdfExtendedPropertiesList

{
    "type":"object",
    "properties":{
        "sdfExtendedPropertiesList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyListDto"
            }
        }
    }
}

Nested Schema : sdfExtendedPropertiesList

Type: array

Show Source

• Array of: object SDFPropertyListDto

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

Nested Schema : SDFPropertyListDto

Type: object

Show Source

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

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

Nested Schema : sdfPropertyList

Type: array

Show Source

• Array of: object SDFsPropertyDto

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

Nested Schema : SDFsPropertyDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100
• propertyValue(required): string
  Minimum Length: 0

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

  Maximum Length: 255
• sdfId: string (uuid)
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "propertyValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        }
    }
}

Back to Top