summaryrefslogtreecommitdiff
path: root/doc/es_ES/api-action-procedures.markdown
blob: dc39fb93da09ebc0fb642f135f7899d542ea0e32 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
API Procedimiento de acciones automaticas
================================

## getAvailableActions [Obtener acciones disponibles]

- Propósito: **Obtener una lista de acciones automaticas disponibles**
- Parametros: ninguno
- Resultado satisfactorio: **list of actions**
- Resultado fallido: **falso**

Ejemplo de solicitud:

```json
{
    "jsonrpc": "2.0",
    "method": "getAvailableActions",
    "id": 1217735483
}
```

Ejemplo de respuesta:

```json
{
    "jsonrpc": "2.0",
    "id": 1217735483,
    "result": {
        "\Kanboard\Action\TaskLogMoveAnotherColumn": "Agregar un comentario moviendo las tareas entre columnas",
        "\Kanboard\Action\TaskAssignColorUser": "Asignar un color especifico aun usuario",
        "\Kanboard\Action\TaskAssignColorColumn": "Asignar un color cuando la tarea es movida a una columna especifica",
        "\Kanboard\Action\TaskAssignCategoryColor": "Asignar automaticamente una categoria basado en un color",
        "\Kanboard\Action\TaskAssignColorCategory": "Asignar automaticamente un color basado en una categoria",
        "\Kanboard\Action\TaskAssignSpecificUser": "Asigar tareas a un usuario especifico",
        "\Kanboard\Action\TaskAssignCurrentUser": "Asignar tareas a la persona que hace la acción",
        "\Kanboard\Action\TaskUpdateStartDate": "Automaticamente actualizar la fecha de inicio",
        "\Kanboard\Action\TaskAssignUser": "Cambiar asigando basado en un nombre de usuario [username] externo",
        "\Kanboard\Action\TaskAssignCategoryLabel": "Cambiar la categoria basado en un etiqueta externa",
        "\Kanboard\Action\TaskClose": "Cerrar una tarea",
        "\Kanboard\Action\CommentCreation": "Crear un comentario desde un proveedor externo",
        "\Kanboard\Action\TaskCreation": "Crear una tarea desde un proveedor externo",
        "\Kanboard\Action\TaskDuplicateAnotherProject": "Duplicar la tarea a otro proyecto",
        "\Kanboard\Action\TaskMoveColumnAssigned": "Mover la tarea a otra columna cuando es asiganada a un usuario",
        "\Kanboard\Action\TaskMoveColumnUnAssigned": "Mover la tarea a otra columna cuando la asignación es limpiada",
        "\Kanboard\Action\TaskMoveAnotherProject": "Mover la tarea a otro proyecto",
        "\Kanboard\Action\TaskOpen": "Abrir una Tarea"
    }
}
```

## getAvailableActionEvents [obtener acciones de eventos disponibles]

- Propósito: **Obtener una lista de acciones disponibles para los eventos**
- Parametros: ninguno
- Resultado satisfactorio: **lista de eventos**
- Resultado fallído : **falso**

Ejemplo de petición:

```json
{
    "jsonrpc": "2.0",
    "method": "getAvailableActionEvents",
    "id": 2116665643
}
```

Ejemplo de respuesta:

```json
{
    "jsonrpc": "2.0",
    "id": 2116665643,
    "result": {
        "bitbucket.webhook.commit": "Bitbucket commit recibido",
        "task.close": "Cerrando tarea",
        "github.webhook.commit": "Github commit recibido",
        "github.webhook.issue.assignee": "Github issue asignación cambiada",
        "github.webhook.issue.closed": "Github issue cerrada",
        "github.webhook.issue.commented": "Github issue comentario creado",
        "github.webhook.issue.label": "Github issue etiqueta cambiada",
        "github.webhook.issue.opened": "Github issue abierta",
        "github.webhook.issue.reopened": "Github issue reabierto",
        "gitlab.webhook.commit": "Gitlab commit recibido",
        "gitlab.webhook.issue.closed": "Gitlab issue cerrado",
        "gitlab.webhook.issue.opened": "Gitlab issue abierto",
        "task.move.column": "Mover una tarea a otra columna",
        "task.open": "Abrir una tarea abierta",
        "task.assignee_change": "Tarea cambio de asignación",
        "task.create": "Creación de tarea",
        "task.create_update": "Creación de tarea o modificación",
        "task.update": "Modificación de tarea"
    }
}
```

## getCompatibleActionEvents [Obtener acciones compatibles con eventos]

- Propósito: **Obtener una lista de eventos compatibles con una acción**
- Parametros:
    - **action_name** (string, required)
- Resultado satisfactorio: **lista de eventos**
- Resultado fallido: **falso**

Ejemplo de petición:

```json
{
    "jsonrpc": "2.0",
    "method": "getCompatibleActionEvents",
    "id": 899370297,
    "params": [
        "\Kanboard\Action\TaskClose"
    ]
}
```

Ejemplo de respuesta:

```json
{
    "jsonrpc": "2.0",
    "id": 899370297,
    "result": {
        "bitbucket.webhook.commit": "Bitbucket commit recibido",
        "github.webhook.commit": "Github commit recibido",
        "github.webhook.issue.closed": "Github issue cerrada",
        "gitlab.webhook.commit": "Gitlab commit recibido",
        "gitlab.webhook.issue.closed": "Gitlab issue cerrado",
        "task.move.column": "Mover una tarea a otra columna"
    }
}
```

## getActions [Obtener acciones]

- Propósito: **Obtener una lista de acciones para un proyecto**
- Parametros:
    - **project_id** (integer, required)
- Resultado satisfactorio: **lista de propiedades de las acciones**
- Resultado fallido: **falso**

Ejemplo de petición:

```json
{
    "jsonrpc": "2.0",
    "method": "getActions",
    "id": 1433237746,
    "params": [
        "1"
    ]
}
```

Ejemplo de respuesta:

```json
{
    "jsonrpc": "2.0",
    "id": 1433237746,
    "result": [
        {
            "id" : "13",
            "project_id" : "2",
            "event_name" : "task.move.column",
            "action_name" : "\Kanboard\Action\TaskAssignSpecificUser",
            "params" : {
                "column_id" : "5",
                "user_id" : "1"
            }
        }
    ]
}
```

## createAction [Creación de acciones]

- Proposito: **Crear una acción**
- Parametros:
    - **project_id** (integer, required)
    - **event_name** (string, required)
    - **action_name** (string, required)
    - **params** (key/value parameters, required)
- Resultados satisfactorios: **action_id**
- Resultados fallidos: **falso**

Ejemplo de petición:

```json
{
    "jsonrpc": "2.0",
    "method": "createAction",
    "id": 1433237746,
    "params": {
        "project_id" : "2",
        "event_name" : "task.move.column",
        "action_name" : "\Kanboard\Action\TaskAssignSpecificUser",
        "params" : {
            "column_id" : "3",
            "user_id" : "2"
        }
    }
}
```

Ejemplo de respuestas:

```json
{
    "jsonrpc": "2.0",
    "id": 1433237746,
    "result": 14
}
```

## removeAction [Eliminar una acción]

- Proposito: **Eliminar una acción**
- Parametros:
    - **action_id** (integer, required)
- Resultados satisfactorios: **true**
- Resultados fallidos: **false**

Ejemplo de petición:

```json
{
    "jsonrpc": "2.0",
    "method": "removeAction",
    "id": 1510741671,
    "params": [
        1
    ]
}
```

Ejemplo de respuesta:

```json
{
    "jsonrpc": "2.0",
    "id": 1510741671,
    "result": true
}
```