APIs generales

Sytex API documentation

Endpoints

GET /api/chat/v2/participants/

OperationId: listParticipantsViewSets
List participants for a given chat (by chat_id).
Responses
HTTP Code
Description
Schema
200
array


GET /api/chat/v2/objects/details/

OperationId: detailsObjectSearch
Get minimal details for an object by type and id plus extra locations.
Responses
HTTP Code
Description
Schema
200
#/components/schemas/ObjectSearch


GET /api/statushistory/

OperationId: listStatusHistories
Parameters
Name
In
Type
Required
Description
limit
query
integer
no
Número de resultados a devolver por página.
offset
query
integer
no
El índice inicial a partir del cual devolver los resultados.
q
query
string
no
Un término de búsqueda.
ordering
query
string
no
Qué campo usar para ordenar los resultados.
Responses
HTTP Code
Description
Schema
200
object


GET /api/automationlogs/

OperationId: listAutomationExecutionLogs
Parameters
Name
In
Type
Required
Description
limit
query
integer
no
Número de resultados a devolver por página.
offset
query
integer
no
El índice inicial a partir del cual devolver los resultados.
q
query
string
no
Un término de búsqueda.
ordering
query
string
no
Qué campo usar para ordenar los resultados.
Responses
HTTP Code
Description
Schema
200
object


POST /api/automationlogs/

OperationId: createAutomationExecutionLog
Request body
  • application/json
  • Schema: #/components/schemas/AutomationExecutionLog
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/AutomationExecutionLog
  • multipart/form-data
  • Schema: #/components/schemas/AutomationExecutionLog
  • application/yaml
  • Schema: #/components/schemas/AutomationExecutionLog
Responses
HTTP Code
Description
Schema
201
#/components/schemas/AutomationExecutionLog


GET /api/automationlogs/{id}/

OperationId: retrieveAutomationExecutionLog
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Un valor de entero único que identifique este automation execution log.
q
query
string
no
Un término de búsqueda.
ordering
query
string
no
Qué campo usar para ordenar los resultados.
Responses
HTTP Code
Description
Schema
200
#/components/schemas/AutomationExecutionLog


PUT /api/automationlogs/{id}/

OperationId: updateAutomationExecutionLog
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Un valor de entero único que identifique este automation execution log.
q
query
string
no
Un término de búsqueda.
ordering
query
string
no
Qué campo usar para ordenar los resultados.
Request body
  • application/json
  • Schema: #/components/schemas/AutomationExecutionLog
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/AutomationExecutionLog
  • multipart/form-data
  • Schema: #/components/schemas/AutomationExecutionLog
  • application/yaml
  • Schema: #/components/schemas/AutomationExecutionLog
Responses
HTTP Code
Description
Schema
200
#/components/schemas/AutomationExecutionLog


PATCH /api/automationlogs/{id}/

OperationId: partialUpdateAutomationExecutionLog
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Un valor de entero único que identifique este automation execution log.
q
query
string
no
Un término de búsqueda.
ordering
query
string
no
Qué campo usar para ordenar los resultados.
Request body
  • application/json
  • Schema: #/components/schemas/AutomationExecutionLog
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/AutomationExecutionLog
  • multipart/form-data
  • Schema: #/components/schemas/AutomationExecutionLog
  • application/yaml
  • Schema: #/components/schemas/AutomationExecutionLog
Responses
HTTP Code
Description
Schema
200
#/components/schemas/AutomationExecutionLog


GET /api/attributevalidcontenttypes/

OperationId: listAttributeValidContentTypesViewSets
ViewSet to serve the valid content types for attributes.
Responses
HTTP Code
Description
Schema
200
array


GET /api/feature-flags/

OperationId: listFeatureFlags
ViewSet for managing feature flags. Only accessible by Sytex admin users.
Parameters
Name
In
Type
Required
Description
limit
query
integer
no
Número de resultados a devolver por página.
offset
query
integer
no
El índice inicial a partir del cual devolver los resultados.
q
query
string
no
Un término de búsqueda.
ordering
query
string
no
Qué campo usar para ordenar los resultados.
Responses
HTTP Code
Description
Schema
200
object


POST /api/feature-flags/

OperationId: createFeatureFlag
ViewSet for managing feature flags. Only accessible by Sytex admin users.
Request body
  • application/json
  • Schema: #/components/schemas/FeatureFlag
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/FeatureFlag
  • multipart/form-data
  • Schema: #/components/schemas/FeatureFlag
  • application/yaml
  • Schema: #/components/schemas/FeatureFlag
Responses
HTTP Code
Description
Schema
201
#/components/schemas/FeatureFlag


GET /api/feature-flags/{id}/

OperationId: retrieveFeatureFlag
ViewSet for managing feature flags. Only accessible by Sytex admin users.
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Un valor de entero único que identifique este feature flag.
q
query
string
no
Un término de búsqueda.
ordering
query
string
no
Qué campo usar para ordenar los resultados.
Responses
HTTP Code
Description
Schema
200
#/components/schemas/FeatureFlag


PUT /api/feature-flags/{id}/

OperationId: updateFeatureFlag
ViewSet for managing feature flags. Only accessible by Sytex admin users.
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Un valor de entero único que identifique este feature flag.
q
query
string
no
Un término de búsqueda.
ordering
query
string
no
Qué campo usar para ordenar los resultados.
Request body
  • application/json
  • Schema: #/components/schemas/FeatureFlag
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/FeatureFlag
  • multipart/form-data
  • Schema: #/components/schemas/FeatureFlag
  • application/yaml
  • Schema: #/components/schemas/FeatureFlag
Responses
HTTP Code
Description
Schema
200
#/components/schemas/FeatureFlag


PATCH /api/feature-flags/{id}/

OperationId: partialUpdateFeatureFlag
ViewSet for managing feature flags. Only accessible by Sytex admin users.
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Un valor de entero único que identifique este feature flag.
q
query
string
no
Un término de búsqueda.
ordering
query
string
no
Qué campo usar para ordenar los resultados.
Request body
  • application/json
  • Schema: #/components/schemas/FeatureFlag
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/FeatureFlag
  • multipart/form-data
  • Schema: #/components/schemas/FeatureFlag
  • application/yaml
  • Schema: #/components/schemas/FeatureFlag
Responses
HTTP Code
Description
Schema
200
#/components/schemas/FeatureFlag


GET /api/template-library/templates/

OperationId: listlist_templates_from_libraries
List form templates from the library with optional filtering.
Supports query parameters:
  • name: Filter by template name (partial match)
  • category_id: Filter by category ID
  • language: Filter by language code (e.g., 'en', 'es')
  • limit: Maximum number of results (default: 100)
  • offset: Number of results to skip for pagination (default: 0)
Responses
HTTP Code
Description
Schema
200
array


GET /api/template-library/categories/

OperationId: listlist_categories
List categories from the library with optional filtering.
Supports query parameters:
  • name: Filter by category name (partial match)
Responses
HTTP Code
Description
Schema
200
array


GET /api/automationaction/

OperationId: listActionViewSets
Responses
HTTP Code
Description
Schema
200
array


GET /api/automations/entity_type_output_fields/

OperationId: listEntityTypeOutputFieldsViewSets
Responses
HTTP Code
Description
Schema
200
array


GET /api/datawarehouses/

OperationId: listDataWarehouseViewSets
Responses
HTTP Code
Description
Schema
200
array



POST /api/chat/v2/participants/{id}/remove_participant/

OperationId: removeParticipantParticipantsViewSet
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Request body
  • application/json
  • application/x-www-form-urlencoded
  • multipart/form-data
  • application/yaml
Responses
HTTP Code
Description
Schema
201
``


POST /api/formtemplatereview/general/

OperationId: generalFormTemplateReview
Request body
  • application/json
  • Schema: #/components/schemas/FormTemplateReview
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/FormTemplateReview
  • multipart/form-data
  • Schema: #/components/schemas/FormTemplateReview
  • application/yaml
  • Schema: #/components/schemas/FormTemplateReview
Responses
HTTP Code
Description
Schema
201
#/components/schemas/FormTemplateReview


POST /api/automationlogs/{id}/retry/

OperationId: retryAutomationExecutionLog
Retry a failed automation execution
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Un valor de entero único que identifique este automation execution log.
Request body
  • application/json
  • Schema: #/components/schemas/AutomationExecutionLog
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/AutomationExecutionLog
  • multipart/form-data
  • Schema: #/components/schemas/AutomationExecutionLog
  • application/yaml
  • Schema: #/components/schemas/AutomationExecutionLog
Responses
HTTP Code
Description
Schema
201
#/components/schemas/AutomationExecutionLog


POST /api/dataaccesspassword/

OperationId: createDataAccessPassword
Request body
  • application/json
  • Schema: #/components/schemas/DataAccessPassword
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/DataAccessPassword
  • multipart/form-data
  • Schema: #/components/schemas/DataAccessPassword
  • application/yaml
  • Schema: #/components/schemas/DataAccessPassword
Responses
HTTP Code
Description
Schema
201
#/components/schemas/DataAccessPassword


POST /api/wizard_trigger/{id}/trigger/

OperationId: triggerWizard
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Un valor de entero único que identifique este wizard.
Request body
  • application/json
  • Schema: #/components/schemas/Wizard
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Wizard
  • multipart/form-data
  • Schema: #/components/schemas/Wizard
  • application/yaml
  • Schema: #/components/schemas/Wizard
Responses
HTTP Code
Description
Schema
201
#/components/schemas/Wizard


POST /api/wizard_trigger/{id}/trigger_import/

OperationId: triggerImportWizard
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Un valor de entero único que identifique este wizard.
Request body
  • application/json
  • Schema: #/components/schemas/Wizard
  • application/x-www-form-urlencoded
  • Schema: #/components/schemas/Wizard
  • multipart/form-data
  • Schema: #/components/schemas/Wizard
  • application/yaml
  • Schema: #/components/schemas/Wizard
Responses
HTTP Code
Description
Schema
201
#/components/schemas/Wizard


POST /api/feature-flags/check/

OperationId: createCheckFeatureFlag
Check if a feature flag is enabled for the authenticated user.
Expected request body: { "flag_name": "feature_flag_name" }
Request body
  • application/json
  • application/x-www-form-urlencoded
  • multipart/form-data
  • application/yaml
Responses
HTTP Code
Description
Schema
201
``


POST /api/template-library/save-template/

OperationId: createsave_template_to_library
Save a FormTemplate to the templates library with new UUIDs.
Takes a FormTemplate, processes it to replace all UUIDs with new ones, and saves it to the external templates library database.
Request body
  • application/json
  • application/x-www-form-urlencoded
  • multipart/form-data
  • application/yaml
Responses
HTTP Code
Description
Schema
201
``


POST /api/template-library/create-from-library/

OperationId: createcreate_template_from_library
Create a new FormTemplate from a template stored in the library.
Takes a library template ID and creates a new FormTemplate instance with the current user as the creator.
Request body
  • application/json
  • application/x-www-form-urlencoded
  • multipart/form-data
  • application/yaml
Responses
HTTP Code
Description
Schema
201
``


POST /api/tower_material_quick_add/

OperationId: createTowerMaterialStockQuickAddApi
Request body
  • application/json
  • application/x-www-form-urlencoded
  • multipart/form-data
  • application/yaml
Responses
HTTP Code
Description
Schema
201
``


POST /api/material_stock_quick_add/

OperationId: createMaterialStockQuickAddApi
Request body
  • application/json
  • application/x-www-form-urlencoded
  • multipart/form-data
  • application/yaml
Responses
HTTP Code
Description
Schema
201
``


POST /api/validate_identity_provider/

OperationId: createValidateIdentityProvider
Validates identity provider name.
Expected request body: { "name": "provider_name" }
Request body
  • application/json
  • application/x-www-form-urlencoded
  • multipart/form-data
  • application/yaml
Responses
HTTP Code
Description
Schema
201
``