Documentos de API

Obtener la configuración de gestión de procesos

Obtiene la configuración de administración de procesos de una aplicación.

MétodoGET
URLhttps://{subdomain}.kintone.com/k/v1/app/status.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/status.json
Autenticación Autenticación de contraseña , Autenticación de token de API , Autenticación de sesión
Content-Typeapplication/json (no es necesario si se especifica la consulta con una cadena de consulta)

Contenido

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/status.json
URL (espacio de invitado) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/status.json

Permisos

  • Se necesita permiso para ver registros o agregar registros al obtener información de aplicaciones activas.
  • Los permisos de administración de aplicaciones son necesarios para obtener información de la configuración previa a la transmisión.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
app Entero o cadena Sí El identificador de la aplicación.
lang Cuerda 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* 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 un encabezado Accept-Language, se utilizará el idioma establecido en la configuración de "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

var body = {
  'app': 1
};

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

XMLHttpRequest 

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

var url = 'https://{subdomain}.kintone.com/k/v1/app/status.json?app=1';
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

Parámetros de respuesta

Parámetro Tipo Descripción
enable Booleano La configuración de activación/desactivación de la configuración de gestión de procesos.
  • true: La configuración de administración de procesos está habilitada.
  • false: La configuración de gestión de procesos está deshabilitada.
states Objeto Objeto que contiene datos de los estados de gestión de procesos.
null se devuelve para las aplicaciones que nunca antes han habilitado la configuración de administración de procesos.
states.{status_name}.name Cuerda El nombre del estado.
states.{status_name}.index Cuerda El orden de visualización (ascendente) del estado, cuando aparece con los otros estados.
states.{status_name}.assignee Objeto Objeto que contiene datos de la configuración de la persona asignada.
states.{status_name}.assignee.type Cuerda El tipo Lista de personas asignadas del Estado.
  • ONE: El usuario elige una persona asignada de la lista para realizar la acción
  • ALL: Todas las personas asignadas de la lista deben tomar medidas
  • ANY: Una persona asignada de la lista debe tomar medidas
El estado con el índice más bajo siempre devolverá UNO.
states.{status_name}.assignee.entities Arreglo Una matriz que enumera los datos de las personas asignadas. Se enumeran en el mismo orden que en la interfaz gráfica de usuario.
states.{status_name}.assignee.entities[].entity Objeto Un objeto que contiene los datos de usuario de las personas asignadas.
Los usuarios inactivos, los usuarios/departamentos/grupos eliminados y los campos personalizados eliminados no se incluirán en la respuesta. Para obtener más información sobre los campos personalizados, consulte el siguiente artículo:
Adición de campos en la información del usuario (campos personalizados) (External link)
states.{status_name}.assignee.entities[].entity.type Cuerda El tipo de entidad del usuario asignado.
  • USER: Usuario
  • GROUP: Grupo
  • ORGANIZATION: Departamento
  • FIELD_ENTITY: Campo de selección de usuario/grupo/departamento
    CREATOR: Creado por campo
    CUSTOM_FIELD: Campos personalizados
states.{status_name}.assignee.entities[].entity.code Cuerda
 El código del cesionario.
Las siguientes entidades devolverán los siguientes valores:Para especificar usuarios de espacio de invitado, agregue la cadena "guest/" antes del nombre de inicio de sesión del invitado.
states.{status_name}.assignee.entities[].includeSubs Booleano La configuración "Incluir departamentos afiliados" del departamento.
  • true: Los departamentos afiliados se incluyen como cesionarios
  • false: Los departamentos afiliados no se incluyen como cesionarios
actions Arreglo Matriz que contiene los datos de las acciones. Se enumeran en el mismo orden que en la interfaz gráfica de usuario.
null se devuelve para las aplicaciones que nunca antes han habilitado la configuración de administración de procesos.
actions[].name Cuerda El nombre de la acción.
actions[].from Cuerda El estado antes de tomar medidas.
actions[].to Cuerda El estado después de realizar una acción.
actions[].filterCond Cuerda Los criterios de rama de la acción.
Para obtener más datos sobre los formatos de consulta, consulte el siguiente documento:
Cadena de consulta
revision Cuerda 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
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

{
  "enable": true,
  "states": {
    "Not started": {
      "name": "Not started",
      "index": "0",
      "assignee": {
        "type": "ONE",
        "entities": []
      }
    },
    "In progress": {
      "name": "In progress",
      "index": "1",
      "assignee": {
        "type": "ALL",
        "entities": [
          {
            "entity": {
              "type": "USER",
              "code": "user1"
            },
            "includeSubs": false
          },
          {
            "entity": {
              "type": "FIELD_ENTITY",
              "code": "creator"
            },
            "includeSubs": false
          },
          {
            "entity": {
              "type": "CUSTOM_FIELD",
              "code": "Boss"
            },
            "includeSubs": false
          }
        ]
      }
    },
    "Completed": {
      "name": "Completed",
      "index": "2",
      "assignee": {
        "type": "ONE",
        "entities": []
      }
    }
  },
  "actions": [
    {
      "name": "Start",
      "from": "Not started",
      "to": "In progress",
      "filterCond": "Record_number = \"1\""
    },
    {
      "name": "Complete",
      "from": "In progress",
      "to": "Completed",
      "filterCond": ""
    }
  ],
  "revision": "3"
}