Actualizar la configuración de la acción

Documentos de API

Actualizar la configuración de la acción

Actualiza la configuración de acción de la aplicación. Para obtener más información sobre las acciones, consulte el siguiente artículo:
Configuración de acciones en la aplicación

Esta API actualiza la configuración previa a la puesta en marcha. Después de usar esta API, use la siguiente API para implementar la configuración en la aplicación activa:
Implementar la configuración de la aplicación

Método	PUT
URL	https://{subdomain}.kintone.com/k/v1/preview/app/actions.json
URL (espacio de invitado)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/actions.json
Autenticación	Autenticación de contraseña , Autenticación de token de API , Autenticación de sesión
Content-Type	application/json

Permisos

Se necesitan permisos de administración de aplicaciones de la aplicación de origen.
Se necesitan permisos para ver la aplicación de destino de copia.*

* Si el actions.{actionname}.destApp y actions.{actionname}.mappings se omiten los parámetros, no se requieren permisos para ver la aplicación de destino de copia.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción
app	Integer o String	Sí	El identificador de la aplicación.
actions	Objeto	Sí	Un listado de objetos `Action` Configuración. La clave del objeto es la `Action`identificador único de , que es igual al `Action`en la configuración predeterminada de idioma. Los valores de la clave son los diversos `Action` Configuraciones asociadas a eso `Action`.
actions.{actionname}	Object		Un listado de objetos `Action` Información de 1 `Action`. Si Nombre de acción es igual al nombre de un existente `Action`el `Action` se actualizará con los valores en el objeto. Si Nombre de acción no es igual a un nombre de un existente `Action`, un nuevo `Action` se creará con los valores del objeto. Cualquiera existente `Action` que no esté configurado para este parámetro será eliminado.
actions.{actionname}.name	Cuerda	Condicional	El nombre de la `Action`. Se pueden especificar de 1 a 32 caracteres. Al crear una nueva `Action`, la petición fallará si el valor de este parámetro no es el mismo que `actions.{actionname}`. Obligatorio al actualizar un existente `Action`, o creando una nueva `Action`.
actions.{actionname}.index	Entero o cadena	Condicional	El orden de la `Actions`. El `Action` se ordena en orden ascendente, empezando desde 0. Se producirá un error en la solicitud si hay valores duplicados. Obligatorio al actualizar un existente `Action`, o creando una nueva `Action`.
actions.{actionname}.destApp	Objeto	Condicional	Objeto que contiene la opción Target que especifica la aplicación de destino en la que se van a copiar los datos. Obligatorio al crear una nueva `Action`.
actions.{actionname}.destApp.app	Entero o cadena	Condicional	El identificador de aplicación de la aplicación de destino de la copia. Requerida si la `actions.{actionname}.destApp.code` no se especifica.
actions.{actionname}.destApp.code	Cuerda	Condicional	El código de aplicación de la aplicación de destino de copia. Requerida si la `actions.{actionname}.destApp.app` no se especifica. Si ambos `actions.{actionname}.destApp.app` y `actions.{actionname}.destApp.code` se especifican, el código tiene prioridad.
actions.{actionname}.mappings	Arreglo	Condicional	Una matriz de objetos que contiene las opciones Asignaciones de campos. Si el array está vacío, el `Action` No lo tendrá Mapas de campo Opciones establecidas. Obligatorio al especificar el `actions.{actionname}.destApp` o crear un nuevo `Action`.
actions.{actionname}.mappings[].srcType	Cuerda	Condicional	Tipo de datos de origen que se van a copiar. `FIELD`: Datos almacenados en el campo de la aplicación de origen `RECORD_URL`: El enlace permanente del registro Obligatorio al especificar el `actions.{actionname}.mappings` parámetro.
actions.{actionname}.mappings[].srcField	Cuerda	Condicional	El código de campo del campo especificado en las opciones Asignaciones de campos como origen. Requerida cuando el `actions.{actionname}.mappings[].srcType` se establece en `FIELD`.
actions.{actionname}.mappings[].destField	Cuerda	Condicional	El código de campo del campo especificado en las opciones Asignaciones de campos como destino. Obligatorio al especificar el `actions.{actionname}.mappings` parámetro.
actions.{actionname}.entities	Arreglo	Condicional	Una matriz de objetos que contiene las entidades `Action` se concede a. Esto refleja las opciones Disponible para. Si el array está vacío, el `Action` No estará disponible para ningún usuario, departamento o grupo. Obligatorio al crear una nueva `Action`.
actions.{actionname}.entities[].type	Cuerda	Condicional	El tipo de entidad el `Action` se concede a. `USER`: Usuario `GROUP`: Grupo `ORGANIZATION`: Departamento En el caso de las aplicaciones de un espacio de invitado, si se especifica un departamento, se producirá un error. Obligatorio al especificar el `actions.{actionname}.entities` parámetro.
actions.{actionname}.entities[].code	Cuerda	Condicional	El código de la entidad la `Action` se concede a. Para usuarios invitados, añadir `guest/` antes del nombre de acceso. Obligatorio al especificar el `actions.{actionname}.entities` parámetro.
Acciones. {nombre de acción}.filterCond	String		La cadena de consulta que se puede usar App Action. Si se ignora, la condición no se cambiará. Si se especifica una cadena vacía al crear o actualizar el `Action`, la condición se establecerá como `All records`. Para obtener más información sobre la cadena de consulta, consulte el siguiente artículo: Cadena de consulta
revision	Entero o cadena		Especifique el número de revisión de la configuración que se implementará. Se producirá un error en la solicitud si el número de revisión no es la última revisión. La revisión no se comprobará si se ignora este parámetro o si se especifica `-1`.

Solicitud de muestra

JavaScript using kintone.api()

 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


var body = {
  'app': kintone.app.getId(),
  'actions': {
    'Action_A': {
      'name': 'Action_A',
      'index': '0',
      'destApp': {
        'code': 'INVOICE',
      },
      'mappings': [
        {
          'srcType': 'FIELD',
          'srcField': 'CompanyName',
          'destField': 'CompanyName',
        },
        {
          'srcType': 'FIELD',
          'srcField': 'DivisionName',
          'destField': 'DivisionName',
        },
        {
          'srcType': 'RECORD_URL',
          'destField': 'URL',
        }
      ],
      'entities': [
        {
          'type': 'USER',
          'code': 'userA',
        }
      ],
      'filterCond': 'OrderDate = TODAY()'
    },
  },
};

kintone.api(kintone.api.url('/k/v1/preview/app/actions.json', true), 'PUT', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

Muestra de curl

 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


$ curl -X PUT 'https://{subdomain}.kintone.com/k/v1/preview/app/actions.json' \
  -H 'X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=' \
  -H 'Content-Type: application/json' \
  -d '{
  "app": "1",
  "actions": {
    "Action_A": {
      "name": "Action_A",
      "index": "0",
      "destApp": {
        "code": "INVOICE"
      },
      "mappings": [
        {
          "srcType": "FIELD",
          "srcField": "CompanyName",
          "destField": "CompanyName"
        },
        {
          "srcType": "FIELD",
          "srcField": "DivisionName",
          "destField": "DivisionName"
        },
        {
          "srcType": "RECORD_URL",
          "destField": "URL"
        }
      ],
      "entities": [
        {
          "type": "USER",
          "code": "userA"
        }
      ],
      "filterCond": "OrderDate = TODAY()"
    }
  },
  "revision": "2"
}'

Parámetros de respuesta

Parámetro	Tipo	Descripción
revision	String	El número de revisión de la configuración de la aplicación.
actions	Object	Un listado de objetos `Action` Configuración.
actions.{actionname}.id	String	El ID de la `Action`.

Ejemplo de respuesta

1
2
3
4
5
6
7
8


{
  "revision": "2",
  "actions": {
    "Action_A": {
      "id": "7319"
    }
  }
}

Limitaciones

Si varias acciones tienen (o darán lugar a tener) el mismo nombre dentro de la misma aplicación, esta API devolverá un error.

Notas

Aunque el Desactiva esta función: Capacidad para establecer condiciones para cuándo se pueden usar acciones de la app opción marcada, seguirá estando incluida en la respuesta de la siguiente API.
Obtener esquema de API