Añade espacio

Crea un espacio a partir de una plantilla de espacio.

MétodoPOST
URLhttps://{subdomain}.kintone.com/k/v1/template/space.json
Autenticación Autenticación de contraseña, Autenticación de sesión
Content-Typeapplication/json

Contenido

Permisos

  • Para crear espacios de invitado, el usuario deberá tener permiso para crear espacios de invitado.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
id Entero o cadena El ID de plantilla de espacio.
Para obtener instrucciones sobre cómo crear plantillas de espacio, consulte el siguiente artículo:
Creación de una plantilla a partir de un espacio (External link)
El ID de plantilla de espacio se muestra en la página de lista Plantillas de espacio, que se encuentra en https://{domainname}.kintone.com/k/admin/system/spacetemplate/
name Cuerda El nuevo nombre del Espacio.
members Arreglo Una lista de los miembros del Espacio.
Se debe especificar al menos un administrador de espacio.
No se pueden especificar los usuarios inactivos y eliminados.
members[].entity Objeto La información de la entidad del miembro Space.
No se pueden especificar usuarios invitados.
members[].entity.type Cuerda Tipo de entidad del miembro Space.
  • USER: Usuario
  • Group: Grupo
  • ORGANIZATION: Departamento
members[].entity.code Cuerda El código de la entidad.
members[].isAdmin Booleano o cadena Condicional La configuración de Administración de espacio del usuario.
  • true: El miembro será el Administrador del Espacio.
  • false: El miembro no será el Administrador del Espacio.
Se requiere que se establezca al menos 1 administrador de espacio en la llamada a la API.
Si se omite, este valor es false.
members[].includeSubs Booleano o cadena El "Incluir departamentos afiliados" configuración del departamento.
  • true: Se incluirán los departamentos adscritos.
  • false: No se incluirán los departamentos afiliados.
Si se omite, este valor es false.
isPrivate Booleano o cadena El "Privado" de la configuración del espacio.
  • true: El espacio será privado.
  • false: El Espacio no será Privado.
Si el isGuest se establece en true, este valor también es true.
Si se omite, este valor es false.
isGuest Booleano o cadena La configuración del espacio de invitado del espacio.
  • true: El Espacio será un Espacio de Invitados
  • false: El Espacio será un Espacio normal.
Si se omite, este valor es false.
fixedMember Booleano o cadena El "Bloquee a los usuarios para que no se unan o abandonen el espacio y sigan o dejen de seguir los hilos." de la configuración del espacio.
  • true: Los usuarios no podrán unirse/salir del espacio ni seguir/dejar de seguir los hilos.
  • false: Los usuarios podrán unirse/salir del espacio y seguir/dejar de seguir los hilos.
Si se omite, este valor es false.

Solicitud de muestra

 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
var body = {
  'id': 1001,
  'name': 'Sample Space Name',
  'members': [
    {
      'entity': {
        'type': 'USER',
        'code': 'user1'
      },
      'isAdmin': true
    },
    {
      'entity': {
        'type': 'GROUP',
        'code': 'group1'
      },
      'isAdmin': false
    },
    {
      'entity': {
        'type': 'ORGANIZATION',
        'code': 'org1'
      },
      'isAdmin': false,
      'includeSubs': true
    }
  ]
};

kintone.api(kintone.api.url('/k/v1/template/space.json', true), 'POST', 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
var body = {
  'id': 1001,
  'name': 'Sample Space Name',
  'members': [
    {
      'entity': {
        'type': 'USER',
        'code': 'user1'
      },
      'isAdmin': true
    },
    {
      'entity': {
        'type': 'GROUP',
        'code': 'group1'
      },
      'isAdmin': false
    },
    {
      'entity': {
        'type': 'ORGANIZATION',
        'code': 'org1'
      },
      'isAdmin': false,
      'includeSubs': true
    }
  ],
  // 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/template/space.json';
var xhr = new XMLHttpRequest();
xhr.open('POST', 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
id Cuerda El ID de espacio del espacio creado.

Ejemplo de respuesta

1
2
3
{
  "id": "1"
}

Limitaciones

  • Si la función Espacio o Espacio de invitado está desactivada, se devolverá un error.