[3020] add documentation for $partition-management-read-partition
This commit is contained in:
parent
d4bb48c551
commit
2489702ab9
|
@ -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:
|
||||||
|
|
||||||
|
<table class="table table-striped table-condensed">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Name</th>
|
||||||
|
<th>Type</th>
|
||||||
|
<th>Cardinality</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>id</td>
|
||||||
|
<td>Integer</td>
|
||||||
|
<td>1..1</td>
|
||||||
|
<td>
|
||||||
|
The numeric ID for the partition to update. This ID must already exist.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
## 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
|
||||||
|
} ]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue