diff --git a/hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_jpa_partitioning/partitioning_management_operations.md b/hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_jpa_partitioning/partitioning_management_operations.md index 8a07aeb3e92..31ce535f810 100644 --- a/hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_jpa_partitioning/partitioning_management_operations.md +++ b/hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/server_jpa_partitioning/partitioning_management_operations.md @@ -186,3 +186,48 @@ The following request body could be used: } ``` +# Reading a Partition + +The `$partition-management-read-partition` operation can be used to read an existing partition. This operation takes the following parameters: + + + + + + + + + + + + + + + + + + +
NameTypeCardinalityDescription
idInteger1..1 + The numeric ID for the partition to update. This ID must already exist. +
+ +## Example + +An HTTP POST to the following URL would be used to invoke this operation: + +```url +http://example.com/DEFAULT/$partition-management-read-partition +``` + +The following request body could be used: + +```json +{ + "resourceType": "Parameters", + "parameter": [ { + "name": "id", + "valueInteger": 123 + } ] +} +``` +