API do módulo reservável do WSD

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

    • A API do módulo reservável Workplace Service Delivery (WSD) recupera detalhes de um módulo reservável de uma instância ServiceNow.

    Um módulo reservável agrupa tipos semelhantes de itens do local de trabalho. Os funcionários podem exibir esses itens semelhantes em uma única categoria. Por exemplo, uma sala é um módulo reservável e contém itens de local de trabalho semelhantes, como salas de reunião, salas de conferência e outras salas.

    Para acessar essa API, o solicitante deve ter a função sn_wsd_core.workplace_user e o plug-in Workplace Reservation Management (sn_wsd_rsv) deve estar ativado. Esta API é executada no namespace sn_wsd_rsv.

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

    Módulo reservável do WSD - GET /sn_wsd_rsv/reservable_module/{sys_id}

    Retorna os detalhes de um módulo reservável especificado.

    Formato de URL

    URL com controle de versões: /api/sn_wsd_rsv/{api_version}/reservable_module/{sys_id}

    URL padrão: /api/sn_wsd_rsv/reservable_module/{sys_id}

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do registro do módulo reversível a ser recuperado. Localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module].

    Tipo de dados: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    is_buildings_tree_data_required Sinalizador que indica se os dados do edifício associados ao modelo reservável devem ser retornados.
    Valores válidos:
    • verdadeiro: retorna os dados do edifício.
    • false: não retorna os dados do edifício.

    Tipo de dados: booliano

    Padrão: falso
    bairro

    Disponível somente se o plug-in Gestão de espaço (sn_wsd_spc_mgmt_nível) estiver ativado.

    Sys_id do registro do bairro a ser usado na consulta codificada. Localizado na tabela Bairro [sn_wsd_spcmgmt_nível_nível].

    Para obter informações adicionais sobre reservas de espaço de bairro, consulte Create neighborhood reservations.

    O endpoint verifica se o bairro é válido e recupera os dados necessários para o caminho de navegação por bairro.

    Tipo de dados: cadeia de caracteres
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum

    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
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado(s) Detalhes do módulo reservável solicitado.

    Tipo de dados: objeto

    {
  "result": {
    "allow_invitees": Boolean,
    "allow_whole_day": Boolean,
    "apply_to_shift": Boolean,
    "browse_by_area_enabled": Boolean,
    "browse_by_neighborhood_enabled": Boolean,
    "browse_near_a_person_enabled": Boolean,
    "buildingsTreeData": [Array],
    "buildingSysIds": [Array],
    "checkin_before_minutes": Number,
    "display_number_of_attendees": Boolean,
    "display_on_behalf_of": Boolean,
    "display_sensitivity": Boolean,
    "display_value": "String",
    "enable_browse_by_area": Boolean,
    "enable_browse_by_neighborhood": Boolean,
    "enable_browse_near_a_person": Boolean,
    "enable_facet_filter": Boolean,
    "enable_group_reservations": Boolean,
    "enable_ical_generation": Boolean,
    "font_awesome_icon": "String",
    "inline_title": "String",      
    "layout_mapping": {JSON Object},
    "max_days_in_future": Number,
    "max_occurrences": Number,
    "name": "String",
    "nbhBuildingIds": [Array],
    "nbhBuildingsData": [Array];
    "nbhBuildingsTreeData": [Array],
    "override_approval_policy": "String",
    "require_cancel_notes": Boolean,
    "require_cc_dept_check": Boolean,
    "require_subject": Boolean,
    "reservable_columns": [Array],
    "reservable_container_field": "String",
    "reservable_filter": "String",
    "reservable_quantity_field": "String",
    "reservable_table": "String",
    "reservable_type": "String",
    "reservable_views": [Array],
    "reservation_paths": [Array],
    "search_limit": Number,
    "selection_type": "String",
    "short_description": "String",
    "show_map_view": Boolean,
    "sys_id": "String",
    "timeSlots": [Array],
    "title": "String",
    "virtual_meeting_provider": {Object}
  }
}
    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.allow_whole_day Sinalizador que indica se os usuários podem reservar o reservável para o dia inteiro.
    Valores válidos:
    • verdadeiro: permite que os usuários reservem o dia inteiro.
    • falso: não permita que os usuários reservem o dia inteiro.

    Tipo de dados: booliano
    resultado.aplicar_ao_turno Sinalizador que indica se as reservas baseadas em turno estão habilitadas para o módulo reservável.
    Valores válidos:
    • verdadeiro: permite reservas baseadas em turno.
    • falso: não permite reservas baseadas em turno.

    Tipo de dados: booliano
    resultado.navegar_por_área_enabled Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por área.
    Valores válidos:
    • verdadeiro: permite que os usuários procurem módulos reserváveis por área.
    • falso: não permite que os usuários procurem módulos reserváveis por área.

    Tipo de dados: booliano
    resultado.procurar_por_nível_enabled Disponível somente se o plug-in Gestão de espaço - sn_wsd_spc_mgmt estiver instalado.

    Sinalizador que indica se os usuários podem pesquisar nos módulos reserváveis por bairro.

    Valores válidos:
    • verdadeiro: permite que os usuários procurem módulos reserváveis por bairro.
    • falso: não permite que os usuários procurem módulos reserváveis por bairro.

    Tipo de dados: booliano
    result.browse_near_a_person_enabled Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada.
    Valores válidos:
    • verdadeiro: permite que os usuários procurem módulos reserváveis perto de uma pessoa.
    • falso: não permita que os usuários procurem módulos reserváveis perto de uma pessoa.

    Tipo de dados: booliano
    result.buildingTreeData Retornado somente se o parâmetro de consulta is_buildings_tree_data_required estiver definido como verdadeiro. Hierarquia dos edifícios associados ao módulo reservável.
    Ordem de hierarquia:
    • Região: localizada na tabela Região [sn_wsd_core_region].
    • Site: localizado na tabela Site [sn_wsd_core_site].
    • Campus: localizado na tabela Campus [sn_wsd_core_campus].
    • Prédio: localizado na tabela Prédio [sn_wsd_core_building].
    Cada nó secundário [ ] reflete um nível/hierarquia de edifício diferente:
    • buildingsTreeData: região
    • buildingsTreeData.children: local
    • buildingsTreeData.children.children: campus
    • edifíciosÁrvoreDeDados.crianças.crianças.crianças: edifício

    Tipo de dados: matriz de objetos

    "buildingsTreeData": [
  {
    "children": [Array],
    "data": {Object},
    "isSelectable": Boolean,
    "isValid": Boolean,
    "label": "String",
    "uId": "String"
  }
]
    resultado.edifíciosÁrvoreDados.secundários Detalhes sobre o local, campus ou edifício associado ao módulo reservável. Cada um dos parâmetros em todos os nós secundários [ ] são os mesmos. Eles se aplicam apenas a diferentes entidades de edifício e são descritos apenas uma vez nesta seção.

    Tipo de dados: matriz de objetos

    "children": [
  {
    "children": [Array],
    "data": {Object},
    "isSelectable": Boolean,
    "isValid": Boolean,
    "label": "String",
    "uId": "String"
  }
]
    result.buildingsTreeData.children.data Detalhes sobre a entidade do edifício.

    Tipo de dados: objeto

    "data": {
  "sysId": "String",
  "table": "String",
  "timezone": {Object}
}
    result.buildingsTreeData.children.data.sys_id Sys_id da entidade do edifício associada.

    Tipo de dados: cadeia de caracteres
    resultado.edifíciosÁrvoreDeDados.secundários.dados.tabela Nome da tabela na qual o registro da entidade do edifício identificado no sys_id está localizado.

    Tipo de dados: cadeia de caracteres
    resultado.edifíciosÁrvoreDeDados.secundários.dados.​fuso horário Detalhes sobre o fuso horário da entidade do edifício.
    "timezone": {
  "displayValue": "String",
  "value":  "String"
}
    result.buildingsTreeData.children.data.​timezone.displayValue Exiba o valor no registro para o fuso horário.

    Tipo de dados: cadeia de caracteres
    result.buildingsTreeData.children.data.​timezone.value Valor interno no registro para o fuso horário.

    Tipo de dados: cadeia de caracteres
    resultado.edifíciosÁrvoreDeDados.secundários.éSelecionável Sinalizador que indica se a entidade de edifício associada está disponível (selecionável) para o modelo reservável.
    Valores válidos:
    • verdadeiro: a entidade de edifício está disponível para o módulo reservável.
    • falso: a entidade de edifício não está disponível para o módulo reservável.

    Tipo de dados: booliano
    resultado.edifíciosÁrvoreDeDados.secundários.éValido Sinalizador que indica se a entidade de edifício associada é válida para o modelo reservável.
    Valores válidos:
    • verdadeiro: a entidade de edifício é válida para o módulo reservável.
    • falso: a entidade de edifício não é válida para o módulo reservável.

    Tipo de dados: booliano
    resultado.edifíciosÁrvoreDeDados.rótulo.secundário Nome da entidade do edifício.

    Tipo de dados: cadeia de caracteres
    result.buildingsTreeData.children.uId Sys_id do registro de entidade do edifício associado.

    Tipo de dados: cadeia de caracteres
    result.buildingSysIds Lista de sys_ids dos edifícios associados ao módulo reservável.

    Tipo de dados: matriz de cadeias de caracteres
    resultado.check-in_before_minutes Quantidade de tempo antes do início de uma reserva em que um usuário pode fazer check-in na reserva.

    Unidade: minutos

    Tipo de dados: número
    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.exibição_valor Exibe o valor do módulo reservável.

    Tipo de dados: cadeia de caracteres
    resultado.enable_browse_by_area Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por área. O mesmo que browse_by_area_enabled.
    Valores válidos:
    • verdadeiro: permite que os usuários procurem módulos reserváveis por área.
    • falso: não permite que os usuários procurem módulos reserváveis por área.

    Tipo de dados: booliano
    resultado.enable_browse_by_neast Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por bairro.
    Valores válidos:
    • verdadeiro: permite que os usuários procurem módulos reserváveis por bairro.
    • falso: não permite que os usuários procurem módulos reserváveis por bairro.

    Tipo de dados: booliano
    resultado.enable_browse_near_a_person Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada. O mesmo que browse_near_a_person_enabled.
    Valores válidos:
    • verdadeiro: permite que os usuários procurem módulos reserváveis perto de uma pessoa.
    • falso: não permita que os usuários procurem módulos reserváveis perto de uma pessoa.

    Tipo de dados: booliano
    resultado.enable_facet_filter Sinalizador que indica se a filtragem de aspecto em itens do local de trabalho está habilitada. Quando habilitadas, as opções de filtro exibidas são baseadas nos resultados da pesquisa. Somente os itens disponíveis no resultado da pesquisa gerado estão disponíveis para os usuários selecionarem no filtro.
    Valores válidos:
    • verdadeiro: os filtros de aspecto estão habilitados.
    • falso: os filtros de aspecto não estão habilitados.

    Tipo de dados: booliano
    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
    resultado.enable_ical_generation Sinalizador que indica se os usuários podem gerar um iCalendar para a reserva.
    Valores válidos:
    • verdadeiro: geração de iCalendar permitida.
    • falso: a geração de iCalendar não é permitida.

    Tipo de dados: booliano
    result.font_awesome_icon Nome do ícone de fonte anexado ao módulo reservável.

    Tipo de dados: cadeia de caracteres
    resultado.título_inline Título em linha do módulo reservável. O título aparece alinhado com o texto descritivo no portal de serviços do Workplace.

    Tipo de dados: cadeia de caracteres
    resultado.layout_mapping Detalhes sobre a estrutura do mapeamento de layout de locais. Use esses dados para exibir as informações na IU.

    Tipo de dados: objeto

    "layout_mapping": {
  "body": [Array],
  "description": [Array],
  "image": "String",
  "subtitle": [Array],
  "subtitle_asc": [Array],
  "title": [Array]
}
    resultado.layout_mapping.body Espaço reservado para mapear os dados da IU de front-end.

    Tipo de dados: matriz de objetos

    "body": [
  {
    "field": "String",
    "field_to_display": "String",
    "icon": "String",
    "label": "String"
  }
]
    resultado.layout_mapping.body.field Espaço reservado para mapear os dados da IU de front-end.

    Tipo de dados: cadeia de caracteres
    resultado.layout_mapping.body.field_to_display Espaço reservado para mapear os dados da IU de front-end.

    Tipo de dados: cadeia de caracteres
    resultado.layout_mapping.body.icon Espaço reservado para mapear os dados da IU de front-end.

    Tipo de dados: cadeia de caracteres
    resultado.layout_mapping.body.label Espaço reservado para mapear os dados da IU de front-end.

    Tipo de dados: cadeia de caracteres
    resultado.layout_mapping.description Espaço reservado para mapear os dados da IU de front-end. Descrição do mapeamento de layout.

    Tipo de dados: matriz
    resultado.layout_mapping.image Espaço reservado para mapear os dados da IU de front-end.

    Tipo de dados: cadeia de caracteres
    resultado.layout_mapping.subtitle Espaço reservado para mapear os dados da IU de front-end.

    Tipo de dados: matriz
    resultado.layout_mapping.subtitle_asc Espaço reservado para mapear os dados da IU de front-end.

    Tipo de dados: matriz
    resultado.layout_mapping.title Espaço reservado para mapear os dados da IU de front-end.

    Tipo de dados: matriz
    resultado.max_days_in_future Número máximo de dias no futuro em que um usuário pode reservar o módulo reservável.

    Tipo de dados: número
    result.max_occurrences Número máximo de ocorrências de reserva recorrentes se houver reservas recorrentes disponíveis para o módulo reservável.

    Tipo de dados: número
    result.name Nome do módulo reservável.

    Tipo de dados: cadeia de caracteres
    result.nbhBuildingIds Retornado somente se o plug-in Gestão de espaço estiver instalado, o parâmetro browse_by_neighborhood_enabled estiver definido como verdadeiroe o parâmetro neighborhood for aprovado nos parâmetros de consulta.

    Lista de sys_ids dos edifícios associados ao módulo reservável e configurados para o bairro.

    Tipo de dados: matriz de cadeias de caracteres
    result.nbhBuildingsData Retornado somente se o plug-in Gestão de espaço estiver instalado, o parâmetro browse_by_neighborhood_enabled estiver definido como verdadeiroe o parâmetro neighborhood for aprovado nos parâmetros de consulta.

    Lista de sys_ids dos edifícios associados ao módulo reservável e configurados para o bairro. Cada elemento de edifício também contém uma lista de sys_ids dos andares correspondentes disponíveis para o edifício.

    Por exemplo:

    "nbhBuildingsData": {
  "4703a4cedb3650106c731dcd13961945": [
    "0f9e304edb7650106c731dcd13961911"
  ],
  "6c0364cedb3650106c731dcd13961927": [
    "b23328cedb3650106c731dcd139619f9"
  ]
}

    Os registros associados ao edifício sys_ids estão localizados na tabela Edifício [sn_wsd_core_building]. Os registros associados ao piso sys_ids estão localizados na tabela Piso [sn_wsd_core_ ordem].

    Tipo de dados: matriz de objetos
    result.nbhBuildingsTreeData Retornado somente se o plug-in Gestão de espaço estiver instalado, o parâmetro browse_by_neighborhood_enabled estiver definido como verdadeiroe o parâmetro neighborhood for aprovado nos parâmetros de consulta.

    Hierarquia dos edifícios associados ao módulo reservável e ao bairro.

    Tipo de dados: matriz de objetos

    "buildingsTreeData": [
  {
    "children": [Array],
    "data": {Object},
    "isSelectable": Boolean,
    "isValid": Boolean,
    "label": "String",
    "uId": "String"
  }
]
    Ordem de hierarquia:
    • Região: localizada na tabela Região [sn_wsd_core_region].
    • Site: localizado na tabela Site [sn_wsd_core_site].
    • Campus: localizado na tabela Campus [sn_wsd_core_campus].
    • Prédio: localizado na tabela Prédio [sn_wsd_core_building].
    resultado.nbhEdifíciosÁrvoreDados.secundários Descreve a hierarquia dos secundários associados ao edifício.
    Cada nó secundário [] reflete um nível/hierarquia de edifício diferente:
    • buildingsTreeData: região
    • buildingsTreeData.children: local
    • buildingsTreeData.children.children: campus
    • edifíciosÁrvoreDeDados.crianças.crianças.crianças: edifício

    Tipo de dados: matriz

    "children": [
  {
    "children": [Array],
    "data": {Object},
    "isSelectable": Boolean,
    "isValid": Boolean,
    "label": "String",
    "uId": "String"
  }
]

    Os parâmetros na matriz filhos [] são os mesmos do objeto nbhBuildingsTreeData, apenas para o tipo de local associado; região, local, campus ou edifício.
    result.nbhBuildingsTreeData.data Detalhes sobre a entidade associada; região, local, campus ou edifício.

    Tipo de dados: objeto

    "data": {
  "sys_id": "String",
  "table": "String",
  "timezone": {Object}
}
    result.nbhBuildingsTreeData.data.sysId Sys_id do registro da entidade associada.

    Tipo de dados: cadeia de caracteres
    result.nbhBuildingsTreeData.data.table Tabela na qual o registro associado está localizado.

    Tipo de dados: cadeia de caracteres
    result.nbhBuildingsTreeData.data.timezone Informações sobre o fuso horário no qual a entidade associada reside.

    Tipo de dados: objeto

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    result.nbhBuildingsTreeData.data.timezone.displayValue Valor de fuso horário a ser usado em uma interface do usuário.

    Tipo de dados: cadeia de caracteres
    result.nbhBuildingsTreeData.data.timezone.value Valor do fuso horário interno.

    Tipo de dados: cadeia de caracteres
    result.nbhBuildingsÁrvoreDados.éSelecionável Sinalizador que indica se a entidade associada está disponível (selecionável) para o modelo reservável.
    Valores válidos:
    • verdadeiro: a entidade está disponível para o módulo reservável.
    • falso: a entidade não está disponível para o módulo reservável.

    Tipo de dados: booliano
    resultado.nbhConstruçõesÁrvoreDados.éValido Sinalizador que indica se a entidade associada é válida para o modelo reservável.
    Valores válidos:
    • verdadeiro: a entidade é válida para o módulo reservável.
    • falso: a entidade não é válida para o módulo reservável.

    Tipo de dados: booliano
    resultado.nbhEdifíciosÁrvoreDados.rótulo Nome da exibição reservável.

    Tipo de dados: cadeia de caracteres
    result.nbhBuildingsTreeData.uId Sys_id da entidade associada.

    Tipo de dados: cadeia de caracteres
    result.override_approval_policy Opção para especificar como implementar a política de aprovação. Estas são as opções:
    • Sem substituição: a política de aprovação é implementada conforme definido no campo Requer aprovação de um espaço ou sala do local de trabalho.
    • Sempre exigir aprovação: a política de aprovação é necessária, independentemente do que está definido no campo Requer aprovação de um espaço ou sala do local de trabalho.
    • Nunca exigir aprovação: a política de aprovação é removida independentemente do que está definido no campo Requer aprovaçãol de um espaço ou sala do local de trabalho.

    Tipo de dados: cadeia de caracteres
    result.require_cancel_notes Sinalizador que indica se os usuários devem inserir uma nota de cancelamento antes de cancelar um módulo reservável.
    Valores válidos:
    • verdadeiro: nota de cancelamento necessária.
    • falso: nota de cancelamento não necessária.

    Tipo de dados: booliano
    resultado.require_cc_dept_check Sinalizador que indica se deve ser verificado se há uma incompatibilidade de centro de custos ou departamento entre o item do espaço e o usuário conectado.
    Valores válidos:
    • verdadeiro: verifique se há uma incompatibilidade.
    • falso: não verifique se há uma incompatibilidade.

    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
    result.reservable_columns Lista das colunas de um reservável. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: matriz
    result.reservable_container_field Nível do contêiner, como um grupo de mesas em uma área específica.

    Tipo de dados: cadeia de caracteres
    result.reservable_filter Condições de filtro usadas para filtrar itens reserváveis na tabela reservável associada. A tabela reservável é um campo na tabela Módulo reservável [sn_wsd_rsv_reservable_module]. Essas condições de filtro foram aplicadas à tabela contida no campo Tabela reservável.

    Tipo de dados: cadeia de caracteres
    result.reservable_quantity_field Quantidade reservável de todos os espaços. A quantidade é usada ao atribuir espaços de bairro a uma área. Para obter informações adicionais, consulte Atribuir espaços de bairro a uma área.

    Tipo de dados: cadeia de caracteres
    resultado.reservável_tabela Tabela que contém os itens reserváveis do local de trabalho.

    Tipo de dados: cadeia de caracteres
    result.reservable_type Tipo do item reservável, como local.

    Tipo de dados: cadeia de caracteres
    result.reservable_views Detalhes sobre as diferentes exibições associadas ao módulo reservável, como exibição de cartão ou exibição de programação.

    Localizado na tabela Exibição reservável [sn_wsd_rsv_reservable_view].

    Tipo de dados: objeto

    "reservable_views": {
  "iconClass": "String",
  "isDefault": Boolean,
  "label": "String",
  "order": Number,
  "type": "String"
}
    result.reservable_views.iconClass Classe do ícone da exibição reservável.

    Tipo de dados: cadeia de caracteres
    result.reservable_views.isDefault Sinalizador que indica se esta exibição reservável deve ser o padrão para módulos reserváveis.
    Valores válidos:
    • verdadeiro: tornar padrão.
    • falso: não tornar padrão.

    Tipo de dados: booliano
    result.reservable_views.label Nome da exibição reservável.

    Tipo de dados: cadeia de caracteres
    result.reservable_views.order Ordem na qual as exibições são exibidas para o módulo reservável na IU. O número de ordem mais baixo vem primeiro na IU. No caso do mesmo número de ordem, ele é atribuído a uma ordem aleatória.

    Tipo de dados: número
    result.reservable_views.type Nome do back-end da exibição reservável. Usado para processamento interno.

    Tipo de dados: cadeia de caracteres
    result.reservation_paths Caminhos de reserva associados aos módulos reserváveis, como Procurar tudo, Procurar próximo a uma pessoa.

    Tipo de dados: matriz de objetos

    "reservation_paths": [
  {
    "displayValue": "String",
    "value": "String"
}
    result.reservation_paths.displayValue Exiba o valor do caminho da reserva, como "Procurar próximo a uma pessoa".

    Tipo de dados: cadeia de caracteres
    result.reservation_paths.value Valor interno para o caminho de reserva, como "browse_near_a_person".

    Tipo de dados: cadeia de caracteres
    resultado.search_limit Número máximo de resultados de pesquisa a serem retornados quando um usuário pesquisa um local de trabalho.

    Tipo de dados: número
    resultado.seleção_tipo

    Tipo de seleção a ser exibido nos resultados da pesquisa.

    Pode ser uma das seguintes opções:
    • Unidade específica: o resultado da pesquisa exibe todos os itens do local de trabalho.
    • Contêiner: o resultado da pesquisa exibe o primário ou o contêiner dos itens do local de trabalho.

    Tipo de dados: cadeia de caracteres
    resultado.short_description Breve descrição do módulo reservável.

    Tipo de dados: cadeia de caracteres
    resultado.mostrar_mapa_exibição Sinalizador que indica se a exibição do mapa deve ser habilitada para módulos reserváveis.
    Valores válidos:
    • verdadeiro: habilitar a exibição do mapa.
    • false: não habilita a exibição do mapa.

    Tipo de dados: booliano
    resultado.sys_id Sys_id do módulo reservável.

    Tipo de dados: cadeia de caracteres
    result.timeSlots Detalhes sobre os intervalos de tempo associados a um módulo reservável.

    Tipo de dados: matriz de objetos

    [
  {
    "name": "String",
    "short_description": "String",
    "slot_end": "String",
    "slot_start": "String",
    "sys_id": "String"
  }
]
    result.timeSlots.name Nome do intervalo de tempo.

    Tipo de dados: cadeia de caracteres
    resultado.timeSlots.short_description Breve descrição do intervalo de tempo.

    Tipo de dados: cadeia de caracteres
    resultado.timeSlots.slot_end Hora de término do intervalo de tempo.

    Tipo de dados: cadeia de caracteres
    resultado.timeSlots.slot_start Hora de início do slot.

    Tipo de dados: cadeia de caracteres
    resultado.timeSlots.sys_id Sys_id do registro do intervalo de tempo.

    Localizado na tabela Intervalo de tempo [sn_wsd_rsv_time_slot].

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

    Tipo de dados: cadeia de caracteres
    resultado.virtual_meeting_provider Detalhes sobre o provedor virtual associado ao módulo reservável.

    Tipo de dados: objeto

    "virtual_meeting_provider": {
  "display_value": "String",
  "sys_id": "String"
}
    resultado.virtual_meeting_provider.display_value Exiba o valor do provedor de reunião virtual.

    Tipo de dados: cadeia de caracteres
    resultado.virtual_meeting_provider.sys_id Sys_id do provedor de reunião virtual.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo de código mostra como solicitar um módulo reservável com os dados da árvore de edifícios.

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/reservable_module/5db44502dbb650106c731dcd13961937&is_buildings_tree_data_required=true" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Corpo da resposta:

    {
  "result": {
    "sys_id": "5db44502dbb650106c731dcd13961937", "name": "Desks",
    "title": "Desks",
    "inline_title": "desk",
    "font_awesome_icon": "fa-desktop",
    "reservable_table": "sn_wsd_core_space",
    "reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
    "short_description": "Reserve a single desks",
    "reservable_type": "location",
    "require_subject": null,
    "require_cancel_notes": false,
    "virtual_meeting_provider": {
      "sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
      "display_value": "Template"
    },
    "allow_invitees": null,
    "display_number_of_attendees": null,
    "display_on_behalf_of": null,
    "display_sensitivity": null,
    "max_days_in_future": "90",
    "allow_whole_day": "1",
    "selection_type": "unit",
    "reservable_container_field": null,
    "reservable_quantity_field": null,
    "apply_to_shift": null,
    "max_occurrences": "90",
    "enable_facet_filter": false,
    "search_limit": 10000,
    "enable_ical_generation": null,
    "enable_group_reservations": null,
    "enable_browse_near_a_person": "1",
    "enable_browse_by_area": "1",
    "enable_browse_by_neighborhood": "1",
    "show_map_view": false,
    "require_cc_dept_check": false,
    "display_value": "Desks",
    "browse_near_a_person_enabled": true,
    "browse_by_area_enabled": true,
    "browse_by_neighborhood_enabled": true,
    "reservable_columns": [
      "sys_id",
      "external_id",
      "email",
      "name",
      "title",
      "description",
      "image",
      "number",
      "site",
      "campus",
      "building",
      "floor",
      "area",
      "capacity",
      "reservable_quantity",
      "location_type",
      "order",
      "requires_check_in",
      "is_reservable"
    ],
    "layout_mapping": { 
      "title": [
        "name"
      ],
      "description": [ 
        "description"
      ],
      "subtitle": [
        "campus",
        "building",
        "floor",
        "area"
      ],
      "subtitle_asc": [
        "area",
        "floor",
        "building",
        "campus"
      ],
      "image": "image",
      "body": [
        {
          "label": "Capacity",
          "icon": "fa-users",
          "field": "capacity",
          "field_to_display": ""
        },
        {
          "label": "Standard services",
          "icon": "fa-check",
          "field": "standard_services",
          "field_to_display": "name"
        },
        {
          "label": "Reservable purposes",
          "icon": "fa-tags",
          "field": "reservable_purposes",
          "field_to_display": "name"
        }
      ]
    },
    "timeSlots": [
      {
        "sys_id": "d5331cf2dbb5f01038e42b24ca961906",
        "name": "All day",
        "short_description": "8am - 6pm",
        "slot_start": "08:00",
        "slot_end": "18:00"
      },
      {
        "sys_id": "de131cf2dbb5f01038e42b24ca961931",
        "name": "Before noon",
        "short_description": "8am - 12pm",
        "slot_start": "08:00",
        "slot_end": "12:00"
      },
      {
        "sys_id": "6e99ab5ddbb930102e8e853e68961929",
        "name": "After noon",
        "short_description": "1pm - 6pm",
        "slot_start": "13:00",
        "slot_end": "18:00"
      }
    ],
    "buildingSysIds": [
      "9e0364cedb3650106c731dcd1396192b"
    ],
    "buildingsTreeData": [
      {
        "isValid": true,
        "label": "Europe",
        "uId": "2d626c4edb3650106c731dcd1396194b",
        "isSelectable": false,
        "children": [
          {
            "isValid": true,
            "label": "Western Europe",
            "uId": "b17220cedb3650106c731dcd1396197a",
            "isSelectable": false,
            "children": [
              {
                "isValid": true,
                "label": "Amsterdam Campus",
                "uId": "44d2e0cedb3650106c731dcd13961988",
                "isSelectable": false,
                "children": [
                  {
                    "isValid": true,
                    "label": "AMS-B1",
                    "uId": "9e0364cedb3650106c731dcd1396192b",
                    "isSelectable": true,
                    "children": [],
                    "data": {
                      "sysId": "9e0364cedb3650106c731dcd1396192b",
                      "table": "sn_wsd_core_building",
                      "timezone": {
                        "value": "Europe/Amsterdam",
                        "displayValue": "Europe/Amsterdam"
                      }
                    }
                  }
                ],
                "data": {
                  "sysId": "44d2e0cedb3650106c731dcd13961988",
                  "table": "sn_wsd_core_campus",
                  "timezone": null
                }
              }
            ],
            "data": {
              "sysId": "b17220cedb3650106c731dcd1396197a",
              "table": "sn_wsd_core_site",
              "timezone": null
            }
          }
        ],
        "data": {
          "sysId": "2d626c4edb3650106c731dcd1396194b",
          "table": "sn_wsd_core_region",
          "timezone": null
        }
      }
    ],
    "reservable_views": [
      {
        "type": "card",
        "label": "Card view",
        "iconClass": "fa-th-large",
        "isDefault": true,
        "order": "1"
      },
      {
        "type": "schedule",
        "label": "Schedule view",
        "iconClass": "fa-calendar-o",
        "isDefault": false,
        "order": "2"
      }
    ],
    "checkin_before_minutes": 30,
    "reservation_paths": [
      {
        "value": "browse_all",
        "displayValue": "Browse all"
      },
      {
        "value": "browse_near_a_person",
        "displayValue": "Browse near a person"
      },
      {
        "value": "browse_by_area",
        "displayValue": "Browse by area"
      }
    ],
    "override_approval_policy": "never_required"
  }
}