API de reserva de WSD
. Prestação de serviços no local de trabalho(WSD) Reserva A API fornece endpoints para gerenciar reservas do local de trabalho.
Para acessar esta API, o solicitante deve ter a função sn_wsd_core.workplace_user e os plug-ins Gestão de segurança no local de trabalho (sn_wsd_core) e Gestão de reservas no local de trabalho (sn_wsd_rsv) devem estar ativados.
Esta API é executada no sn_wsd_rsv namespace.
Para obter informações adicionais sobre Gestão de reservas do local de trabalho, consulte Gestão de reservas do local de trabalho .
Reserva de WSD - OBTER /api/sn_wsd_rsv/reservation/get
Recupera a reserva do local de trabalho especificada.
Formato de URL
URL com controle de versão: /api/sn_wsd_rsv//reservation/get
URL padrão: /api/sn_wsd_rsv/reservation/get
Parâmetros de solicitação compatíveis
| 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 |
| Nome | Descrição |
|---|---|
| external_ical | Identificação externa exclusiva do iCalendar da reserva. Use este valor para identificar a reserva quando esta for uma reserva relacionada à sincronização de calendário. Obtenha este valor na aplicação iCalendar externa associada. Tipo de dados: Cadeia de caracteres |
| external_id | Identificação externa exclusiva da reserva. Use este valor para identificar a reserva quando esta for uma reserva relacionada à sincronização de calendário. Obtenha este valor da aplicação externa associada. Tipo de dados: Cadeia de caracteres |
| include_multi_child_data | Se o valor do campo reservation_subtipo no registro Reserva do local de trabalho associado [sn_wsd_rsv_reservation] estiver definido como MULTI_child, este sinalizador indicará se os detalhes da reserva devem ser retornados. Valores válidos:
Tipo de dados: Booliano Valor padrão: falso |
| include_standard_services | Sinalizador que indica se as informações de serviços padrão devem ser retornadas na resposta. Essas informações estão localizadas na tabela Serviço padrão [sn_wsd_rsv_standard_service]. Um serviço padrão descreve provisões básicas disponíveis com um item reservável do local de trabalho 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 . Valores válidos:
Tipo de dados: Booliano Padrão: falso |
| sys_id | Obrigatório. Sys_id do registro de reserva. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
| 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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xmlou, text/xml. Padrão: application/json |
| 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 .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 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
| Nome | Descrição |
|---|---|
| resultado.reserva | Detalhes sobre a reserva. Tipo de dados: Objeto |
| result.reservation.active | Sinalizador que indica se a reserva está ativa. Valores válidos:
Tipo de dados: Booliano |
| reservation.results | Lista de participantes da reserva. Tipo de dados: Matriz de objetos |
| resultado.reserva.participantes.avatar | Sys_id do avatar associado ao participante. Tipo de dados: Cadeia de caracteres Tabela: Anexos [sys_attachment] |
| Result.reservation.attendentes.displayValue | Valor de exibição do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendentes.display_value | Valor de exibição do participante. Igual a displayValue. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendees.email | Endereço de e-mail do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendees.initials | Iniciais do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendees.name | Nome do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendentes.sys_id | Sys_id do registro do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.participes.table | Tabela na qual o registro de participante existe. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendees.user_name | Nome de usuário do participante. Tipo de dados: Cadeia de caracteres |
| resultado.reserva.participantes.valor | Valor interno do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.check_in_state | Detalhes sobre o estado de check-in da reserva. Tipo de dados: Objeto |
| result.reservation.check_in_state.display_value | Valor de exibição do estado de check-in atual da reserva, como Em andamento ou Concluído. Tipo de dados: Cadeia de caracteres |
| result.reservation.check_in_state.value | Valor interno do estado de check-in atual da reserva, como 2. Tipo de dados: Cadeia de caracteres |
| result.reservation.edit_restriction | Descrição das restrições de edição do usuário para a reserva, como no_restrictions, service_only ou fully_restricted. Tipo de dados: Objeto |
| result.reservation.edit_restriction.display_value | Valor de exibição das restrições de edição da reserva, como Sem restrição . Tipo de dados: Cadeia de caracteres |
| result.reservation.edit_restriction.value | Valor interno para as restrições de edição da reserva, como no_restriction . Tipo de dados: Cadeia de caracteres |
| resultado.reservation.end | Data e hora de término da reserva. Tipo de dados: Cadeia de caracteres Formato: UTC: aaaa-MM-DDThh:mm:ssZ, como 2021-02-05T18:00:00Z |
| result.reservation.external_ical | Identificação externa exclusiva do iCalendar da reserva. Use este valor para identificar a reserva quando esta for uma reserva relacionada à sincronização de calendário. Tipo de dados: Cadeia de caracteres |
| result.reservation.external_id | Identificação externa exclusiva da reserva. Use este valor para identificar a reserva quando esta for uma reserva relacionada à sincronização de calendário. Tipo de dados: Cadeia de caracteres |
| result.reservation.is_parent | Sinalizador que indica se esta reserva é uma reserva primária. Valores possíveis:
Tipo de dados: Booliano |
| result.reservation.is_private | Sinalizador que indica se a reserva é privada. Se for privada, a reserva não aparecerá para ninguém, exceto o proprietário. Para obter informações adicionais sobre essas configurações de privacidade, consulte Configurações de privacidade do local e impacto . Valores válidos:
Tipo de dados: Booliano Valor definido para privacidade nas propriedades do sistema. |
| result.reservation.last_updated_sub_source | Detalhes sobre a última subfonte atualizada para a reserva. As suborigens são usadas ao integrar reservas com um calendário externo. Este objeto contém informações como "ServiceNow_workplace_service_delivery", "google_calendar" ou "microsoft_exchange". Tipo de dados: Objeto |
| result.reservation.last_updated_sub_source.display_value | Valor de exibição da última suborigem atualizada da reserva, como ServiceNow Workplace Service Delivery ou Google Agenda . Usado ao integrar a reserva com um serviço externo, como o Google Agenda ou o Microsoft Outlook. Tipo de dados: Cadeia de caracteres |
| result.reservation.last_updated_sub_source.valor | Valor interno da última subfonte atualizada da reserva, como servicenow_workplace_service_delivery ou google_calendar . Usado ao integrar a reserva com um serviço externo, como o Google Agenda ou o Microsoft Outlook. Tipo de dados: Cadeia de caracteres |
| result.reservation.location | Detalhes sobre o local associado à reserva. Tipo de dados: Objeto |
| result.reservation.location.area | Detalhes sobre a área associada ao local. Tipo de dados: Objeto |
| result.reservation.location.area.active | Sinalizador que indica se a área está ativa. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.area.display_value | Valor de exibição da área à qual este local pertence, como Mesa A2. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.area.sys_id | Sys_id da área à qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Área [sn_wsd_core_area] |
| result.reservation.location.building | Detalhes sobre o edifício associado ao local. Tipo de dados: Objeto |
| result.reservation.location.building.active | Sinalizador que indica se o edifício está ativo. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.building.display_value | Valor de exibição do edifício ao qual este local pertence, como AMS - BLD1. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.building.sys_id | Sys_id do edifício ao qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Criando [sn_wsd_core_building] |
| result.reservation.location.building.timezone | Detalhes sobre o fuso horário associado ao local. Tipo de dados: Objeto |
| result.reservation.location.building.timezone.display_value | Valor de exibição do fuso horário ao qual este local pertence. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.building.timezone.valor | Valor interno do fuso horário ao qual este local pertence. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.campus | Detalhes sobre o campus associado ao local. Tipo de dados: Objeto |
| result.reservation.location.campus.active | Sinalizador que indica se o campus está ativo. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.campus.display_value | Valor de exibição do campus ao qual este local pertence, como Campus de Amsterdã. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.campus.sys_id | Sys_id do campus ao qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Campus [sn_wsd_core_campus] |
| result.reservation.location.capacity | Número máximo de ocupantes do local. Tipo de dados: Número |
| result.reservation.location.description | Breve descrição do local. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.display_value | Valor a ser exibido na IU deste local. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.email | Endereço de e-mail do local. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.floor | Detalhes sobre o andar associado ao local. Tipo de dados: Objeto |
| result.reservation.location.floor.active | Sinalizador que indica se o andar está ativo. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.floor.display_value | Valor de exibição do andar ao qual este local pertence, como primeiro andar. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.floor.sys_id | Sys_id do andar ao qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Andar [sn_wsd_core_floor] |
| result.reservation.location.label_value | Tipo de valor especificado em nameParâmetro, como Nome da sala. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.name | Nome do local. Tipo de dados: Cadeia de caracteres |
| resultado.reservation.location.number | Número da reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.number_of_participantes | Número de participantes da reserva. Tipo de dados: Número |
| result.reservation.location.region | Detalhes sobre a região associada ao local. Tipo de dados: Objeto |
| result.reservation.location.region.active | Sinalizador que indica se a região está ativa. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.region.display_value | Valor de exibição da região à qual este local pertence, como Europa. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.region.sys_id | Sys_id da região à qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Região [sn_wsd_core_region] |
| result.reservation.location.requested_for | Detalhes sobre a pessoa para quem a reserva foi solicitada em nome. Tipo de dados: Objeto |
| result.reservation.location.requested_for.nome | Nome do usuário para o qual a reserva foi solicitada. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.requested_for.sys_id | Sys_id do usuário para o qual a reserva está sendo solicitada. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| result.reservation.location.requested_for.user_name | Nome de usuário para o qual a reserva foi solicitada. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservation | Detalhes sobre a reserva associada ao local. Tipo de dados: Objeto |
| result.reservation.location.reservation.active | Sinalizador que indica se a reserva está ativa. Valores válidos:
Tipo de dados: Booliano |
| resultado.reservation.location.reservation.number | Número da reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservation.number_of_attendentes | Número de participantes da reserva. Tipo de dados: Número |
| result.reservation.location.reservation.requested_for | Detalhes sobre a pessoa para quem a reserva foi solicitada em nome. Tipo de dados: Objeto |
| result.reservation.location.reservation.requested_for.name | Nome do usuário para o qual a reserva foi solicitada. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservation.requested_for.sys_id | Sys_id do usuário Solicitado para. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| result.reservation.location.reservation.requested_for.user_name | Nome de usuário para o qual a reserva foi solicitada. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservable_module | Detalhes sobre o módulo reservável associado à reserva. Tipo de dados: Objeto |
| result.reservation.location.reservable_module.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.reservable.location.reservable_module.nome | Nome do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservable_module.sys_id | Sys_id do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservable_module.título | Título do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.site | Site ao qual o local pertence. Tipo de dados: Objeto Tabela: Site [sn_wsd_core_site] |
| result.reservation.location.site.active | Sinalizador que indica se o site está ativo. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.site.display_value | Valor de exibição do site ao qual este local pertence, como Europa Ocidental. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.site.sys_id | Sys_id do site ao qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Site [sn_wsd_core_site] |
| result.reservation.location.state | Detalhes sobre o estado da reserva do local. Tipo de dados: Objeto |
| result.reservation.location.state.display_value | Valor de exibição do estado atual da reserva, como Confirmado. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.state.value | Valor interno do estado atual da reserva, como 2. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.sys_id | Sys_id do registro de local associado. Tipo de dados: Cadeia de caracteres Tabela: Local do local de trabalho [sn_wsd_core_workplace_location] |
| result.reservation.notification_custom_mensagem | Mensagem personalizada para a notificação enviada aos destinatários listados em reservation.notification_recipients. Tipo de dados: Cadeia de caracteres |
| result.reservation.notification_recipients | Lista de destinatários que recebem notificação sobre a reserva. Tipo de dados: Matriz de objetos |
| result.reservation.notification_recipients.name | Nome do destinatário. Tipo de dados: Cadeia de caracteres |
| result.reservation.notification_recipients.sys_id | Sys_id do destinatário. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| result.reservation.notification_recipients.user_name | Nome de usuário do destinatário. Tipo de dados: Cadeia de caracteres |
| número.reservation.result | Número exclusivo do registro de reserva. Você pode usar este valor para consultar a reserva. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
| result.reservation.opened_by | Detalhes sobre o usuário que criou a reserva. Tipo de dados: Objeto |
| result.reservation.opened_by.avatar | Avatar do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| Result.reservation.opened_by.displayValue | Valor de exibição do aberto pelo usuário. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.display_value | Valor de exibição do aberto pelo usuário. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.email | Endereço de e-mail do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.initials | Iniciais do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.label | Rótulo do usuário que abriu a reserva. Esta é uma combinação do título e do departamento do usuário. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.name | Nome do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| resultado.rservation.opened_by.sys_id | Sys_id_do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| resultado.rservation.opened_by.table | Tabela que contém o registro do usuário. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.user_name | Nome de usuário do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.value | Valor interno do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| número.reservation.result | Número da reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.number_of_attenes | Número de participantes nesta reserva. Tipo de dados: Número |
| result.reservation.recording_details | Detalhes sobre as gravações associadas à reserva (reunião). Tipo de dados: Matriz de objetos |
| recording_details.recording_details.recording_url | URL das gravações associadas à reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for | Detalhes sobre o usuário do qual a reserva foi feita em nome. Tipo de dados: Objeto |
| result.reservation.requested_for.avatar | Avatar do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| Result.reservation.requested_for.displayValue | Valor de exibição do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.display_value | Valor de exibição do usuário do qual a reserva foi feita em nome. Igual ao displayValue. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.email | Endereço de e-mail do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.initials | Iniciais do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.label | Rótulo do usuário para o qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.name | Nome do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| resultado.rservation.requested_for.sys_id | Sys_id_of do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| resultado.rservation.requested_for.table | Tabela que contém o registro do usuário. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.user_name | Nome de usuário do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.value | Valor interno do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservable_module | Detalhes do módulo reservável solicitado. Tipo de dados: Objeto |
| result.reservable_module.allow_invites | Sinalizador que indica se os funcionários podem adicionar convidados à reserva. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.allow_whole_day | Sinalizador que indica se os usuários podem reservar o reservável para o dia inteiro. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.apply_to_shift | Sinalizador que indica se as reservas baseadas em turno estão habilitadas para o módulo reservável. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.browse_by_area_enabled | Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por área. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.browse_next_a_person_enabled | Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada. Valores válidos:
Tipo de dados: Booliano |
| Result.reservable_module.BuildingSysIds | Lista de sys_ids dos edifícios associados ao módulo reservável. Tipo de dados: Matriz de cadeias de caracteres |
| result.reservable_module.check-in_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 |
| result.reservable_module.display_number_of_attendentes | Sinalizador que indica se os usuários podem especificar o número de participantes na reserva. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.display_on_beemend_of | Sinalizador que indica se as reservas podem ser feitas em nome de outra pessoa. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.display_sensitivity | Sinalizador que indica se os usuários podem definir a sensibilidade da reserva, como normal ou privado. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.display_value | Valor de exibição do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservable_module. 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:
Tipo de dados: Booliano |
| result.reservable_module. 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:
Tipo de dados: Booliano |
| result.reservable_module. 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:
Tipo de dados: Booliano |
| result.reservable_module. enable_group_reservations | Sinalizador que indica se os usuários podem fazer uma reserva de grupo. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module. enable_ical_generation | Sinalizador que indica se os usuários podem gerar um iCalendar para a reserva. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.font_awesome_icon | Nome do ícone de fonte anexado ao módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.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.reservable_module.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 |
| result.reservable_module.layout_mapping.body | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Matriz de objetos |
| result.reservable_module.layout_mapping.body.field | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.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.reservable_module.layout_mapping.body.icon | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.layout_mapping.body.label | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.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.reservable_module.layout_mapping.image | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.layout_mapping.subtitle | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Matriz |
| result.reservable_module.layout_mapping.subtitle_asc | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Matriz |
| result.reservable_module.layout_mapping.title | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Matriz |
| result.reservable_module.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.reservable_module.max_occurnces | 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.reservation.reservable_module.name | Nome do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.override_approval_policy | Opção para especificar como implementar a política de aprovação. Opções:
Tipo de dados: Cadeia de caracteres |
| result.reservable_module.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:
Tipo de dados: Booliano |
| result.reservable_module.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:
Tipo de dados: Booliano |
| result.reservable_module.require_subject | Sinalizador que indica se o usuário deve inserir um assunto ao fazer a reserva. Valores válidos:
Tipo de dados: Booliano |
| reservable_module.reservable_module.reservable_columns | Lista de colunas de um reservável. Tipo de dados: Matriz Tabela: Local do local de trabalho [sn_wsd_core_workplace_location] |
| reservable_module.reservable_module.reservable_container_field | Nível do contêiner, como um grupo de mesas em uma área específica. Tipo de dados: Cadeia de caracteres |
| reservable_module.reservable_module.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_module.reservable_module.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 |
| reservable_module.reservable_module.reservable_table | Tabela que contém os itens reserváveis do local de trabalho. Tipo de dados: Cadeia de caracteres |
| reservable_module.reservable.reservable_module. reservable_type | Item reservável, como local. Tipo de dados: Cadeia de caracteres |
| reservable_module.reservable_module.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 Tabela: Exibição reservável [sn_wsd_rsv_reservable_view] |
| Reservable_module.reservable.reservable_views.iconClass | Classe de ícone da exibição reservável. Tipo de dados: Cadeia de caracteres |
| Reservable_module.reservable.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:
Tipo de dados: Booliano |
| result.reservable_module. reservable_views.label | Nome da exibição reservável. Tipo de dados: Cadeia de caracteres |
| reservable_module.reservable_module.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 |
| reservable_module.reservable_module.reservable_views.type | Nome de back-end da exibição reservável. Usado para processamento interno. Tipo de dados: Cadeia de caracteres |
| result.reservable_module. 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 |
| result.reservable_module. reservation_paths.display_value | Valor de exibição do caminho de reserva, como "Navegar próximo a uma pessoa". Tipo de dados: Cadeia de caracteres |
| result.reservable_module. reservable_paths.value | Valor interno do caminho de reserva, como "browse_next_a_person". Tipo de dados: Cadeia de caracteres |
| result.reservable_module.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.reservable_module.selection_type | Tipo de seleção a ser exibida nos resultados da pesquisa. Pode ser uma das seguintes opções:
Tipo de dados: Cadeia de caracteres |
| result.reservable_module.short_description | Breve descrição do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.show_map_view | Sinalizador que indica se a exibição de mapa deve ser habilitada para módulos reserváveis. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.sys_id | Sys_id do módulo reservável. Tipo de dados: Cadeia de caracteres |
| Result.reservable_module.timesLots | Detalhes sobre os intervalos de tempo associados a um módulo reservável. Tipo de dados: Matriz de objetos |
| Result.reservable_module.timeSlots.name | Nome do intervalo de tempo. Tipo de dados: Cadeia de caracteres |
| Result.reservable_module.TimesLots.short_description | Breve descrição do intervalo de tempo. Tipo de dados: Cadeia de caracteres |
| Result.reservable_module.TimesLots.slot_end | Hora de término do intervalo de tempo. Tipo de dados: Cadeia de caracteres |
| Result.reservable_module.TimesLots.slot_start | Hora de início do slot. Tipo de dados: Cadeia de caracteres |
| Result.reservable_module.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.reservable_module.title | Título do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.virtual_meeting_provider | Detalhes sobre o provedor virtual associado ao módulo reservável. Tipo de dados: Objeto |
| result.reservable_module.virtual_meeting_provider.display_value | Valor de exibição do provedor de reunião virtual. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.virtual_meeting_provider.sys_id | Sys_id do provedor de reunião virtual. Tipo de dados: Cadeia de caracteres |
| ReservaçãoResultado.reservaçãoAcl | Detalhes das verificações de níveis de controle de acesso (ACL) do usuário definidas na reserva associada. Tipo de dados: Objeto |
| result.reservation.reservationAcl.read | Sinalizador que indica se o usuário pode ler esta reserva. Valores válidos:
Tipo de dados: Booliano |
| ReservationAcl.reservationAcl.write | Detalhes sobre os recursos de gravação do usuário para a reserva associada. Tipo de dados: Objeto |
| ReservationAcl.write.allFields | Sinalizador que indica se o usuário pode gravar em todos os campos especificados em reservationACL.write.fieldsobjeto. Se o usuário só tiver acesso a alguns campos específicos, somente esses campos serão verdadeiros em reservationACL.write.fieldsobjeto. Valores válidos:
Tipo de dados: Booliano |
| ReservationAcl.write.fields.result.reservation.reservationAcl | Detalhes dos controles de acesso em vários campos da reserva. Tipo de dados: Objeto |
| Result.reservationAcl.write.fields.Local | Sinalizador que indica se o usuário pode gravar nos campos de local nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.Number_of_attendentes | Sinalizador que indica se o usuário pode gravar nos campos Número de participantes nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.Requested_for | Sinalizador que indica se o usuário pode gravar nos campos Solicitado para nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.Sensibilidade | Sinalizador que indica se o usuário pode gravar nos campos de confidencialidade nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.Assunto | Sinalizador que indica se o usuário pode gravar nos campos de assunto nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.record | Sinalizador que indica se o usuário pode gravar todo o registro de reserva. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.reservation_purpose | Detalhes sobre a finalidade da reserva. Tipo de dados: Objeto |
| result.reservation.reservation_purpose.display_value | Valor de exibição para a finalidade da reserva, como Reunião da empresa. Tipo de dados: Cadeia de caracteres |
| result.reservation.reservation_purpose.value | Valor interno para a finalidade da reserva, como company_meeting. Tipo de dados: Cadeia de caracteres |
| result.reservation.reservation_type | Detalhes sobre o tipo de reserva. Tipo de dados: Objeto |
| result.reservation.reservation_type.display_value | Valor de exibição do tipo de reserva, como Espaço. Tipo de dados: Cadeia de caracteres |
| result.reservation.reservation_type.value | Valor interno para o tipo de reserva, como espaço. Tipo de dados: Cadeia de caracteres |
| result.reservation.reservation_subtipo | Detalhes sobre o subtipo da reserva. Os subtipos indicam o tipo de reserva, como único, vários primários, vários secundários, primário recorrente, ou ocorrência. Tipo de dados: Objeto |
| result.reservation.reservation_subtipo.display_value | Valor de exibição do subtipo da reserva, como Simples. Tipo de dados: Cadeia de caracteres |
| result.reservation.reservation_subtype.value | Valor interno para o subtipo da reserva, como único. Tipo de dados: Cadeia de caracteres |
| result.reservation.sensitivity | Detalhes sobre a confidencialidade da reserva. Tipo de dados: Objeto |
| result.reservation.sensitivity.display_value | Valor de exibição da sensibilidade da reserva, como alto ou baixo. Tipo de dados: Cadeia de caracteres |
| result.reservation.sensitivity.value | Valor interno para a sensibilidade da reserva, como 1 ou 3. Tipo de dados: Cadeia de caracteres |
| resultado.reservation.turno | Detalhes sobre o turno aplicado à reserva. Tipo de dados: Objeto |
| result.reservation.shift.display_value | Valor de exibição do turno. Tipo de dados: Cadeia de caracteres |
| result.reservation.shift.name | Nome do turno. Igual a display_value. Tipo de dados: Cadeia de caracteres |
| Result.reservation.shift.shiftDetails | Detalhes do turno. Tipo de dados: Cadeia de caracteres |
| result.reservation.shift.sys_id | Sys_id do registro de turno. Tipo de dados: Cadeia de caracteres Tabela: Shift [sn_wsd_core_shift] |
| result.reservation.source | Detalhes sobre a origem da reserva, como Serviços do local de trabalho ou Google Mail. Tipo de dados: Objeto |
| result.reservation.source.display_value | Valor de exibição da origem da reserva, como Serviços do local de trabalho. Tipo de dados: Cadeia de caracteres |
| result.reservation.source.value | Valor interno da origem da reserva, como serviceNow. Tipo de dados: Cadeia de caracteres |
| result.reservation.source_icon | Detalhes sobre a origem do ícone usado na reserva. Este ícone é usado na IU. Tipo de dados: Objeto |
| Result.reservation.source_icon.classNames | Nomes de classe separados por vírgulas para o ícone de origem. Tipo de dados: Cadeia de caracteres |
| Result.reservation.source_icon.imgSrc | Nome da origem da imagem para o ícone de origem. Este ícone é armazenado na tabela Imagens [db_image]. Tipo de dados: Cadeia de caracteres |
| result.reservation.source_icon.tooltip | Dica de ferramenta associada ao ícone de origem. Tipo de dados: Cadeia de caracteres |
| result.reservation.source_reservation | Reserva de origem da reserva atual. Por exemplo, no caso de várias reservas, a reserva primária é a origem da reserva secundária. Tipo de dados: Cadeia de caracteres |
| resultado.reservation.start | Data e hora de início da reserva. Tipo de dados: Cadeia de caracteres Formato: UTC - aaaa-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z |
| resultado.reservation.assunto | Assunto da reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.sub_source | Detalhes sobre a suborigem da reserva. A suborigem especifica de onde a reserva se originou, como Google Agenda ou Microsoft Exchange. Tipo de dados: Objeto |
| result.reservation.sub_source.display_value | Valor de exibição da suborigem da reserva, como Google Agenda. Tipo de dados: Cadeia de caracteres |
| result.reservation.sub_source.value | Valor interno do campo de suborigem da reserva, como google_calendar. Tipo de dados: Cadeia de caracteres |
| result.reservation.sync_state | Detalhes sobre o estado de sincronização de uma reserva de outro serviço, como "sync_enfileied" ou "Synchronized". Tipo de dados: Objeto |
| result.reservation.sync_state.display_value | Valor de exibição do estado de sincronização atual da reserva, como Sincronizado. Tipo de dados: Cadeia de caracteres |
| result.reservation.sync_state.value | Valor interno do estado de sincronização atual da reserva, como Sincronizado. Tipo de dados: Cadeia de caracteres |
| result.reservation.sys_created_on | Data e hora em que a reserva foi criada. Tipo de dados: Cadeia de caracteres |
| result.reservation.sys_id | Obrigatório. Sys_id do registro de reserva. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
| Result.reservation.sys_updated_on | Data e hora em que a reserva foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres |
| result.reservation.virtual_meeting | URL do link da reunião virtual. Tipo de dados: Cadeia de caracteres |
| Result.reservationAcl | Detalhes das verificações de níveis de controle de acesso (ACL) do usuário definidas na reserva associada. Tipo de dados: Objeto |
| result.reservationAcl.read | Sinalizador que indica se o usuário pode ler esta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write | Detalhes sobre os recursos de gravação do usuário para a reserva associada. Tipo de dados: Objeto |
| Result.reservationAcl.write.allFields | Sinalizador que indica se o usuário pode gravar em todos os campos especificados em reservationACL.write.fieldsobjeto. Se o usuário só tiver acesso a alguns campos específicos, somente esses campos serão verdadeiros em reservationACL.write.fieldsobjeto. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields | Detalhes dos controles de acesso em vários campos da reserva. Tipo de dados: Objeto |
| Result.reservationAcl.write.fields.location | Sinalizador que indica se o usuário pode gravar nos campos de local nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.Number_of_attendentes | Sinalizador que indica se o usuário pode gravar nos campos Número de participantes nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.requested_for | Sinalizador que indica se o usuário pode gravar nos campos Solicitado para nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| result.reservationAcl.write.fields.sensitivity | Sinalizador que indica se o usuário pode gravar nos campos de confidencialidade nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.subject | Sinalizador que indica se o usuário pode gravar nos campos de assunto nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.record | Sinalizador que indica se o usuário pode gravar todo o registro de reserva. Valores válidos:
Tipo de dados: Booliano |
| result.standard_services | Preenchido somente se include_standard_serviceso parâmetro está definido como verdadeiro. Serviços padrão associados, como flipchart, tela de projetor, quadro branco e marcadores. Tipo de dados: Matriz de objetos
|
| 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 |
| result.standard_services.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. Tipo de dados: Cadeia de caracteres Tabela: Serviço padrão [sn_wsd_rsv_standard_service] |
Solicitação de curl
O exemplo de código a seguir mostra como chamar este endpoint e incluir as informações de serviços padrão.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/get?sys_id=8e87c722870741106342b846dabb3573&include_standard_services=true" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Resultados de retorno:
"result": {
"reservation": {
"sys_id": "bf3621de842c2110fa9b813be354f327",
"number": "WRES0001005",
"location": {
"sys_id": "9841e94adb7210106c731dcd13961914",
"name": "A1-02-02",
"description": "General desk available for reservation.",
"display_value": "A1-02-02",
"capacity": 1,
"label_value": "Workspace/Desk name",
"wsd_email": null,
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk",
"table": "sn_wsd_core_space"
},
"region": {
"sys_id": "3752ac8edb3650106c731dcd139619e0",
"display_value": "Americas",
"active": true
},
"site": {
"sys_id": "628eec06db7650106c731dcd139619dd",
"display_value": "North America",
"active": true
},
"campus": {
"sys_id": "82b2a0cedb3650106c731dcd139619e9",
"display_value": "California Campus",
"active": true
},
"building": {
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"active": true,
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"floor": {
"sys_id": "fc7368cedb3650106c731dcd13961902",
"display_value": "Floor 1",
"active": true
},
"area": {
"sys_id": "",
"display_value": "",
"active": false
},
"is_favorite": false,
"reservation": {
"sys_id": "bf3621de842c2110fa9b813be354f327",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"auto_conflict_resolution_state": {
"value": null,
"display_value": null
},
"requested_for": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"name": "System Administrator",
"user_name": "admin"
},
"number": "WRES0001005",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001005",
"requested_for": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"name": "System Administrator",
"user_name": "admin"
},
"is_private": true
},
"start": "2023-01-24T16:00:00Z",
"end": "2023-01-24T17:00:00Z",
"sys_created_on": "2023-01-24T15:49:49Z",
"sys_updated_on": "2023-01-24T15:49:50Z",
"source_reservation": null,
"check_in_state": {
"value": "awaiting_check_in",
"display_value": "Awaiting check-in"
},
"external_id": null,
"external_ical": null,
"building": {
"active": true,
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"campus": {
"display_value": "California Campus",
"value": "82b2a0cedb3650106c731dcd139619e9",
"active": true
},
"site": {
"display_value": "North America",
"value": "628eec06db7650106c731dcd139619dd",
"active": true
},
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"active": true,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"sensitivity": {
"value": "normal",
"display_value": "Normal"
},
"reservation_type": {
"value": "space",
"display_value": "Space"
},
"reservation_subtype": {
"value": "single",
"display_value": "Single"
},
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"attendees": [
{
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
}
],
"number_of_attendees": 1,
"is_parent": false,
"is_private": true,
"subject": "Reservation for A1-02-02",
"virtual_meeting": null,
"recording_details": [],
"sync_state": {
"value": "not_required",
"display_value": "Synchronization not required"
},
"sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"last_updated_sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"reservable_module": {
"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": null,
"enable_reservation_privacy": true,
"allow_invitees": "1",
"display_number_of_attendees": null,
"display_on_behalf_of": "1",
"display_sensitivity": null,
"max_days_in_future": "90",
"allow_recurring": "1",
"auto_resolve_conflict": null,
"allow_whole_day": "1",
"allow_multi_building": "1",
"require_whole_day": null,
"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_floor_search": null,
"enable_browse_by_neighborhood": null,
"require_cc_dept_check": false,
"display_value": "Desks",
"browse_near_a_person_enabled": true,
"browse_by_area_enabled": true,
"browse_by_neighborhood_enabled": false,
"reservable_columns": [
"sys_id",
"external_id",
"wsd_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": [
"03c45bf7dba41010d7981dcd1396196d",
"07c45bf7dba41010d7981dcd1396196b",
"07c45bf7dba41010d7981dcd13961972",
"0bc45bf7dba41010d7981dcd13961970",
"0fc45bf7dba41010d7981dcd1396196e",
"1aa39b1977220110b3d7be377b5a9953",
"2130659ae7321010809a268b03f6a91e",
"22c41bf7dba41010d7981dcd139619fe",
"2ac45bf7dba41010d7981dcd13961901",
"2ec41bf7dba41010d7981dcd139619ff",
"32c45bf7dba41010d7981dcd13961905",
"32c45bf7dba41010d7981dcd1396190c",
"32c45bf7dba41010d7981dcd13961943",
"e2c41bf7dba41010d7981dcd139619fb"
],
"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",
"availableFor": true
},
{
"value": "browse_favorites",
"displayValue": "Browse favorites",
"availableFor": false
},
{
"value": "browse_near_a_person",
"displayValue": "Browse near a person",
"availableFor": true
},
{
"value": "browse_by_area",
"displayValue": "Browse by area",
"availableFor": true
}
],
"override_approval_policy": "never_required"
},
"notification_recipients": null,
"notification_custom_message": null,
"opened_by": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
},
"requested_for": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
},
"auto_conflict_resolution_state": {
"value": null,
"display_value": null
},
"parent_reservation": {},
"edit_restriction": {
"value": "no_restriction",
"display_value": "No restriction"
},
"source": {
"value": "servicenow",
"display_value": "Workplace Services"
},
"source_icon": {
"classNames": "fa fa-calendar-check-o",
"tooltip": "Reservation is confirmed",
"imgSrc": ""
},
"shift": null,
"hasPrivateReservation": true,
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true,
"is_private": true
},
"allFields": true
},
"read": true
}
},
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true,
"is_private": true
},
"allFields": true
},
"read": true
}
}
}
Reserva de WSD - OBTER /api/sn_wsd_rsv/reservation/get_user_reservations
Recupera a lista de reservas de um usuário especificado para os próximos sete dias.
Formato de URL
URL com controle de versão: /api/sn_wsd_rsv//reservation/get_user_reservations
URL padrão: /api/sn_wsd_rsv/reservation/get_user_reservations
Parâmetros de solicitação compatíveis
| 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 |
| Nome | Descrição |
|---|---|
| userId | Sys_id do usuário cujas reservas serão retornadas. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| 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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xmlou, text/xml. Padrão: application/json |
| 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 .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 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
| Nome | Descrição |
|---|---|
| resultado | Resultados de retorno da reserva. Tipo de dados: Objeto |
| result.informEmployeePrivacy | Sinalizador que indica se uma mensagem deve ser exibida quando são retornadas reservas marcadas como privadas. Valores possíveis:
Tipo de dados: Booliano |
| Result.reservationsByDate | Detalhes sobre cada reserva por data. Objeto - Cada data em sua própria matriz |
| Result.reservationsByDate.building | Edifício onde o reservável está localizado. Tipo de dados: Objeto Tabela: Criando [sn_wsd_core_building] |
| Result.reservationsByDate.building.Display_value | Valor de exibição do edifício. Tipo de dados: Cadeia de caracteres |
| Result.reservationsByDate.building.sys_id | Sys_id do registro de edifício associado. Tipo de dados: Cadeia de caracteres |
| Result.reservationsByDate.building.timezone | Detalhes do fuso horário do edifício. Tipo de dados: Objeto |
| Result.reservationsByDate.building.timezone.Display_value | Valor de exibição do fuso horário no qual o edifício associado reside. Tipo de dados: Cadeia de caracteres |
| Result.reservationsByDate.building.timezone.Sys_id | Sys_id do registro de fuso horário no qual o edifício associado reside. Tipo de dados: Cadeia de caracteres |
| Result.reservationsByDate.building.value | Valor interno do edifício. Tipo de dados: Cadeia de caracteres |
| Result.reservationsPorDate.andar | Detalhes sobre o andar associado à reserva. Tipo de dados: Objeto |
| Result.reservationsPorDate.floor.displayValue | Número de exibição do andar em que o reservável reside, como 12. Tipo de dados: Cadeia de caracteres |
| Result.reservationsPorDate.floor.value | Valor interno do andar no qual a reserva reside. Tipo de dados: Cadeia de caracteres |
| Result.reservationsPorDate.location | Detalhes sobre o local da reserva. Tipo de dados: Objeto |
| Result.reservationsByDate.location.DisplayValue | Valor de exibição do local, como South Parks. Tipo de dados: Cadeia de caracteres |
| Result.reservationsPorDate.location.type | Tipo de local, como local de trabalho/mesa, café ou academia. Tipo de dados: Cadeia de caracteres |
| Result.reservationsPorDate.location.value | Valor interno do local, como south_parks. Tipo de dados: Cadeia de caracteres |
| result.searchEndDate | Data de término da pesquisa de reserva. Sete dias a partir da data de início. Formato: aaaa-MM-dd Tipo de dados: Cadeia de caracteres |
| result.searchStartDate | Data de início da pesquisa de reserva. Data em que o endpoint foi chamado. Formato: aaaa-MM-dd Tipo de dados: Cadeia de caracteres |
| Result.SortedReservationDates | Datas em que o usuário especificado tem reservas para os próximos sete dias, classificadas em ordem de datas. Tipo de dados: Matriz |
| Result.WorkplaceProfile | Perfil do local de trabalho dos usuários. Descreve onde o usuário especificado trabalha. Tipo de dados: Objeto |
| WorkplaceProfile.building | Edifício onde o usuário trabalha. Tipo de dados: Objeto Tabela: Criando [sn_wsd_core_building] |
| WorkplaceProfile.building.display_value | Valor de exibição do edifício. Tipo de dados: Cadeia de caracteres |
| WorkplaceProfile.building.sys_id | Sys_id do registro de edifício associado. Tipo de dados: Cadeia de caracteres |
| WorkplaceProfile.building.timezone | Detalhes do fuso horário do edifício. Tipo de dados: Objeto |
| WorkplaceProfile.building.timezone.Display_value | Valor de exibição do fuso horário no qual o edifício associado reside. Tipo de dados: Cadeia de caracteres |
| WorkplaceProfile.building.timezone.Sys_id | Sys_id do registro de fuso horário no qual o edifício associado reside. Tipo de dados: Cadeia de caracteres |
| WorkplaceProfile.building.value | Valor interno do edifício. Tipo de dados: Cadeia de caracteres |
| WorkplaceProfile.floor | Detalhes sobre o andar em que o usuário trabalha. Tipo de dados: Objeto |
| Result.workplaceProfile.floor.displayValue | Número de exibição do andar em que o usuário trabalha, como Andar 8. Tipo de dados: Cadeia de caracteres |
| WorkplaceProfile.floor.value | Valor interno do andar no qual o usuário trabalha. Tipo de dados: Cadeia de caracteres |
| WorkplaceProfile.location | Detalhes sobre o local do usuário. Tipo de dados: Objeto |
| Result.workplaceProfile.location.displayValue | Valor de exibição do local, como San Diego. Tipo de dados: Cadeia de caracteres |
| WorkplaceProfile.location.type | Tipo de local, como mesa ou escritório. Tipo de dados: Cadeia de caracteres |
| WorkplaceProfile.location.value | Valor interno do local, como san_diego. Tipo de dados: Cadeia de caracteres |
Solicitação de curl
O exemplo de código a seguir mostra como chamar este endpoint.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/get_user_reservations?userId=2de07e1887cb89106342b846dabb35fe" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Resultados de retorno:
{
"result": {
"sortedReservationDates": [
"2023-01-24"
],
"workplaceProfile": {
"location": {
"displayValue": "DDC-A2.0016A",
"value": "96d3139977220110b3d7be377b5a9918",
"externalId": "0e7bddfb475a011064062782846d43c2",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 2",
"value": "68d31f5977220110b3d7be377b5a991b"
},
"building": {
"displayValue": "Building A",
"value": "dea39b1977220110b3d7be377b5a9955",
"timezone": {
"value": "Europe/Paris",
"displayValue": "Europe/Paris"
}
}
},
"reservationsByDate": {
"2023-01-24": [
{
"location": {
"displayValue": "A1-02-04",
"value": "3e41e94adb7210106c731dcd1396198c",
"externalId": "",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 1",
"value": "fc7368cedb3650106c731dcd13961902"
},
"building": {
"displayValue": "CAL-B1",
"value": "94e264cedb3650106c731dcd13961919",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
}
},
{
"location": {
"displayValue": "A1-02-02",
"value": "9841e94adb7210106c731dcd13961914",
"externalId": "",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 1",
"value": "fc7368cedb3650106c731dcd13961902"
},
"building": {
"displayValue": "CAL-B1",
"value": "94e264cedb3650106c731dcd13961919",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
}
},
{
"location": {
"displayValue": "A1-02-03",
"value": "fd41a94adb7210106c731dcd1396195a",
"externalId": "",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 1",
"value": "fc7368cedb3650106c731dcd13961902"
},
"building": {
"displayValue": "CAL-B1",
"value": "94e264cedb3650106c731dcd13961919",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
}
}
]
},
"searchStartDate": "2023-01-24",
"searchEndDate": "2023-01-31",
"informEmployeePrivacy": true
}
}
Reserva de WSD - OBTER /api/sn_wsd_rsv/reservation/icalendar/
Gera um corpo de arquivo iCalendar para uma reserva especificada.
Formato de URL
URL com controle de versão: /api/sn_wsd_rsv//reservation/icalendar/ sys_id
URL padrão: /api/sn_wsd_rsv/reservation/icalendar/
Parâmetros de solicitação compatíveis
| 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 da reserva para a qual gerar um corpo de arquivo iCalendar. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| 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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xmlou, text/xml. Padrão: application/json |
| 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 .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 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
| Nome | Descrição |
|---|---|
| resultado | Corpo do arquivo iCalendar para a reserva especificada. Tipo de dados: Cadeia de caracteres |
Solicitação de curl
O exemplo de código a seguir mostra como chamar este endpoint para criar um corpo do iCalender.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/icalendar/60d26a0f47578910003a4587746d4331" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Resultados de retorno:
{
"result": "BEGIN:VCALENDAR\nPRODID:-//Service-now.com//Outlook 11.0 MIMEDIR//EN\nVERSION:2.0\nMETHOD:REQUEST\nBEGIN:VEVENT\nATTENDEE;ROLE=REQ-PARTICIPANT;RSVP=TRUE:MAILTO:workplace_user@example.com\nDTSTART:20220521T050000Z\nDTEND:20220521T060000Z\nUID:60d26a0f47578910003a4587746d4331\nDTSTAMP:20220511T044018Z\nSUMMARY:For user 1\nDESCRIPTION:Dear System Administrator,\\n\\nThank you for your reservation.\\n\\nYou can find more details on your reservation, or manage your reservation using the following link: https://damay2.service-now.com/ws?id=wsd_reservation_summary&reservation_id=60d26a0f47578910003a4587746d4331\\n\\nKind regards,\\nWorkplace Services Team\nLOCATION:Berlin\nCLASS:PUBLIC\nORGANIZER;CN=Workplace User:MAILTO:workplace_user@example.com\nATTENDEE;ROLE=REQ-PARTICIPANT;CN=Workplace User:RSVP=TRUE:MAILTO:workplace_user@example.com\nEND:VEVENT\nEND:VCALENDAR"
}
Reserva de WSD - OBTER /api/sn_wsd_rsv/reservation/list
Recupera a lista de reservas pertencentes a um usuário especificado.
Este endpoint retorna somente reservas que foram solicitadas ou abertas pelo usuário especificado.
Formato de URL
URL com controle de versão: /api/sn_wsd_rsv//reservation/list
URL padrão: /api/sn_wsd_rsv/reservation/list
Parâmetros de solicitação compatíveis
| 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 |
| Nome | Descrição |
|---|---|
| encodedQuery | Consulta codificada a ser usada para filtrar os resultados do registro de reserva retornados. Todos os campos na tabela Reserva do local de trabalho [sn_wsd_rsv_reservation] são válidos na consulta. Por exemplo, Tipo de dados: Cadeia de caracteres |
| endIndex | Último registro de reserva no conjunto de resultados a ser retornado ao especificar índices para paginação. Se este valor for maior do que o número disponível de registros de resultados de retorno, todos os registros restantes serão retornados. Tipo de dados: Número |
| OrderPorEndDesc | Sinalizador que indica se os resultados de retorno devem ser retornados em ordem decrescente da hora de início. Valores válidos:
Padrão: falso |
| PesquisarCritérios | Texto que precisa corresponder à reserva para que seja incluído nos resultados de retorno. O endpoint verifica esse valor nos seguintes campos:
Tipo de dados: Cadeia de caracteres |
| startIndex | Registro inicial para o qual retornar registros, com base em zero. Use este parâmetro para paginar grandes conjuntos de registros. Tipo de dados: Cadeia de caracteres Padrão: 0 |
| userId | Sys_id de um usuário para filtrar as informações de reserva retornadas. Quando esse valor é passado, o endpoint filtra as reservas em que o campo requested_for ou opened_by é igual ao usuário conectado no momento. Dessa lista de reserva, ele filtra as reservas em que requested_for ou opened_by é igual ao passado userId. Tipo de dados: Cadeia de caracteres Padrão: Retorna todas as reservas em que os campos requested_for ou opened_by são iguais ao usuário conectado no momento. Tabela: Usuário [sys_user] |
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xmlou, text/xml. Padrão: application/json |
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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json |
| 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 .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 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
| Nome | Descrição |
|---|---|
| resultado.reserva | Detalhes sobre a reserva. Tipo de dados: Objeto |
| result.reservation.active | Sinalizador que indica se a reserva está ativa. Valores válidos:
Tipo de dados: Booliano |
| reservation.results | Lista de participantes da reserva. Tipo de dados: Matriz de objetos |
| resultado.reserva.participantes.avatar | Sys_id do avatar associado ao participante. Tipo de dados: Cadeia de caracteres Tabela: Anexos [sys_attachment] |
| Result.reservation.attendentes.displayValue | Valor de exibição do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendentes.display_value | Valor de exibição do participante. Igual a displayValue. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendees.email | Endereço de e-mail do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendees.initials | Iniciais do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendees.name | Nome do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendentes.sys_id | Sys_id do registro do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.participes.table | Tabela na qual o registro de participante existe. Tipo de dados: Cadeia de caracteres |
| result.reservation.attendees.user_name | Nome de usuário do participante. Tipo de dados: Cadeia de caracteres |
| resultado.reserva.participantes.valor | Valor interno do participante. Tipo de dados: Cadeia de caracteres |
| result.reservation.check_in_state | Detalhes sobre o estado de check-in da reserva. Tipo de dados: Objeto |
| result.reservation.check_in_state.display_value | Valor de exibição do estado de check-in atual da reserva, como Em andamento ou Concluído. Tipo de dados: Cadeia de caracteres |
| result.reservation.check_in_state.value | Valor interno do estado de check-in atual da reserva, como 2. Tipo de dados: Cadeia de caracteres |
| result.reservation.edit_restriction | Descrição das restrições de edição do usuário para a reserva, como no_restrictions, service_only ou fully_restricted. Tipo de dados: Objeto |
| result.reservation.edit_restriction.display_value | Valor de exibição das restrições de edição da reserva, como Sem restrição . Tipo de dados: Cadeia de caracteres |
| result.reservation.edit_restriction.value | Valor interno para as restrições de edição da reserva, como no_restriction . Tipo de dados: Cadeia de caracteres |
| resultado.reservation.end | Data e hora de término da reserva. Tipo de dados: Cadeia de caracteres Formato: UTC: aaaa-MM-DDThh:mm:ssZ, como 2021-02-05T18:00:00Z |
| result.reservation.external_ical | Identificação externa exclusiva do iCalendar da reserva. Use este valor para identificar a reserva quando esta for uma reserva relacionada à sincronização de calendário. Tipo de dados: Cadeia de caracteres |
| result.reservation.external_id | Identificação externa exclusiva da reserva. Use este valor para identificar a reserva quando esta for uma reserva relacionada à sincronização de calendário. Tipo de dados: Cadeia de caracteres |
| result.reservation.is_parent | Sinalizador que indica se esta reserva é uma reserva primária. Valores possíveis:
Tipo de dados: Booliano |
| result.reservation.is_private | Sinalizador que indica se a reserva é privada. Se for privada, a reserva não aparecerá para ninguém, exceto o proprietário. Para obter informações adicionais sobre essas configurações de privacidade, consulte Configurações de privacidade do local e impacto . Valores válidos:
Tipo de dados: Booliano Valor definido para privacidade nas propriedades do sistema. |
| result.reservation.last_updated_sub_source | Detalhes sobre a última subfonte atualizada para a reserva. As suborigens são usadas ao integrar reservas com um calendário externo. Este objeto contém informações como "ServiceNow_workplace_service_delivery", "google_calendar" ou "microsoft_exchange". Tipo de dados: Objeto |
| result.reservation.last_updated_sub_source.display_value | Valor de exibição da última suborigem atualizada da reserva, como ServiceNow Workplace Service Delivery ou Google Agenda . Usado ao integrar a reserva com um serviço externo, como o Google Agenda ou o Microsoft Outlook. Tipo de dados: Cadeia de caracteres |
| result.reservation.last_updated_sub_source.valor | Valor interno da última subfonte atualizada da reserva, como servicenow_workplace_service_delivery ou google_calendar . Usado ao integrar a reserva com um serviço externo, como o Google Agenda ou o Microsoft Outlook. Tipo de dados: Cadeia de caracteres |
| result.reservation.location | Detalhes sobre o local associado à reserva. Tipo de dados: Objeto |
| result.reservation.location.area | Detalhes sobre a área associada ao local. Tipo de dados: Objeto |
| result.reservation.location.area.active | Sinalizador que indica se a área está ativa. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.area.display_value | Valor de exibição da área à qual este local pertence, como Mesa A2. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.area.sys_id | Sys_id da área à qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Área [sn_wsd_core_area] |
| result.reservation.location.building | Detalhes sobre o edifício associado ao local. Tipo de dados: Objeto |
| result.reservation.location.building.active | Sinalizador que indica se o edifício está ativo. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.building.display_value | Valor de exibição do edifício ao qual este local pertence, como AMS - BLD1. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.building.sys_id | Sys_id do edifício ao qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Criando [sn_wsd_core_building] |
| result.reservation.location.building.timezone | Detalhes sobre o fuso horário associado ao local. Tipo de dados: Objeto |
| result.reservation.location.building.timezone.display_value | Valor de exibição do fuso horário ao qual este local pertence. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.building.timezone.valor | Valor interno do fuso horário ao qual este local pertence. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.campus | Detalhes sobre o campus associado ao local. Tipo de dados: Objeto |
| result.reservation.location.campus.active | Sinalizador que indica se o campus está ativo. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.campus.display_value | Valor de exibição do campus ao qual este local pertence, como Campus de Amsterdã. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.campus.sys_id | Sys_id do campus ao qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Campus [sn_wsd_core_campus] |
| result.reservation.location.capacity | Número máximo de ocupantes do local. Tipo de dados: Número |
| result.reservation.location.description | Breve descrição do local. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.display_value | Valor a ser exibido na IU deste local. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.email | Endereço de e-mail do local. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.floor | Detalhes sobre o andar associado ao local. Tipo de dados: Objeto |
| result.reservation.location.floor.active | Sinalizador que indica se o andar está ativo. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.floor.display_value | Valor de exibição do andar ao qual este local pertence, como primeiro andar. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.floor.sys_id | Sys_id do andar ao qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Andar [sn_wsd_core_floor] |
| result.reservation.location.label_value | Tipo de valor especificado em nameParâmetro, como Nome da sala. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.name | Nome do local. Tipo de dados: Cadeia de caracteres |
| resultado.reservation.location.number | Número da reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.number_of_participantes | Número de participantes da reserva. Tipo de dados: Número |
| result.reservation.location.region | Detalhes sobre a região associada ao local. Tipo de dados: Objeto |
| result.reservation.location.region.active | Sinalizador que indica se a região está ativa. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.region.display_value | Valor de exibição da região à qual este local pertence, como Europa. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.region.sys_id | Sys_id da região à qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Região [sn_wsd_core_region] |
| result.reservation.location.requested_for | Detalhes sobre a pessoa para quem a reserva foi solicitada em nome. Tipo de dados: Objeto |
| result.reservation.location.requested_for.nome | Nome do usuário para o qual a reserva foi solicitada. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.requested_for.sys_id | Sys_id do usuário para o qual a reserva está sendo solicitada. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| result.reservation.location.requested_for.user_name | Nome de usuário para o qual a reserva foi solicitada. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservation | Detalhes sobre a reserva associada ao local. Tipo de dados: Objeto |
| result.reservation.location.reservation.active | Sinalizador que indica se a reserva está ativa. Valores válidos:
Tipo de dados: Booliano |
| resultado.reservation.location.reservation.number | Número da reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservation.number_of_attendentes | Número de participantes da reserva. Tipo de dados: Número |
| result.reservation.location.reservation.requested_for | Detalhes sobre a pessoa para quem a reserva foi solicitada em nome. Tipo de dados: Objeto |
| result.reservation.location.reservation.requested_for.name | Nome do usuário para o qual a reserva foi solicitada. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservation.requested_for.sys_id | Sys_id do usuário Solicitado para. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| result.reservation.location.reservation.requested_for.user_name | Nome de usuário para o qual a reserva foi solicitada. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservable_module | Detalhes sobre o módulo reservável associado à reserva. Tipo de dados: Objeto |
| result.reservation.location.reservable_module.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.reservable.location.reservable_module.nome | Nome do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservable_module.sys_id | Sys_id do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.reservable_module.título | Título do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.site | Site ao qual o local pertence. Tipo de dados: Objeto Tabela: Site [sn_wsd_core_site] |
| result.reservation.location.site.active | Sinalizador que indica se o site está ativo. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.location.site.display_value | Valor de exibição do site ao qual este local pertence, como Europa Ocidental. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.site.sys_id | Sys_id do site ao qual este local pertence. Tipo de dados: Cadeia de caracteres Tabela: Site [sn_wsd_core_site] |
| result.reservation.location.state | Detalhes sobre o estado da reserva do local. Tipo de dados: Objeto |
| result.reservation.location.state.display_value | Valor de exibição do estado atual da reserva, como Confirmado. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.state.value | Valor interno do estado atual da reserva, como 2. Tipo de dados: Cadeia de caracteres |
| result.reservation.location.sys_id | Sys_id do registro de local associado. Tipo de dados: Cadeia de caracteres Tabela: Local do local de trabalho [sn_wsd_core_workplace_location] |
| result.reservation.notification_custom_mensagem | Mensagem personalizada para a notificação enviada aos destinatários listados em reservation.notification_recipients. Tipo de dados: Cadeia de caracteres |
| result.reservation.notification_recipients | Lista de destinatários que recebem notificação sobre a reserva. Tipo de dados: Matriz de objetos |
| result.reservation.notification_recipients.name | Nome do destinatário. Tipo de dados: Cadeia de caracteres |
| result.reservation.notification_recipients.sys_id | Sys_id do destinatário. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| result.reservation.notification_recipients.user_name | Nome de usuário do destinatário. Tipo de dados: Cadeia de caracteres |
| número.reservation.result | Número exclusivo do registro de reserva. Você pode usar este valor para consultar a reserva. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
| result.reservation.opened_by | Detalhes sobre o usuário que criou a reserva. Tipo de dados: Objeto |
| result.reservation.opened_by.avatar | Avatar do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| Result.reservation.opened_by.displayValue | Valor de exibição do aberto pelo usuário. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.display_value | Valor de exibição do aberto pelo usuário. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.email | Endereço de e-mail do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.initials | Iniciais do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.label | Rótulo do usuário que abriu a reserva. Esta é uma combinação do título e do departamento do usuário. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.name | Nome do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| resultado.rservation.opened_by.sys_id | Sys_id_do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| resultado.rservation.opened_by.table | Tabela que contém o registro do usuário. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.user_name | Nome de usuário do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.opened_by.value | Valor interno do usuário que abriu a reserva. Tipo de dados: Cadeia de caracteres |
| número.reservation.result | Número da reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.number_of_attenes | Número de participantes nesta reserva. Tipo de dados: Número |
| result.reservation.recording_details | Detalhes sobre as gravações associadas à reserva (reunião). Tipo de dados: Matriz de objetos |
| recording_details.recording_details.recording_url | URL das gravações associadas à reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for | Detalhes sobre o usuário do qual a reserva foi feita em nome. Tipo de dados: Objeto |
| result.reservation.requested_for.avatar | Avatar do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| Result.reservation.requested_for.displayValue | Valor de exibição do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.display_value | Valor de exibição do usuário do qual a reserva foi feita em nome. Igual ao displayValue. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.email | Endereço de e-mail do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.initials | Iniciais do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.label | Rótulo do usuário para o qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.name | Nome do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| resultado.rservation.requested_for.sys_id | Sys_id_of do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| resultado.rservation.requested_for.table | Tabela que contém o registro do usuário. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.user_name | Nome de usuário do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservation.requested_for.value | Valor interno do usuário do qual a reserva foi feita em nome. Tipo de dados: Cadeia de caracteres |
| result.reservable_module | Detalhes do módulo reservável solicitado. Tipo de dados: Objeto |
| result.reservable_module.allow_invites | Sinalizador que indica se os funcionários podem adicionar convidados à reserva. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.allow_whole_day | Sinalizador que indica se os usuários podem reservar o reservável para o dia inteiro. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.apply_to_shift | Sinalizador que indica se as reservas baseadas em turno estão habilitadas para o módulo reservável. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.browse_by_area_enabled | Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por área. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.browse_next_a_person_enabled | Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada. Valores válidos:
Tipo de dados: Booliano |
| Result.reservable_module.BuildingSysIds | Lista de sys_ids dos edifícios associados ao módulo reservável. Tipo de dados: Matriz de cadeias de caracteres |
| result.reservable_module.check-in_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 |
| result.reservable_module.display_number_of_attendentes | Sinalizador que indica se os usuários podem especificar o número de participantes na reserva. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.display_on_beemend_of | Sinalizador que indica se as reservas podem ser feitas em nome de outra pessoa. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.display_sensitivity | Sinalizador que indica se os usuários podem definir a sensibilidade da reserva, como normal ou privado. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.display_value | Valor de exibição do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservable_module. 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:
Tipo de dados: Booliano |
| result.reservable_module. 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:
Tipo de dados: Booliano |
| result.reservable_module. 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:
Tipo de dados: Booliano |
| result.reservable_module. enable_group_reservations | Sinalizador que indica se os usuários podem fazer uma reserva de grupo. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module. enable_ical_generation | Sinalizador que indica se os usuários podem gerar um iCalendar para a reserva. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.font_awesome_icon | Nome do ícone de fonte anexado ao módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.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.reservable_module.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 |
| result.reservable_module.layout_mapping.body | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Matriz de objetos |
| result.reservable_module.layout_mapping.body.field | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.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.reservable_module.layout_mapping.body.icon | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.layout_mapping.body.label | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.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.reservable_module.layout_mapping.image | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.layout_mapping.subtitle | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Matriz |
| result.reservable_module.layout_mapping.subtitle_asc | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Matriz |
| result.reservable_module.layout_mapping.title | Espaço reservado para mapear os dados de IU de front-end. Tipo de dados: Matriz |
| result.reservable_module.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.reservable_module.max_occurnces | 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.reservation.reservable_module.name | Nome do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.override_approval_policy | Opção para especificar como implementar a política de aprovação. Opções:
Tipo de dados: Cadeia de caracteres |
| result.reservable_module.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:
Tipo de dados: Booliano |
| result.reservable_module.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:
Tipo de dados: Booliano |
| result.reservable_module.require_subject | Sinalizador que indica se o usuário deve inserir um assunto ao fazer a reserva. Valores válidos:
Tipo de dados: Booliano |
| reservable_module.reservable_module.reservable_columns | Lista de colunas de um reservável. Tipo de dados: Matriz Tabela: Local do local de trabalho [sn_wsd_core_workplace_location] |
| reservable_module.reservable_module.reservable_container_field | Nível do contêiner, como um grupo de mesas em uma área específica. Tipo de dados: Cadeia de caracteres |
| reservable_module.reservable_module.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_module.reservable_module.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 |
| reservable_module.reservable_module.reservable_table | Tabela que contém os itens reserváveis do local de trabalho. Tipo de dados: Cadeia de caracteres |
| reservable_module.reservable.reservable_module. reservable_type | Item reservável, como local. Tipo de dados: Cadeia de caracteres |
| reservable_module.reservable_module.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 Tabela: Exibição reservável [sn_wsd_rsv_reservable_view] |
| Reservable_module.reservable.reservable_views.iconClass | Classe de ícone da exibição reservável. Tipo de dados: Cadeia de caracteres |
| Reservable_module.reservable.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:
Tipo de dados: Booliano |
| result.reservable_module. reservable_views.label | Nome da exibição reservável. Tipo de dados: Cadeia de caracteres |
| reservable_module.reservable_module.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 |
| reservable_module.reservable_module.reservable_views.type | Nome de back-end da exibição reservável. Usado para processamento interno. Tipo de dados: Cadeia de caracteres |
| result.reservable_module. 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 |
| result.reservable_module. reservation_paths.display_value | Valor de exibição do caminho de reserva, como "Navegar próximo a uma pessoa". Tipo de dados: Cadeia de caracteres |
| result.reservable_module. reservable_paths.value | Valor interno do caminho de reserva, como "browse_next_a_person". Tipo de dados: Cadeia de caracteres |
| result.reservable_module.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.reservable_module.selection_type | Tipo de seleção a ser exibida nos resultados da pesquisa. Pode ser uma das seguintes opções:
Tipo de dados: Cadeia de caracteres |
| result.reservable_module.short_description | Breve descrição do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.show_map_view | Sinalizador que indica se a exibição de mapa deve ser habilitada para módulos reserváveis. Valores válidos:
Tipo de dados: Booliano |
| result.reservable_module.sys_id | Sys_id do módulo reservável. Tipo de dados: Cadeia de caracteres |
| Result.reservable_module.timesLots | Detalhes sobre os intervalos de tempo associados a um módulo reservável. Tipo de dados: Matriz de objetos |
| Result.reservable_module.timeSlots.name | Nome do intervalo de tempo. Tipo de dados: Cadeia de caracteres |
| Result.reservable_module.TimesLots.short_description | Breve descrição do intervalo de tempo. Tipo de dados: Cadeia de caracteres |
| Result.reservable_module.TimesLots.slot_end | Hora de término do intervalo de tempo. Tipo de dados: Cadeia de caracteres |
| Result.reservable_module.TimesLots.slot_start | Hora de início do slot. Tipo de dados: Cadeia de caracteres |
| Result.reservable_module.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.reservable_module.title | Título do módulo reservável. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.virtual_meeting_provider | Detalhes sobre o provedor virtual associado ao módulo reservável. Tipo de dados: Objeto |
| result.reservable_module.virtual_meeting_provider.display_value | Valor de exibição do provedor de reunião virtual. Tipo de dados: Cadeia de caracteres |
| result.reservable_module.virtual_meeting_provider.sys_id | Sys_id do provedor de reunião virtual. Tipo de dados: Cadeia de caracteres |
| ReservaçãoResultado.reservaçãoAcl | Detalhes das verificações de níveis de controle de acesso (ACL) do usuário definidas na reserva associada. Tipo de dados: Objeto |
| result.reservation.reservationAcl.read | Sinalizador que indica se o usuário pode ler esta reserva. Valores válidos:
Tipo de dados: Booliano |
| ReservationAcl.reservationAcl.write | Detalhes sobre os recursos de gravação do usuário para a reserva associada. Tipo de dados: Objeto |
| ReservationAcl.write.allFields | Sinalizador que indica se o usuário pode gravar em todos os campos especificados em reservationACL.write.fieldsobjeto. Se o usuário só tiver acesso a alguns campos específicos, somente esses campos serão verdadeiros em reservationACL.write.fieldsobjeto. Valores válidos:
Tipo de dados: Booliano |
| ReservationAcl.write.fields.result.reservation.reservationAcl | Detalhes dos controles de acesso em vários campos da reserva. Tipo de dados: Objeto |
| Result.reservationAcl.write.fields.Local | Sinalizador que indica se o usuário pode gravar nos campos de local nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.Number_of_attendentes | Sinalizador que indica se o usuário pode gravar nos campos Número de participantes nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.Requested_for | Sinalizador que indica se o usuário pode gravar nos campos Solicitado para nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.Sensibilidade | Sinalizador que indica se o usuário pode gravar nos campos de confidencialidade nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.Assunto | Sinalizador que indica se o usuário pode gravar nos campos de assunto nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.record | Sinalizador que indica se o usuário pode gravar todo o registro de reserva. Valores válidos:
Tipo de dados: Booliano |
| result.reservation.reservation_purpose | Detalhes sobre a finalidade da reserva. Tipo de dados: Objeto |
| result.reservation.reservation_purpose.display_value | Valor de exibição para a finalidade da reserva, como Reunião da empresa. Tipo de dados: Cadeia de caracteres |
| result.reservation.reservation_purpose.value | Valor interno para a finalidade da reserva, como company_meeting. Tipo de dados: Cadeia de caracteres |
| result.reservation.reservation_type | Detalhes sobre o tipo de reserva. Tipo de dados: Objeto |
| result.reservation.reservation_type.display_value | Valor de exibição do tipo de reserva, como Espaço. Tipo de dados: Cadeia de caracteres |
| result.reservation.reservation_type.value | Valor interno para o tipo de reserva, como espaço. Tipo de dados: Cadeia de caracteres |
| result.reservation.reservation_subtipo | Detalhes sobre o subtipo da reserva. Os subtipos indicam o tipo de reserva, como único, vários primários, vários secundários, primário recorrente, ou ocorrência. Tipo de dados: Objeto |
| result.reservation.reservation_subtipo.display_value | Valor de exibição do subtipo da reserva, como Simples. Tipo de dados: Cadeia de caracteres |
| result.reservation.reservation_subtype.value | Valor interno para o subtipo da reserva, como único. Tipo de dados: Cadeia de caracteres |
| result.reservation.sensitivity | Detalhes sobre a confidencialidade da reserva. Tipo de dados: Objeto |
| result.reservation.sensitivity.display_value | Valor de exibição da sensibilidade da reserva, como alto ou baixo. Tipo de dados: Cadeia de caracteres |
| result.reservation.sensitivity.value | Valor interno para a sensibilidade da reserva, como 1 ou 3. Tipo de dados: Cadeia de caracteres |
| resultado.reservation.turno | Detalhes sobre o turno aplicado à reserva. Tipo de dados: Objeto |
| result.reservation.shift.display_value | Valor de exibição do turno. Tipo de dados: Cadeia de caracteres |
| result.reservation.shift.name | Nome do turno. Igual a display_value. Tipo de dados: Cadeia de caracteres |
| Result.reservation.shift.shiftDetails | Detalhes do turno. Tipo de dados: Cadeia de caracteres |
| result.reservation.shift.sys_id | Sys_id do registro de turno. Tipo de dados: Cadeia de caracteres Tabela: Shift [sn_wsd_core_shift] |
| result.reservation.source | Detalhes sobre a origem da reserva, como Serviços do local de trabalho ou Google Mail. Tipo de dados: Objeto |
| result.reservation.source.display_value | Valor de exibição da origem da reserva, como Serviços do local de trabalho. Tipo de dados: Cadeia de caracteres |
| result.reservation.source.value | Valor interno da origem da reserva, como serviceNow. Tipo de dados: Cadeia de caracteres |
| result.reservation.source_icon | Detalhes sobre a origem do ícone usado na reserva. Este ícone é usado na IU. Tipo de dados: Objeto |
| Result.reservation.source_icon.classNames | Nomes de classe separados por vírgulas para o ícone de origem. Tipo de dados: Cadeia de caracteres |
| Result.reservation.source_icon.imgSrc | Nome da origem da imagem para o ícone de origem. Este ícone é armazenado na tabela Imagens [db_image]. Tipo de dados: Cadeia de caracteres |
| result.reservation.source_icon.tooltip | Dica de ferramenta associada ao ícone de origem. Tipo de dados: Cadeia de caracteres |
| result.reservation.source_reservation | Reserva de origem da reserva atual. Por exemplo, no caso de várias reservas, a reserva primária é a origem da reserva secundária. Tipo de dados: Cadeia de caracteres |
| resultado.reservation.start | Data e hora de início da reserva. Tipo de dados: Cadeia de caracteres Formato: UTC - aaaa-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z |
| resultado.reservation.assunto | Assunto da reserva. Tipo de dados: Cadeia de caracteres |
| result.reservation.sub_source | Detalhes sobre a suborigem da reserva. A suborigem especifica de onde a reserva se originou, como Google Agenda ou Microsoft Exchange. Tipo de dados: Objeto |
| result.reservation.sub_source.display_value | Valor de exibição da suborigem da reserva, como Google Agenda. Tipo de dados: Cadeia de caracteres |
| result.reservation.sub_source.value | Valor interno do campo de suborigem da reserva, como google_calendar. Tipo de dados: Cadeia de caracteres |
| result.reservation.sync_state | Detalhes sobre o estado de sincronização de uma reserva de outro serviço, como "sync_enfileied" ou "Synchronized". Tipo de dados: Objeto |
| result.reservation.sync_state.display_value | Valor de exibição do estado de sincronização atual da reserva, como Sincronizado. Tipo de dados: Cadeia de caracteres |
| result.reservation.sync_state.value | Valor interno do estado de sincronização atual da reserva, como Sincronizado. Tipo de dados: Cadeia de caracteres |
| result.reservation.sys_created_on | Data e hora em que a reserva foi criada. Tipo de dados: Cadeia de caracteres |
| result.reservation.sys_id | Obrigatório. Sys_id do registro de reserva. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
| Result.reservation.sys_updated_on | Data e hora em que a reserva foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres |
| result.reservation.virtual_meeting | URL do link da reunião virtual. Tipo de dados: Cadeia de caracteres |
| Result.reservationAcl | Detalhes das verificações de níveis de controle de acesso (ACL) do usuário definidas na reserva associada. Tipo de dados: Objeto |
| result.reservationAcl.read | Sinalizador que indica se o usuário pode ler esta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write | Detalhes sobre os recursos de gravação do usuário para a reserva associada. Tipo de dados: Objeto |
| Result.reservationAcl.write.allFields | Sinalizador que indica se o usuário pode gravar em todos os campos especificados em reservationACL.write.fieldsobjeto. Se o usuário só tiver acesso a alguns campos específicos, somente esses campos serão verdadeiros em reservationACL.write.fieldsobjeto. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields | Detalhes dos controles de acesso em vários campos da reserva. Tipo de dados: Objeto |
| Result.reservationAcl.write.fields.location | Sinalizador que indica se o usuário pode gravar nos campos de local nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.Number_of_attendentes | Sinalizador que indica se o usuário pode gravar nos campos Número de participantes nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.requested_for | Sinalizador que indica se o usuário pode gravar nos campos Solicitado para nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| result.reservationAcl.write.fields.sensitivity | Sinalizador que indica se o usuário pode gravar nos campos de confidencialidade nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.write.fields.subject | Sinalizador que indica se o usuário pode gravar nos campos de assunto nesta reserva. Valores válidos:
Tipo de dados: Booliano |
| Result.reservationAcl.record | Sinalizador que indica se o usuário pode gravar todo o registro de reserva. Valores válidos:
Tipo de dados: Booliano |
| result.standard_services | Preenchido somente se include_standard_serviceso parâmetro está definido como verdadeiro. Serviços padrão associados, como flipchart, tela de projetor, quadro branco e marcadores. Tipo de dados: Matriz de objetos
|
| 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 |
| result.standard_services.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. Tipo de dados: Cadeia de caracteres Tabela: Serviço padrão [sn_wsd_rsv_standard_service] |
Solicitação de curl
Este exemplo de código mostra como chamar este endpoint para recuperar uma lista de reservas associadas ao usuário especificado.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/list" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Resultados de retorno:
{
"result": {
"reservations": [
{
"sys_id": "12e2da5e87c701106342b846dabb354d",
"number": "WRES0001010",
"location": {
"sys_id": "02000d4edb7650106c731dcd13961914",
"name": "Eureka",
"description": "A comfortable meeting room with leather chairs and a wooden table. Client meeting room.",
"display_value": "Eureka",
"capacity": 12,
"label_value": "Room name",
"email": "eureka@example.com",
"reservable_module": {
"sys_id": "c31241cedb7650106c731dcd13961917",
"name": "Meeting rooms",
"title": "Meeting rooms",
"inline_title": "meeting room"
},
"region": {
"sys_id": "2d626c4edb3650106c731dcd1396194b",
"display_value": "Europe",
"active": true
},
"site": {
"sys_id": "b17220cedb3650106c731dcd1396197a",
"display_value": "Western Europe",
"active": true
},
"campus": {
"sys_id": "44d2e0cedb3650106c731dcd13961988",
"display_value": "Amsterdam Campus",
"active": true
},
"building": {
"sys_id": "9e0364cedb3650106c731dcd1396192b",
"display_value": "AMS-B1",
"active": true,
"timezone": {
"value": "Europe/Amsterdam",
"displayValue": "Europe/Amsterdam"
}
},
"floor": {
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3",
"active": true
},
"area": {
"sys_id": "",
"display_value": "",
"active": false
},
"reservation": {
"sys_id": "12e2da5e87c701106342b846dabb354d",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User",
"user_name": "workplace_user"
},
"number": "WRES0001010",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001010",
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User",
"user_name": "workplace_user"
}
},
"start": "2022-05-15T16:00:00Z",
"end": "2022-05-15T17:00:00Z",
"sys_created_on": "2022-04-26T09:19:37Z",
"sys_updated_on": "2022-04-26T09:20:04Z",
"source_reservation": null,
"check_in_state": {
"value": "not_required",
"display_value": "Not required"
},
"external_id": null,
"external_ical": null,
"active": true,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"sensitivity": {
"value": "normal",
"display_value": "Normal"
},
"reservation_type": {
"value": "space",
"display_value": "Space"
},
"reservation_subtype": {
"value": "single",
"display_value": "Single"
},
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"attendees": [
{
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"value": "2de07e1887cb89106342b846dabb35fe",
"displayValue": "Workplace User",
"display_value": "Workplace User",
"name": "Workplace User",
"user_name": "workplace_user",
"table": "sys_user",
"avatar": "eb513744c3222010ae17dd981840dd97",
"initials": "WU",
"email": "workplace_user@example.com",
"label": ""
}
],
"number_of_attendees": 1,
"is_parent": false,
"subject": "Add rsv_1",
"virtual_meeting": "https://samplemeetingurl.com",
"recording_details": [
{
"recording_url": "https://samplerecordingurl.com"
}
],
"sync_state": {
"value": "not_required",
"display_value": "Synchronization not required"
},
"sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"last_updated_sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"reservable_module": {
"sys_id": "c31241cedb7650106c731dcd13961917",
"name": "Meeting rooms",
"title": "Meeting rooms",
"inline_title": "meeting room",
"font_awesome_icon": "fa-building",
"reservable_table": "sn_wsd_core_room",
"reservable_filter": "active=true^is_reservable=true^building!=6c0364cedb3650106c731dcd13961927^building.is_reservable=true^floor.is_reservable=true^EQ",
"short_description": "Reserve a meeting room",
"reservable_type": "location",
"require_subject": "1",
"require_cancel_notes": true,
"virtual_meeting_provider": {
"sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
"display_value": "Template"
},
"allow_invitees": "1",
"display_number_of_attendees": "1",
"display_on_behalf_of": "1",
"display_sensitivity": "1",
"max_days_in_future": "180",
"allow_whole_day": "1",
"selection_type": "unit",
"reservable_container_field": null,
"reservable_quantity_field": null,
"apply_to_shift": null,
"max_occurrences": "180",
"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",
"display_value": "Meeting rooms",
"browse_near_a_person_enabled": true,
"browse_by_area_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"
}
],
"buildingSysIds": [
"4703a4cedb3650106c731dcd13961945",
"6c0364cedb3650106c731dcd13961927",
"94e264cedb3650106c731dcd13961919",
"9e0364cedb3650106c731dcd1396192b"
],
"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"
},
"notification_recipients": [
{
"sys_id": "7016f79cc0a8016401c5a33be04be441",
"name": "workplace user",
"user_name": "workplace.user"
}
],
"notification_custom_message": "Demo notification message",
"opened_by": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "eb513744c3222010ae17dd981840dd97",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator"
},
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"value": "2de07e1887cb89106342b846dabb35fe",
"displayValue": "Workplace User",
"display_value": "Workplace User",
"name": "Workplace User",
"user_name": "workplace_user",
"table": "sys_user",
"avatar": "d3513744c3222010ae17dd981840dd97",
"initials": "WU",
"email": "workplace_user@example.com",
"label": ""
},
"edit_restriction": {
"value": "no_restriction",
"display_value": "No restriction"
},
"source": {
"value": "servicenow",
"display_value": "Workplace Services"
},
"source_icon": {
"classNames": "fa fa-calendar-check-o",
"tooltip": "Reservation is confirmed",
"imgSrc": ""
},
"shift": {
"sys_id": "e5d23acfdb42a01097acc9003996193a",
"name": "Test shift AMS-B1",
"display_value": "Test shift AMS-B1",
"shiftDetails": "8-5 weekdays excluding holidays\n - Monday-Friday 8-5"
},
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true
},
"allFields": true
},
"read": true
}
}
]
}
}
Reserva de WSD - PATCH /api/sn_wsd_rsv/reservation/cancel/
Cancela uma reserva de local de trabalho especificada.
Formato de URL
URL com controle de versão: /api/sn_wsd_rsv//reservation/cancel/ sys_id
URL padrão: /api/sn_wsd_rsv/reservation/cancel/
Parâmetros de solicitação compatíveis
| 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 da reserva a ser cancelada. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| cancel_notes | Motivo para cancelar a reserva. Tipo de dados: Cadeia de caracteres |
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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xmlou, text/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| 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 .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 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
| Nome | Descrição |
|---|---|
| sys_id | Sys_id do registro de reserva cancelada. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
Solicitação de curl
O exemplo de código a seguir mostra como cancelar uma reserva usando este endpoint.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/cancel/12e2da5e87c701106342b846dabb354d" \
--request PATCH \
--header "Accept:application/json" \
--user ‘username’:’password’
Resultados de retorno:
"result": {
"sys_id": "73c316d2474b0150003a4587746d4337"
}
Reserva de WSD - PATCH /api/sn_wsd_rsv/reservation/share_details/
Atualiza e compartilha os detalhes da reserva com uma lista especificada de destinatários por meio de uma notificação por e-mail. Opcionalmente, você pode enviar uma mensagem especificada junto com a reserva.
Formato de URL
URL com controle de versão: /api/sn_wsd_rsv//reservation/share_details/(sys_id)
URL padrão: /api/sn_wsd_rsv/reservation/share_details/
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Tipo de dados: Cadeia de caracteres |
| sys_id | Sys_id da reserva a ser compartilhada. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| notification_custom_message | Mensagem a ser enviada aos destinatários especificados. Tipo de dados: Cadeia de caracteres |
| notification_destinatários | Obrigatório. Lista de sys_ids dos usuários para os quais enviar a notificação por e-mail. Tipo de dados: Matriz Tabela: Usuário [sys_user] |
| notification_type | Tipo de notificação a ser enviada. Tipos válidos:
Tipo de dados: Cadeia de caracteres |
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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xmlou, text/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| 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 .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 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
| Nome | Descrição |
|---|---|
| sys_id | Sys_id do registro de reserva que foi compartilhado. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
Solicitação de curl
O exemplo de código a seguir mostra como usar este endpoint para compartilhar uma reserva.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/share_details/60d26a0f47578910003a4587746d4331" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"notification_recipients\": [\"5dfb9fcf47d78910003a4587746d4367\"],
\"notification_type\":\"reservation_updated\",
\"notification_custom_message\": \"Please join our design brainstorming meeting!\"
}" \
--user "username":"password"
Resultados de retorno:
"result": {
"sys_id": "60d26a0f47578910003a4587746d4331"
}
Reserva de WSD - PATCH /api/sn_wsd_rsv/reservation/update/
Atualiza uma reserva de local de trabalho especificada.
Formato de URL
URL com controle de versão: /api/sn_wsd_rsv//reservation/update/ sys_id
URL padrão: /api/sn_wsd_rsv/reservation/update/
Parâmetros de solicitação compatíveis
| 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 da reserva a ser modificada. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
| Nome | Descrição |
|---|---|
| ignore_same_day_validation | Sinalizador que indica se a pesquisa de reserva ignora a mudança da validação de data entre os parâmetros de início e término. Valores válidos:
Tipo de dados: Booliano Padrão: falso |
| Nome | Descrição |
|---|---|
| término | Necessário se shifto parâmetro não foi passado. Hora de término solicitada da reserva. Tipo de dados: Cadeia de caracteres Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss) |
| is_private | Sinalizador que indica se a reserva é privada. Se for privada, a reserva não aparecerá para ninguém, exceto o proprietário. Para obter informações adicionais sobre essas configurações de privacidade, consulte Configurações de privacidade do local e impacto . Valores válidos:
Tipo de dados: Booliano Valor definido para privacidade nas propriedades do sistema. |
| local | Obrigatório. Sys_id do local a ser reservado. Tipo de dados: Cadeia de caracteres Tabela: Local do local de trabalho [sn_wsd_core_workplace_location] |
| requested_for | Sys_id ou endereço de e-mail do usuário para o qual a reserva está sendo feita. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| shift | Sys_id do turno a ser associado à reserva. Se este parâmetro for passado, o endo parâmetro não é necessário. Para obter informações adicionais sobre reservas baseadas em turno, consulte Habilitar reserva baseada em turno . Tipo de dados: Cadeia de caracteres Tabela: Shift [sn_wsd_core_shift] |
| início | Obrigatório. Hora de início solicitada da reserva. Tipo de dados: Cadeia de caracteres Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss) |
| assunto | Obrigatório. Assunto da reunião associada à reserva. Tipo de dados: Cadeia de caracteres |
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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xmlou, text/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| 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 .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 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 | Detalhes da reserva atualizada. Tipo de dados: Objeto |
| result.location_id | Sys_id do registro do local de reserva. Tipo de dados: Cadeia de caracteres Tabela: Local do local de trabalho [sn_wsd_core_workplace_location] |
| sys_id.result.sys_id | Sys_id do registro de reserva modificado. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
| resultado.type_of_change | Tipo de informação atualizada na reserva. Tipo de dados: Cadeia de caracteres |
Solicitação de curl
O exemplo de código a seguir mostra como atualizar uma reserva usando este endpoint.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/update/b537abc947db4510003a4587746d4351" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"subject\": \"Rsv Update_1\",
\"start\": \"2022-07-21 14:00:00\",
\"end\": \"2022-07-21 15:00:00\",
\"requested_for\": \"workplace_user@example.com\",
\"workplace_location\": \"fe1f744edb7650106c731dcd139619ca\",
\"is_private\": \false\
}" \
--user "username":"password"
Resultados de retorno:
{
"result": {
"sys_id": "b537abc947db4510003a4587746d4351",
"location_id": "fe1f744edb7650106c731dcd139619ca",
"type_of_change": "location"
}
}
Reserva de WSD - POST /api/sn_wsd_rsv/reservation/add
Cria uma nova reserva de local de trabalho.
Formato de URL
URL com controle de versão: /api/sn_wsd_rsv//reservation/add
URL padrão: /api/sn_wsd_rsv/reservation/add
Parâmetros de solicitação compatíveis
| 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 |
| Nome | Descrição |
|---|---|
| ignore_same_day_validation | Sinalizador que indica se a pesquisa de reserva ignora a mudança da validação de data entre os parâmetros de início e término. Valores válidos:
Tipo de dados: Booliano Padrão: falso |
| fuso horário | Fuso horário preferencial para executar as validações de solicitação. Por exemplo: Europa/Amsterdam. Esta validação verifica se a hora de início e de término estão no mesmo dia. Tipo de dados: Cadeia de caracteres Fuso horário do usuário |
| Nome | Descrição |
|---|---|
| término | Necessário se shifto parâmetro não foi passado. Hora de término solicitada da reserva. Tipo de dados: Cadeia de caracteres Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss) |
| is_private | Sinalizador que indica se a reserva é privada. Se for privada, a reserva não aparecerá para ninguém, exceto o proprietário. Para obter informações adicionais sobre essas configurações de privacidade, consulte Configurações de privacidade do local e impacto . Valores válidos:
Tipo de dados: Booliano Valor definido para privacidade nas propriedades do sistema. |
| local | Obrigatório. Sys_id do local a ser reservado. Tipo de dados: Cadeia de caracteres Tabela: Local do local de trabalho [sn_wsd_core_workplace_location] |
| requested_for | Sys_id ou endereço de e-mail do usuário para o qual a reserva está sendo feita. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user] |
| reservable_module | Obrigatório. Sys_id do módulo reservável a ser associado à reserva. . módulo reservável define os itens do local de trabalho necessários para uma reserva. Tipo de dados: Cadeia de caracteres Tabela: Módulo reservável [sn_wsd_rsv_reservable_module] |
| shift | Sys_id do turno a ser associado à reserva. Se este parâmetro for passado, o endo parâmetro não é necessário. Para obter informações adicionais sobre reservas baseadas em turno, consulte Habilitar reserva baseada em turno . Tipo de dados: Cadeia de caracteres Tabela: Shift [sn_wsd_core_shift] |
| início | Obrigatório. Hora de início solicitada da reserva. Tipo de dados: Cadeia de caracteres Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss) |
| assunto | Obrigatório. Assunto da reunião associada à reserva. Tipo de dados: Cadeia de caracteres |
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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xmlou, text/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| 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 .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 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
| Nome | Descrição |
|---|---|
| sys_id | Sys_id do registro de reserva criado. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
Solicitação de curl
O exemplo de código a seguir mostra como usar este endpoint para criar uma reserva.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/add" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservable_module\": \"c31241cedb7650106c731dcd13961917\",
\"subject\": \"Test-123\",
\"reservation_purpose\": \"meeting\",
\"timezone\": \"US/Pacific\",
\"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
\"location\": \"5eafb44edb7650106c731dcd13961943\",
\"is_private\": false,
\"start\": \"2023-01-12T11:00:00Z\",
\"end\": \"2023-01-12T12:00:00Z\"
}" \
--user "username":"password"
Resultados de retorno:
"result": {
"sys_id": "4b036a9e474b0150003a4587746d43b1"
}
Reserva de WSD - POST /api/sn_wsd_rsv/reservation/quick_reserve
Cria uma nova reserva de local de trabalho usando a reserva rápida.
Formato de URL
URL com controle de versão: /api/sn_wsd_rsv//reservation/quick_reserve
URL padrão: /api/sn_wsd_rsv/reservation/quick_reserve
Parâmetros de solicitação compatíveis
| 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 |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| término | Necessário se shifto parâmetro não foi passado. Hora de término solicitada da reserva. Tipo de dados: Cadeia de caracteres Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss) |
| ignore_same_day_validation | Obrigatório. Sinalizador que indica se o endpoint ignora a validação da mudança de data entre starte. endparâmetros. Valores válidos:
Tipo de dados: Booliano |
| reference_location_id | Obrigatório. Sys_id do local, próximo ao qual o usuário deseja reservar um local. Tipo de dados: Cadeia de caracteres Tabela: Local do local de trabalho [sn_wsd_core_workplace_location] |
| reservable_module | Obrigatório. Sys_id do módulo reservável a ser associado à reserva. . módulo reservável define os itens do local de trabalho necessários para uma reserva. Tipo de dados: Cadeia de caracteres Tabela: Módulo reservável [sn_wsd_rsv_reservable_module] |
| shift | Sys_id do turno a ser associado à reserva. Se este parâmetro for passado, o endo parâmetro não é necessário. Para obter informações adicionais sobre reservas baseadas em turno, consulte Habilitar reserva baseada em turno . Tipo de dados: Cadeia de caracteres Tabela: Shift [sn_wsd_core_shift] |
| início | Obrigatório. Hora de início solicitada da reserva. Tipo de dados: Cadeia de caracteres Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss) |
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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xmlou, text/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| 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 .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 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
| Nome | Descrição |
|---|---|
| sys_id | Sys_id do registro de reserva criado. Tipo de dados: Cadeia de caracteres Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation] |
Solicitação de curl
O exemplo de código a seguir mostra como usar o endpoint de reserva rápida para criar uma reserva.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/quick_reserve" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"start\":\"2022-05-23 16:00:00\",
\"end\": \"2022-05-23 17:00:00\",
\"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
\"reference_location_id\": \"05f5290edb7210106c731dcd13961951\",
\"ignore_same_day_validation\": \"true\"
}" \
--user "username":"password"
Resultados de retorno:
"result": {
"sys_id": "4b036a9e474b0150003a4587746d43b1"
}