Está en la página 1de 34

Taiga api web services

Autenticacion:

Para autenticar las solicitudes se debe agregar un encabezado http llamado "Autorización".
Su formato debe ser:

Instale jq (un procesador JSON de línea de comandos):

Si no puede instalar jq, es posible (pero no recomendado) usar grep y cut para extraer el valor
de auth_token del objeto de detalle de autenticación de usuario JSON; use la siguiente línea
en su lugar:

Este tipo de tokens están diseñados para permitir que las aplicaciones externas utilicen la API
de Taiga, están asociadas a un usuario existente y una aplicación. Se pueden crear
manualmente a través de Django ADMIN o crear mediante programación a través de API.

Funcionan de la misma manera que los tokens de autenticación estándar de Taiga, pero el
encabezado "Autorización" cambia ligeramente. Su formato debe ser:
Listas (list)
Para enumerar proyectos, envíe una solicitud GET con los siguientes parámetros aquí un
ejemplo:

La respuesta HTTP es 200 OK y el cuerpo de respuesta es una lista JSON de objetos de


entrada de lista de proyectos

Los resultados se pueden filtrar utilizando los siguientes parámetros:

 Member: Identificación de miembro

 Members: Identificación de miembros

 is_looking_for_people: el proyecto busca nuevos miembros

 is_featured: el proyecto ha sido destacado por el personal de la instancia

 is_backlog_activated: la cartera de pedidos está activa

 is_kanban_activated: Kanban está activo


Los resultados se pueden ordenar utilizando el parámetro order_by con los valores:

 memberships__user_order: el orden del proyecto especificado por el usuario.

 total_fans: admiradores totales para el proyecto

 total_fans_last_week: cantidad de nuevos fanáticos en la última semana.

 total_fans_last_month: cantidad de nuevos fanáticos en el último mes

 total_fans_last_year: cantidad de nuevos fanáticos en el último año

 total_activity: Número de entradas de historial para el proyecto

 total_activity_last_week: cantidad de entradas del historial generadas en la última


semana

 total_activity_last_month: cantidad de entradas del historial generadas en el último


mes

 total_activity_last_year: cantidad de entradas del historial generadas en el último


año
Crear (create)
 name (requerido)

 description (requerido)

 creation_template: plantilla base para el proyecto

 is_backlog_activated

 is_issues_activated

 is_kanban_activated

 is_private

 is_wiki_activated

 videoconferences: aparecer o hablar, el tercero utilizado para reuniones si está habilitado

 videoconferences_extra_data: cadena utilizada para la generación de URL de chat de


videoconferencia
 total_milestones

 total_story_points
Obtener (get)
Para obtener un proyecto, envíe una solicitud GET especificando la identificación del
proyecto en la url

La respuesta HTTP es 200 OK y el cuerpo de respuesta es un objeto de detalle de proyecto


JSON
Llegar por babosa (Get by slug)

Para obtener un proyecto, envíe una solicitud GET especificando la ficha del proyecto como
parámetro:

La respuesta HTTP es 200 OK y el cuerpo de respuesta es un objeto de detalle de proyecto


JSON
Editar(edit)

Para editar proyectos, envíe un PUT o un PATCH especificando la identificación del


proyecto en la url. En una solicitud PATCH solo necesita enviar los datos modificados, en
un PUT se debe enviar todo el objeto.

Cuando la edición es exitosa, la respuesta HTTP es 200 OK y el cuerpo de respuesta es un


objeto de detalle de proyecto JSON
Eliminar(delete)

Para eliminar proyectos, envíe un DELETE especificando la identificación del proyecto en


la url

Cuando la eliminación se realizó correctamente, la respuesta HTTP es 204 SIN contenido


con una respuesta de cuerpo vacío
Orden de actualización masiva
(Bulk update order)

Para actualizar el orden de los proyectos para el usuario conectado, envíe una solicitud POST
con una lista json donde cada elemento es un objeto json con dos atributos, la identificación
del proyecto y el nuevo orden

Cuando la actualización es exitosa, la respuesta HTTP es 200 OK y el cuerpo de la


respuesta está vacío
Obtener configuración de módulos
(Get modules configuration)

Para obtener una configuración de módulos de proyecto, envíe una solicitud GET
especificando la identificación del proyecto en la url

La respuesta HTTP es 200 OK y el cuerpo de respuesta es un objeto de configuración de


módulos de proyecto JSON
Editar configuración de módulos
(Edit modules configuration)

Para editar la configuración de los módulos de un proyecto, envíe un PATCH especificando


la identificación del proyecto en la url.

Cuando la edición se realizó correctamente, la respuesta HTTP es 204 SIN CONTENIDO


con una respuesta de cuerpo vacío
Estadísticas
(Stats)

Para obtener las estadísticas de un proyecto, envíe una solicitud GET especificando la
identificación del proyecto en la URL

La respuesta HTTP es 200 OK y el cuerpo de respuesta es un objeto de estadísticas de


proyecto JSON
Emitir estadísticas
Issue Stats

Para obtener las estadísticas de un problema del proyecto, envíe una solicitud GET
especificando la identificación del proyecto en la url

La respuesta HTTP es 200 OK y el cuerpo de respuesta es un objeto de estadísticas de


problema de proyecto JSON
Colores de la etiqueta
(Tag colors)

Para obtener las estadísticas de colores de la etiqueta de un proyecto, envíe una solicitud
GET especificando la identificación del proyecto en la URL

La respuesta HTTP es 200 OK y el cuerpo de respuesta es un objeto de colores de etiqueta


de proyecto JSON
Crear etiqueta
(Create tag)

Para crear etiquetas, envíe una solicitud POST que especifique la identificación del proyecto
en la url con los siguientes datos:
 tag (requerido)
 color: HEX color

Cuando la creación es exitosa, la respuesta HTTP es 200 OK con una respuesta de cuerpo
vacío
Editar etiqueta
(Edit tag)

Para editar una etiqueta, envíe una POST especificando la identificación del proyecto en la
url.

Cuando la edición es exitosa, la respuesta HTTP es 200 OK con una respuesta de cuerpo
vacío
Eliminar etiqueta
(Delete-tag)

Para eliminar una etiqueta, envíe una POST especificando la identificación del proyecto en
la url.

Cuando la edición es exitosa, la respuesta HTTP es 200 OK con una respuesta de cuerpo
vacío
Mezclar etiquetas
(Mix tags)

Para mezclar etiquetas, envíe una POST especificando la identificación del proyecto en la url

Cuando la edición es exitosa, la respuesta HTTP es 200 OK con una respuesta de cuerpo
vacío
Como un proyecto
(Like a Project)

Para dar me gusta a un proyecto, envíe una solicitud POST especificando la identificación
del proyecto en la url

La respuesta HTTP es 200 OK con una respuesta de cuerpo vacío.


Diferenciar un proyecto
(Unlike a Project)

A diferencia de un proyecto, envíe una solicitud POST que especifique el ID del proyecto en
la url

La respuesta HTTP es 200 OK con una respuesta de cuerpo vacío


Lista de fans del proyecto

(List Project fans)

Para obtener la lista de fans de un proyecto, envíe una solicitud GET especificando la
identificación del proyecto en la url

La respuesta HTTP es 200 OK y el cuerpo de respuesta es una lista JSON del objeto votante
del proyecto
Mira un proyecto
(Watch a Project)

Para ver un proyecto, envíe una solicitud POST que especifique la identificación del proyecto
en la url

La respuesta HTTP es 200 OK con una respuesta de cuerpo vacío.


Deja de mirar proyecto
(Stop watching Project)

Para dejar de ver un proyecto, envíe una solicitud POST especificando la identificación del
proyecto en la url

La respuesta HTTP es 200 OK con una respuesta de cuerpo vacío.


Lista de observadores de proyectos
(List Project watchers)

Para obtener la lista de observadores de un proyecto, envíe una solicitud GET especificando
la identificación del proyecto en la URL

La respuesta HTTP es 200 OK y el cuerpo de la respuesta es una lista JSON del objeto
observador del proyecto
Crear plantilla
(Create témplate)

Para crear una plantilla a partir de un proyecto seleccionado, envíe una solicitud POST
especificando la identificación del proyecto en la url con los siguientes parámetros

 name (requerido)
 description (requerido)

Cuando la creación es exitosa, la respuesta HTTP es 201 Creado y el cuerpo de respuesta es


un objeto de detalle de plantilla de proyecto JSON
Salir
(Leave)

Para dejar un proyecto, envíe una solicitud POST que especifique la identificación del
proyecto en la url

La respuesta HTTP es 200 OK con una respuesta de cuerpo vacío.


Cambiar logo
(Change logo)

Para cambiar el logotipo de su proyecto, envíe una solicitud POST con los siguientes datos

Cuando el cambio es exitoso, la respuesta HTTP es 200 OK y el cuerpo de respuesta es un


objeto de detalle de proyecto JSON
Remover logo
(Remove logo)

Para eliminar el logotipo de su proyecto, envíe una POST con los siguientes datos

Cuando el cambio es exitoso, la respuesta HTTP es 200 OK y el cuerpo de respuesta es un


objeto de detalle de proyecto JSON
Transferir token de validación
(Transfer valídate-token)

Para verificar si un token de transferencia para un proyecto es válido para su usuario, envíe
una solicitud POST que especifique la identificación del proyecto en la URL y que contenga
los siguientes datos.

 token: ficha de transferencia válida recibida por correo electrónico.

La respuesta HTTP es 200 OK con una respuesta de cuerpo vacío.


Solicitud de transferencia
(Transfer request)

Para solicitar al propietario la transferencia de un proyecto, envíe una solicitud POST


especificando la identificación del proyecto en la url

La respuesta HTTP es 200 OK con una respuesta de cuerpo vacío.


Inicio de transferencia
(Transfer start)

Para comenzar la transferencia de uno de sus proyectos a otro usuario, envíe una solicitud
POST que especifique la identificación del proyecto en la URL y que contenga los siguientes
datos:

 user: ID de usuario de otro miembro administrador del proyecto

La respuesta HTTP es 200 OK con una respuesta de cuerpo vacío.


Aceptar transferencia
(Transfer accept)

Para aceptar la transferencia de un proyecto a su usuario, envíe una solicitud POST que
especifique la identificación del proyecto en la URL y que contenga los siguientes datos:

 token: ficha de transferencia válida recibida por correo electrónico.


 reason: texto incluido en la respuesta por correo electrónico al propietario del
proyecto .

La respuesta HTTP es 200 OK con una respuesta de cuerpo vacío


Transferencia rechazada
(Transfer reject)

Para rechazar la transferencia de un proyecto a su usuario, envíe una solicitud POST que
especifique la identificación del proyecto en la URL y que contenga los siguientes datos:

 token: ficha de transferencia válida recibida por correo electrónico

 reason: texto incluido en la respuesta por correo electrónico al propietario del proyecto

La respuesta HTTP es 200 OK con una respuesta de cuerpo vacío.


Duplicar
(Duplícate)

Para duplicar un proyecto (cree uno nuevo con el mismo estado, colores, atributos ...) envíe
una solicitud POST especificando la identificación del proyecto en la url

Cuando la creación es exitosa, la respuesta HTTP es 201 Creado y el cuerpo de respuesta es


un objeto de detalle de proyecto JSON

También podría gustarte