Documentos de API

Actualizar la configuración de administración de procesos

Actualiza la configuración de gestión de procesos de una aplicación.
Para obtener más información, consulte el siguiente artículo:
Configuración de la gestión de procesos (External link)

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étodoPUT
URLhttps://{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
Autenticación Autenticación de contraseña , Autenticación de token de API , Autenticación de sesión
Content-Typeapplication/json

Contenido

Permisos

  • Se necesitan permisos de administración de aplicaciones.

Parámetros de solicitud

Los parámetros que se ignoren no se actualizarán.

Parámetro Tipo Obligatorio Descripción
app Integer o String Sí El identificador de la aplicación.
enable Booleano o cadena 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 Object Objeto que contiene datos de los estados de gestión de procesos.
Al añadir o actualizar un estado, especifica los estados existentes en states También.
Si no se especifica, los estados existentes serán eliminados.
states.{status_name} Objeto Objeto que contiene la configuración de cada estado.
  • Añadir un nuevo estado: Especifica un nombre de estado que no existe.
  • Actualiza un estado: Especifica el nombre del estado que se va a actualizar.
  • Eliminar un estado: No especifiques el nombre de estado para eliminar.
El primer estatus no puede añadirse. Para cambiar el primer estado, actualiza el nombre del primer estado existente.
states.{status_name}.name Cuerda Condicional El nombre del estado.
La longitud máxima es de 64 caracteres.
Obligatorio, si se indica un nuevo estado para {status_name}. En este caso, estatus el mismo valor usado para {status_name}.
states.{status_name}.index Entero o cadena Condicional El orden de visualización (ascendente desde 0) del estado, cuando aparece con los demás estados. Obligatorio, si se establece el parámetro {status_name} parámetro.
states.{status_name}.assignee Objeto Objeto que contiene datos de la configuración de la persona asignada.
states.{status_name}.assignee.type Cuerda Condicional 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
Obligatorio, si se establece el parámetro {status_name}.assignee parámetro.
states.{status_name}.assignee.entities Arreglo Condicional Una matriz que enumera los datos de las personas asignadas.
Obligatorio, si se establece el parámetro {status_name}.assignee parámetro.
states.{status_name}.assignee.entities[].entity Objeto Condicional Un objeto que contiene los datos de usuario de las personas asignadas.
Obligatorio, si se establece el parámetro entities parámetro.
states.{status_name}.assignee.entities[].entity.type Cuerda Condicional El tipo de entidad del usuario asignado.Obligatorio, para cada entidad indicada.
Los departamentos no se pueden especificar en las aplicaciones de espacio de invitados.
states.{status_name}.assignee.entities[].entity.code Cuerda Condicional El código del cesionario.
Para especificar usuarios en el espacio de invitados, añade la cadena guest/ antes del nombre de acceso del invitado.
Si FIELD_ENTITY se especifica para el entity.type, indica el código de campo de los siguientes campos:
  • Creado por
  • Actualizado por
  • Selección de usuarios
  • Selección de departamentos
  • Selección de grupos
Si CUSTOM_FIELD se especifica para entity.type, indica el código de campo del campo personalizado.
Para obtener más información, consulte el siguiente artículo:
Adición de campos en la información del usuario (campos personalizados) (External link)
Si CREATOR se especifica para entity.type, ignora este parámetro.
states.{status_name}.assignee.entities[].includeSubs Booleano o cadena 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
Si se omite, este valor es falso.
actions Array Matriz que contiene los datos de las acciones.
actions[].name Cuerda Condicional El nombre de la acción.
La longitud máxima es de 64 caracteres.
Obligatorio, si se establece el parámetro actions parámetro.
actions[].from Cuerda Condicional El nombre del estado antes de realizar la acción.
Si se ha cambiado un nombre de estado que desea especificar, coloque el valor modificado para este parámetro.
Obligatorio, si se establece el parámetro actions parámetro.
actions[].to Cuerda Condicional El nombre del estado después de realizar la acción.
Si se ha cambiado un nombre de estado que desea especificar, coloque el valor modificado para este parámetro.
Obligatorio, si se establece el parámetro actions parámetro.
actions[].filterCond Cuerda Los criterios de bifurcación de la acción, especificados como una consulta.
Para obtener más información sobre los formatos de consulta, consulte el siguiente documento:
Cadena de consulta
El campo Estado no se puede incluir en la 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
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

var body = {
  'app': '5',
  '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': 'Created_by'
            },
            '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': ''
    }
  ]
};

kintone.api(kintone.api.url('/k/v1/preview/app/status.json', true), 'PUT', 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
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

var body = {
  'app': '5',
  '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': 'Created_by'
            },
            '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': ''
    }
  ],
  // CSRF TOKEN: used for all APIs that have an HTTP method of POST, PUT and DELETE on Kintone.
  '__REQUEST_TOKEN__': kintone.getRequestToken()
};

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

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.

Ejemplo de respuesta

1
2
3

{
  "revision": "3"
}