Table with field descriptions
| Field | Type | Required? | Description |
|---|---|---|---|
id| int |
No | Unique identifier of the custom entity element (required when updating). | |
slug| string |
Yes | Unique element slug. | |
active| boolean |
No | Enabled/disabled element. The default value is True. |
|
group_code_id| string |
Yes | A unique identifier for the entity on your system. (Can be used for contact instead of ID) | |
order| int |
No | The ordinal value of the element. | |
custom_instance| int |
Yes | ID of the custom entity to which the element belongs (for example, "Author"). | |
name_ro| string |
Yes | The name of the element is in Romanian. | |
name_ru| string |
Yes | Element name in Russian. | |
name_en| string |
Yes | Element name in English. | |
name_uk| string |
Yes | The name of the element is in Ukrainian. | |
description_ro| string |
No | Description of the item in Romanian. | |
description_ru| string |
No | Description of the element in Russian. | |
description_en| string |
No | Description of the item in English. | |
description_uk| string |
No | Description of the element in Ukrainian. | |
seo_title_ro| string |
No | SEO title in Romanian. | |
seo_title_ru| string |
No | SEO title in Russian. | |
seo_title_en| string |
No | SEO title in English. | |
seo_title_uk| string |
No | SEO title in Ukrainian. | |
seo_keywords_ro| string |
No | SEO keywords in Romanian. | |
seo_keywords_ru| string |
No | SEO keywords in Russian. | |
seo_keywords_en| string |
No | SEO keywords in English. | |
seo_keywords_uk| string |
No | SEO keywords in Ukrainian. | |
seo_description_ro| string |
No | SEO description in Romanian. | |
seo_description_ru| string |
No | SEO description in Russian. | |
seo_description_en| string |
No | SEO description in English. | |
seo_description_uk| string |
No | SEO description in Ukrainian. |
Endpoints
1. Getting all elements of custom entities
Description : Returns a list of all elements of the site's custom entities.
Endpoint :
[GET] /external/custom-instance-item/
Answer : An array of custom entity element objects:
[ { "id": 1, "slug": "author3556", "active": true, "groupcodeid": "12455", "order": 5, "custominstance": 1, "namero": "Authornamero3", "nameru": "Authornamero3", "nameen": "Authornamero3", "nameuk": "Authornamero3", "descriptionro": "Authordescriptionro3", "descriptionru": "Authordescriptionro3", "descriptionen": "Authordescriptionro3", "descriptionuk": "Authordescriptionro3", "seotitlero": "seotitle3", "seotitleru": "seotitle3", "seotitleen": "seotitle3", "seotitleuk": "seotitle3", "seokeywordsro": "seokeywords3", "seokeywordsru": "seokeywords3", "seokeywordsen": "seokeywords3", "seokeywordsuk": "seokeywords3", "seodescriptionro": "seodescription3", "seodescriptionru": "seodescription3", "seodescriptionen": "seodescription3", "seodescriptionuk": "seo_description3" } ]
2. Getting one element of a custom entity
Description : Returns information about one element of a custom entity.
Endpoint :
[GET] /external/custom-instance-item/{id}/
URL Parameters :
id(int) : Unique identifier of the element.
Answer :
{ "id": 1, "slug": "author3556", "active": true, "groupcodeid": "12455", "order": 5, "custominstance": 1, "namero": "Authornamero3", "nameru": "Authornamero3", "nameen": "Authornamero3", "nameuk": "Authornamero3", "descriptionro": "Authordescriptionro3", "descriptionru": "Authordescriptionro3", "descriptionen": "Authordescriptionro3", "descriptionuk": "Authordescriptionro3", "seotitlero": "seotitle3", "seotitleru": "seotitle3", "seotitleen": "seotitle3", "seotitleuk": "seotitle3", "seokeywordsro": "seokeywords3", "seokeywordsru": "seokeywords3", "seokeywordsen": "seokeywords3", "seokeywordsuk": "seokeywords3", "seodescriptionro": "seodescription3", "seodescriptionru": "seodescription3", "seodescriptionen": "seodescription3", "seodescriptionuk": "seo_description3" }
3. Updating one element of a custom entity
Description : Allows you to update one element of a custom entity.
Endpoint :
[PUT] /external/custom-instance-item/{id}/
Example request :
{ "slug": "updatedslug", "nameru": "Updated author", "seokeywordsen": "keywords" }
Answer :
{ "id": 1, "slug": "updatedslug", "nameru": "Updated author", "seokeywordsen": "keywords" }
4. Mass update of custom entity elements
Description: Allows you to update multiple elements of custom entities.
Endpoint :
[PUT] /external/custom-instance-item/bulk-update/
Example request :
[ { "id": 1, "nameru": "Author updated 1" }, { "id": 2, "nameru": "Author updated 2" } ]
Answer :
[ { "id": 1, "nameru": "Author updated 1" }, { "id": 2, "nameru": "Author updated 2" } ]
5. Bulk creation of custom entity elements
Description: Allows you to create multiple custom entity elements in one request.
Endpoint :
[POST] /external/custom-instance-item/bulk-create/
Example request :
[ { "slug": "author1", "active": true, "groupcodeid": "code1", "custominstance": 1, "nameru": "Author 1", "seokeywordsru": "keywords1" }, { "slug": "author2", "active": false, "groupcodeid": "code2", "custominstance": 1, "nameru": "Author 2", "seokeywordsru": "key2" } ]
Answer :
[ { "id": 1, "slug": "author1", "active": true, "groupcodeid": "code1", "custominstance": 1, "nameru": "Author 1", "seokeywordsru": "keywords1" }, { "id": 2, "slug": "author2", "active": false, "groupcodeid": "code2", "custominstance": 1, "nameru": "Author 2", "seokeywordsru": "key2" } ]
If you have additional questions about using the API, please contact us!
Was the article helpful?
Yes, thank you! Unfortunately no