Consigue espacio

Obtiene información de un espacio.

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

Contenido

Permisos

En el caso de los espacios privados, el usuario debe ser miembro del Espacio.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
id Entero o cadena El ID del espacio.
El ID del espacio se puede encontrar en la URL del espacio.
Un espacio con la URL de https://{domainname}.kintone.com/k/#/space/111 tiene un ID de espacio de 111.

Solicitud de muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var body = {
  'id': 1
};

kintone.api(kintone.api.url('/k/v1/space.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
15
var url = 'https://{subdomain}.kintone.com/k/v1/space.json?id=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
id Cuerda El ID del espacio.
name Cuerda El nombre del Espacio
defaultThread Cuerda El identificador de subproceso del subproceso predeterminado que se creó cuando se creó el espacio.
isPrivate Booleano El "Privado" de la configuración del espacio.
true: El espacio es privado.
false: El Espacio no es privado.
creator Objeto Un objeto que contiene información del creador del Espacio.
creator.code Cuerda El código (nombre de inicio de sesión) del creador.
Se devuelve una cadena vacía para los usuarios inactivos o eliminados.
creator.name Cuerda El nombre para mostrar del creador.
Se devuelve una cadena vacía para los usuarios inactivos o eliminados.
modifier Objeto Un objeto que contiene información del actualizador del espacio.
modifier.code Cuerda El código (nombre de inicio de sesión) del actualizador.
Se devuelve una cadena vacía para los usuarios inactivos o eliminados.
modifier.name Cuerda El nombre para mostrar del actualizador.
Se devuelve una cadena vacía para los usuarios inactivos o eliminados.
memberCount Cuerda El número de miembros del Espacio.
coverType Cuerda El tipo de imagen de la foto de portada.
BLOB: Una imagen cargada.
PRESET: Una imagen preestablecida.
coverKey Cuerda La clave de la foto de portada.
coverUrl Cuerda La URL de la foto de portada.
body Cuerda El HTML del cuerpo del espacio.
Se devuelve null si el HTML del cuerpo está vacío.
Sin embargo, si el cuerpo se ha establecido antes, las etiquetas HTML se pueden establecer incluso si no se muestra nada en la pantalla y se devolverá la cadena.
useMultiThread Booleano El Habilitación de varios subprocesos ajuste.
true: El espacio es un espacio multiproceso.
false: El espacio es un espacio de un solo subproceso.
isGuest Booleano La configuración del espacio de invitado.
true: El Espacio es un Espacio de Invitados.
false: El Espacio no es un Espacio de Invitado.
attachedApps Arreglo Una lista de aplicaciones que se encuentran en el hilo.
Esto no incluye las aplicaciones que aún no están activas.
attachedApps[].threadId Cuerda El identificador de subproceso del subproceso en el que se creó la aplicación.
Las aplicaciones que se crean dentro de Spaces mediante la interfaz gráfica de usuario se asignarán automáticamente al Thread predeterminado.
attachedApps[].appId Cuerda El identificador de la aplicación.
attachedApps[].code Cuerda El código de la aplicación.
Se devuelve una cadena vacía si no se establece un código de aplicación en la configuración de la aplicación.
attachedApps[].name Cuerda El nombre de la aplicación.
Si la aplicación tiene configuración de localización, se devolverá el nombre localizado.
attachedApps[].description Cuerda La descripción de la aplicación.
Si la aplicación tiene ajustes de localización, se devolverá la descripción localizada.
attachedApps[].createdAt Cuerda La fecha de creación de la aplicación.
attachedApps[].creator Objeto La información del usuario que creó la App.
attachedApps[].creator.code Cuerda El código (nombre de inicio de sesión) del creador.
Se devuelve una cadena vacía para los usuarios inactivos y los usuarios eliminados.
attachedApps[].creator.name Cuerda El nombre para mostrar del creador.
Se devuelve una cadena vacía para los usuarios inactivos y los usuarios eliminados.
attachedApps[].modifiedAt Cuerda La fecha de la última actualización de la aplicación.
attachedApps[].modifier Objeto La información del usuario que actualizó por última vez la App.
attachedApps[].modifier.code Cuerda El código (nombre de inicio de sesión) del último actualizador.
Se devuelve una cadena vacía para los usuarios inactivos y los usuarios eliminados.
attachedApps[].modifier.name Cuerda El nombre para mostrar del último actualizador.
Se devuelve una cadena vacía para los usuarios inactivos y los usuarios eliminados.
fixedMember Booleano Las opciones establecidas para el Impedir que los usuarios se unan o abandonen el espacio y sigan o dejen de seguir los hilos ajuste.
true: Los usuarios no pueden unirse/salir del espacio ni seguir/dejar de seguir los hilos.
false: Los usuarios pueden unirse/salir del espacio y seguir/dejar de seguir los hilos.
showAnnouncement Booleano El estado de visualización de la pantalla Anuncio widget.
true: El Anuncio widget.
false: El Anuncio widget no se muestra.
null se devuelve para los espacios con el atributo Habilitación de varios subprocesos opción desactivada.
showThreadList Booleano El estado de visualización de la pantalla Hilos widget.
true: El Hilos widget.
false: El Hilos widget no se muestra.
null se devuelve para los espacios con el atributo Habilitación de varios subprocesos opción desactivada.
showAppList Booleano El estado de visualización de la pantalla Aplicaciones widget.
true: El Aplicaciones widget.
false: El Aplicaciones widget no se muestra.
null se devuelve para los espacios con el atributo Habilitación de varios subprocesos opción desactivada.
showMemberList Booleano El estado de visualización de la pantalla Gente widget.
true: El Gente widget.
false: El Gente widget no se muestra.
null se devuelve para los espacios con el atributo Habilitación de varios subprocesos opción desactivada.
showRelatedLinkList Booleano El estado de visualización de la pantalla Aplicaciones y espacios relacionados widget.
true: El Aplicaciones y espacios relacionados widget.
false: El Aplicaciones y espacios relacionados widget no se muestra.
null se devuelve para los espacios con el atributo Habilitación de varios subprocesos opción desactivada.
permissions Objeto Objeto que contiene información sobre la configuración de permisos del espacio.
permissions.createApp Cuerda La opción establecida para el Permitir que solo los administradores de espacio creen aplicaciones ajuste
EVERYONE: todos los usuarios pueden crear Apps.
ADMIN: solo los administradores pueden crear aplicaciones.

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
{
  "id": "1",
  "name": "Sample Space Name",
  "defaultThread": "12",
  "isPrivate": false,
  "creator": {
    "code": "john-d",
    "name": "John Doe"
  },
  "modifier": {
    "code": "john-d",
    "name": "John Doe"
  },
  "memberCount": 3,
  "coverType": "PRESET",
  "coverKey": "GREEN",
  "coverUrl": "https://*******/green.jpg",
  "body": "<b>Space Body</b>",
  "useMultiThread": false,
  "showAnnouncement": true,
  "showThreadList": true,
  "showAppList": true,
  "showMemberList": true,
  "showRelatedLinkList": true,
  "isGuest": false,
  "fixedMember": false,
  "permissions": {
    "createApp": "EVERYONE"
  },
  "attachedApps": [
    {
      "appId": "33",
      "code": "",
      "name": "Document Library",
      "description": "Document Library Description",
      "createdAt": "2017-03-08T06:31:30.000Z",
      "creator": {
        "code": "john-d",
        "name": "John Doe"
      },
      "modifiedAt": "2017-03-13T01:36:17.000Z",
      "modifier": {
        "code": "jane-r",
        "name": "Jane Roe"
      },
      "threadId": "12"
    },
    {
      "appId": "52",
      "code": "",
      "name": "Recruiting Pack",
      "description": "Recruiting Pack Description",
      "createdAt": "2017-03-30T06:30:26.000Z",
      "creator": {
        "code": "john-d",
        "name": "John Doe"
      },
      "modifiedAt": "2017-04-10T09:09:51.000Z",
      "modifier": {
        "code": "john-d",
        "name": "John Doe"
      },
      "threadId": "12"
    }
  ]
}

Limitaciones

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