Lista de promociones para un espacio de trabajo

OBTENER /api/v1/projects/{id}/workspaces/{workspace_id}/promotions
Autorización del portador

Historial de promociones de devoluciones dirigidas a este espacio de trabajo, de la más reciente a la más antigua.

Parámetros de path

  • ID string Requerido

    ID del proyecto objetivo

  • ID del espacio de trabajo string Requerido

    ID del espacio de trabajo de destino

Parámetros de query

  • limit entero

    Tamaño de página (1-100, predeterminado 20)

    El valor mínimo es 1, el valor máximo es 100. El valor por defecto es 20.

  • desplazamiento entero

    Desplazamiento de página (0-10000, por defecto 0)

    El valor mínimo es 0, el valor máximo es 10000. El valor por defecto es 0.

Respuestas

  • 406

    Versión de API no compatible o con formato incorrecto, operación no disponible en el contrato publicado seleccionado o representación inaceptable (incluidos parámetros de tipo de medio no compatibles o SSE excluidos). Los fallos de autenticación, autorización y límite de velocidad existentes tienen prioridad.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.
  • 200

    OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • promociones arreglo[objeto]
      Ocultar atributos de promociones Mostrar atributos de las promociones Objeto
      • created_at string
      • motivo de fallo string
      • terminado_en string
      • fuerza booleano
      • iniciado_por string
      • org_id string
      • ID de promoción string
      • source_build_id string
      • Estado string

        El estado puede ser pendiente, copiando, listo o fallido. Listo y fallido son resultados finales; pendiente y copiando son estados de sondeo observables no finales.

        Los valores son pending, copying, ready o failed.

      • ID de compilación objetivo string
      • ID del proyecto objetivo string
      • ID del espacio de trabajo de destino string
    • Total entero
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • promociones arreglo[objeto]
      Ocultar atributos de promociones Mostrar atributos de las promociones Objeto
      • created_at string
      • motivo de fallo string
      • terminado_en string
      • fuerza booleano
      • iniciado_por string
      • org_id string
      • ID de promoción string
      • source_build_id string
      • Estado string

        El estado puede ser pendiente, copiando, listo o fallido. Listo y fallido son resultados finales; pendiente y copiando son estados de sondeo observables no finales.

        Los valores son pending, copying, ready o failed.

      • ID de compilación objetivo string
      • ID del proyecto objetivo string
      • ID del espacio de trabajo de destino string
    • Total entero
  • 400

    Solicitud incorrecta

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 403

    Forbidden

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 404

    No encontrado

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 429

    Demasiadas peticiones

    Atributo de ocultar encabezados Mostrar atributo de encabezados
    • Después de reintento string

      Segundos de espera antes de volver a intentarlo

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 500

    Error interno del servidor

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 502

    Puerta de enlace incorrecta

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 503

    Servicio no disponible

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
GET /api/v1/projects/{id}/workspaces/{workspace_id}/promotions 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces/{workspace_id}/promotions' \
 --header "Authorization: $API_KEY"
Ejemplos de respuesta (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Ejemplos de respuesta (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Ejemplos de respuesta (200) 
{
  "promotions": [
    {
      "created_at": "string",
      "failure_reason": "string",
      "finished_at": "string",
      "force": true,
      "initiated_by": "string",
      "org_id": "string",
      "promotion_id": "string",
      "source_build_id": "string",
      "status": "pending",
      "target_build_id": "string",
      "target_project_id": "string",
      "target_workspace_id": "string"
    }
  ],
  "total": 42
}
Ejemplos de respuesta (200) 
{
  "promotions": [
    {
      "created_at": "string",
      "failure_reason": "string",
      "finished_at": "string",
      "force": true,
      "initiated_by": "string",
      "org_id": "string",
      "promotion_id": "string",
      "source_build_id": "string",
      "status": "pending",
      "target_build_id": "string",
      "target_project_id": "string",
      "target_workspace_id": "string"
    }
  ],
  "total": 42
}
Ejemplos de respuesta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (429) 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (429) 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}