API do módulo reservável do WSD

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 18 min. de leitura

    • . Prestação de serviços no local de trabalho(WSD) Módulo reservável A API fornece endpoints para recuperar detalhes de um módulo reservável de um ServiceNow instância.

    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 semelhantes do local de trabalho, como salas de reunião, salas de conferência e outras salas.

    Para acessar esta API, o solicitante deve ter a função sn_wsd_core.workplace_user e o plug-in Gestão de reservas do local de trabalho (sn_wsd_rsv) deve estar ativado. Esta API é executada no sn_wsd_rsv namespace.

    Para obter informações adicionais sobre Gestão de reservas do local de trabalho, consulte Workplace Reservation Management.

    Módulo reservável WSD - OBTER /sn_wsd_rsv/reservable_module/

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

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//reservable_module/ sys_id

    URL padrão: /api/sn_wsd_rsv/reservable_module/

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

    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 acessado. 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Módulo reservável [sn_wsd_rsv_reservable_module]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    _buildings_tree_data_required Sinalizador que indica se os dados de construção devem ser retornados associados ao modelo reservável.
    Valores válidos:
    • Verdadeiro: Retorna os dados do edifício.
    • Falso: 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_vizinhança) estiver ativado.

    Sys_id do registro de vizinhança a ser usado na consulta codificada.

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

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

    Tipo de dados: Cadeia de caracteres
    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    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/jsonou application/xml.

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    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
    resultados 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}
  }
}
    allow_invites Sinalizador que indica se os funcionários podem adicionar convidados à reserva.
    Valores válidos:
    • Verdadeiro: Permitir que os funcionários adicionem convidados à reserva.
    • Falso: Não permita que os funcionários adicionem convidados à reserva.

    Tipo de dados: Booliano
    allow_whole_day Sinalizador que indica se os usuários podem reservar o reservável para o dia inteiro.
    Valores válidos:
    • Verdadeiro: Permitir que os usuários reservem o dia inteiro.
    • Falso: Não permita que os usuários reservem para o dia inteiro.

    Tipo de dados: Booliano
    apply_to_shift Sinalizador que indica se as reservas baseadas em turno estão habilitadas para o módulo reservável.
    Valores válidos:
    • Verdadeiro: Permitir reservas baseadas em turno.
    • Falso: Não permitir reservas baseadas em turno.

    Tipo de dados: Booliano
    result.browse_by_area_enabled Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por área.
    Valores válidos:
    • Verdadeiro: Permitir que os usuários pesquisem módulos reserváveis por área.
    • Falso: Não permitir que os usuários pesquisem módulos reserváveis por área.

    Tipo de dados: Booliano
    result.browse_by_neighborhood_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: Permitir que os usuários pesquisem módulos reserváveis por bairro.
    • Falso: Não permita que os usuários pesquisem 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: Permitir que os usuários pesquisem módulos reserváveis próximos a uma pessoa.
    • Falso: Não permita que os usuários naveguem por módulos reserváveis próximos a uma pessoa.

    Tipo de dados: Booliano
    BuildingTreeData Retornado somente se is_buildings_tree_data_requiredo parâmetro de consulta está definido como verdadeiro . Hierarquia dos edifícios associados ao módulo reservável.
    Ordem de hierarquia:
    • Região: Localizado na tabela Região [sn_wsd_core_region].
    • Local: Localizado na tabela Site [sn_wsd_core_site].
    • Campus: Localizado na tabela Campus [sn_wsd_core_campus].
    • Edifício: Localizado na tabela Edifício [sn_wsd_core_building].
    Cada um secundários[ ] o nó reflete um nível/hierarquia de construção diferente:
    • BuildingsTreeData: Região
    • buildingsTreeData.children: Site
    • Campus buildingsTreeData.children.children:
    • buildingsTreeData.children.children.children: Edifício

    Tipo de dados: Matriz de objetos

    "buildingsTreeData": [
  {
    "children": [Array],
    "data": {Object},
    "isSelectable": Boolean,
    "isValid": Boolean,
    "label": "String",
    "uId": "String"
  }
]
    result.buildingsTreeData.children Detalhes sobre o local, campus ou edifício associado ao módulo reservável. Cada um dos parâmetros em Todos secundários[ ] os nós são os mesmos. Eles apenas se aplicam a diferentes entidades de construção 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 de construção.

    Tipo de dados: Objeto

    "data": {
  "sysId": "String",
  "table": "String",
  "timezone": {Object}
}
    result.buildingsTreeData.children.data.sys_id Sys_id da entidade de construção associada.

    Tipo de dados: Cadeia de caracteres
    result.buildingsTreeData.children.data.table Nome da tabela na qual o registro da entidade de construção identificado no sys_id está localizado.

    Tipo de dados: Cadeia de caracteres
    result.buildingsTreeData.children.data.​Fuso horário Detalhes sobre o fuso horário da entidade de edifício.
    "timezone": {
  "displayValue": "String",
  "value":  "String"
}
    result.buildingsTreeData.children.data.​Timezone.displayValue Valor de exibição no registro do fuso horário.

    Tipo de dados: Cadeia de caracteres
    result.buildingsTreeData.children.data.​Timezone.value Valor interno no registro do fuso horário.

    Tipo de dados: Cadeia de caracteres
    result.buildingsTreeData.children.isSelectable 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 criação está disponível para o módulo reservável.
    • Falso: A entidade de criação não está disponível para o módulo reservável.

    Tipo de dados: Booliano
    result.buildingsTreeData.children.isValid Sinalizador que indica se a entidade de edifício associada é válida para o modelo reservável.
    Valores válidos:
    • Verdadeiro: A entidade de criação é válida para o módulo reservável.
    • Falso: A entidade de criação não é válida para o módulo reservável.

    Tipo de dados: Booliano
    result.buildingsTreeData.children.label Nome da entidade de construção.

    Tipo de dados: Cadeia de caracteres
    result.buildingsTreeData.children.uId Sys_id do registro da entidade de construção associada.

    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
    result.checkin_before_minutes Tempo antes do início de uma reserva que um usuário pode fazer check-in em sua reserva.

    Unidade: Minutos

    Tipo de dados: Número
    display_number_of_attendentes 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_nome_of Sinalizador que indica se as reservas podem ser feitas em nome de outra pessoa.
    Valores válidos:
    • Verdadeiro: Em nome do compatível.
    • Falso: Em nome de não compatível.

    Tipo de dados: Booliano
    resultado.display_sensitivity Sinalizador que indica se os usuários podem definir a sensibilidade da reserva, como normal ou privado.
    Valores válidos:
    • Verdadeiro: Capaz de definir a sensibilidade.
    • Falso: Não é possível definir a sensibilidade. O padrão é Normal.

    Tipo de dados: Booliano
    result.display_value Valor de exibição do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    enable_browse_by_area Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por área. Igual a browse_by_area_enabled.
    Valores válidos:
    • Verdadeiro: Permitir que os usuários pesquisem módulos reserváveis por área.
    • Falso: Não permitir que os usuários pesquisem módulos reserváveis por área.

    Tipo de dados: Booliano
    enable_browse_by_neighborship Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por bairro.
    Valores válidos:
    • Verdadeiro: Permitir que os usuários pesquisem módulos reserváveis por bairro.
    • Falso: Não permita que os usuários pesquisem módulos reserváveis por bairro.

    Tipo de dados: Booliano
    enable_browse_next_a_person Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada. Igual a browse_near_a_person_enabled.
    Valores válidos:
    • Verdadeiro: Permitir que os usuários pesquisem módulos reserváveis próximos a uma pessoa.
    • Falso: Não permita que os usuários naveguem por módulos reserváveis próximos a uma pessoa.

    Tipo de dados: Booliano
    enable_aspect_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 que estão disponíveis no resultado da pesquisa gerado estão disponíveis para os usuários para seleção 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
    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
    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.
    • 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
    result.inline_title 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
    result.layout_mapping Detalhes sobre a estrutura do mapeamento de layout de locais. Use esses dados para organizar as informações na IU.

    Tipo de dados: Objeto

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

    Tipo de dados: Matriz de objetos

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

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

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

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

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

    Tipo de dados: Matriz
    result.layout_mapping.image Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Cadeia de caracteres
    result.layout_mapping.subtitle Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Matriz
    result.layout_mapping.subtitle_asc Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Matriz
    result.layout_mapping.title Espaço reservado para mapear os dados de IU de front-end.

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

    Tipo de dados: Número
    result.max_occurces 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. browse_by_neighborhood_enabledo parâmetro está definido como verdadeiro e neighborhoodo parâmetro é passado 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. browse_by_neighborhood_enabledo parâmetro está definido como verdadeiro e neighborhoodo parâmetro é passado 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"
  ]
}

    Tipo de dados: Matriz de objetos

    Tabela: Os registros associados ao sys_ids do edifício estão localizados na tabela Edifício [sn_wsd_core_building]. Os registros associados aos sys_ids do andar estão localizados na tabela Andar [sn_wsd_core_floor].
    NbhBuildingsTreeData Retornado somente se o plug-in Gestão de espaço estiver instalado, o. browse_by_neighborhood_enabledo parâmetro está definido como verdadeiro e neighborhoodo parâmetro é passado nos parâmetros de consulta.

    Hierarquia dos edifícios associada 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: Localizado na tabela Região [sn_wsd_core_region].
    • Local: Localizado na tabela Site [sn_wsd_core_site].
    • Campus: Localizado na tabela Campus [sn_wsd_core_campus].
    • Edifício: Localizado na tabela Edifício [sn_wsd_core_building].
    result.nbhBuildingsTreeData.children Descreve a hierarquia dos secundários associados ao edifício.
    Cada um secundários[] o nó reflete um nível/hierarquia de construção diferente:
    • BuildingsTreeData: Região
    • buildingsTreeData.children: Site
    • Campus buildingsTreeData.children.children:
    • buildingsTreeData.children.children.children: Edifício

    Tipo de dados: Matriz de objetos

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

    Os parâmetros em secundários[] as matrizes são iguais às do nbhBuildingsTreeDataobjeto, 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
    NbhBuildingsTreeData.data.table Tabela na qual o registro associado está localizado.

    Tipo de dados: Cadeia de caracteres
    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 do fuso horário a ser usado em uma interface do usuário.

    Tipo de dados: Cadeia de caracteres
    NbhBuildingsTreeData.data.timezone.value Valor de fuso horário interno.

    Tipo de dados: Cadeia de caracteres
    NbhBuildingsTreeData.isSelecioná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
    NbhBuildingsTreeData.isValid 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
    Result.nbhBuildingsTreeData.label 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
    override_approval_policy Opção para especificar como implementar a política de aprovação.
    Opções:
    • Nenhuma substituição: A política de aprovação é implementada conforme definido em Requer aprovação campo de um espaço ou sala de trabalho.
    • Sempre exigir aprovação: A política de aprovação é necessária independentemente do que está definido em Requer aprovação campo de um espaço ou sala de trabalho.
    • Nunca exigir aprovação: A política de aprovação é removida independentemente do que está definido em Requer aprovação l campo de um espaço ou sala de trabalho.

    Tipo de dados: Cadeia de caracteres
    require_cancel_notes Sinalizador que indica se os usuários devem inserir uma anotação de cancelamento antes de cancelar um módulo reservável.
    Valores válidos:
    • Observação de cancelamento necessária.
    • Nota de cancelamento não necessária.

    Tipo de dados: Booliano
    resultado.require_cc_dept_check Sinalizador que indica 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á incompatibilidade.
    • Falso: Não verifique se há 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.
    • Falso: O assunto não é necessário.

    Tipo de dados: Booliano
    result.reservable_columns Lista de colunas de um reservável.

    Tipo de dados: Matriz

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    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 na tabela reservável do campo.

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

    Tipo de dados: Cadeia de caracteres
    result.reservable_table Tabela que contém os itens reserváveis do local de trabalho.

    Tipo de dados: Cadeia de caracteres
    result.reservable_type 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.

    Tipo de dados: Objeto

    "reservable_views": {
  "iconClass": "String",
  "isDefault": Boolean,
  "label": "String",
  "order": Number,
  "type": "String"
}

    Tabela: Exibição reservável [sn_wsd_rsv_reservable_view]
    Result.reservable_views.iconClass Classe de í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: Torna o padrão.
    • Falso: Não torna o 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 inferior vem primeiro na IU. No caso do mesmo número de pedido, ele é atribuído a uma ordenação aleatória.

    Tipo de dados: Número
    result.reservable_views.type Nome de 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 Pesquisar tudo, Navegar próximo a uma pessoa.

    Tipo de dados: Matriz de objetos

    "reservation_paths": [
  {
    "displayValue": "String",
    "value": "String"
  }
]
    Result.reservation_paths.displayValue Valor de exibição do caminho de reserva, como "Navegar próximo a uma pessoa".

    Tipo de dados: Cadeia de caracteres
    result.reservation_paths.value Valor interno do caminho de reserva, como "browse_next_a_person".

    Tipo de dados: Cadeia de caracteres
    result.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
    result.selection_type

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

    Pode ser uma das seguintes opções:
    • Unidade específica: O resultado da pesquisa exibe cada item do local de trabalho.
    • Contêiner: O resultado da pesquisa exibe o primário ou 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
    show_map_view Sinalizador que indica se a exibição de mapa deve ser habilitada para módulos reserváveis.
    Valores válidos:
    • Verdadeiro: Habilitar exibição de mapa.
    • Falso: Não habilite a exibição de mapa.

    Tipo de dados: Booliano
    sys_id.result.sys_id Sys_id do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    Resultado.intervalos de tempo 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
    Result.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
    Result.timeslots.sys_id Sys_id do registro do intervalo de tempo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Intervalo de tempo [sn_wsd_rsv_time_slot]
    result.title 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 Valor de exibição 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"
  }
}