Jump to

• Request
• Response

v1.0

post

/ec-site-svc/rest/v1.0/facilities/{InstitutionId}

Creates one or more facility or department records for the given institution.

Request

Path Parameters

• InstitutionId(required): string
  Institution ID.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : FACILITY_MODEL_REQUEST_LIST_TITLE

Type: object

Title: FACILITY_MODEL_REQUEST_LIST_TITLE

FACILITY_MODEL_REQUEST_LIST_DESC

Show Source

• facilityModels: object FACILITY_MODEL_REQUEST_TITLE
  Title: FACILITY_MODEL_REQUEST_TITLE

  FACILITY_MODEL_REQUEST_DESC

{
    "title":"FACILITY_MODEL_REQUEST_LIST_TITLE",
    "type":"object",
    "properties":{
        "facilityModels":{
            "title":"FACILITY_MODEL_REQUEST_TITLE",
            "type":"object",
            "properties":{
                "facilityDto":{
                    "$ref":"#/components/schemas/FacilityDto"
                },
                "properties":{
                    "title":"PROPERTY_DTO_TITLE",
                    "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."
                        },
                        "entityId":{
                            "type":"string",
                            "description":"ENTITY_ID_DESC",
                            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                        },
                        "entityType":{
                            "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
                            "maxLength":50,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
                            "example":"INSTITUTION"
                        },
                        "propertyName":{
                            "title":"PROPERTY_DTO_NAME_TITLE",
                            "maxLength":100,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_NAME_DESC",
                            "example":"LabId"
                        },
                        "propertyValue":{
                            "title":"PROPERTY_DTO_VALUE_TITLE",
                            "maxLength":500,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_VALUE_DESC",
                            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                        }
                    },
                    "description":"PROPERTY_DTO_DESC"
                },
                "entityOperationType":{
                    "title":"FACILITY_MODEL_REQUEST_OPERATION_TITLE",
                    "type":"string",
                    "description":"FACILITY_MODEL_REQUEST_OPERATION_DESC",
                    "example":"CREATE"
                }
            },
            "description":"FACILITY_MODEL_REQUEST_DESC",
            "example":[
                "test"
            ]
        }
    },
    "description":"FACILITY_MODEL_REQUEST_LIST_DESC"
}

Nested Schema : FACILITY_MODEL_REQUEST_TITLE

Type: object

Title: FACILITY_MODEL_REQUEST_TITLE

FACILITY_MODEL_REQUEST_DESC

Show Source

• entityOperationType: string
  Title: FACILITY_MODEL_REQUEST_OPERATION_TITLE

  FACILITY_MODEL_REQUEST_OPERATION_DESC

  Example: CREATE
• facilityDto: object FACILITY_DTO_TITLE
  Title: FACILITY_DTO_TITLE

  FACILITY_DTO_DESC
• properties: object PROPERTY_DTO_TITLE
  Title: PROPERTY_DTO_TITLE

  PROPERTY_DTO_DESC

{
    "title":"FACILITY_MODEL_REQUEST_TITLE",
    "type":"object",
    "properties":{
        "facilityDto":{
            "$ref":"#/components/schemas/FacilityDto"
        },
        "properties":{
            "title":"PROPERTY_DTO_TITLE",
            "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."
                },
                "entityId":{
                    "type":"string",
                    "description":"ENTITY_ID_DESC",
                    "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                },
                "entityType":{
                    "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
                    "maxLength":50,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
                    "example":"INSTITUTION"
                },
                "propertyName":{
                    "title":"PROPERTY_DTO_NAME_TITLE",
                    "maxLength":100,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_NAME_DESC",
                    "example":"LabId"
                },
                "propertyValue":{
                    "title":"PROPERTY_DTO_VALUE_TITLE",
                    "maxLength":500,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_VALUE_DESC",
                    "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                }
            },
            "description":"PROPERTY_DTO_DESC"
        },
        "entityOperationType":{
            "title":"FACILITY_MODEL_REQUEST_OPERATION_TITLE",
            "type":"string",
            "description":"FACILITY_MODEL_REQUEST_OPERATION_DESC",
            "example":"CREATE"
        }
    },
    "description":"FACILITY_MODEL_REQUEST_DESC",
    "example":[
        "test"
    ]
}

Example:

[
    "test"
]

Nested Schema : FACILITY_DTO_TITLE

Type: object

Title: FACILITY_DTO_TITLE

FACILITY_DTO_DESC

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.
• entityId(required): string (uuid)
• entityType(required): string
  Title: FACILITY_DTO_ENTITY_TYPE_TITLE

  Minimum Length: 0

  Maximum Length: 50

  FACILITY_DTO_ENTITY_TYPE_DESC

  Example: FACILITY
• facilityName(required): string
  Title: FACILITY_DTO_NAME_TITLE

  Minimum Length: 0

  Maximum Length: 100

  FACILITY_DTO_NAME_DESC

  Example: Acme Research Facility
• id: string (uuid)
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "title":"FACILITY_DTO_TITLE",
    "required":[
        "entityId",
        "entityType",
        "facilityName"
    ],
    "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",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityType":{
            "title":"FACILITY_DTO_ENTITY_TYPE_TITLE",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"FACILITY_DTO_ENTITY_TYPE_DESC",
            "example":"FACILITY"
        },
        "facilityName":{
            "title":"FACILITY_DTO_NAME_TITLE",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"FACILITY_DTO_NAME_DESC",
            "example":"Acme Research Facility"
        }
    },
    "description":"FACILITY_DTO_DESC"
}

Nested Schema : PROPERTY_DTO_TITLE

Type: object

Title: PROPERTY_DTO_TITLE

PROPERTY_DTO_DESC

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.
• entityId: string
  ENTITY_ID_DESC

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• entityType: string
  Title: PROPERTY_DTO_ENTITY_TYPE_TITLE

  Minimum Length: 0

  Maximum Length: 50

  PROPERTY_DTO_ENTITY_TYPE_DESC

  Example: INSTITUTION
• propertyName(required): string
  Title: PROPERTY_DTO_NAME_TITLE

  Minimum Length: 0

  Maximum Length: 100

  PROPERTY_DTO_NAME_DESC

  Example: LabId
• propertyValue(required): string
  Title: PROPERTY_DTO_VALUE_TITLE

  Minimum Length: 0

  Maximum Length: 500

  PROPERTY_DTO_VALUE_DESC

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.

{
    "title":"PROPERTY_DTO_TITLE",
    "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."
        },
        "entityId":{
            "type":"string",
            "description":"ENTITY_ID_DESC",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "entityType":{
            "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
            "example":"INSTITUTION"
        },
        "propertyName":{
            "title":"PROPERTY_DTO_NAME_TITLE",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_NAME_DESC",
            "example":"LabId"
        },
        "propertyValue":{
            "title":"PROPERTY_DTO_VALUE_TITLE",
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_VALUE_DESC",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        }
    },
    "description":"PROPERTY_DTO_DESC"
}

Examples

Select an example Create Facilities Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : FACILITY_MODEL_RESPONSE_LIST_TITLE

Type: object

Title: FACILITY_MODEL_RESPONSE_LIST_TITLE

FACILITY_MODEL_RESPONSE_LIST_DESC

Show Source

• facilityModels: object FACILITY_MODEL_RESPONSE_TITLE
  Title: FACILITY_MODEL_RESPONSE_TITLE

  FACILITY_MODEL_RESPONSE_DESC

{
    "title":"FACILITY_MODEL_RESPONSE_LIST_TITLE",
    "type":"object",
    "properties":{
        "facilityModels":{
            "title":"FACILITY_MODEL_RESPONSE_TITLE",
            "type":"object",
            "properties":{
                "facilityDto":{
                    "$ref":"#/components/schemas/FacilityDto"
                },
                "properties":{
                    "title":"PROPERTY_DTO_TITLE",
                    "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."
                        },
                        "entityId":{
                            "type":"string",
                            "description":"ENTITY_ID_DESC",
                            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                        },
                        "entityType":{
                            "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
                            "maxLength":50,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
                            "example":"INSTITUTION"
                        },
                        "propertyName":{
                            "title":"PROPERTY_DTO_NAME_TITLE",
                            "maxLength":100,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_NAME_DESC",
                            "example":"LabId"
                        },
                        "propertyValue":{
                            "title":"PROPERTY_DTO_VALUE_TITLE",
                            "maxLength":500,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_VALUE_DESC",
                            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                        }
                    },
                    "description":"PROPERTY_DTO_DESC"
                }
            },
            "description":"FACILITY_MODEL_RESPONSE_DESC",
            "example":[
                "test"
            ]
        }
    },
    "description":"FACILITY_MODEL_RESPONSE_LIST_DESC"
}

Nested Schema : FACILITY_MODEL_RESPONSE_TITLE

Type: object

Title: FACILITY_MODEL_RESPONSE_TITLE

FACILITY_MODEL_RESPONSE_DESC

Show Source

• facilityDto: object FACILITY_DTO_TITLE
  Title: FACILITY_DTO_TITLE

  FACILITY_DTO_DESC
• properties: object PROPERTY_DTO_TITLE
  Title: PROPERTY_DTO_TITLE

  PROPERTY_DTO_DESC

{
    "title":"FACILITY_MODEL_RESPONSE_TITLE",
    "type":"object",
    "properties":{
        "facilityDto":{
            "$ref":"#/components/schemas/FacilityDto"
        },
        "properties":{
            "title":"PROPERTY_DTO_TITLE",
            "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."
                },
                "entityId":{
                    "type":"string",
                    "description":"ENTITY_ID_DESC",
                    "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                },
                "entityType":{
                    "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
                    "maxLength":50,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
                    "example":"INSTITUTION"
                },
                "propertyName":{
                    "title":"PROPERTY_DTO_NAME_TITLE",
                    "maxLength":100,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_NAME_DESC",
                    "example":"LabId"
                },
                "propertyValue":{
                    "title":"PROPERTY_DTO_VALUE_TITLE",
                    "maxLength":500,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_VALUE_DESC",
                    "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                }
            },
            "description":"PROPERTY_DTO_DESC"
        }
    },
    "description":"FACILITY_MODEL_RESPONSE_DESC",
    "example":[
        "test"
    ]
}

Example:

[
    "test"
]

Nested Schema : FACILITY_DTO_TITLE

Type: object

Title: FACILITY_DTO_TITLE

FACILITY_DTO_DESC

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.
• entityId(required): string (uuid)
• entityType(required): string
  Title: FACILITY_DTO_ENTITY_TYPE_TITLE

  Minimum Length: 0

  Maximum Length: 50

  FACILITY_DTO_ENTITY_TYPE_DESC

  Example: FACILITY
• facilityName(required): string
  Title: FACILITY_DTO_NAME_TITLE

  Minimum Length: 0

  Maximum Length: 100

  FACILITY_DTO_NAME_DESC

  Example: Acme Research Facility
• id: string (uuid)
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "title":"FACILITY_DTO_TITLE",
    "required":[
        "entityId",
        "entityType",
        "facilityName"
    ],
    "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",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityType":{
            "title":"FACILITY_DTO_ENTITY_TYPE_TITLE",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"FACILITY_DTO_ENTITY_TYPE_DESC",
            "example":"FACILITY"
        },
        "facilityName":{
            "title":"FACILITY_DTO_NAME_TITLE",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"FACILITY_DTO_NAME_DESC",
            "example":"Acme Research Facility"
        }
    },
    "description":"FACILITY_DTO_DESC"
}

Nested Schema : PROPERTY_DTO_TITLE

Type: object

Title: PROPERTY_DTO_TITLE

PROPERTY_DTO_DESC

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.
• entityId: string
  ENTITY_ID_DESC

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• entityType: string
  Title: PROPERTY_DTO_ENTITY_TYPE_TITLE

  Minimum Length: 0

  Maximum Length: 50

  PROPERTY_DTO_ENTITY_TYPE_DESC

  Example: INSTITUTION
• propertyName(required): string
  Title: PROPERTY_DTO_NAME_TITLE

  Minimum Length: 0

  Maximum Length: 100

  PROPERTY_DTO_NAME_DESC

  Example: LabId
• propertyValue(required): string
  Title: PROPERTY_DTO_VALUE_TITLE

  Minimum Length: 0

  Maximum Length: 500

  PROPERTY_DTO_VALUE_DESC

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.

{
    "title":"PROPERTY_DTO_TITLE",
    "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."
        },
        "entityId":{
            "type":"string",
            "description":"ENTITY_ID_DESC",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "entityType":{
            "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
            "example":"INSTITUTION"
        },
        "propertyName":{
            "title":"PROPERTY_DTO_NAME_TITLE",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_NAME_DESC",
            "example":"LabId"
        },
        "propertyValue":{
            "title":"PROPERTY_DTO_VALUE_TITLE",
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_VALUE_DESC",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        }
    },
    "description":"PROPERTY_DTO_DESC"
}

Examples

Select an example Create Facilities Success Response

400 Response

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

Body ()

Root Schema : FACILITY_MODEL_RESPONSE_LIST_TITLE

Type: object

Title: FACILITY_MODEL_RESPONSE_LIST_TITLE

FACILITY_MODEL_RESPONSE_LIST_DESC

Show Source

• facilityModels: object FACILITY_MODEL_RESPONSE_TITLE
  Title: FACILITY_MODEL_RESPONSE_TITLE

  FACILITY_MODEL_RESPONSE_DESC

{
    "title":"FACILITY_MODEL_RESPONSE_LIST_TITLE",
    "type":"object",
    "properties":{
        "facilityModels":{
            "title":"FACILITY_MODEL_RESPONSE_TITLE",
            "type":"object",
            "properties":{
                "facilityDto":{
                    "$ref":"#/components/schemas/FacilityDto"
                },
                "properties":{
                    "title":"PROPERTY_DTO_TITLE",
                    "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."
                        },
                        "entityId":{
                            "type":"string",
                            "description":"ENTITY_ID_DESC",
                            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                        },
                        "entityType":{
                            "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
                            "maxLength":50,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
                            "example":"INSTITUTION"
                        },
                        "propertyName":{
                            "title":"PROPERTY_DTO_NAME_TITLE",
                            "maxLength":100,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_NAME_DESC",
                            "example":"LabId"
                        },
                        "propertyValue":{
                            "title":"PROPERTY_DTO_VALUE_TITLE",
                            "maxLength":500,
                            "minLength":0,
                            "type":"string",
                            "description":"PROPERTY_DTO_VALUE_DESC",
                            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                        }
                    },
                    "description":"PROPERTY_DTO_DESC"
                }
            },
            "description":"FACILITY_MODEL_RESPONSE_DESC",
            "example":[
                "test"
            ]
        }
    },
    "description":"FACILITY_MODEL_RESPONSE_LIST_DESC"
}

Nested Schema : FACILITY_MODEL_RESPONSE_TITLE

Type: object

Title: FACILITY_MODEL_RESPONSE_TITLE

FACILITY_MODEL_RESPONSE_DESC

Show Source

• facilityDto: object FACILITY_DTO_TITLE
  Title: FACILITY_DTO_TITLE

  FACILITY_DTO_DESC
• properties: object PROPERTY_DTO_TITLE
  Title: PROPERTY_DTO_TITLE

  PROPERTY_DTO_DESC

{
    "title":"FACILITY_MODEL_RESPONSE_TITLE",
    "type":"object",
    "properties":{
        "facilityDto":{
            "$ref":"#/components/schemas/FacilityDto"
        },
        "properties":{
            "title":"PROPERTY_DTO_TITLE",
            "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."
                },
                "entityId":{
                    "type":"string",
                    "description":"ENTITY_ID_DESC",
                    "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                },
                "entityType":{
                    "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
                    "maxLength":50,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
                    "example":"INSTITUTION"
                },
                "propertyName":{
                    "title":"PROPERTY_DTO_NAME_TITLE",
                    "maxLength":100,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_NAME_DESC",
                    "example":"LabId"
                },
                "propertyValue":{
                    "title":"PROPERTY_DTO_VALUE_TITLE",
                    "maxLength":500,
                    "minLength":0,
                    "type":"string",
                    "description":"PROPERTY_DTO_VALUE_DESC",
                    "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
                }
            },
            "description":"PROPERTY_DTO_DESC"
        }
    },
    "description":"FACILITY_MODEL_RESPONSE_DESC",
    "example":[
        "test"
    ]
}

Example:

[
    "test"
]

Nested Schema : FACILITY_DTO_TITLE

Type: object

Title: FACILITY_DTO_TITLE

FACILITY_DTO_DESC

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.
• entityId(required): string (uuid)
• entityType(required): string
  Title: FACILITY_DTO_ENTITY_TYPE_TITLE

  Minimum Length: 0

  Maximum Length: 50

  FACILITY_DTO_ENTITY_TYPE_DESC

  Example: FACILITY
• facilityName(required): string
  Title: FACILITY_DTO_NAME_TITLE

  Minimum Length: 0

  Maximum Length: 100

  FACILITY_DTO_NAME_DESC

  Example: Acme Research Facility
• id: string (uuid)
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "title":"FACILITY_DTO_TITLE",
    "required":[
        "entityId",
        "entityType",
        "facilityName"
    ],
    "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",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityType":{
            "title":"FACILITY_DTO_ENTITY_TYPE_TITLE",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"FACILITY_DTO_ENTITY_TYPE_DESC",
            "example":"FACILITY"
        },
        "facilityName":{
            "title":"FACILITY_DTO_NAME_TITLE",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"FACILITY_DTO_NAME_DESC",
            "example":"Acme Research Facility"
        }
    },
    "description":"FACILITY_DTO_DESC"
}

Nested Schema : PROPERTY_DTO_TITLE

Type: object

Title: PROPERTY_DTO_TITLE

PROPERTY_DTO_DESC

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.
• entityId: string
  ENTITY_ID_DESC

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• entityType: string
  Title: PROPERTY_DTO_ENTITY_TYPE_TITLE

  Minimum Length: 0

  Maximum Length: 50

  PROPERTY_DTO_ENTITY_TYPE_DESC

  Example: INSTITUTION
• propertyName(required): string
  Title: PROPERTY_DTO_NAME_TITLE

  Minimum Length: 0

  Maximum Length: 100

  PROPERTY_DTO_NAME_DESC

  Example: LabId
• propertyValue(required): string
  Title: PROPERTY_DTO_VALUE_TITLE

  Minimum Length: 0

  Maximum Length: 500

  PROPERTY_DTO_VALUE_DESC

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.

{
    "title":"PROPERTY_DTO_TITLE",
    "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."
        },
        "entityId":{
            "type":"string",
            "description":"ENTITY_ID_DESC",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "entityType":{
            "title":"PROPERTY_DTO_ENTITY_TYPE_TITLE",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_ENTITY_TYPE_DESC",
            "example":"INSTITUTION"
        },
        "propertyName":{
            "title":"PROPERTY_DTO_NAME_TITLE",
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_NAME_DESC",
            "example":"LabId"
        },
        "propertyValue":{
            "title":"PROPERTY_DTO_VALUE_TITLE",
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"PROPERTY_DTO_VALUE_DESC",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        }
    },
    "description":"PROPERTY_DTO_DESC"
}

Examples

Select an example Bad Request Response

Back to Top