API V2 reservável do WSD

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 18 min. de leitura

    • A API V2 reservável Workplace Service Delivery (WSD) recupera detalhes de um reservável, uma entidade que pode ser reservada, como um local de trabalho, de uma instância ServiceNow.

    A API V2 reservável do WSD é uma nova versão do API reservável do WSD. A API WSD reservável v2 busca detalhes de todos os espaços reserváveis no portal WSD que você seleciona ao fazer uma reserva. A versão original da API reservável do WSD usava uma chamada GET, mas limitava o parâmetro de caminho sys_ID a 35 caracteres. A nova versão da API V2 reservável do WSD é uma chamada POST e usa todos os sys_ids no corpo da solicitação para evitar limitações de caracteres.

    Para acessar essa API, o solicitante deve ter a função sn_wsd_core.workplace_user.

    Esta API é executada no namespace sn_wsd_rsv. Para acessar essa API, o plug-in Workplace Reservation Management (sn_wsd_rsv) deve ser ativado.

    Para obter informações adicionais sobre Workplace Reservation Management, consulte Workplace Reservation Management.

    API reservável V2 do WSD - POST /sn_wsd_rsv/v2/reservable/list_reservables

    Retorna os detalhes de um ou mais reserváveis especificados.

    Formato de URL

    URL padrão: POST api/sn_wsd_rsv/v2/reservable/list_reservables

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    api_version Obrigatório. Versão do endpoint a ser acessada. Especifique v2 para empregar esta API. Caso contrário, o uso de v1 empregará a versão padrão da API reservável do WSD.

    Tipo de dados: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    espaço_sys_ids Obrigatório. sys_ids separados por vírgulas de espaços selecionados.

    Tipo de dados: cadeia de caracteres

    Padrão: valor vazio

    reservable_module_sys_id

    		 Obrigatório. Sys_id do módulo reservável, por exemplo: mesa, sala de reunião etc.

    Um módulo reservável agrupa tipos semelhantes de itens do local de trabalho. Este sys_id está localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module].

    Para obter informações adicionais sobre módulos reserváveis, consulte Configurar um módulo reservável.

    Tipo de dados: cadeia de caracteres

    Padrão: valor vazio
    include_flexible_services Sinalizador que indica se os serviços flexíveis associados ao reservável em devem ser retornados à resposta.

    Um serviço flexível é uma provisão adicional disponível com um item do local de trabalho reservável quando uma reserva é feita. Por exemplo, Estilo de sala de aula - Filas de tabelas organizadas com todos os participantes voltados para a frente da sala. Para obter informações adicionais sobre serviços flexíveis, consulte Criar um serviço flexível.

    Valores válidos:
    • verdadeiro: retorna as informações do serviço flexível.
    • falso: não retorne as informações de serviço flexível.

    Tipo de dados: booliano

    Padrão: falso
    include_standard_​serviços Sinalizador que indica se as informações de serviços padrão devem ser retornadas na resposta.

    Um serviço padrão descreve provisões básicas disponíveis com um item do local de trabalho reservável quando a reserva é feita, como quadros brancos, monitores adicionais e serviços semelhantes. Para obter informações adicionais sobre serviços padrão, consulte Serviços padrão. Essas informações estão localizadas na tabela Serviço padrão [sn_wsd_rsv_standard_service].

    Valores válidos:
    • verdadeiro: retorna as informações de serviços padrão.
    • false: não retorna as informações de serviços padrão.

    Tipo de dados: booliano

    Padrão: falso
    include_reservável_propósitos Opcional. Sinalizador que indica se a finalidade associada ao reservável deve ser retornada.
    Valores válidos:
    • verdadeiro: retorna a finalidade do reservável.
    • falso: não retorne a finalidade do reservável.

    Tipo de dados: booliano

    Padrão: falso
    include_layouts Sinalizador que indica se as informações de layout do local devem ser retornadas na resposta.

    As informações de layout do local incluem capacidade, capacidade máxima, preparação e duração da limpeza. Essas informações estão localizadas na tabela Layout do local [sn_wsd_rsv_m2m_location_layout].

    Valores válidos:
    • verdadeiro: retorna as informações de layout do local.
    • falso: não retorna as informações de layout do local.

    Tipo de dados: booliano

    Padrão: falso

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a aplicação/json.
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

    Tabela 6. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    404Não foi possível encontrar reserváveis.

    Procure a tabela Espaços principais do WSD [sn_wsd_core_spaces] e verifique se o registro de espaço está presente.
    500Ocorreu um erro! Não é possível recuperar os reserváveis.

    Este é um erro do servidor. Entre em contato com a administração do sistema.

    Parâmetros do corpo da resposta

    Nome Descrição
    resultado Detalhes sobre cada reservável correspondente.

    Tipo de dados: matriz de objetos

    {
  "result": [
    {
      "allow_invitees": Boolean,
      "area": {Object},
      "building": {Object},
      "campus": {Object},
      "capacity": Number,
      "description": "String",
      "display_number_of_attendees": Boolean,
      "display_on_behalf_of": Boolean,
      "display_sensitivity": Boolean,
      "email": "String",
      "employee_override_privacy": Boolean
      "enable_group_reservations": Boolean,
      "enable_reservation_privacy": Boolean,
      "external_id": "String",
      "flexible_services": [Array],
      "floor": {Object},
      "image": {Object},
      "is_reservable": Boolean,
      "layouts": [Array],
      "location_type": {Object},
      "meetingProviders": [Array],
      "moduleType": "String",
      "name": "String",
      "number": "String",
      "order": Number,
      "require_approval": Boolean,
      "requires_check_in": Boolean,
      "require_subject": Boolean,
      "reservable_quantity": Number,
      "site": {Object},
      "standard_services": [Array],
      "sys_id": "String",
      "title": "String",
      "type": "String",
      "tableName": "String"
    }
  ]
}
    resultado.allow_invitees Sinalizador que indica se os funcionários podem adicionar convidados à reserva.
    Valores válidos:
    • verdadeiro: permite que os funcionários adicionem convidados à reserva.
    • falso: não permita que os funcionários adicionem convidados à reserva.

    Tipo de dados: booliano
    resultado.área Área onde o reservável está localizado.

    Essas informações estão localizadas na tabela Área [sn_wsd_core_area].

    "area": {
   "display_value": "String",
   "sys_id": "String"
}
    result.area.display_value Exibe o valor da área.

    Tipo de dados: cadeia de caracteres
    result.area.sys_id Sys_id do registro da área associada.

    Tipo de dados: cadeia de caracteres
    resultado.edifício Edifício onde o reservável está localizado.

    Essas informações estão localizadas na tabela Edifício [sn_wsd_core_building].

    "building": {
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
    result.building.display_value Exiba o valor do edifício.

    Tipo de dados: cadeia de caracteres
    result.building.sys_id Sys_id do registro do edifício associado.

    Tipo de dados: cadeia de caracteres
    result.building.timezone Detalhes do fuso horário do edifício.
    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    result.building.timezone.display_value Exiba o valor do fuso horário no qual o edifício associado reside.

    Tipo de dados: cadeia de caracteres
    result.building.timezone.value Valor interno do fuso horário no qual o edifício associado reside.

    Tipo de dados: cadeia de caracteres
    resultado.campus Campus onde o reservável está localizado.

    Essas informações estão localizadas na tabela Campus [sn_wsd_core_campus].

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}
    resultado.campus.display_value Exiba o valor do campus.

    Tipo de dados: cadeia de caracteres
    resultado.campus.sys_id Sys_id do registro do campus associado.

    Tipo de dados: cadeia de caracteres
    resultado.capacidade Número de pessoas que o reservável pode acomodar.

    Tipo de dados: número
    resultado.descrição

    Descrição do reservável.

    Tipo de dados: cadeia de caracteres
    resultado.exibir_número_de_participantes Sinalizador que indica se os usuários podem especificar o número de participantes na reserva.
    Valores válidos:
    • verdadeiro: os usuários podem especificar o número de participantes.
    • falso: os usuários não podem especificar o número de exibição de participantes.

    Tipo de dados: booliano
    resultado.display_on_behalf_of Sinalizador que indica se as reservas podem ser feitas em nome de outra pessoa.
    Valores válidos:
    • verdadeiro: em nome de com suporte.
    • falso: em nome de sem suporte.

    Tipo de dados: booliano
    resultado.display_sensibilidade Sinalizador que indica se os usuários podem definir a confidencialidade da reserva, como normal ou privada.
    Valores válidos:
    • verdadeiro: capaz de definir a confidencialidade.
    • falso: não é possível definir a confidencialidade. O padrão é normal.

    Tipo de dados: booliano
    resultado.e-mail Endereço de e-mail associado ao reservável.

    Tipo de dados: cadeia de caracteres
    resultado.funcionário_override_privacy Sinalizador que indica se os usuários podem substituir a configuração de privacidade do reservável associado.

    Para obter informações adicionais sobre essas configurações de privacidade, consulte Configurações de privacidade do local e impacto.

    Valores válidos:
    • verdadeiro: os usuários podem substituir a configuração de privacidade do reservável associado.
    • falso: os usuários não podem substituir a configuração de privacidade do reservável associado.
    result.enable_group_reservations Sinalizador que indica se os usuários podem fazer uma reserva de grupo.
    Valores válidos:
    • verdadeiro: capaz de fazer reservas de grupo.
    • falso: não é possível fazer reservas de grupo.

    Tipo de dados: booliano
    result.enable_reservation_privacy

    Sinalizador que indica a configuração padrão da privacidade da reserva.

    Para obter informações adicionais sobre essas configurações de privacidade, consulte Location privacy settings and impact.

    Valores possíveis:
    • verdadeiro: as reservas são privadas por padrão.
    • false: as reservas não são privadas por padrão.

    Tipo de dados: booliano
    resultado.id_externo ID externo do reservável.

    Tipo de dados: cadeia de caracteres
    resultado.serviços_flexíveis Preenchido somente se o parâmetro include_flexible_services estiver definido como verdadeiro e o plug-in de gestão de casos do local de trabalho estiver instalado. Descrição dos serviços flexíveis associados aos reserváveis. Pode haver um serviço flexível primário e vários serviços flexíveis secundários.

    Essas informações estão localizadas na tabela [sn_wsd_case_workplace_service_item].

    flexible_services": [
  {
    "additional_text": "String",
    "allow_only_single_service_item_selection": Boolean,
    "category": "String",
    "currency_code": "String",
    "flexible_service": [Array],
    "label": "String",
    "sub_category": "String",
    "sub_title": "String",
    "text": "String",
    "title": {Object}
  }
]
    result.flexible_services.additional_text Texto para solicitar que o usuário selecione serviços flexíveis adicionais.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.allow_only_single_​service_item_selection Sinalizador que indica se os usuários podem selecionar apenas um item de serviço entre o grupo de serviços flexíveis em uma reserva.
    Valores válidos:
    • verdadeiro: só pode fazer uma única seleção.
    • falso: capaz de fazer várias seleções.

    Tipo de dados: booliano
    resultado.serviços_flexíveis.categoria Categoria dos serviços flexíveis.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.currency_code Código de moeda usado para calcular o valor da moeda ao solicitar serviços flexíveis.

    Tipo de dados: cadeia de caracteres
    resultado.serviços_flexíveis.serviço_flexível Serviços flexíveis correspondentes a um serviço flexível primário. Essas informações estão localizadas na tabela [sn_wsd_case_workplace_service_item].

    Tipo de dados: matriz de objetos

    "flexible_service": [
  {
    "flexible_service": [Array],
    "label": "String",
    "sub_category": "String"
 }
]
    result.flexible_services.flexible_service.​flexible_service Detalhes de cada serviço flexível correspondente a um serviço flexível primário.

    Tipo de dados: matriz de objetos

    "flexible_service": [
  {
    "additional_text": "String",
    "capacity_enabled": Boolean,
    "category": "String",
    "category_label": "String",
    "cleanup_duration": "String",
    "image": "String",
    "max_capacity": Number,
    "name": "String",
    "preparation_duration": "String",
    "price_per_unit": {Object},
    "quantity_enabled": Boolean,
    "quantity_required": Boolean,
    "short_description": "String",
    "sub_category": "String",
    "sub_category_label": "String",
    "sub_title": "String",
    "sys_id": "String",
    "text": "String",
    "title": {Object}
  }
]
    result.flexible_services.flexible_service.​flexible_service.additional_text Texto usado para solicitar que um usuário selecione serviços flexíveis adicionais.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.capacity_enabled Sinalizador que indica se a capacidade da sala deve aparecer na reserva. Se for definido como verdadeiro, quantity_enabled será sempre falso.
    Valores válidos:
    • verdadeiro: a capacidade deve ser exibida.
    • falso: a capacidade não deve aparecer.

    Tipo de dados: booliano
    result.flexible_services.flexible_service.​flexible_service.category Categoria do serviço flexível.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.category_label Rótulo da categoria do serviço flexível.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.cleanup_duration Quantidade de tempo necessária para limpar ou remover o serviço adicionado ao reservável.

    Tipo de dados: número

    Unidade: milissegundos
    result.flexible_services.flexible_service.​flexible_service.image Link para a imagem do serviço flexível.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.max_capacity Número máximo de ocupantes que o reservável pode acomodar.

    Tipo de dados: número
    result.flexible_services.flexible_service.​flexible_service.name Nome do serviço flexível.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.preparation_duration Quantidade de tempo necessária para adicionar o serviço ao reservável.

    Tipo de dados: cadeia de caracteres

    Unidade: milissegundos
    result.flexible_services.flexible_service.​flexible_service.price_per_unit Detalhes do custo de adição do serviço flexível ao reservável.

    Tipo de dados: objeto

    "price_per_unit": {
  "code": "String",
  "value": "String"
}
    result.flexible_services.flexible_service.​flexible_service.price_per_unit.code Código da moeda a ser usado ao calcular o custo, como GBP ou USD.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.price_per_unit.value Custo para cada unidade do serviço flexível na moeda definida no parâmetro do código.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.quantity_enabled Sinalizador que indica se o campo de quantidade deve aparecer na reserva. Se for definido como verdadeiro, capacity_enabled será sempre falso.
    Valores válidos:
    • verdadeiro: a quantidade deve ser exibida.
    • falso: a quantidade não deve aparecer.

    Tipo de dados: booliano
    result.flexible_services.flexible_service.​flexible_service.quantity_required Sinalizador que indica se a quantidade é necessária.
    Valores válidos:
    • verdadeiro: a quantidade é necessária.
    • falso: a quantidade não é necessária.

    Tipo de dados: booliano

    result.flexible_services.flexible_service.​flexible_service.short_description

    		 Breve descrição do serviço flexível.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.sub_category Nome da subcategoria do serviço flexível, comochair_layout.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.sub_category_label Rótulo de subcategoria do serviço flexível, como Layout da cadeira.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.sub_title Nome do subtítulo do serviço flexível secundário.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.sys_id Sys_id do serviço flexível.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.text Texto usado para solicitar que um usuário selecione serviços flexíveis.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.title Detalhes dos títulos a serem usados ao adicionar e editar o serviço flexível secundário na IU.

    Tipo de dados: objeto

    "title": {
  "add": "String",
  "edit": "String"
}
    result.flexible_services.flexible_service.​flexible_service.title.add Título usado ao adicionar um serviço flexível secundário na IU.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​flexible_service.title.edit Título usado ao editar um serviço flexível secundário na IU.

    Tipo de dados: cadeia de caracteres
    resultado.serviços_flexíveis.serviço_flexível.rótulo Rótulo de serviço flexível.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​sub_category Subcategoria dos serviços flexíveis primários, como cadeira adicional.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.​sub_title Nome do subtítulo do serviço flexível primário.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.text Texto usado para solicitar que um usuário selecione um serviço flexível primário.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.title Detalhes dos títulos a serem usados ao adicionar e editar o serviço flexível primário na IU.

    Tipo de dados: objeto

    "title": {
  "add": "String",
  "edit": "String"
}
    result.flexible_services.flexible_service.title.​adicionar Título usado ao adicionar um serviço flexível primário na IU.

    Tipo de dados: cadeia de caracteres
    result.flexible_services.flexible_service.title.​editar Título usado ao editar um serviço flexível primário na IU.

    Tipo de dados: cadeia de caracteres
    resultado.piso Detalhes sobre o piso em que o reservável está localizado.

    Localizado na tabela Piso [sn_wsd_core_payment].

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}
    resultado.piso.exibição_valor Exiba o número do andar no qual o reservável reside, como 12.

    Tipo de dados: cadeia de caracteres
    resultado.piso.sys_id Sys_id do registro associado na tabela Piso.

    Tipo de dados: cadeia de caracteres
    resultado.imagem Detalhes sobre uma imagem que representa o reservável associado.

    Localizado na tabela Imagens [db_image].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.image.link Link para uma imagem que representa o reservável.

    Tipo de dados: cadeia de caracteres
    result.image.sys_id Sys_id do registro de imagem associado.

    Tipo de dados: cadeia de caracteres
    resultado.é_reservável Sinalizador que indica se o serviço flexível pode ser reservado.
    Valores válidos:
    • verdadeiro: o serviço flexível pode ser reservado.
    • falso: o serviço flexível não pode ser reservado.

    Tipo de dados: booliano
    layouts.resultados Preenchido somente se o parâmetro include_layouts estiver definido como verdadeiro.

    Lista dos layouts associados ao reservável.

    Tipo de dados: matriz de objetos

    "layouts": [
  {
    "capacity": Number,
    "cleanup_duration": "String",
    "image": {Object},
    "is_default": Boolean,
    "max_capacity": Number,
    "name": "String",
    "preparation_duration": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    resultado.layouts.capacidade Número de pessoas que participarão da reunião.

    Tipo de dados: número
    resultado.layouts.cleanup_duration Quantidade de tempo necessária para limpar o reservável para este layout.

    Tipo de dados: número

    Unidade: milissegundos
    resultado.layouts.imagem Detalhes sobre uma imagem que representa o layout do reservável associado.

    Localizado na tabela Imagens [db_image].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.layouts.image.link Link para uma imagem que representa o layout deste reservável. Localizado na tabela Imagens [db_image].

    Tipo de dados: cadeia de caracteres
    resultado.layouts.image.sys_id Sys_id do registro de imagem associado.

    Tipo de dados: cadeia de caracteres
    resultado.layouts.é_padrão Sinalizador que indica se o layout associado é o padrão para o reservável.
    Valores válidos:
    • verdadeiro: padrão.
    • falso: não é padrão.

    Tipo de dados: booliano
    resultado.layouts.max_capacity Número máximo de pessoas que o layout associado ao reservável pode acomodar.

    Tipo de dados: número
    result.layouts.name Nome do layout do local.

    Tipo de dados: cadeia de caracteres
    resultado.layouts.preparação_duração Quantidade de tempo necessária para preparar o layout do local associado.

    Tipo de dados: número

    Unidade: milissegundos
    resultado.layouts.short_description Breve descrição do layout do local.

    Tipo de dados: cadeia de caracteres
    resultado.layouts.sys_id Sys_id do layout do local.

    Localizado na tabela Layout [sn_wsd_rsv_layout].

    Tipo de dados: cadeia de caracteres
    resultado.local_tipo Detalhes sobre o tipo de local do reservável, como local de trabalho/mesa, café ou academia.

    Localizado na tabela Tipo de espaço [sn_wsd_core_space_type].

    "location_type": {
  "display_value": "String",
  "sys_id": "String"
}
    result.location_type.display_value Exiba o valor do tipo de local.

    Tipo de dados: cadeia de caracteres
    result.location_type.sys_id Sys_id do registro associado na tabela Tipo de espaço [sn_wsd_core_space_type].

    Tipo de dados: cadeia de caracteres
    result.meetingProviders Detalhes sobre os provedores de reunião virtual associados ao reservável.

    Essas informações estão localizadas na tabela Provedor de reunião virtual [sn_wsd_rsv_virtual_meeting_provider].

    "meetingProviders": [
  {
    "display_value": "String",
    "value": "String"
  }
]
    result.meetingProviders.display_value Exiba o valor do nome do provedor virtual.

    Tipo de dados: cadeia de caracteres
    result.meetingProviders.value Valor real para o nome do provedor virtual no registro.

    Tipo de dados: cadeia de caracteres
    result.moduleType Módulo reservável associado ao reservável, como mesas ou sala de reunião.

    Tipo de dados: cadeia de caracteres
    result.name Nome do reservável.

    Tipo de dados: cadeia de caracteres
    número.resultado Identificador exclusivo do reservável. Este valor é mais legível do que o sys_id.

    Tipo de dados: cadeia de caracteres
    resultado.ordem Número do pedido do reservável.

    Tipo de dados: número
    result.require_approval Sinalizador que indica se a reserva do reservável requer uma aprovação.
    Valores possíveis:
    • verdadeiro: aprovação necessária.
    • false: a aprovação não é necessária.

    Tipo de dados: booliano
    result.requires_check_in Sinalizador que indica se o reservável requer que o usuário faça check-in.
    Valores válidos:
    • verdadeiro: check-in necessário.
    • false: o check-in não é necessário.

    Tipo de dados: booliano
    result.require_subject Sinalizador que indica se o usuário deve inserir um assunto ao fazer a reserva.
    Valores válidos:
    • verdadeiro: assunto obrigatório.
    • false: o assunto não é obrigatório.

    Tipo de dados: booliano
    resultado.quantidade_reservada Número máximo de vezes que o reservável associado pode ser reservado ao mesmo tempo. Este valor é usado ao atribuir espaços de bairro a uma área.

    Tipo de dados: inteiro
    resultado.site Detalhes sobre o site onde reside o reservável.

    Localizado na tabela Site [sn_wsd_core_site].

    "site": {
  "display_value": "String",
  "sys_id": "String"
}
    resultado.site.display_value Exiba o valor do site.

    Tipo de dados: cadeia de caracteres
    resultado.padrão_serviços Preenchido somente se o parâmetro include_standard_services estiver definido como verdadeiro.
    Serviços padrão associados, como bloco de listras, tela de projetor, quadro branco e marcadores.

    Tipo de dados: matriz de objetos

    "standard_services": [
  {
    "font_awesome_icon": "String",
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.standard_services.font_awesome_icon Nome do ícone de miniatura associado ao serviço padrão.

    Tipo de dados: cadeia de caracteres
    result.standard_services.name Nome do serviço padrão.

    Tipo de dados: cadeia de caracteres
    resultado.padrão_serviços.short_description Breve descrição do serviço padrão.

    Tipo de dados: cadeia de caracteres
    result.standard_services.sys_id Sys_id do registro de serviço padrão. Localizado na tabela Serviço padrão [sn_wsd_rsv_standard_service].

    Tipo de dados: cadeia de caracteres
    resultado.site.sys_id Sys_id do registro do site associado na tabela Site [sn_wsd_core_site].

    Tipo de dados: cadeia de caracteres
    result.tableName Nome da tabela na qual reside o registro reservável.

    Tipo de dados: cadeia de caracteres
    resultado.título Título do reservável.

    Tipo de dados: cadeia de caracteres
    resultado.tipo Tipo de um reservável, como local.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint para retornar detalhes sobre os reserváveis especificados.

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/v2/reservable/list_reservables" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"space_sys_ids\":\"3ed3139977220110b3d7be377b5a99d1\",\"reservable_module_sys_id\":\"c31241cedb7650106c731dcd13961917\",\"include_flexible_services\":true,\"include_standard_services\":true,\"include_reservable_purposes\":true,\"include_layouts\":false}" \
--user 'username:'password'

    Corpo da resposta. Este exemplo retorna detalhes sobre todos os reserváveis listados no corpo da solicitação.

    {
  "result": [
    {
      "sys_id": "3ed3139977220110b3d7be377b5a99d1",
      "external_id": "447b9dfb475a011064062782846d4382",
      "wsd_email": null,
      "name": "A263",
      "title": "A263",
      "description": null,
      "image": null,
      "number": "ROOM0000181",
      "site": {
        "sys_id": "b35f47ffdba05010f342a0da4b961998",
        "display_value": "Italy"
      },
      "campus": {
        "sys_id": "87831b1977220110b3d7be377b5a9946",
        "display_value": ""
      },
      "building": {
        "sys_id": "dea39b1977220110b3d7be377b5a9955",
        "display_value": "",
        "timezone": {
          "value": "",
          "displayValue": ""
        }
      },
      "floor": {
        "sys_id": "68d31f5977220110b3d7be377b5a991b",
        "display_value": ""
      },
      "area": null,
      "capacity": "17",
      "reservable_quantity": "1",
      "location_type": {
        "sys_id": "20713b83eb512010b89bfdfc9c522899",
        "display_value": "Room"
      },
      "order": null,
      "requires_check_in": null,
      "is_reservable": "1",
      "type": "location",
      "moduleType": "Meeting rooms",
      "meetingProviders": [],
      "require_subject": true,
      "allow_invitees": false,
      "display_number_of_attendees": false,
      "display_on_behalf_of": true,
      "display_sensitivity": true,
      "enable_group_reservations": false,
      "allow_reservation_message": false,
      "warn_employee_for_duplicate_reservation": false,
      "enable_reservation_privacy": false,
      "employee_override_privacy": false,
      "tableName": "sn_wsd_core_room",
      "require_approval": false,
      "flexible_services": [
        {
          "allow_only_single_service_item_selection": true,
          "category": "50723fbf07100110c9b36b6e0ad300b4",
          "label": "Space arrangement",
          "description": "This is a service to request a different space configuration as part of a reservation.",
          "sub_category": "chair_layout",
          "title": {
            "edit": "Update Space arrangement for A263",
            "add": "Add Space arrangement for A263"
          },
          "sub_title": "Add a space arrangement item to get started",
          "text": "Select space arrangement item",
          "additional_text": "Select another space arrangement item",
          "currency_code": "GBP",
          "flexible_service": [
            {
              "sub_category": "chair_layout",
              "label": "Chair layout",
              "flexible_service": [
                {
                  "sys_id": "e2ecf7b307500110c9b36b6e0ad30033",
                  "name": "Classroom Style",
                  "short_description": "Rows of tables arranged with all participants facing towards the front of the room",
                  "category": "50723fbf07100110c9b36b6e0ad300b4",
                  "category_label": "Space arrangement",
                  "sub_category": "chair_layout",
                  "sub_category_label": "Chair layout",
                  "image": "08d6ff68d5122110fa9b1500c1d696c5.iix",
                  "quantity_enabled": false,
                  "quantity_required": false,
                  "capacity_enabled": true,
                  "max_capacity": "",
                  "preparation_duration": "1970-01-01 00:15:00",
                  "cleanup_duration": "1970-01-01 00:15:00",
                  "price_per_unit": {
                    "value": 0,
                    "code": "GBP"
                  },
                  "title": {
                    "edit": "Update Space arrangement for A263",
                    "add": "Add Space arrangement for A263"
                  },
                  "sub_title": "Add a space arrangement item to get started",
                  "text": "Select space arrangement item",
                  "additional_text": "Select another space arrangement item"
                },
                {
                  "sys_id": "1cf33fff07100110c9b36b6e0ad30077",
                  "name": "Banquet Rounds",
                  "short_description": "Round tables arranged throughout the room. Participants are seated around the entire perimeter of each table",
                  "category": "50723fbf07100110c9b36b6e0ad300b4",
                  "category_label": "Space arrangement",
                  "sub_category": "chair_layout",
                  "sub_category_label": "Chair layout",
                  "image": "cdc67720d5522110fa9b1500c1d69636.iix",
                  "quantity_enabled": false,
                  "quantity_required": false,
                  "capacity_enabled": true,
                  "max_capacity": "",
                  "preparation_duration": "1970-01-01 00:15:00",
                  "cleanup_duration": "1970-01-01 00:15:00",
                  "price_per_unit": {
                    "value": 0,
                    "code": "GBP"
                  },
                  "title": {
                    "edit": "Update Space arrangement for A263",
                    "add": "Add Space arrangement for A263"
                  },
                  "sub_title": "Add a space arrangement item to get started",
                  "text": "Select space arrangement item",
                  "additional_text": "Select another space arrangement item"
                },
                {
                  "sys_id": "21e2c08407600110c9b36b6e0ad3007c",
                  "name": "Theater Style",
                  "short_description": "Rows of chairs (no tables) arranged with all participants facing towards the front of the room",
                  "category": "50723fbf07100110c9b36b6e0ad300b4",
                  "category_label": "Space arrangement",
                  "sub_category": "chair_layout",
                  "sub_category_label": "Chair layout",
                  "image": "f3d67fa4d5122110fa9b1500c1d6968b.iix",
                  "quantity_enabled": false,
                  "quantity_required": false,
                  "capacity_enabled": true,
                  "max_capacity": "",
                  "preparation_duration": "1970-01-01 00:15:00",
                  "cleanup_duration": "1970-01-01 00:15:00",
                  "price_per_unit": {
                    "value": 0,
                    "code": "GBP"
                  },
                  "title": {
                    "edit": "Update Space arrangement for A263",
                    "add": "Add Space arrangement for A263"
                  },
                  "sub_title": "Add a space arrangement item to get started",
                  "text": "Select space arrangement item",
                  "additional_text": "Select another space arrangement item"
                }
              ]
            }
          ]
        },
        {
          "allow_only_single_service_item_selection": false,
          "category": "c9ab1c89c3500110547e3810a840dd41",
          "label": "Catering",
          "description": "This is a service to request catering as part of a reservation.",
          "sub_category": "drinks",
          "title": {
            "edit": "Update Catering for A263",
            "add": "Add Catering for A263"
          },
          "sub_title": "Add a catering item to get started",
          "text": "Select catering item",
          "additional_text": "Select another catering item",
          "currency_code": "GBP",
          "flexible_service": [
            {
              "sub_category": "drinks",
              "label": "Drinks",
              "flexible_service": [
                {
                  "sys_id": "48d72985c3900110547e3810a840dd7d",
                  "name": "Champagne",
                  "short_description": "",
                  "category": "c9ab1c89c3500110547e3810a840dd41",
                  "category_label": "Catering",
                  "sub_category": "drinks",
                  "sub_category_label": "Drinks",
                  "image": "",
                  "quantity_enabled": true,
                  "quantity_required": false,
                  "capacity_enabled": false,
                  "max_capacity": "",
                  "preparation_duration": 0,
                  "cleanup_duration": 0,
                  "price_per_unit": {
                    "value": 0,
                    "code": "GBP"
                  },
                  "title": {
                    "edit": "Update Catering for A263",
                    "add": "Add Catering for A263"
                  },
                  "sub_title": "Add a catering item to get started",
                  "text": "Select catering item",
                  "additional_text": "Select another catering item"
                }
              ]
            }
          ]
        }
      ],
      "standard_services": [],
      "reservable_purposes": []
    }
  ]
}