Obtener la configuración de la acción

Documentos de API

Obtener la configuración de la acción

Obtiene 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

Método	GET
URL	https://{subdomain}.kintone.com/k/v1/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 (no es necesario si se especifica la consulta con una cadena de consulta)

Ajustes previos a la transmisión en vivo

Es posible que las aplicaciones contengan configuraciones previas a la transmisión en vivo que aún no se hayan implementado en la aplicación en vivo.
Acceda a la configuración previa a la transmisión en vivo con la siguiente URL.

URL	https://{subdomain}.kintone.com/k/v1/preview/app/actions.json
URL (espacio de invitado)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/actions.json

Permisos

Se necesitan permisos de administración de aplicaciones.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción
app	Integer o String	Sí	El identificador de la aplicación.
lang	String		El idioma localizado en el que se recuperarán los datos: `default`: recupera los nombres predeterminados `en`: recupera los nombres localizados en inglés `zh`: recupera los nombres chinos localizados `ja`: recupera los nombres japoneses localizados `user`: recupera los nombres localizados en el mismo idioma que la configuración de idioma establecida en el usuario utilizado para la autenticación. Si se ignora, se recuperarán los nombres predeterminados.

Si la configuración de idioma del usuario se establece en Usar la configuración del navegador web, se utilizará la configuración establecida en el encabezado Accept-Language. Si no hay ningún encabezado Accept-Language, el idioma establecido en el Localización en el menú del administrador del sistema.

Solicitud de muestra

JavaScript using kintone.api()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


var body = {
  'app': kintone.app.getId(),
  'lang': 'en'
};

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

Muestra de curl

1
2
3
4
5
6
7
8


$ curl -X GET \
  https://{subdomain}.kintone.com/v1/app/actions.json \
  -H 'Content-Type: application/json' \
  -H 'X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=' \
  -d '{
        "app": 1,
        "lang": "en"
      }'

Parámetros de respuesta

Parámetro	Tipo	Descripción
actions	Objeto	Un objeto de Acción Configuración. La clave del objeto es la Acción, que se establece como el identificador único Acciónen su configuración de idioma predeterminada (esto es independientemente del valor del parámetro de solicitud lang). Los valores de la clave son los distintos Acción configuración asociada a eso Acción.
actions.{actionname}.name	Cuerda	El nombre de la Acción. Cuando se especifica el parámetro de solicitud lang, el parámetro Acción, en ese idioma.
actions.{actionname}.id	Cuerda	El ID de la propiedad Acción.
actions.{actionname}.index	Cuerda	El orden de la Acción, a partir de 0.
actions.{actionname}.destApp	Objeto	Objeto que contiene la opción Target que especifica la aplicación de destino en la que se van a copiar los datos.
actions.{actionname}.destApp.app	Cuerda	El identificador de aplicación de la aplicación de destino de copia.
actions.{actionname}.destApp.code	Cuerda	El código de aplicación de la aplicación de destino de copia. Se devuelve una cadena vacía si no se establece un código de aplicación en la configuración de la aplicación de destino.
actions.{actionname}.mappings	Arreglo	Una matriz de objetos que contiene las opciones Asignaciones de campos. Se devuelve una matriz vacía si las opciones Asignaciones de campos no están configuradas.
actions.{actionname}.mappings[].srcType	Cuerda	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
actions.{actionname}.mappings[].srcField	Cuerda	El código de campo del campo especificado en las opciones Asignaciones de campos como origen. Este parámetro solo se devuelve si el parámetro `actions.{actionname}.mappings[].srcType` El parámetro se establece en `FIELD`.
actions.{actionname}.mappings[].destField	Cuerda	El código de campo del campo especificado en las opciones Asignaciones de campos como destino.
actions.{actionname}.entities	Arreglo	Una matriz de objetos que contiene las entidades `Action` se concede a. Esto refleja las opciones Disponible para. Los usuarios inactivos y los usuarios/departamentos/grupos eliminados no se incluirán en la respuesta.
actions.{actionname}.entities[].type	Cuerda	El tipo de entidad que el Acción se concede a. `USER`: Usuario `GROUP`: Grupo `ORGANIZATION`: Departamento
actions.{actionname}.entities[].code	Cuerda	El código de la entidad el Acción se concede a. En el caso de los usuarios invitados, el nombre de inicio de sesión va precedido de invitado/.
Acciones. {nombre de acción}.filterCond	String	La condición para ejecutar el Acción. Si se especifica una cadena vacía, la Acción se va a correr Todos los récords. No se puede especificar el Usuario/Grupo/Departamento eliminado o inactivo. Para obtener más información sobre la cadena de consulta, consulte el siguiente artículo: Cadena de consulta
revision	String	El número de revisión de la configuración de la aplicación.

Ejemplo de respuesta

 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


{
  "actions": {
    "Action_A": {
      "name": "Action_A",
      "id": "1",
      "index": "0",
      "destApp": {
        "app": "2",
        "code": "INVOICE"
      },
      "mappings": [
        {
          "srcType": "FIELD",
          "srcField": "CompanyName",
          "destField": "CompanyName"
        },
        {
          "srcType": "RECORD_URL",
          "destField": "URL"
        }
      ],
      "entities": [
        {
          "type": "USER",
          "code": "userA"
        }
      ],
      "filterCond": "User_selection in (\"user1\")"
    }
  },
  "revision": "2"
}

Limitaciones

Si varias acciones tienen 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