SpringImport\Swagger\Magento2\Client\CmsBlockRepositoryV1Api
May 23, 2017 ยท View on GitHub
All URIs are relative to http://t213.vg/rest/default
| Method | HTTP request | Description |
|---|---|---|
| cmsBlockRepositoryV1DeleteByIdDelete | DELETE /V1/cmsBlock/{blockId} | |
| cmsBlockRepositoryV1GetByIdGet | GET /V1/cmsBlock/{blockId} | |
| cmsBlockRepositoryV1GetListGet | GET /V1/cmsBlock/search | |
| cmsBlockRepositoryV1SavePost | POST /V1/cmsBlock | |
| cmsBlockRepositoryV1SavePut | PUT /V1/cmsBlock/{id} |
cmsBlockRepositoryV1DeleteByIdDelete
bool cmsBlockRepositoryV1DeleteByIdDelete($blockId)
Delete block by ID.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new SpringImport\Swagger\Magento2\Client\Api\CmsBlockRepositoryV1Api();
$blockId = 56; // int |
try {
$result = $api_instance->cmsBlockRepositoryV1DeleteByIdDelete($blockId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CmsBlockRepositoryV1Api->cmsBlockRepositoryV1DeleteByIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| blockId | int |
Return type
bool
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
cmsBlockRepositoryV1GetByIdGet
\SpringImport\Swagger\Magento2\Client\Model\CmsDataBlockInterface cmsBlockRepositoryV1GetByIdGet($blockId)
Retrieve block.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new SpringImport\Swagger\Magento2\Client\Api\CmsBlockRepositoryV1Api();
$blockId = 56; // int |
try {
$result = $api_instance->cmsBlockRepositoryV1GetByIdGet($blockId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CmsBlockRepositoryV1Api->cmsBlockRepositoryV1GetByIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| blockId | int |
Return type
\SpringImport\Swagger\Magento2\Client\Model\CmsDataBlockInterface
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
cmsBlockRepositoryV1GetListGet
\SpringImport\Swagger\Magento2\Client\Model\CmsDataBlockSearchResultsInterface cmsBlockRepositoryV1GetListGet(searchCriteriaFilterGroups0Filters0Value, searchCriteriaSortOrders0Field, searchCriteriaPageSize, $searchCriteriaCurrentPage)
Retrieve blocks matching the specified criteria.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new SpringImport\Swagger\Magento2\Client\Api\CmsBlockRepositoryV1Api();
$searchCriteriaFilterGroups0Filters0Field = "searchCriteriaFilterGroups0Filters0Field_example"; // string | Field
$searchCriteriaFilterGroups0Filters0Value = "searchCriteriaFilterGroups0Filters0Value_example"; // string | Value
$searchCriteriaFilterGroups0Filters0ConditionType = "searchCriteriaFilterGroups0Filters0ConditionType_example"; // string | Condition type
$searchCriteriaSortOrders0Field = "searchCriteriaSortOrders0Field_example"; // string | Sorting field.
$searchCriteriaSortOrders0Direction = "searchCriteriaSortOrders0Direction_example"; // string | Sorting direction.
$searchCriteriaPageSize = 56; // int | Page size.
$searchCriteriaCurrentPage = 56; // int | Current page.
try {
$result = $api_instance->cmsBlockRepositoryV1GetListGet($searchCriteriaFilterGroups0Filters0Field, $searchCriteriaFilterGroups0Filters0Value, $searchCriteriaFilterGroups0Filters0ConditionType, $searchCriteriaSortOrders0Field, $searchCriteriaSortOrders0Direction, $searchCriteriaPageSize, $searchCriteriaCurrentPage);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CmsBlockRepositoryV1Api->cmsBlockRepositoryV1GetListGet: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchCriteriaFilterGroups0Filters0Field | string | Field | [optional] |
| searchCriteriaFilterGroups0Filters0Value | string | Value | [optional] |
| searchCriteriaFilterGroups0Filters0ConditionType | string | Condition type | [optional] |
| searchCriteriaSortOrders0Field | string | Sorting field. | [optional] |
| searchCriteriaSortOrders0Direction | string | Sorting direction. | [optional] |
| searchCriteriaPageSize | int | Page size. | [optional] |
| searchCriteriaCurrentPage | int | Current page. | [optional] |
Return type
\SpringImport\Swagger\Magento2\Client\Model\CmsDataBlockSearchResultsInterface
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
cmsBlockRepositoryV1SavePost
\SpringImport\Swagger\Magento2\Client\Model\CmsDataBlockInterface cmsBlockRepositoryV1SavePost($body)
Save block.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new SpringImport\Swagger\Magento2\Client\Api\CmsBlockRepositoryV1Api();
$body = new \SpringImport\Swagger\Magento2\Client\Model\Body16(); // \SpringImport\Swagger\Magento2\Client\Model\Body16 |
try {
$result = $api_instance->cmsBlockRepositoryV1SavePost($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CmsBlockRepositoryV1Api->cmsBlockRepositoryV1SavePost: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | \SpringImport\Swagger\Magento2\Client\Model\Body16 | [optional] |
Return type
\SpringImport\Swagger\Magento2\Client\Model\CmsDataBlockInterface
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
cmsBlockRepositoryV1SavePut
\SpringImport\Swagger\Magento2\Client\Model\CmsDataBlockInterface cmsBlockRepositoryV1SavePut(body)
Save block.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new SpringImport\Swagger\Magento2\Client\Api\CmsBlockRepositoryV1Api();
$id = "id_example"; // string |
$body = new \SpringImport\Swagger\Magento2\Client\Model\Body17(); // \SpringImport\Swagger\Magento2\Client\Model\Body17 |
try {
$result = $api_instance->cmsBlockRepositoryV1SavePut($id, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CmsBlockRepositoryV1Api->cmsBlockRepositoryV1SavePut: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ||
| body | \SpringImport\Swagger\Magento2\Client\Model\Body17 | [optional] |
Return type
\SpringImport\Swagger\Magento2\Client\Model\CmsDataBlockInterface
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]