Table with field descriptions
| Field | Type | Required? | Description |
|---|---|---|---|
id| int |
No | Unique identifier of the custom entity (required when updating). | |
slug| string |
Yes | Unique slug (used to identify an entity). | |
active| boolean |
No | Enabled/disabled entity. 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 entity. | |
name_ro| string |
Yes | Entity name in Romanian. | |
name_ru| string |
Yes | The name of the entity in Russian. | |
name_en| string |
Yes | Entity name in English. | |
name_uk| string |
Yes | The name of the entity in Ukrainian. | |
plural_name_ro| string |
Yes | Plural name of an entity in Romanian. | |
plural_name_ru| string |
Yes | Plural name of an entity in Russian. | |
plural_name_en| string |
Yes | Plural name of an entity in English. | |
plural_name_uk| string |
Yes | Plural name of an entity 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 custom entities
Description : Returns a list of all custom entities on the site.
Endpoint :
[GET] /external/custom-instance/
Answer : An array of custom entity objects:
[ { "id": 1, "slug": "author22", "active": true, "groupcodeid": "code25", "order": 4, "namero": "Authorro2", "nameru": "Authorru2", "nameen": "Authoren2", "nameuk": "Author2", "pluralnamero": "Authorsro2", "pluralnameru": "Authorsru2", "pluralnameen": "Authorsen2", "pluralnameuk": "Authors", "seotitlero": "int", "seotitleru": "int", "seotitleen": "int", "seotitleuk": "int", "seokeywordsro": "int", "seokeywordsru": "int", "seokeywordsen": "int", "seokeywordsuk": "int", "seodescriptionro": "int", "seodescriptionru": "int", "seodescriptionen": "int", "seodescriptionuk": "int" } ]
2. Getting one custom entity
Description : Returns information about a specific custom entity.
Endpoint :
[GET] /external/custom-instance/{id}/
URL Parameters :
id(int) : Unique identifier of the entity.
Answer :
{ "id": 1, "slug": "author22", "active": true, "groupcodeid": "code25", "order": 4, "namero": "Authorro2", "nameru": "Authorru2", "nameen": "Authoren2", "nameuk": "Author2", "pluralnamero": "Authorsro2", "pluralnameru": "Authorsru2", "pluralnameen": "Authorsen2", "pluralnameuk": "Authors", "seotitlero": "int", "seotitleru": "int", "seotitleen": "int", "seotitleuk": "int", "seokeywordsro": "int", "seokeywordsru": "int", "seokeywordsen": "int", "seokeywordsuk": "int", "seodescriptionro": "int", "seodescriptionru": "int", "seodescriptionen": "int", "seodescriptionuk": "int" }
3. Updating one custom entity
Description: Allows you to update one custom entity.
Endpoint :
[PUT] /external/custom-instance/{id}/
Request : { "slug": "updatedslug", "active": true, "nameru": "Updated author", "seokeywordsen": "keywords" }
Answer :
{ "id": 1, "slug": "updatedslug", "active": true, "nameru": "Updated author", "seokeywordsen": "keywords" }
4. Mass update of custom entities
Description: Allows you to update several custom entities.
Endpoint :
[PUT] /external/custom-instance/bulk-update/
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 entities
Description: Allows you to create several custom entities in one request.
Endpoint :
[POST] /external/custom-instance/bulk-create/
Request :
[ { "slug": "author1", "active": true, "groupcodeid": "code1", "nameru": "Author 1", "seokeywordsru": "keywords1" }, { "slug": "author2", "active": false, "groupcodeid": "code2", "nameru": "Author 2", "seokeywordsru": "key2" } ]
Answer :
[ { "id": 1, "slug": "author1", "active": true, "groupcodeid": "code1", "nameru": "Author 1", "seokeywordsru": "keywords1" }, { "id": 2, "slug": "author2", "active": false, "groupcodeid": "code2", "nameru": "Author 2", "seokeywordsru": "key2" } ]
Was the article helpful?
Yes, thank you! Unfortunately no