SternerStuff\InsightlyPHP\KnowledgeArticlesApi

All URIs are relative to https://api.insightly.com/v3.1

Method	HTTP request	Description
addEntity	POST /KnowledgeArticle	Adds a Knowledge Article
addFollow	POST /KnowledgeArticle/{id}/Follow	Start following a Knowledge Article
addTag	POST /KnowledgeArticle/{id}/Tags	Adds a Tag to a Knowledge Article
addTranslation	POST /KnowledgeArticle/{id}/Translations/{language}	Adds a Translation for a Knowledge Article in a specific language
deleteEntity	DELETE /KnowledgeArticle/{id}	Deletes a Knowledge Article
deleteFollow	DELETE /KnowledgeArticle/{id}/Follow	Stop following a Knowledge Article
deleteImageField	DELETE /KnowledgeArticle/{id}/ImageField/{fieldName}	Deletes a Knowledge Article's Custom Image Field
deleteTag	DELETE /KnowledgeArticle/{id}/Tags	Deletes a Tag from a Knowledge Article
getEntities	GET /KnowledgeArticle	Gets a list of Knowledge Articles
getEntitiesBySearch	GET /KnowledgeArticle/Search	Gets a filtered list of Knowledge Articles
getEntitiesByTag	GET /KnowledgeArticle/SearchByTag	Gets a list of Knowledge Articles filtered by tags
getEntity	GET /KnowledgeArticle/{id}	Gets a Knowledge Article
getFollow	GET /KnowledgeArticle/{id}/Follow	Gets a Follow state for a Knowledge Article
getImageField	GET /KnowledgeArticle/{id}/ImageField/{fieldName}	Gets a Knowledge Article's Custom Image Field
getTags	GET /KnowledgeArticle/{id}/Tags	Gets a Knowledge Article's Tags
getTranslation	GET /KnowledgeArticle/{id}/Translations/{language}	Gets a Knowledge Article's translation in a specific language
updateEntity	PUT /KnowledgeArticle	Updates a Knowledge Article
updateImageField	PUT /KnowledgeArticle/{id}/ImageField/{fieldName}/{fileName}	Updates a Knowledge Article's Custom Image Field
updateTags	PUT /KnowledgeArticle/{id}/Tags	Updates a Knowledge Article's Tags
updateTranslation	PUT /KnowledgeArticle/{id}/Translations/{language}	Updates a Knowledge Article's translation in a specific language

addEntity

object addEntity($authorization, $field_values)

Adds a Knowledge Article

If you have trouble with creating a Knowledge Article, try creating Knowledge Articles via the web interface, and then access those Knowledge Articles via the API. This way you can see examples of the fields and sub-elements attached to the Knowledge Article. A common source of problems during write/update request is caused when users omit required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \SternerStuff\InsightlyPHP\Model\\SternerStuff\InsightlyPHP\Model\FieldValues(); // \SternerStuff\InsightlyPHP\Model\FieldValues | The record to add (just include the JSON object as the request body)

try {
    $result = $apiInstance->addEntity($authorization, $field_values);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->addEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Authorization	[default to {{Authorization}}]
field_values	\SternerStuff\InsightlyPHP\Model\FieldValues	The record to add (just include the JSON object as the request body)

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addFollow

\SternerStuff\InsightlyPHP\Model\APIFollow addFollow($id, $authorization)

Start following a Knowledge Article

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->addFollow($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->addFollow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID (RECORD_ID)
authorization	string	Authorization	[default to {{Authorization}}]

Return type

\SternerStuff\InsightlyPHP\Model\APIFollow

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addTag

\SternerStuff\InsightlyPHP\Model\APITag addTag($id, $authorization, $api_tag)

Adds a Tag to a Knowledge Article

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_tag = new \SternerStuff\InsightlyPHP\Model\APITag(); // \SternerStuff\InsightlyPHP\Model\APITag | The Record's Tag

try {
    $result = $apiInstance->addTag($id, $authorization, $api_tag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->addTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	The record's ID
authorization	string	Authorization	[default to {{Authorization}}]
api_tag	\SternerStuff\InsightlyPHP\Model\APITag	The Record's Tag

Return type

\SternerStuff\InsightlyPHP\Model\APITag

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addTranslation

object[] addTranslation($language, $id, $authorization, $field_values)

Adds a Translation for a Knowledge Article in a specific language

If you have trouble with creating a Knowledge Article, try creating Knowledge Articles via the web interface, and then access those Knowledge Articles via the API. This way you can see examples of the fields and sub-elements attached to the Knowledge Article. A common source of problems during write/update request is caused when users omit required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$language = "language_example"; // string | The language of the translation to add
$id = "id_example"; // string | 
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \SternerStuff\InsightlyPHP\Model\\SternerStuff\InsightlyPHP\Model\FieldValues(); // \SternerStuff\InsightlyPHP\Model\FieldValues | The record to add (just include the JSON object as the request body)

try {
    $result = $apiInstance->addTranslation($language, $id, $authorization, $field_values);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->addTranslation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
language	string	The language of the translation to add
id	string
authorization	string	Authorization	[default to {{Authorization}}]
field_values	\SternerStuff\InsightlyPHP\Model\FieldValues	The record to add (just include the JSON object as the request body)

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEntity

deleteEntity($id, $authorization)

Deletes a Knowledge Article

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | Entity's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteEntity($id, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->deleteEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	Entity's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteFollow

deleteFollow($id, $authorization)

Stop following a Knowledge Article

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteFollow($id, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->deleteFollow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID (RECORD_ID)
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteImageField

deleteImageField($id, $field_name, $authorization)

Deletes a Knowledge Article's Custom Image Field

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteImageField($id, $field_name, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->deleteImageField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
field_name	string	An image field name
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteTag

deleteTag($id, $api_tag, $authorization)

Deletes a Tag from a Knowledge Article

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$api_tag = new \SternerStuff\InsightlyPHP\Model\APITag(); // \SternerStuff\InsightlyPHP\Model\APITag | The Record's Tag
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteTag($id, $api_tag, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->deleteTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	The record's ID
api_tag	\SternerStuff\InsightlyPHP\Model\APITag	The Record's Tag
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntities

object[] getEntities($authorization, $brief, $skip, $top, $count_total)

Gets a list of Knowledge Articles

Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional,true if total number of records should be returned in the response headers.

try {
    $result = $apiInstance->getEntities($authorization, $brief, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->getEntities: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Authorization	[default to {{Authorization}}]
brief	bool	Optional, true if response should only contain top level properties of the record.	[optional] [default to false]
skip	int	Optional, number of records to skip.	[optional]
top	int	Optional, maximum number of records to return in the response.	[optional]
count_total	bool	Optional,true if total number of records should be returned in the response headers.	[optional] [default to false]

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntitiesBySearch

object[] getEntitiesBySearch($authorization, $field_name, $field_value, $updated_after_utc, $brief, $skip, $top, $count_total)

Gets a filtered list of Knowledge Articles

To filter with a field name and value, both field_name and field_value parameters must be provided.
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_name = "field_name_example"; // string | Optional, field name for object
$field_value = "field_value_example"; // string | Optional, field value of the record
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when a record was last updated.
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional, true if total number of records should be returned in the response headers.

try {
    $result = $apiInstance->getEntitiesBySearch($authorization, $field_name, $field_value, $updated_after_utc, $brief, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->getEntitiesBySearch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Authorization	[default to {{Authorization}}]
field_name	string	Optional, field name for object	[optional]
field_value	string	Optional, field value of the record	[optional]
updated_after_utc	\DateTime	Optional, earliest date when a record was last updated.	[optional]
brief	bool	Optional, true if response should only contain top level properties of the record.	[optional] [default to false]
skip	int	Optional, number of records to skip.	[optional]
top	int	Optional, maximum number of records to return in the response.	[optional]
count_total	bool	Optional, true if total number of records should be returned in the response headers.	[optional] [default to false]

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntitiesByTag

object[] getEntitiesByTag($tag_name, $authorization, $brief, $skip, $top, $count_total)

Gets a list of Knowledge Articles filtered by tags

Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$tag_name = "tag_name_example"; // string | Tag name to filter on
$authorization = "{{Authorization}}"; // string | Authorization
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional, true if total number of records should be returned in the response headers.

try {
    $result = $apiInstance->getEntitiesByTag($tag_name, $authorization, $brief, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->getEntitiesByTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
tag_name	string	Tag name to filter on
authorization	string	Authorization	[default to {{Authorization}}]
brief	bool	Optional, true if response should only contain top level properties of the record.	[optional] [default to false]
skip	int	Optional, number of records to skip.	[optional]
top	int	Optional, maximum number of records to return in the response.	[optional]
count_total	bool	Optional, true if total number of records should be returned in the response headers.	[optional] [default to false]

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntity

object getEntity($id, $authorization)

Gets a Knowledge Article

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getEntity($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->getEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	The record's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFollow

\SternerStuff\InsightlyPHP\Model\APIFollow getFollow($id, $authorization)

Gets a Follow state for a Knowledge Article

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | A record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getFollow($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->getFollow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A record's ID (RECORD_ID)
authorization	string	Authorization	[default to {{Authorization}}]

Return type

\SternerStuff\InsightlyPHP\Model\APIFollow

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getImageField

getImageField($id, $field_name, $authorization)

Gets a Knowledge Article's Custom Image Field

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->getImageField($id, $field_name, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->getImageField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
field_name	string	An image field name
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTags

\SternerStuff\InsightlyPHP\Model\APITag[] getTags($id, $authorization)

Gets a Knowledge Article's Tags

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getTags($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->getTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	The record's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

\SternerStuff\InsightlyPHP\Model\APITag[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTranslation

object[] getTranslation($id, $language, $authorization)

Gets a Knowledge Article's translation in a specific language

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$language = "language_example"; // string | The requested language
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getTranslation($id, $language, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->getTranslation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	The record's ID
language	string	The requested language
authorization	string	Authorization	[default to {{Authorization}}]

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEntity

object updateEntity($authorization, $field_values)

Updates a Knowledge Article

If you have trouble updating a Knowledge Article, try accessing the Knowledge Article via the GET request to inspect its fields and sub-elements. A common source of problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a CATEGORY_ID or LINK_ID which does not exist.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \SternerStuff\InsightlyPHP\Model\\SternerStuff\InsightlyPHP\Model\FieldValues(); // \SternerStuff\InsightlyPHP\Model\FieldValues | The record to update (just include the JSON object as the request body)

try {
    $result = $apiInstance->updateEntity($authorization, $field_values);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->updateEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Authorization	[default to {{Authorization}}]
field_values	\SternerStuff\InsightlyPHP\Model\FieldValues	The record to update (just include the JSON object as the request body)

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateImageField

object[] updateImageField($id, $field_name, $file_name, $authorization, $file)

Updates a Knowledge Article's Custom Image Field

This action will replace any existing Image attached to the Knowledge Article's image field. The contents of the image data should be sent as binary data in the request payload. See our <a href="http://github.com/Insightly\" target="_blank">client libraries for an example of how this is done.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$file_name = "file_name_example"; // string | An image file name
$authorization = "{{Authorization}}"; // string | Authorization
$file = "B"; // string | File to upload

try {
    $result = $apiInstance->updateImageField($id, $field_name, $file_name, $authorization, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->updateImageField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
field_name	string	An image field name
file_name	string	An image file name
authorization	string	Authorization	[default to {{Authorization}}]
file	string	File to upload

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/octet-stream
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateTags

\SternerStuff\InsightlyPHP\Model\APITag[] updateTags($id, $authorization, $api_tag)

Updates a Knowledge Article's Tags

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_tag = new \SternerStuff\InsightlyPHP\Model\APITag(); // \SternerStuff\InsightlyPHP\Model\APITag | The Record's Tags

try {
    $result = $apiInstance->updateTags($id, $authorization, $api_tag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->updateTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	The record's ID
authorization	string	Authorization	[default to {{Authorization}}]
api_tag	\SternerStuff\InsightlyPHP\Model\APITag	The Record's Tags

Return type

\SternerStuff\InsightlyPHP\Model\APITag[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateTranslation

object[] updateTranslation($language, $id, $authorization, $field_values)

Updates a Knowledge Article's translation in a specific language

If you have trouble updating a Knowledge Article, try accessing the Knowledge Article via the GET request to inspect its fields and sub-elements. A common source of problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a CATEGORY_ID or LINK_ID which does not exist.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\KnowledgeArticlesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$language = "language_example"; // string | The language of the record's translation to update
$id = "id_example"; // string | 
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \SternerStuff\InsightlyPHP\Model\\SternerStuff\InsightlyPHP\Model\FieldValues(); // \SternerStuff\InsightlyPHP\Model\FieldValues | The record to update (just include the JSON object as the request body)

try {
    $result = $apiInstance->updateTranslation($language, $id, $authorization, $field_values);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KnowledgeArticlesApi->updateTranslation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
language	string	The language of the record's translation to update
id	string
authorization	string	Authorization	[default to {{Authorization}}]
field_values	\SternerStuff\InsightlyPHP\Model\FieldValues	The record to update (just include the JSON object as the request body)

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

KnowledgeArticlesApi.md

Latest commit

History

KnowledgeArticlesApi.md

File metadata and controls

SternerStuff\InsightlyPHP\KnowledgeArticlesApi

addEntity

Example

Parameters

Return type

Authorization

HTTP request headers

addFollow

Example

Parameters

Return type

Authorization

HTTP request headers

addTag

Example

Parameters

Return type

Authorization

HTTP request headers

addTranslation

Example

Parameters

Return type

Authorization

HTTP request headers

deleteEntity

Example

Parameters

Return type

Authorization

HTTP request headers

deleteFollow

Example

Parameters

Return type

Authorization

HTTP request headers

deleteImageField

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTag

Example

Parameters

Return type

Authorization

HTTP request headers

getEntities

Example

Parameters

Return type

Authorization

HTTP request headers

getEntitiesBySearch

Example

Parameters

Return type

Authorization

HTTP request headers

getEntitiesByTag

Example

Parameters

Return type

Authorization

HTTP request headers

getEntity

Example

Parameters

Return type

Authorization

HTTP request headers

getFollow