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 Acciones. {actionname}.destApp y Acciones. {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	Entero o cadena	Sí	El identificador de la aplicación.
actions	Objeto	Sí	Una lista de objetos Acción Configuración. La clave del objeto es la Acción, que es igual al identificador único Acciónen su configuración de idioma predeterminada. Los valores de la clave son los distintos Acción configuración asociada a eso Acción.
actions.{actionname}	Objeto		Una lista de objetos Acción Información de 1 Acción. Si actionname es igual al nombre de un Acciónel Acción se actualizará con los valores del objeto. Si actionname no es igual a un nombre de un Acción, un nuevo Acción se creará con los valores del objeto. Cualquier Acción que no esté establecido para este parámetro se eliminará.
actions.{actionname}.name	Cuerda	Condicional	El nombre de la Acción. Se pueden especificar de 1 a 32 caracteres. Al crear un nuevo archivo Acción, se producirá un error en la solicitud si el valor de este parámetro no es el mismo que Acciones. {actionname}. Obligatorio al actualizar un archivo existente Accióno la creación de un nuevo archivo Acción.
actions.{actionname}.index	Entero o cadena	Condicional	El orden de la Acciones. El Acción se ordena en orden ascendente, a partir de 0. Se producirá un error en la solicitud si hay valores duplicados. Obligatorio al actualizar un archivo existente Accióno la creación de un nuevo archivo Acción.
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 un nuevo archivo Acción.
actions.{actionname}.destApp.app	Entero o cadena	Condicional	El identificador de aplicación de la aplicación de destino de la copia. Requerido si el Acciones. {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. Requerido si el Acciones. {actionname}.destApp.app no se especifica. Si ambos Acciones. {actionname}.destApp.app y Acciones. {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 la matriz está vacía, el Acción no tendrá configuradas las opciones de "Asignaciones de campos". Obligatorio al especificar el parámetro Acciones. {actionname}.destApp o crear un nuevo parámetro Acción.
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 parámetro Acciones. {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. Requerido cuando el Acciones. {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 parámetro Acciones. {actionname}.mappings parámetro.
actions.{actionname}.entities	Arreglo	Condicional	Una matriz de objetos que contiene las entidades Acción se concede a. Esto refleja las opciones "Disponible para". Si la matriz está vacía, el Acción no estará disponible para ningún usuario/departamento/grupo. Obligatorio al crear un nuevo archivo Acción.
actions.{actionname}.entities[].type	Cuerda	Condicional	El tipo de entidad que el Acción 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 parámetro Acciones. {actionname}.entities parámetro.
actions.{actionname}.entities[].code	Cuerda	Condicional	El código de la entidad el Acción se concede a. En el caso de los usuarios invitados, agregue guest/ antes del nombre de inicio de sesión. Obligatorio al especificar el parámetro Acciones. {actionname}.entities parámetro.
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 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


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',
        }
      ],
    },
  },
};

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
40
41
42


$ curl -X PUT \
  https://{subdomain}.kintone.com/v1/app/actions.json \
  -H 'X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=' \
  -H 'Content-Type: application/json' \
  -d '{"actions": [
        {
          "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"
                }
              ]
            }
          },
          "revision": "2"
        }
      ]
    }'

Parámetros de respuesta

Parámetro	Tipo	Descripción
revision	Cuerda	El número de revisión de la configuración de la aplicación.
actions	Objeto	Una lista de objetos Acción Configuración.
actions.{actionname}.id	Cuerda	El ID de la propiedad Acción.

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.