Explorar endpoint

Usa el Explorar punto de enlace para acceder programáticamente a tus datos de Violet.

Primeros pasos

Primero, necesitarás Generar una clave API.

A continuación, tu endpoint de API es:

• https://[YOUR-TENANT-NAME].violetlabs.com/api/ para clientes de Violet

• https://[YOUR-TENANT-NAME].violetgov.com/api/ para clientes de VioletGov

Por último, la carga útil (payload) de la API se describe en el Explorar endpoint a continuación, pero la forma más fácil de generar una consulta es en realidad a través del Explorador de Datos.

Generar una consulta

1. Dirígete a Explorador de datos para generar una consulta. Puedes usar Vistas Rápidas, una exploración guardada o filtros para configurar la consulta para los datos que te interesan.

1. A continuación, haz clic en el Copiar payload de la API botón en la barra de herramientas.

1. La carga útil de la API para la consulta se copiará en tu portapapeles: luego puedes pegarla directamente en una solicitud.

Pruébalo en Postman

Para probar en Postman:

1. Crea una nueva solicitud en Postman, selecciona el POST método, y completa tu URL (por ejemplo. https://magictoaster.violetlabs.com/api/explore/)

2. En la pestaña Autorización, selecciona Clave de API en el desplegable Tipo de autenticación. Ingresa x-api-key para la Clave, y coloca tu clave de API en el Valor.

1. En la pestaña Cuerpo, selecciona raw, luego pega la carga útil de la API que generaste arriba. Haz clic en Enviar.

1. Tus resultados deberían aparecer abajo.

1. Nos encanta usar el Visualizador de Postman para generar visualizaciones de tus datos:

¿Por qué POST?

El Explorar endpoint admite un conjunto amplio de opciones de filtrado de datos, por lo que Violet utiliza un POST endpoint para la consulta. Esto permite que consultas complejas se envíen en el cuerpo (payload) en lugar de directamente en la URL.

especificación de la API

post

Autorizaciones

bearer

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

keywordstringOpcional

Search keyword to filter entities

Example: part number

groupKeysarrayOpcional

Array of group keys (strings or objects)

sortobjectOpcional

Elasticsearch sort configuration

pagenumber · mín: 1Opcional

Page number (1-indexed)

Example: 1

limitnumber · mín: 1Opcional

Number of items per page

Example: 50

includeParametersbooleanOpcional

Whether to include parameters in the response

Default: false

includeSubEntitiesbooleanOpcional

Whether to include sub-entities in the response

Default: false

includeSchemasbooleanOpcional

Whether to include entity schemas in the response

Default: false

Respuestas

200

Search for entities

application/json

y

post

/api/explore

HTTPcURLJavaScriptPython

POST /api/explore HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "keyword": "part number",
  "rowGroupCols": [
    {
      "id": "text",
      "displayName": "text",
      "field": "text"
    }
  ],
  "groupKeys": [],
  "filterModel": {
    "ANY_ADDITIONAL_PROPERTY": {
      "filterType": "text",
      "type": "text",
      "operator": "AND",
      "filter": "text",
      "filterTo": "text",
      "dateFrom": "text",
      "dateTo": "text",
      "values": [
        "text"
      ],
      "conditions": []
    }
  },
  "sort": {},
  "page": 1,
  "limit": 50,
  "includeParameters": false,
  "includeSubEntities": false,
  "includeSchemas": false
}

200

Search for entities

{
  "items": [
    {
      "id": "text",
      "entityType": "text",
      "key": "text",
      "name": "text",
      "externalId": "text",
      "tenantId": "text",
      "createdAt": "2026-03-13T11:48:50.394Z",
      "updatedAt": "2026-03-13T11:48:50.394Z",
      "externalLastModifiedAt": "2026-03-13T11:48:50.394Z",
      "externalCreatedAt": "2026-03-13T11:48:50.394Z",
      "violetId": "text",
      "violetCoreEntity": "Account",
      "externalUrl": "text",
      "description": "text",
      "s3FileUrl": "text",
      "isReference": true,
      "isSubEntity": true,
      "isRevision": true,
      "isContainer": true,
      "isCustomEntity": true,
      "namedEntityProperties": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "namedEntityId": "123e4567-e89b-12d3-a456-426614174000",
          "violetEntityId": "123e4567-e89b-12d3-a456-426614174000",
          "propertyName": "text",
          "propertyIndex": 1,
          "namedEntity": "[Circular Reference]"
        }
      ],
      "application": {
        "id": "text",
        "name": "text",
        "imageUrl": "text"
      },
      "applicationId": "text",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "color": "text",
          "taggingsCount": 1,
          "taggedEntityIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "connectionIds": [
        "text"
      ],
      "programIds": [
        "text"
      ],
      "integrationIds": [
        "text"
      ],
      "integrationNames": [
        "text"
      ],
      "externalEntitySchemaIds": [
        "text"
      ],
      "internalEntitySchemaIds": [
        "text"
      ],
      "violetScriptId": "text",
      "parameterId": "text",
      "assignee": "text",
      "cost": 1,
      "dueDate": "text",
      "mass": 1,
      "part": "text",
      "status": "text",
      "import": true,
      "properties": {},
      "categories": {},
      "entityDesignations": [
        "ASSEMBLY"
      ],
      "partOrAssemblyDescriptor": "ASSEMBLY"
    }
  ],
  "meta": {
    "itemCount": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "totalPages": 1,
    "currentPage": 1
  },
  "links": {
    "first": "text",
    "previous": "text",
    "next": "text",
    "last": "text"
  }
}