Skip to content

Latest commit

 

History

History
495 lines (347 loc) · 19.7 KB

FeatureValuesApi.md

File metadata and controls

495 lines (347 loc) · 19.7 KB

FeatureValuesApi

All URIs are relative to https://api.kinow.com/api

Method HTTP request Description
attachFeaturesToActor POST /actors/{actor_id}/features
attachFeaturesToBlogPage POST /blog-pages/{blog_page_id}/features
attachFeaturesToCategory POST /categories/{category_id}/features
attachFeaturesToDirector POST /directors/{director_id}/features
attachFeaturesToExtract POST /extracts/{extract_id}/features
attachFeaturesToProduct POST /products/{product_id}/features
attachFeaturesToVideo POST /videos/{video_id}/features
detachFeatureToProduct DELETE /products/{product_id}/features/{feature_id}
getFeatureValues GET /feature-values

attachFeaturesToActor

attachFeaturesToActor($actor_id, $features)

Attach feature to actor

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\FeatureValuesApi();
$actor_id = 789; // int | 
$features = "features_example"; // string | To attach existing FeatureValue to actor:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]     ```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]     ```

try {
    $api_instance->attachFeaturesToActor($actor_id, $features);
} catch (Exception $e) {
    echo 'Exception when calling FeatureValuesApi->attachFeaturesToActor: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
actor_id int
features string To attach existing FeatureValue to actor: ``` [{ &quot;id_feature&quot;:3, &quot;id_feature_value&quot;:5 }] ``` To create a custom FeatureValue: ``` [{ &quot;id_feature&quot;:3, &quot;custom_value&quot;:[{ &quot;lang&quot;: 1, &quot;value&quot;: &quot;string&quot; }] }] ```

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

attachFeaturesToBlogPage

attachFeaturesToBlogPage($blog_page_id, $features)

Attach feature to blog page

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\FeatureValuesApi();
$blog_page_id = 789; // int | 
$features = "features_example"; // string | To attach existing FeatureValue to blog page:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]     ```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]     ```

try {
    $api_instance->attachFeaturesToBlogPage($blog_page_id, $features);
} catch (Exception $e) {
    echo 'Exception when calling FeatureValuesApi->attachFeaturesToBlogPage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
blog_page_id int
features string To attach existing FeatureValue to blog page: ``` [{ &quot;id_feature&quot;:3, &quot;id_feature_value&quot;:5 }] ``` To create a custom FeatureValue: ``` [{ &quot;id_feature&quot;:3, &quot;custom_value&quot;:[{ &quot;lang&quot;: 1, &quot;value&quot;: &quot;string&quot; }] }] ```

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

attachFeaturesToCategory

attachFeaturesToCategory($category_id, $features)

Attach feature to category

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\FeatureValuesApi();
$category_id = 789; // int | 
$features = "features_example"; // string | To attach existing FeatureValue to Category:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]     ```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]     ```

try {
    $api_instance->attachFeaturesToCategory($category_id, $features);
} catch (Exception $e) {
    echo 'Exception when calling FeatureValuesApi->attachFeaturesToCategory: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
category_id int
features string To attach existing FeatureValue to Category: ``` [{ &quot;id_feature&quot;:3, &quot;id_feature_value&quot;:5 }] ``` To create a custom FeatureValue: ``` [{ &quot;id_feature&quot;:3, &quot;custom_value&quot;:[{ &quot;lang&quot;: 1, &quot;value&quot;: &quot;string&quot; }] }] ```

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

attachFeaturesToDirector

attachFeaturesToDirector($director_id, $features)

Attach feature to director

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\FeatureValuesApi();
$director_id = 789; // int | 
$features = "features_example"; // string | To attach existing FeatureValue to director:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]     ```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]     ```

try {
    $api_instance->attachFeaturesToDirector($director_id, $features);
} catch (Exception $e) {
    echo 'Exception when calling FeatureValuesApi->attachFeaturesToDirector: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
director_id int
features string To attach existing FeatureValue to director: ``` [{ &quot;id_feature&quot;:3, &quot;id_feature_value&quot;:5 }] ``` To create a custom FeatureValue: ``` [{ &quot;id_feature&quot;:3, &quot;custom_value&quot;:[{ &quot;lang&quot;: 1, &quot;value&quot;: &quot;string&quot; }] }] ```

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

attachFeaturesToExtract

attachFeaturesToExtract($extract_id, $features)

Attach feature to extract

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\FeatureValuesApi();
$extract_id = 789; // int | 
$features = "features_example"; // string | To attach existing FeatureValue to Product:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]     ```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]     ```

try {
    $api_instance->attachFeaturesToExtract($extract_id, $features);
} catch (Exception $e) {
    echo 'Exception when calling FeatureValuesApi->attachFeaturesToExtract: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
extract_id int
features string To attach existing FeatureValue to Product: ``` [{ &quot;id_feature&quot;:3, &quot;id_feature_value&quot;:5 }] ``` To create a custom FeatureValue: ``` [{ &quot;id_feature&quot;:3, &quot;custom_value&quot;:[{ &quot;lang&quot;: 1, &quot;value&quot;: &quot;string&quot; }] }] ```

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

attachFeaturesToProduct

attachFeaturesToProduct($product_id, $features)

Attach feature to product

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\FeatureValuesApi();
$product_id = 789; // int | 
$features = "features_example"; // string | To attach existing FeatureValue to Product:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]```

try {
    $api_instance->attachFeaturesToProduct($product_id, $features);
} catch (Exception $e) {
    echo 'Exception when calling FeatureValuesApi->attachFeaturesToProduct: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
product_id int
features string To attach existing FeatureValue to Product: ``` [{ &quot;id_feature&quot;:3, &quot;id_feature_value&quot;:5 }]``` To create a custom FeatureValue: ``` [{ &quot;id_feature&quot;:3, &quot;custom_value&quot;:[{ &quot;lang&quot;: 1, &quot;value&quot;: &quot;string&quot; }] }]```

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

attachFeaturesToVideo

attachFeaturesToVideo($video_id, $features)

Attach feature to video

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\FeatureValuesApi();
$video_id = 789; // int | 
$features = "features_example"; // string | To attach existing FeatureValue to Product:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]     ```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]     ```

try {
    $api_instance->attachFeaturesToVideo($video_id, $features);
} catch (Exception $e) {
    echo 'Exception when calling FeatureValuesApi->attachFeaturesToVideo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
video_id int
features string To attach existing FeatureValue to Product: ``` [{ &quot;id_feature&quot;:3, &quot;id_feature_value&quot;:5 }] ``` To create a custom FeatureValue: ``` [{ &quot;id_feature&quot;:3, &quot;custom_value&quot;:[{ &quot;lang&quot;: 1, &quot;value&quot;: &quot;string&quot; }] }] ```

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

detachFeatureToProduct

detachFeatureToProduct($product_id, $feature_id)

Detach feature to product

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\FeatureValuesApi();
$product_id = 789; // int | 
$feature_id = 789; // int | 

try {
    $api_instance->detachFeatureToProduct($product_id, $feature_id);
} catch (Exception $e) {
    echo 'Exception when calling FeatureValuesApi->detachFeatureToProduct: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
product_id int
feature_id int

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getFeatureValues

\Kinow\Client\Model\FeatureValueListResponse1 getFeatureValues($page, $per_page)

Get feature value list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\FeatureValuesApi();
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getFeatureValues($page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeatureValuesApi->getFeatureValues: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\FeatureValueListResponse1

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined