Testes

Obter teste do projeto

Retorna um teste ou componente.

GET /api/public/v1/tests/{testId}

Obter teste do projeto

curl --request GET \
  --url 'https://api.buildprint.ai/api/public/v1/tests/{TESTID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "createdAt": 1,
  "name": "<string>",
  "description": "<string>",
  "isComponent": true,
  "viewportPreset": "desktop",
  "liveTestUserId": "<string>",
  "testVersionTestUserId": "<string>",
  "updatedAt": 1,
  "projectId": "<string>",
  "archivedAt": 1,
  "steps": [
    {
      "id": "<string>",
      "position": 1,
      "kind": "<string>",
      "instruction": "<string>",
      "onFailure": "stop"
    }
  ]
}

Teste encontrado

Authorizations

  • Authorization string obrigatório header

    Token da API REST do workspace prefixado com bp_

Path Parameters

  • testId string obrigatório

    ID do teste.

Response

application/json
  • id string

    Identificador opaco para este recurso.

  • createdAt number

    Timestamp Unix em milissegundos de quando o recurso foi criado.

  • name string

    Nome legível por humanos para o recurso.

  • description string | null

    Descrição legível por humanos para o recurso.

  • isComponent boolean

    Se a definição do teste é reutilizável como uma etapa de componente em outros testes.

  • viewportPreset string enum | null

    Predefinição de viewport que o Buildprint deve aplicar ao executar o teste.

  • liveTestUserId string | null

    Usuário de teste do projeto atribuído quando o teste é executado contra dados reais.

  • testVersionTestUserId string | null

    Usuário de teste do projeto atribuído quando o teste é executado contra dados de teste.

  • updatedAt number

    Timestamp Unix em milissegundos de quando o recurso foi atualizado pela última vez.

  • projectId string

    Identificador opaco para o projeto do workspace.

  • archivedAt number | null

    Timestamp Unix em milissegundos de quando o recurso foi arquivado, se arquivado.

  • steps[] oneOf array

    Etapas ordenadas para o teste ou componente.

    + Show Child Attributes
    • oneOf options 2 variants oneOf

      Exactly one option applies.

      + Show Child Attributes
      • option 1 object
        + Show Child Attributes
        • id string

          Identificador opaco para este recurso.

        • position number

          Posição baseada em zero do item dentro de sua coleção ordenada.

        • kind string

          Discriminador que descreve o tipo de objeto retornado.

        • instruction string

          Instrução para a etapa.

        • details string | null

          Detalhe extra opcional para a etapa.

        • onFailure string enum enum

          Se uma execução deve parar imediatamente ou continuar quando esta etapa falhar. Allowed values: stop, continue.

      • option 2 object
        + Show Child Attributes
        • id string

          Identificador opaco para este recurso.

        • position number

          Posição baseada em zero do item dentro de sua coleção ordenada.

        • kind string

          Discriminador que descreve o tipo de objeto retornado.

        • componentId string | null

          Identificador do componente de teste do projeto referenciado pela etapa.

        • onFailure string enum enum

          Se uma execução deve parar imediatamente ou continuar quando esta etapa falhar. Allowed values: stop, continue.