API de reserva do WSD

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 92 min. de leitura

    • A API de reservaPrestação de serviços no local de trabalho (WSD) fornece endpoints para gerenciar reservas de local de trabalho.

    Para acessar esta API, o solicitante deve ter a função sn_wsd_core.workplace_user e os plug-ins Workplace Safety Management (sn_wsd_core) e Workplace Reservation Management (sn_wsd_rsv) devem estar ativados.

    Esta API é executada no namespace sn_wsd_rsv.

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

    Reserva de WSD - GET /api/sn_wsd_rsv/reservation/get

    Recupera a reserva de local de trabalho especificada.

    Formato da URL

    URL com controle de versões: /api/sn_wsd_rsv/{api_version}/reservation/get

    URL padrão: /api/sn_wsd_rsv/reservation/get

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    externo_ical Identificação iCalendar 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 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_dados Se o valor do campo reserva_subtipo no registro de reserva de 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:
    • verdadeiro: retorna os detalhes da reserva.
    • falso: não retorna os detalhes da reserva.

    Tipo de dados: booliano

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

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

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

    Tipo de dados: booliano

    Padrão: falso
    sys_id Obrigatório.
    Sys_id do registro de reserva. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

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

    Cabeçalhos

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

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

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

    Códigos de status

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

    Tabela 6. Códigos de status
    Código de 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

    "reservation": {
  "active": Boolean,
  "attendees": [Array],
  "check_in_state": {Object},
  "end": "String",
  "external_ical": "String",
  "external_id": "String",
  "is_parent": Boolean,
  "is_private": Boolean,
  "informEmployeePrivacy": Boolean.
  "last_updated_sub_source": {Object},
  "location" {Object},
  "number": "String",
  "number_of_attendees": Number,
  "recording_details": [Array],
  "reservable_module": {Object},
  "reservation_purpose": {Object},
  "reservation_type": {Object},
  "reservation_subtype": {Object},
  "sensitivity": {Object},
  "start": "String",
  "state": {Object},
  "source_reservation": "String",
  "subject": "String",
  "sub_source": {Object},
  "sync_state": {Object},
  "sys_created_on: "String",
  "sys_id": "String",
  "sys_updated_on": "String",
  "virtual_meeting": "String"
}
    result.reservation.active Sinalizador que indica se a reserva está ativa.
    Valores válidos:
    • verdadeiro: a reserva está ativa.
    • falso: a reserva está inativa.

    Tipo de dados: booliano
    resultado.reserva.participantes Lista de participantes da reserva.

    Tipo de dados: matriz de objetos

    "attendees": [
  {
    "avatar": "String",
    "displayValue": "String",
    "display_value": "String",
    "email": "String",
    "initials": "String",
    "label": "String",
    "name": "String",
    "sys_id": "String",
    "table": "String",
    "user_name": "String",
    "value": "String"
  }
]
    resultado.reserva.participantes.avatar Sys_id do avatar associado ao participante. Localizado na tabela Anexos [sys_attachment].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.displayValue Valor de exibição para o participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.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
    resultado.reserva.participantes.iniciais Iniciais do participante.

    Tipo de dados: cadeia de caracteres
    result.reservation.attendees.name Nome do participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.sys_id Sys_id_of do registro do participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.tabela Tabela na qual existe o registro do participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.nome_usuário 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
    resultado.reserva.check_in_state Detalhes sobre o estado de check-in da reserva.

    Tipo de dados: objeto

    "check_in_state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.check_in_state.​display_value Valor de exibição para o estado de check-in atual da reserva, como Em andamento ou concluído.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.check_in_state.value Valor interno para o 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 full_restricted.

    Tipo de dados: objeto

    "edit_restriction": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.edit_restriction.display_​value Valor de exibição para as 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.reserva.término 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
    resultado.reserva.externo_ical Identificação iCalendar 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.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
    resultado.reserva.é_primário Sinalizador que indica se esta reserva é uma reserva primária.
    Valores possíveis:
    • verdadeiro: reserva primária.
    • falso: não há uma reserva primária.

    Tipo de dados: booliano
    resultado.reserva.é_privado 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 e impacto da privacidade do local.

    Valores válidos:
    • verdadeiro: a reserva é privada.
    • falso: a reserva não é privada.

    Tipo de dados: booliano

    Padrão: valor definido para privacidade nas propriedades do sistema.
    result.reservation.last_updated_sub_source Detalhes sobre a última suborigem atualizada da reserva. 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

    "last_updated_sub_source": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.last_updated_sub_source.​display_value Valor de exibição da última suborigem atualizada da reserva, como Prestação de serviços no local de trabalho da ServiceNow ou Google Calendar. Usado ao integrar a reserva com um serviço externo, como o calendário do Google ou o Microsoft Outlook.

    Tipo de dados: cadeia de caracteres
    result.reservation.last_updated_sub_source.​value Valor interno da última suborigem atualizada da reserva, como servicenow_workplace_service_delivery ou google_calendar. Usado ao integrar a reserva com um serviço externo, como o calendário do Google ou o Microsoft Outlook.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local Detalhes sobre o local associado à reserva.

    Tipo de dados: objeto

    "location": {
  "active": Boolean,
  "area": {Object},
  "building": {Object},
  "campus": {Object},
  "capacity": Number,
  "description": "String",
  "display_value": "String",
  "email": "String",
  "floor": {Object},
  "label_value": "String",
  "name": "String",
  "number_of_attendees": Number,
  "region": {Object},
  "reservable_module": {Object},
  "reservation": {Object},
  "site": {Object},
  "state": {Object},
  "sys_id": "String"
}
    resultado.reserva.local.área Detalhes sobre a área associada ao local.

    Tipo de dados: objeto

    "area": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.area.active Sinalizador que indica se a área está ativa.
    Valores válidos:
    • verdadeiro: a área está ativa.
    • falso: a área está inativa.

    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. Localizado na tabela Área [sn_wsd_core_area].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.edifício Detalhes sobre o edifício associado ao local.

    Tipo de dados: objeto

    "building": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
    result.reservation.location.building.active Sinalizador que indica se o edifício está ativo.
    Valores válidos:
    • verdadeiro: o edifício está ativo.
    • falso: o edifício está inativo.

    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. Localizado na tabela edifício [sn_wsd_core_building].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.prédio.fuso horário Detalhes sobre o fuso horário associado ao local.

    Tipo de dados: objeto

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    result.reservation.location.building.timezone.​display_value Valor de exibição para o fuso horário ao qual este local pertence.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.building.timezone.​value Valor interno para o fuso horário ao qual este local pertence.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.campus Detalhes sobre o campus associado ao local.

    Tipo de dados: objeto

    "campus": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.campus.active Sinalizador que indica se o campus está ativo.
    Valores válidos:
    • verdadeiro: o campus está ativo.
    • falso: o campus está inativo.

    Tipo de dados: booliano
    result.reservation.location.campus.​display_value Valor de exibição do campus ao qual este local pertence, como Campus Amsterdã.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.campus.sys_id Sys_id do campus ao qual este local pertence. Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.capacidade Número máximo de ocupantes do local.

    Tipo de dados: número
    resultado.reserva.local.descrição Breve descrição do local.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.exibição_valor Valor a ser exibido na IU para este local.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.email Endereço de e-mail do local.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.piso Detalhes sobre o andar associado ao local.

    Tipo de dados: objeto

    "floor": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.floor.active Sinalizador que indica se o piso está ativo.
    Valores válidos:
    • verdadeiro: o piso está ativo.
    • falso: o piso está inativo.

    Tipo de dados: booliano
    resultado.reserva.local.piso.valor_de_exibição Valor de exibição do andar ao qual este local pertence, como Primeiro andar.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.piso.sys_id Sys_id do andar ao qual este local pertence. Localizado na tabela Piso [sn_wsd_core_chão].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.rótulo_valor Tipo de valor especificado no parâmetro name, como Nome da sala.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.name Nome do local.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.número 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
    resultado.reserva.local.região Detalhes sobre a região associada ao local.

    Tipo de dados: objeto

    "region": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.region.active Sinalizador que indica se a região está ativa.
    Valores válidos:
    • verdadeiro: a região está ativa.
    • falso: a região está inativa.

    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. Localizado na tabela Região [sn_wsd_core_region].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.solicitado_para Detalhes sobre a pessoa para quem a reserva foi solicitada.

    Tipo de dados: objeto

    "requested_for": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
    result.reservation.location.requested_for.​name 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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservation.location.requested_for.​user_name Nome de usuário do usuário para o qual a reserva foi solicitada.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.reserva Detalhes sobre a reserva associada ao local.

    Tipo de dados: objeto

    "reservation": {
  "active": Boolean,
  "number": "String",
  "number_of_attendees": Number,
  "requested_for": {Object},
  "state": {Object},
  "sys_id": "String"
}
    result.reservation.location.reservation.active Sinalizador que indica se a reserva está ativa.
    Valores válidos:
    • verdadeiro: a reserva está ativa.
    • falso: a reserva está inativa.

    Tipo de dados: booliano
    resultado.reserva.local.reserva.número Número da reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.reserva.​número_de_participantes 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.

    Tipo de dados: objeto

    "requested_for": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
    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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservation.location.reservation.​requested_for.user_name Nome de usuário do 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

    
  "reservable_module": {
    "inline_title": "String",
    "name": "String",
    "sys_id": "String",
    "title": "String",
  },
    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.reservation.location.reservable_module.​name 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.​title Título do módulo reservável.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.site Site ao qual o local pertence. Localizado na tabela Site [sn_wsd_core_site].

    Tipo de dados: objeto

    "site": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String",
}
    result.reservation.location.site.active Sinalizador que indica se o site está ativo.
    Valores válidos:
    • verdadeiro: o site está ativo.
    • falso: o site está inativo.

    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. Localizado na tabela Site [sn_wsd_core_site].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.estado Detalhes sobre o estado da reserva do local.

    Tipo de dados: objeto

    "state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.location.state.display_value Valor de exibição para o estado atual da reserva, como confirmado.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.estado.valor Valor interno para o estado atual da reserva, como 2.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.sys_id Sys_id do registro de local associado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    result.reservation.notification_custom_​message 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

    "notification_recipients":[
  {
    "name": "String",
    "sys_id": "String",
    "user_name": "String"
  }
]
    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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservation.notification_recipients.​user_name Nome de usuário do destinatário.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.número Número exclusivo do registro de reserva. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation]. Você pode usar este valor para consultar a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.aberto_por Detalhes sobre o usuário que criou a reserva.

    Tipo de dados: objeto

    "opened_by": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
    resultado.reserva.aberto_por.avatar Avatar do usuário que abriu a reserva.

    Tipo de dados: cadeia de caracteres
    result.reservation.opened_by.displayValue Valor de exibição de aberto pelo usuário.

    Tipo de dados: cadeia de caracteres
    result.reservation.opened_by.display_value Valor de exibição de 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
    resultado.reserva.aberto_por.iniciais Iniciais do usuário que abriu a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.aberto_por.rótulo Rótulo para o usuário que abriu a reserva. Esta é uma combinação do cargo 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
    result.rservation.opened_by.sys_id Sys_id_of do usuário que abriu a reserva. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.rservation.opened_by.table Tabela que contém o registro do usuário.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.aberto_por.nome_usuário Nome de usuário do usuário que abriu a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.aberto_por.valor Valor interno do usuário que abriu a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.número Número da reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.número_de_participantes 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

    "recording_details": [
  "recording_url": "String"
]
    result.reservation.recording_details.​recording_url URL das gravações associadas à reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitada_para Detalhes sobre o usuário para o qual a reserva foi feita.

    Tipo de dados: objeto

    "requested_for": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
    resultado.reserva.solicitado_para.avatar Avatar do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    result.reservation.requested_for.displayValue Valor de exibição do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    result.reservation.requested_for.display_value Valor de exibição do usuário para o qual a reserva foi feita. Igual a displayValue.

    Tipo de dados: cadeia de caracteres
    result.reservation.requested_for.email Endereço de e-mail do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitada_para.iniciais Iniciais do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitada_para.rótulo Rótulo para o 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 para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    result.rservation.requested_for.sys_id Sys_id_of do usuário para o qual a reserva foi feita. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.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 para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitado_para.valor Valor interno do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.módulo_reservado Detalhes do módulo reservável solicitado.

    Tipo de dados: objeto

    {
  "reservable_module": {
    "allow_invitees": Boolean,
    "allow_whole_day": Boolean,
    "apply_to_shift": Boolean,
    "browse_by_area_enabled": Boolean,
    "browse_near_a_person_enabled": Boolean,
    "buildingSysIds": [Array],
    "checkin_before_minutes": Number,
    "display_number_of_attendees": Boolean,
    "display_on_behalf_of": Boolean,
    "display_sensitivity": Boolean,
    "display_value": "String",
    "enable_browse_by_area": Boolean,
    "enable_browse_near_a_person": Boolean,
    "enable_facet_filter": Boolean,
    "enable_group_reservations": Boolean,
    "enable_ical_generation": Boolean,
    "font_awesome_icon": "String",
    "inline_title": "String",      
    "layout_mapping": {JSON Object},
    "max_days_in_future": Number,
    "max_occurrences": Number,
    "name": "String",
    "override_approval_policy": "String",
    "require_cancel_notes": Boolean,
    "require_cc_dept_check": Boolean,
    "require_subject": Boolean,
    "reservable_columns": [Array],
    "reservable_container_field": "String",
    "reservable_filter": "String",
    "reservable_quantity_field": "String",
    "reservable_table": "String",
    "reservable_type": "String",
    "reservable_views": [Array],
    "reservation_paths": [Array],
    "search_limit": Number,
    "selection_type": "String",
    "short_description": "String",
    "show_map_view": Boolean,
    "sys_id": "String",
    "timeSlots": [Array],
    "title": "String",
    "virtual_meeting_provider": {Object}
  }
}
    result.reservation.reservable_module.​allow_invitees Sinalizador que indica se os funcionários podem adicionar convidados à reserva.
    Valores válidos:
    • verdadeiro: permite que os funcionários adicionem convidados à reserva.
    • falso: não permite que os funcionários adicionem convidados à reserva.

    Tipo de dados: booliano
    result.reservation.reservable_module.​allow_whole_day Sinalizador que indica se os usuários podem reservar o reservável pelo dia inteiro.
    Valores válidos:
    • verdadeiro: permite que os usuários reservem o dia inteiro.
    • falso: não permite que os usuários reservem o dia inteiro.

    Tipo de dados: booliano
    result.reservation.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:
    • verdadeiro: permite reservas baseadas em turno.
    • falso: não permite reservas baseadas em turno.

    Tipo de dados: booliano
    result.reservation.reservable_module.​browse_by_area_enabled Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por área.
    Valores válidos:
    • verdadeiro: permite que os usuários pesquisem módulos reserváveis por área.
    • falso: não permite que os usuários pesquisem módulos reserváveis por área.

    Tipo de dados: booliano
    result.reservation.reservable_module.​browse_near_a_person_enabled Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada.
    Valores válidos:
    • verdadeiro: permite que os usuários naveguem pelos módulos reserváveis próximos a uma pessoa.
    • falso: não permite que os usuários naveguem pelos módulos reserváveis perto de uma pessoa.

    Tipo de dados: booliano
    result.reservation.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.reservation.reservable_module.​checkin_before_minutes Quantidade de tempo antes do início de uma reserva em que um usuário pode fazer check-in na reserva.

    Unidade: minutos

    Tipo de dados: número
    result.reservation.reservable_module.​display_number_of_appers Sinalizador que indica se os usuários podem especificar o número de participantes na reserva.
    Valores válidos:
    • verdadeiro: os usuários podem especificar o número de participantes.
    • falso: os usuários não podem especificar o número de exibição de participantes.

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

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

    Tipo de dados: booliano
    result.reservation.reservable_module.​display_value Valor de exibição do módulo reservável.

    Tipo de dados: cadeia de caracteres
    result.reservation.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:
    • verdadeiro: permite que os usuários pesquisem módulos reserváveis por área.
    • falso: não permite que os usuários pesquisem módulos reserváveis por área.

    Tipo de dados: booliano
    result.reservation.reservable_module.​enable_browse_near_a_person Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada. Igual a browse_near_a_person_enabled.
    Valores válidos:
    • verdadeiro: permite que os usuários naveguem pelos módulos reserváveis próximos a uma pessoa.
    • falso: não permite que os usuários naveguem pelos módulos reserváveis perto de uma pessoa.

    Tipo de dados: booliano
    result.reservation.reservable_module.​enable_facet_filter Sinalizador que indica se a filtragem de aspecto nos itens do local de trabalho está habilitada. Quando habilitadas, as opções de filtro que aparecem 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 selecionarem no filtro.
    Valores válidos:
    • verdadeiro: os filtros de aspecto estão habilitados.
    • falso: os filtros de aspecto não estão habilitados.

    Tipo de dados: booliano
    result.reservation.reservable_module.​enable_group_reservations Sinalizador que indica se os usuários podem fazer uma reserva de grupo.
    Valores válidos:
    • verdadeiro: capaz de fazer reservas de grupo.
    • falso: não é possível fazer reservas de grupo.

    Tipo de dados: booliano
    result.reservation.reservable_module.​enable_ical_generation Sinalizador que indica se os usuários podem gerar um iCalendar para a reserva.
    Valores válidos:
    • verdadeiro: geração de iCalendar permitida.
    • falso: a geração de iCalendar não é permitida.

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

    Tipo de dados: cadeia de caracteres
    result.reservation.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.reservation.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

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

    Tipo de dados: matriz de objetos

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Tipo de dados: booliano
    result.reservation.reservable_module.​reservable_columns Lista das colunas de um reservável. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: matriz
    result.reservation.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
    result.reservation.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 no campo Tabela reservável.

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

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​reservable_table Tabela que contém os itens de local de trabalho reserváveis.

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

    Tipo de dados: cadeia de caracteres
    result.reservation.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.

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

    Tipo de dados: objeto

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

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

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

    Tipo de dados: cadeia de caracteres
    result.reservation.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 de o mesmo número de ordem, ele é atribuído à ordem aleatória.

    Tipo de dados: número
    result.reservation.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.reservation.reservable_module.​reservation_paths Caminhos de reserva associados aos módulos reserváveis, como Procurar tudo, Procurar próximo a uma pessoa.

    Tipo de dados: matriz de objetos

    "reservation_paths": [
  {
    "displayValue": "String",
    "value": "String"
}
    result.reservation.reservable_module.​reservation_paths.display_value Valor de exibição para o caminho da reserva, como "Navegar próximo a uma pessoa".

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

    Tipo de dados: cadeia de caracteres
    result.reservation.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.reservation.reservable_module.​selection_type

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

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

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

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

    Tipo de dados: booliano
    result.reservation.reservable_module.sys_id Sys_id do módulo reservável.

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

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.short_description Breve descrição do intervalo de tempo.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.slot_end Hora de término do intervalo de tempo.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.slot_start Hora de início do slot.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.sys_id Sys_id do registro do intervalo de tempo.

    Localizado na tabela Intervalo de tempo [sn_wsd_rsv_time_slot].

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.title Título do módulo reservável.

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

    Tipo de dados: objeto

    "virtual_meeting_provider": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservation.reservable_module.​virtual_meeting_provider.display_value Valor de exibição do provedor de reunião virtual.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​virtual_meeting_provider.sys_id Sys_id do provedor de reunião virtual.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservationAcl Detalhes das verificações de níveis de controle de acesso (ACL) do usuário definidas na reserva associada.

    Tipo de dados: objeto

    "reservationAcl": {
  "read": Boolean,
  "write": {Object}
}
    result.reservation.reservationAcl.read Sinalizador que indica se deve ser verificado se o usuário pode ler esta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode ler a reserva.
    • falso: não verifica se o usuário pode ler a reserva.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write Detalhes sobre as capacidades de gravação do usuário para a reserva associada.

    Tipo de dados: objeto

    "write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
    result.reservation.reservationAcl.write.allFields Sinalizador que indica se deve ser verificado se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields. Se o usuário só tiver acesso a alguns campos específicos, somente esses campos serão verdadeiros no objeto reservationACL.write.fields.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields.
    • falso: não verifica se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields Detalhes dos controles de acesso em vários campos da reserva.

    Tipo de dados: objeto

    "fields": {
  "location": Boolean,
  "number_of_attendees": Boolean,
  "requested_for": Boolean,
  "sensitivity": Boolean,
  "subject": Boolean
}
    result.reservation.reservationAcl.write.fields.​location Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de local nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar nos campos de local.
    • falso: não verifica se o usuário pode gravar nos campos de local.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​número_de_participantes Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de número de participantes nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de número de participantes.
    • falso: não verifica se o usuário pode gravar no campo de número de participantes.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​requested_for Sinalizador que indica se o usuário deve verificar se pode gravar nos campos solicitados nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo solicitado para.
    • falso: não verifica se o usuário pode gravar no campo solicitado para.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​sensibilidade Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de confidencialidade nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de confidencialidade.
    • falso: não verifica se o usuário pode gravar no campo de confidencialidade.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​assunto Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de assunto nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de assunto.
    • falso: não verifica se o usuário pode gravar nos campos de assunto.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.record Sinalizador que indica se deve ser verificado se o usuário pode gravar em todo o registro de reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar em todo o registro de reserva.
    • falso: não verifica se o usuário pode gravar em todo o registro de reserva.

    Tipo de dados: booliano
    resultado.reserva.propósito_de_reserva Detalhes sobre a finalidade da reserva.

    Tipo de dados: objeto

    "reservation_purpose": {
  "display_value": "String,"
  "value": "String"
}
    resultado.reserva.reserva_propósito.​display_value Valor de exibição para fins de reserva, como reunião da empresa.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_propósito.valor Valor interno para fins de reserva, como company_meeting.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.tipo_de_reserva Detalhes sobre o tipo da reserva.

    Tipo de dados: objeto

    "reservation_type": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.reservation_type.​display_value Valor de exibição para o tipo de reserva, como Espaço.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.tipo_de_reserva.valor Valor interno para o tipo de reserva, como espaço.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_subtipo Detalhes sobre o subtipo da reserva. Os subtipos indicam o tipo de reserva, como única, primária múltipla, secundária múltipla, primária recorrente ou ocorrência.

    Tipo de dados: objeto

    "reservation_subtype": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.reservation_subtype.​display_value Valor de exibição para o subtipo da reserva, como Single.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_subtipo.valor Valor interno para o subtipo da reserva, como único.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sensibilidade Detalhes sobre a confidencialidade da reserva.

    Tipo de dados: objeto

    "sensitivity": {
  "display_value": "String,"
  "value": "String"
}
    resultado.reserva.sensibilidade.display_value Valor de exibição para a confidencialidade da reserva, como alta ou baixa.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sensibilidade.valor Valor interno para a confidencialidade da reserva, como 1 ou 3.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.turno Detalhes sobre o turno aplicado à reserva.

    Tipo de dados: objeto

    "shift": {
  "display_value": "String",
  "name": "String",
  "shiftDetails": "String",
  "sys_id": "String"
}
    result.reserva.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
    Resultado.reserva.turno.DetalhesDeMundo Detalhes do turno.

    Tipo de dados: cadeia de caracteres
    result.reservation.shift.sys_id Sys_id do registro de turno. Localizado na tabela Turno [sn_wsd_core_shift].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.origem Detalhes sobre a origem da reserva, como Serviços de local de trabalho ou Google Mail.

    Tipo de dados: objeto

    "source": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.source.display_value Valor de exibição para a origem da reserva, como Serviços de local de trabalho.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.valor.origem Valor interno para a 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

    "source_icon": {
  "classNames": "String",
  "imgSrc": "String",
  "tooltip": "String"
}
    result.reservation.source_icon.classNames Nomes de classe separados por vírgula 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 da ferramenta associada ao ícone de origem.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_origem 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.reserva.início Data e hora de início da reserva.

    Tipo de dados: cadeia de caracteres

    Formato: UTC - yyyy-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    resultado.reserva.assunto Assunto da reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sub_origem Detalhes sobre a suborigem da reserva. A suborigem especifica a origem da reserva, como Google Calendar ou Microsoft Exchange.

    Tipo de dados: objeto

    "sub_source": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.sub_source.display_value Valor de exibição para a suborigem da reserva, como o Google Calendar.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sub_origem.valor Valor interno do campo de suborigem da reserva, como google_calendar.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sincronização_estado Detalhes sobre o estado de sincronização de uma reserva de outro serviço, como "sync_enqueued" ou "synchronized".

    Tipo de dados: objeto

    "sync_state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.sync_state.display_value Valor de exibição para o 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
    resultado.reserva.sys_created_on Data e hora em que a reserva foi criada.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sys_id Obrigatório.
    Sys_id do registro de reserva. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres
    Resultado.reserva.sys_updated_on Data e hora em que a reserva foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reunião_virtual 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

    "reservationAcl": {
  "read": Boolean,
  "write": {Object}
}
    result.reservationAcl.read Sinalizador que indica se deve ser verificado se o usuário pode ler esta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode ler a reserva.
    • falso: não verifica se o usuário pode ler a reserva.

    Tipo de dados: booliano
    result.reservationAcl.write Detalhes sobre as capacidades de gravação do usuário para a reserva associada.

    Tipo de dados: objeto

    "write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
    result.reservationAcl.write.allFields Sinalizador que indica se deve ser verificado se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields. Se o usuário só tiver acesso a alguns campos específicos, somente esses campos serão verdadeiros no objeto reservationACL.write.fields.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields.
    • falso: não verifica se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields

    Tipo de dados: booliano
    result.reservationAcl.write.fields Detalhes dos controles de acesso em vários campos da reserva.

    Tipo de dados: objeto

    "fields": {
  "location": Boolean,
  "number_of_attendees": Boolean,
  "requested_for": Boolean,
  "sensitivity": Boolean,
  "subject": Boolean
}
    result.reservationAcl.write.fields.location Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de local nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar nos campos de local.
    • falso: não verifica se o usuário pode gravar nos campos de local.

    Tipo de dados: booliano
    result.reservationAcl.write.fields.​number_of_addeees Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de número de participantes nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de número de participantes.
    • falso: não verifica se o usuário pode gravar no campo de número de participantes.

    Tipo de dados: booliano
    result.reservationAcl.write.fields.requested_for Sinalizador que indica se o usuário deve verificar se pode gravar nos campos solicitados nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo solicitado para.
    • falso: não verifica se o usuário pode gravar no campo solicitado para.

    Tipo de dados: booliano
    result.reservationAcl.write.fields.sensibility Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de confidencialidade nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de confidencialidade.
    • falso: não verifica se o usuário pode gravar no campo de confidencialidade.

    Tipo de dados: booliano
    result.reservationAcl.write.fields.subject Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de assunto nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de assunto.
    • falso: não verifica se o usuário pode gravar nos campos de assunto.

    Tipo de dados: booliano
    resultado.ACL.reserva.registro Sinalizador que indica se deve ser verificado se o usuário pode gravar em todo o registro de reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar em todo o registro de reserva.
    • falso: não verifica se o usuário pode gravar em todo o registro de reserva.

    Tipo de dados: booliano
    resultado.serviços_padrão Preenchido somente se o parâmetro include_standard_services estiver definido como verdadeiro.
    Serviços padrão associados, como Flip Chart, Tela do projetor, Quadro branco e marcadores.

    Tipo de dados: matriz de objetos

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

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

    Tipo de dados: cadeia de caracteres
    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. Localizado na tabela Serviço padrão [sn_wsd_rsv_standard_service].

    Tipo de dados: cadeia de caracteres

    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"

    Retornar resultados:

    
  "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 - GET /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 da URL

    URL com controle de versões: /api/sn_wsd_rsv/{api_version}/reservation/get_user_reservations

    URL padrão: /api/sn_wsd_rsv/reservation/get_user_reservations

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    userId Sys_id do usuário cujas reservas serão retornadas. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    Tabela 9. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

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

    Códigos de status

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

    Tabela 12. Códigos de status
    Código de 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 de reserva.

    Tipo de dados: objeto

    "result":{
  "informEmployeePrivacy": Boolean,
  "reservationsByDate": {Object},
  "searchEndDate": "String",
  "searchStartDate": "String",
  "sortedReservationDates" : [Array],
  "workplaceProfile": {Object}
}
    result.informEmployeePrivacy Sinalizador que indica se uma mensagem deve ser exibida quando as reservas marcadas como privadas forem retornadas.
    Valores possíveis:
    • verdadeiro: exibe uma mensagem para o usuário de que há reservas privadas que não são exibidas.
    • falso: não exibe nenhuma mensagem.

    Tipo de dados: booliano
    resultado.reservasPorData Detalhes sobre cada reserva por data.

    Tipo de dados: objeto - cada data em sua própria matriz

    "reservationsByDate": {
  string: [
    {
      "building": {Object},
      "floor": {Object},
      "location": {Object}
    }
  ]
}
    result.reservationsByDate.building Edifício onde o reservável está localizado.

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

    "building": {
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
    result.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 do edifício associado.

    Tipo de dados: cadeia de caracteres
    result.reservationsByDate.building.timezone Detalhes do fuso horário do edifício.
    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    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
    resultado.reservasPorData.piso Detalhes sobre o piso associado à reserva.

    Tipo de dados: objeto

    "floor": {
  "displayValue": "String",
  "value": "String"
}
    resultado.reservasPorData.piso.ValorExibição Número de exibição do andar no qual o reservável reside, como 12.

    Tipo de dados: cadeia de caracteres
    resultado.reservasPorData.piso.valor Valor interno do piso no qual a reserva reside.

    Tipo de dados: cadeia de caracteres
    resultado.reservasPorData.local Detalhes sobre o local da reserva.

    Tipo de dados: objeto

    "location": {
  "displayValue": "String",
  "type": "String",
  "value": "String"
}
    result.reservationsByDate.location.​displayValue Valor de exibição do local, como Parques do Sul.

    Tipo de dados: cadeia de caracteres
    result.reservationsByDate.location.type Tipo de local, como local de trabalho/mesa, café ou academia.

    Tipo de dados: cadeia de caracteres
    result.reservationsByDate.location.value Valor interno do local, como sul_parques.

    Tipo de dados: cadeia de caracteres
    resultado.pesquisaEndDate 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
    resultado.pesquisaInícioDate 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 data.

    Tipo de dados: matriz
    resultado.perfildolocaldetrabalho Perfil do local de trabalho dos usuários. Descreve onde o usuário especificado trabalha.

    Tipo de dados: objeto

    "reservationsByDate": {
  "building": {Object},
  "floor": {Object},
  "location": {Object}
}
    resultado.workplaceProfile.building Edifício onde o usuário trabalha.

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

    "building": {
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
    result.workplaceProfile.building.display_value Valor de exibição do edifício.

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

    Tipo de dados: cadeia de caracteres
    result.workplaceProfile.building.timezone Detalhes do fuso horário do edifício.
    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    result.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
    result.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
    resultado.workplaceProfile.building.value Valor interno do edifício.

    Tipo de dados: cadeia de caracteres
    resultado.perfildolocaldetrabalho.piso Detalhes sobre o andar no qual o usuário trabalha.

    Tipo de dados: objeto

    "floor": {
  "displayValue": "String",
  "value": "String"
}
    result.workplaceProfile.andar.displayValue Número de exibição do andar no qual o usuário trabalha, como Andar 8.

    Tipo de dados: cadeia de caracteres
    resultado.trabalho.perfil.andar.valor Valor interno do andar no qual o usuário trabalha.

    Tipo de dados: cadeia de caracteres
    resultado.perfil.localdetrabalho.local Detalhes sobre a localização do usuário.

    Tipo de dados: objeto

    "location": {
  "displayValue": "String",
  "type": "String",
  "value": "String"
}
    result.workplaceProfile.location.displayValue Valor de exibição do local, como San Diego.

    Tipo de dados: cadeia de caracteres
    result.workplaceProfile.location.type Tipo de local, como mesa ou escritório.

    Tipo de dados: cadeia de caracteres
    resultado.workplaceProfile.location.value Valor interno para o 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"

    Retornar resultados:

    {
  "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 – GET /api/sn_wsd_rsv/reservation/icalendar/{sys_id}

    Gera um corpo de arquivo iCalendar para uma reserva especificada.

    Formato da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/reservation/icalendar/{sys_id}

    URL padrão: /api/sn_wsd_rsv/reservation/icalendar/{sys_id}

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor 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. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

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

    Cabeçalhos

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

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

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

    Códigos de status

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

    Tabela 18. Códigos de status
    Código de 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 iCalender.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/icalendar/60d26a0f47578910003a4587746d4331" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Retornar resultados:

    {
  "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 - GET /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 da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/reservation/list

    URL padrão: /api/sn_wsd_rsv/reservation/list

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    encodedQuery Consulta codificada a ser usada para filtrar os resultados do registro de reserva retornado. Todos os campos na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation] são válidos na consulta.

    Por exemplo, active=true^requested_for=2de07e1887cb89106342b846dabb35fe​^building=4703a4cedb3650106c731dcd13961945

    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 que o número disponível de registros de resultados de retorno, todos os registros restantes serão retornados.

    Tipo de dados: número
    orderByEndDesc

    Sinalizador que indica se os resultados de retorno devem ser retornados na ordem decrescente de hora de início.

    Valores válidos:
    • verdadeiro: retorna os resultados em ordem decrescente.
    • falso: retorna os resultados em ordem crescente.

    Padrão: falso
    searchCriteria Texto que precisa corresponder à reserva para ser incluído nos resultados de retorno. O endpoint verifica esse valor nos seguintes campos:
    • configuração_item.nome
    • local.nome
    • assunto_privado
    • request_for.name
    • assunto

    Tipo de dados: cadeia de caracteres
    startIndex Registro inicial para o qual os registros serão retornados, com base em zero. Use este parâmetro para paginar por meio de 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. Localizado na tabela Usuário [sys_user].

    Quando este valor é aprovado, o endpoint filtra as reservas em que o campo request_for ou opened_by é igual ao usuário conectado no momento. A partir dessa lista de reservas, ele filtra as reservas em que o 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 21. Parâmetros do corpo da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xml ou, 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.

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

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

    Códigos de status

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

    Tabela 24. Códigos de status
    Código de 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

    "reservation": {
  "active": Boolean,
  "attendees": [Array],
  "check_in_state": {Object},
  "end": "String",
  "external_ical": "String",
  "external_id": "String",
  "is_parent": Boolean,
  "is_private": Boolean,
  "informEmployeePrivacy": Boolean.
  "last_updated_sub_source": {Object},
  "location" {Object},
  "number": "String",
  "number_of_attendees": Number,
  "recording_details": [Array],
  "reservable_module": {Object},
  "reservation_purpose": {Object},
  "reservation_type": {Object},
  "reservation_subtype": {Object},
  "sensitivity": {Object},
  "start": "String",
  "state": {Object},
  "source_reservation": "String",
  "subject": "String",
  "sub_source": {Object},
  "sync_state": {Object},
  "sys_created_on: "String",
  "sys_id": "String",
  "sys_updated_on": "String",
  "virtual_meeting": "String"
}
    result.reservation.active Sinalizador que indica se a reserva está ativa.
    Valores válidos:
    • verdadeiro: a reserva está ativa.
    • falso: a reserva está inativa.

    Tipo de dados: booliano
    resultado.reserva.participantes Lista de participantes da reserva.

    Tipo de dados: matriz de objetos

    "attendees": [
  {
    "avatar": "String",
    "displayValue": "String",
    "display_value": "String",
    "email": "String",
    "initials": "String",
    "label": "String",
    "name": "String",
    "sys_id": "String",
    "table": "String",
    "user_name": "String",
    "value": "String"
  }
]
    resultado.reserva.participantes.avatar Sys_id do avatar associado ao participante. Localizado na tabela Anexos [sys_attachment].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.displayValue Valor de exibição para o participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.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
    resultado.reserva.participantes.iniciais Iniciais do participante.

    Tipo de dados: cadeia de caracteres
    result.reservation.attendees.name Nome do participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.sys_id Sys_id_of do registro do participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.tabela Tabela na qual existe o registro do participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.nome_usuário 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
    resultado.reserva.check_in_state Detalhes sobre o estado de check-in da reserva.

    Tipo de dados: objeto

    "check_in_state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.check_in_state.​display_value Valor de exibição para o estado de check-in atual da reserva, como Em andamento ou concluído.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.check_in_state.value Valor interno para o 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 full_restricted.

    Tipo de dados: objeto

    "edit_restriction": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.edit_restriction.display_​value Valor de exibição para as 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.reserva.término 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
    resultado.reserva.externo_ical Identificação iCalendar 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.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
    resultado.reserva.é_primário Sinalizador que indica se esta reserva é uma reserva primária.
    Valores possíveis:
    • verdadeiro: reserva primária.
    • falso: não há uma reserva primária.

    Tipo de dados: booliano
    resultado.reserva.é_privado 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 e impacto da privacidade do local.

    Valores válidos:
    • verdadeiro: a reserva é privada.
    • falso: a reserva não é privada.

    Tipo de dados: booliano

    Padrão: valor definido para privacidade nas propriedades do sistema.
    result.reservation.last_updated_sub_source Detalhes sobre a última suborigem atualizada da reserva. 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

    "last_updated_sub_source": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.last_updated_sub_source.​display_value Valor de exibição da última suborigem atualizada da reserva, como Prestação de serviços no local de trabalho da ServiceNow ou Google Calendar. Usado ao integrar a reserva com um serviço externo, como o calendário do Google ou o Microsoft Outlook.

    Tipo de dados: cadeia de caracteres
    result.reservation.last_updated_sub_source.​value Valor interno da última suborigem atualizada da reserva, como servicenow_workplace_service_delivery ou google_calendar. Usado ao integrar a reserva com um serviço externo, como o calendário do Google ou o Microsoft Outlook.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local Detalhes sobre o local associado à reserva.

    Tipo de dados: objeto

    "location": {
  "active": Boolean,
  "area": {Object},
  "building": {Object},
  "campus": {Object},
  "capacity": Number,
  "description": "String",
  "display_value": "String",
  "email": "String",
  "floor": {Object},
  "label_value": "String",
  "name": "String",
  "number_of_attendees": Number,
  "region": {Object},
  "reservable_module": {Object},
  "reservation": {Object},
  "site": {Object},
  "state": {Object},
  "sys_id": "String"
}
    resultado.reserva.local.área Detalhes sobre a área associada ao local.

    Tipo de dados: objeto

    "area": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.area.active Sinalizador que indica se a área está ativa.
    Valores válidos:
    • verdadeiro: a área está ativa.
    • falso: a área está inativa.

    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. Localizado na tabela Área [sn_wsd_core_area].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.edifício Detalhes sobre o edifício associado ao local.

    Tipo de dados: objeto

    "building": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
    result.reservation.location.building.active Sinalizador que indica se o edifício está ativo.
    Valores válidos:
    • verdadeiro: o edifício está ativo.
    • falso: o edifício está inativo.

    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. Localizado na tabela edifício [sn_wsd_core_building].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.prédio.fuso horário Detalhes sobre o fuso horário associado ao local.

    Tipo de dados: objeto

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    result.reservation.location.building.timezone.​display_value Valor de exibição para o fuso horário ao qual este local pertence.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.building.timezone.​value Valor interno para o fuso horário ao qual este local pertence.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.campus Detalhes sobre o campus associado ao local.

    Tipo de dados: objeto

    "campus": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.campus.active Sinalizador que indica se o campus está ativo.
    Valores válidos:
    • verdadeiro: o campus está ativo.
    • falso: o campus está inativo.

    Tipo de dados: booliano
    result.reservation.location.campus.​display_value Valor de exibição do campus ao qual este local pertence, como Campus Amsterdã.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.campus.sys_id Sys_id do campus ao qual este local pertence. Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.capacidade Número máximo de ocupantes do local.

    Tipo de dados: número
    resultado.reserva.local.descrição Breve descrição do local.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.exibição_valor Valor a ser exibido na IU para este local.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.email Endereço de e-mail do local.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.piso Detalhes sobre o andar associado ao local.

    Tipo de dados: objeto

    "floor": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.floor.active Sinalizador que indica se o piso está ativo.
    Valores válidos:
    • verdadeiro: o piso está ativo.
    • falso: o piso está inativo.

    Tipo de dados: booliano
    resultado.reserva.local.piso.valor_de_exibição Valor de exibição do andar ao qual este local pertence, como Primeiro andar.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.piso.sys_id Sys_id do andar ao qual este local pertence. Localizado na tabela Piso [sn_wsd_core_chão].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.rótulo_valor Tipo de valor especificado no parâmetro name, como Nome da sala.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.name Nome do local.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.número 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
    resultado.reserva.local.região Detalhes sobre a região associada ao local.

    Tipo de dados: objeto

    "region": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.region.active Sinalizador que indica se a região está ativa.
    Valores válidos:
    • verdadeiro: a região está ativa.
    • falso: a região está inativa.

    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. Localizado na tabela Região [sn_wsd_core_region].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.solicitado_para Detalhes sobre a pessoa para quem a reserva foi solicitada.

    Tipo de dados: objeto

    "requested_for": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
    result.reservation.location.requested_for.​name 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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservation.location.requested_for.​user_name Nome de usuário do usuário para o qual a reserva foi solicitada.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.reserva Detalhes sobre a reserva associada ao local.

    Tipo de dados: objeto

    "reservation": {
  "active": Boolean,
  "number": "String",
  "number_of_attendees": Number,
  "requested_for": {Object},
  "state": {Object},
  "sys_id": "String"
}
    result.reservation.location.reservation.active Sinalizador que indica se a reserva está ativa.
    Valores válidos:
    • verdadeiro: a reserva está ativa.
    • falso: a reserva está inativa.

    Tipo de dados: booliano
    resultado.reserva.local.reserva.número Número da reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.reserva.​número_de_participantes 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.

    Tipo de dados: objeto

    "requested_for": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
    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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservation.location.reservation.​requested_for.user_name Nome de usuário do 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

    
  "reservable_module": {
    "inline_title": "String",
    "name": "String",
    "sys_id": "String",
    "title": "String",
  },
    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.reservation.location.reservable_module.​name 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.​title Título do módulo reservável.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.site Site ao qual o local pertence. Localizado na tabela Site [sn_wsd_core_site].

    Tipo de dados: objeto

    "site": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String",
}
    result.reservation.location.site.active Sinalizador que indica se o site está ativo.
    Valores válidos:
    • verdadeiro: o site está ativo.
    • falso: o site está inativo.

    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. Localizado na tabela Site [sn_wsd_core_site].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.estado Detalhes sobre o estado da reserva do local.

    Tipo de dados: objeto

    "state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.location.state.display_value Valor de exibição para o estado atual da reserva, como confirmado.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.estado.valor Valor interno para o estado atual da reserva, como 2.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.sys_id Sys_id do registro de local associado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    result.reservation.notification_custom_​message 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

    "notification_recipients":[
  {
    "name": "String",
    "sys_id": "String",
    "user_name": "String"
  }
]
    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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservation.notification_recipients.​user_name Nome de usuário do destinatário.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.número Número exclusivo do registro de reserva. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation]. Você pode usar este valor para consultar a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.aberto_por Detalhes sobre o usuário que criou a reserva.

    Tipo de dados: objeto

    "opened_by": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
    resultado.reserva.aberto_por.avatar Avatar do usuário que abriu a reserva.

    Tipo de dados: cadeia de caracteres
    result.reservation.opened_by.displayValue Valor de exibição de aberto pelo usuário.

    Tipo de dados: cadeia de caracteres
    result.reservation.opened_by.display_value Valor de exibição de 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
    resultado.reserva.aberto_por.iniciais Iniciais do usuário que abriu a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.aberto_por.rótulo Rótulo para o usuário que abriu a reserva. Esta é uma combinação do cargo 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
    result.rservation.opened_by.sys_id Sys_id_of do usuário que abriu a reserva. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.rservation.opened_by.table Tabela que contém o registro do usuário.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.aberto_por.nome_usuário Nome de usuário do usuário que abriu a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.aberto_por.valor Valor interno do usuário que abriu a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.número Número da reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.número_de_participantes 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

    "recording_details": [
  "recording_url": "String"
]
    result.reservation.recording_details.​recording_url URL das gravações associadas à reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitada_para Detalhes sobre o usuário para o qual a reserva foi feita.

    Tipo de dados: objeto

    "requested_for": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
    resultado.reserva.solicitado_para.avatar Avatar do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    result.reservation.requested_for.displayValue Valor de exibição do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    result.reservation.requested_for.display_value Valor de exibição do usuário para o qual a reserva foi feita. Igual a displayValue.

    Tipo de dados: cadeia de caracteres
    result.reservation.requested_for.email Endereço de e-mail do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitada_para.iniciais Iniciais do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitada_para.rótulo Rótulo para o 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 para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    result.rservation.requested_for.sys_id Sys_id_of do usuário para o qual a reserva foi feita. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.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 para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitado_para.valor Valor interno do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.módulo_reservado Detalhes do módulo reservável solicitado.

    Tipo de dados: objeto

    {
  "reservable_module": {
    "allow_invitees": Boolean,
    "allow_whole_day": Boolean,
    "apply_to_shift": Boolean,
    "browse_by_area_enabled": Boolean,
    "browse_near_a_person_enabled": Boolean,
    "buildingSysIds": [Array],
    "checkin_before_minutes": Number,
    "display_number_of_attendees": Boolean,
    "display_on_behalf_of": Boolean,
    "display_sensitivity": Boolean,
    "display_value": "String",
    "enable_browse_by_area": Boolean,
    "enable_browse_near_a_person": Boolean,
    "enable_facet_filter": Boolean,
    "enable_group_reservations": Boolean,
    "enable_ical_generation": Boolean,
    "font_awesome_icon": "String",
    "inline_title": "String",      
    "layout_mapping": {JSON Object},
    "max_days_in_future": Number,
    "max_occurrences": Number,
    "name": "String",
    "override_approval_policy": "String",
    "require_cancel_notes": Boolean,
    "require_cc_dept_check": Boolean,
    "require_subject": Boolean,
    "reservable_columns": [Array],
    "reservable_container_field": "String",
    "reservable_filter": "String",
    "reservable_quantity_field": "String",
    "reservable_table": "String",
    "reservable_type": "String",
    "reservable_views": [Array],
    "reservation_paths": [Array],
    "search_limit": Number,
    "selection_type": "String",
    "short_description": "String",
    "show_map_view": Boolean,
    "sys_id": "String",
    "timeSlots": [Array],
    "title": "String",
    "virtual_meeting_provider": {Object}
  }
}
    result.reservation.reservable_module.​allow_invitees Sinalizador que indica se os funcionários podem adicionar convidados à reserva.
    Valores válidos:
    • verdadeiro: permite que os funcionários adicionem convidados à reserva.
    • falso: não permite que os funcionários adicionem convidados à reserva.

    Tipo de dados: booliano
    result.reservation.reservable_module.​allow_whole_day Sinalizador que indica se os usuários podem reservar o reservável pelo dia inteiro.
    Valores válidos:
    • verdadeiro: permite que os usuários reservem o dia inteiro.
    • falso: não permite que os usuários reservem o dia inteiro.

    Tipo de dados: booliano
    result.reservation.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:
    • verdadeiro: permite reservas baseadas em turno.
    • falso: não permite reservas baseadas em turno.

    Tipo de dados: booliano
    result.reservation.reservable_module.​browse_by_area_enabled Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por área.
    Valores válidos:
    • verdadeiro: permite que os usuários pesquisem módulos reserváveis por área.
    • falso: não permite que os usuários pesquisem módulos reserváveis por área.

    Tipo de dados: booliano
    result.reservation.reservable_module.​browse_near_a_person_enabled Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada.
    Valores válidos:
    • verdadeiro: permite que os usuários naveguem pelos módulos reserváveis próximos a uma pessoa.
    • falso: não permite que os usuários naveguem pelos módulos reserváveis perto de uma pessoa.

    Tipo de dados: booliano
    result.reservation.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.reservation.reservable_module.​checkin_before_minutes Quantidade de tempo antes do início de uma reserva em que um usuário pode fazer check-in na reserva.

    Unidade: minutos

    Tipo de dados: número
    result.reservation.reservable_module.​display_number_of_appers Sinalizador que indica se os usuários podem especificar o número de participantes na reserva.
    Valores válidos:
    • verdadeiro: os usuários podem especificar o número de participantes.
    • falso: os usuários não podem especificar o número de exibição de participantes.

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

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

    Tipo de dados: booliano
    result.reservation.reservable_module.​display_value Valor de exibição do módulo reservável.

    Tipo de dados: cadeia de caracteres
    result.reservation.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:
    • verdadeiro: permite que os usuários pesquisem módulos reserváveis por área.
    • falso: não permite que os usuários pesquisem módulos reserváveis por área.

    Tipo de dados: booliano
    result.reservation.reservable_module.​enable_browse_near_a_person Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada. Igual a browse_near_a_person_enabled.
    Valores válidos:
    • verdadeiro: permite que os usuários naveguem pelos módulos reserváveis próximos a uma pessoa.
    • falso: não permite que os usuários naveguem pelos módulos reserváveis perto de uma pessoa.

    Tipo de dados: booliano
    result.reservation.reservable_module.​enable_facet_filter Sinalizador que indica se a filtragem de aspecto nos itens do local de trabalho está habilitada. Quando habilitadas, as opções de filtro que aparecem 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 selecionarem no filtro.
    Valores válidos:
    • verdadeiro: os filtros de aspecto estão habilitados.
    • falso: os filtros de aspecto não estão habilitados.

    Tipo de dados: booliano
    result.reservation.reservable_module.​enable_group_reservations Sinalizador que indica se os usuários podem fazer uma reserva de grupo.
    Valores válidos:
    • verdadeiro: capaz de fazer reservas de grupo.
    • falso: não é possível fazer reservas de grupo.

    Tipo de dados: booliano
    result.reservation.reservable_module.​enable_ical_generation Sinalizador que indica se os usuários podem gerar um iCalendar para a reserva.
    Valores válidos:
    • verdadeiro: geração de iCalendar permitida.
    • falso: a geração de iCalendar não é permitida.

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

    Tipo de dados: cadeia de caracteres
    result.reservation.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.reservation.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

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

    Tipo de dados: matriz de objetos

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Tipo de dados: booliano
    result.reservation.reservable_module.​reservable_columns Lista das colunas de um reservável. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: matriz
    result.reservation.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
    result.reservation.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 no campo Tabela reservável.

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

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​reservable_table Tabela que contém os itens de local de trabalho reserváveis.

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

    Tipo de dados: cadeia de caracteres
    result.reservation.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.

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

    Tipo de dados: objeto

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

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

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

    Tipo de dados: cadeia de caracteres
    result.reservation.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 de o mesmo número de ordem, ele é atribuído à ordem aleatória.

    Tipo de dados: número
    result.reservation.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.reservation.reservable_module.​reservation_paths Caminhos de reserva associados aos módulos reserváveis, como Procurar tudo, Procurar próximo a uma pessoa.

    Tipo de dados: matriz de objetos

    "reservation_paths": [
  {
    "displayValue": "String",
    "value": "String"
}
    result.reservation.reservable_module.​reservation_paths.display_value Valor de exibição para o caminho da reserva, como "Navegar próximo a uma pessoa".

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

    Tipo de dados: cadeia de caracteres
    result.reservation.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.reservation.reservable_module.​selection_type

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

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

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

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

    Tipo de dados: booliano
    result.reservation.reservable_module.sys_id Sys_id do módulo reservável.

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

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.short_description Breve descrição do intervalo de tempo.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.slot_end Hora de término do intervalo de tempo.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.slot_start Hora de início do slot.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.sys_id Sys_id do registro do intervalo de tempo.

    Localizado na tabela Intervalo de tempo [sn_wsd_rsv_time_slot].

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.title Título do módulo reservável.

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

    Tipo de dados: objeto

    "virtual_meeting_provider": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservation.reservable_module.​virtual_meeting_provider.display_value Valor de exibição do provedor de reunião virtual.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​virtual_meeting_provider.sys_id Sys_id do provedor de reunião virtual.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservationAcl Detalhes das verificações de níveis de controle de acesso (ACL) do usuário definidas na reserva associada.

    Tipo de dados: objeto

    "reservationAcl": {
  "read": Boolean,
  "write": {Object}
}
    result.reservation.reservationAcl.read Sinalizador que indica se deve ser verificado se o usuário pode ler esta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode ler a reserva.
    • falso: não verifica se o usuário pode ler a reserva.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write Detalhes sobre as capacidades de gravação do usuário para a reserva associada.

    Tipo de dados: objeto

    "write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
    result.reservation.reservationAcl.write.allFields Sinalizador que indica se deve ser verificado se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields. Se o usuário só tiver acesso a alguns campos específicos, somente esses campos serão verdadeiros no objeto reservationACL.write.fields.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields.
    • falso: não verifica se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields Detalhes dos controles de acesso em vários campos da reserva.

    Tipo de dados: objeto

    "fields": {
  "location": Boolean,
  "number_of_attendees": Boolean,
  "requested_for": Boolean,
  "sensitivity": Boolean,
  "subject": Boolean
}
    result.reservation.reservationAcl.write.fields.​location Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de local nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar nos campos de local.
    • falso: não verifica se o usuário pode gravar nos campos de local.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​número_de_participantes Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de número de participantes nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de número de participantes.
    • falso: não verifica se o usuário pode gravar no campo de número de participantes.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​requested_for Sinalizador que indica se o usuário deve verificar se pode gravar nos campos solicitados nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo solicitado para.
    • falso: não verifica se o usuário pode gravar no campo solicitado para.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​sensibilidade Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de confidencialidade nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de confidencialidade.
    • falso: não verifica se o usuário pode gravar no campo de confidencialidade.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​assunto Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de assunto nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de assunto.
    • falso: não verifica se o usuário pode gravar nos campos de assunto.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.record Sinalizador que indica se deve ser verificado se o usuário pode gravar em todo o registro de reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar em todo o registro de reserva.
    • falso: não verifica se o usuário pode gravar em todo o registro de reserva.

    Tipo de dados: booliano
    resultado.reserva.propósito_de_reserva Detalhes sobre a finalidade da reserva.

    Tipo de dados: objeto

    "reservation_purpose": {
  "display_value": "String,"
  "value": "String"
}
    resultado.reserva.reserva_propósito.​display_value Valor de exibição para fins de reserva, como reunião da empresa.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_propósito.valor Valor interno para fins de reserva, como company_meeting.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.tipo_de_reserva Detalhes sobre o tipo da reserva.

    Tipo de dados: objeto

    "reservation_type": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.reservation_type.​display_value Valor de exibição para o tipo de reserva, como Espaço.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.tipo_de_reserva.valor Valor interno para o tipo de reserva, como espaço.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_subtipo Detalhes sobre o subtipo da reserva. Os subtipos indicam o tipo de reserva, como única, primária múltipla, secundária múltipla, primária recorrente ou ocorrência.

    Tipo de dados: objeto

    "reservation_subtype": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.reservation_subtype.​display_value Valor de exibição para o subtipo da reserva, como Single.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_subtipo.valor Valor interno para o subtipo da reserva, como único.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sensibilidade Detalhes sobre a confidencialidade da reserva.

    Tipo de dados: objeto

    "sensitivity": {
  "display_value": "String,"
  "value": "String"
}
    resultado.reserva.sensibilidade.display_value Valor de exibição para a confidencialidade da reserva, como alta ou baixa.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sensibilidade.valor Valor interno para a confidencialidade da reserva, como 1 ou 3.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.turno Detalhes sobre o turno aplicado à reserva.

    Tipo de dados: objeto

    "shift": {
  "display_value": "String",
  "name": "String",
  "shiftDetails": "String",
  "sys_id": "String"
}
    result.reserva.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
    Resultado.reserva.turno.DetalhesDeMundo Detalhes do turno.

    Tipo de dados: cadeia de caracteres
    result.reservation.shift.sys_id Sys_id do registro de turno. Localizado na tabela Turno [sn_wsd_core_shift].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.origem Detalhes sobre a origem da reserva, como Serviços de local de trabalho ou Google Mail.

    Tipo de dados: objeto

    "source": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.source.display_value Valor de exibição para a origem da reserva, como Serviços de local de trabalho.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.valor.origem Valor interno para a 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

    "source_icon": {
  "classNames": "String",
  "imgSrc": "String",
  "tooltip": "String"
}
    result.reservation.source_icon.classNames Nomes de classe separados por vírgula 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 da ferramenta associada ao ícone de origem.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_origem 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.reserva.início Data e hora de início da reserva.

    Tipo de dados: cadeia de caracteres

    Formato: UTC - yyyy-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    resultado.reserva.assunto Assunto da reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sub_origem Detalhes sobre a suborigem da reserva. A suborigem especifica a origem da reserva, como Google Calendar ou Microsoft Exchange.

    Tipo de dados: objeto

    "sub_source": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.sub_source.display_value Valor de exibição para a suborigem da reserva, como o Google Calendar.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sub_origem.valor Valor interno do campo de suborigem da reserva, como google_calendar.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sincronização_estado Detalhes sobre o estado de sincronização de uma reserva de outro serviço, como "sync_enqueued" ou "synchronized".

    Tipo de dados: objeto

    "sync_state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.sync_state.display_value Valor de exibição para o 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
    resultado.reserva.sys_created_on Data e hora em que a reserva foi criada.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sys_id Obrigatório.
    Sys_id do registro de reserva. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres
    Resultado.reserva.sys_updated_on Data e hora em que a reserva foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reunião_virtual 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

    "reservationAcl": {
  "read": Boolean,
  "write": {Object}
}
    result.reservationAcl.read Sinalizador que indica se deve ser verificado se o usuário pode ler esta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode ler a reserva.
    • falso: não verifica se o usuário pode ler a reserva.

    Tipo de dados: booliano
    result.reservationAcl.write Detalhes sobre as capacidades de gravação do usuário para a reserva associada.

    Tipo de dados: objeto

    "write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
    result.reservationAcl.write.allFields Sinalizador que indica se deve ser verificado se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields. Se o usuário só tiver acesso a alguns campos específicos, somente esses campos serão verdadeiros no objeto reservationACL.write.fields.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields.
    • falso: não verifica se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields

    Tipo de dados: booliano
    result.reservationAcl.write.fields Detalhes dos controles de acesso em vários campos da reserva.

    Tipo de dados: objeto

    "fields": {
  "location": Boolean,
  "number_of_attendees": Boolean,
  "requested_for": Boolean,
  "sensitivity": Boolean,
  "subject": Boolean
}
    result.reservationAcl.write.fields.location Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de local nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar nos campos de local.
    • falso: não verifica se o usuário pode gravar nos campos de local.

    Tipo de dados: booliano
    result.reservationAcl.write.fields.​number_of_addeees Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de número de participantes nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de número de participantes.
    • falso: não verifica se o usuário pode gravar no campo de número de participantes.

    Tipo de dados: booliano
    result.reservationAcl.write.fields.requested_for Sinalizador que indica se o usuário deve verificar se pode gravar nos campos solicitados nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo solicitado para.
    • falso: não verifica se o usuário pode gravar no campo solicitado para.

    Tipo de dados: booliano
    result.reservationAcl.write.fields.sensibility Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de confidencialidade nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de confidencialidade.
    • falso: não verifica se o usuário pode gravar no campo de confidencialidade.

    Tipo de dados: booliano
    result.reservationAcl.write.fields.subject Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de assunto nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de assunto.
    • falso: não verifica se o usuário pode gravar nos campos de assunto.

    Tipo de dados: booliano
    resultado.ACL.reserva.registro Sinalizador que indica se deve ser verificado se o usuário pode gravar em todo o registro de reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar em todo o registro de reserva.
    • falso: não verifica se o usuário pode gravar em todo o registro de reserva.

    Tipo de dados: booliano
    resultado.serviços_padrão Preenchido somente se o parâmetro include_standard_services estiver definido como verdadeiro.
    Serviços padrão associados, como Flip Chart, Tela do projetor, Quadro branco e marcadores.

    Tipo de dados: matriz de objetos

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

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

    Tipo de dados: cadeia de caracteres
    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. Localizado na tabela Serviço padrão [sn_wsd_rsv_standard_service].

    Tipo de dados: cadeia de caracteres

    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"

    Retornar resultados:

    {
  "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/{sys_id}

    Cancela uma reserva de local de trabalho especificada.

    Formato da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/reservation/cancel/{sys_id}

    URL padrão: /api/sn_wsd_rsv/reservation/cancel/{sys_id}

    Parâmetros de solicitação compatíveis

    Tabela 25. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor 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. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres
    Tabela 26. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 27. Parâmetros do corpo da solicitação
    Nome Descrição
    cancel_notas Motivo do cancelamento da 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.

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

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

    Códigos de status

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

    Tabela 30. Códigos de status
    Código de 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. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres

    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’

    Retornar resultados:

    "result": {
  "sys_id": "73c316d2474b0150003a4587746d4337"
}

    Reserva de WSD – PATCH /api/sn_wsd_rsv/reservation/share_details/{sys_id}

    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 da URL

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

    URL padrão: /api/sn_wsd_rsv/reservation/share_details/{sys_id}

    Parâmetros de solicitação compatíveis

    Tabela 31. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor 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 compartilhada. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres
    Tabela 32. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 33. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    notificação_mensagem_personalizada Mensagem a ser enviada aos destinatários especificados.

    Tipo de dados: cadeia de caracteres
    notificação_recipients Obrigatório. Lista de sys_ids dos usuários para os quais a notificação por e-mail será enviada. Localizado na tabela Usuário [sys_user].

    Tipo de dados: matriz
    notificação_tipo Tipo de notificação a ser enviada.
    Tipos válidos:
    • reserva_cancelada
    • reserva_criada
    • reserva_atualizada

    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.

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

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

    Códigos de status

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

    Tabela 36. Códigos de status
    Código de 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. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres

    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"

    Retornar resultados:

    "result": {
  "sys_id": "60d26a0f47578910003a4587746d4331"
}

    Reserva de WSD – PATCH /api/sn_wsd_rsv/reservation/update/{sys_id}

    Atualiza uma reserva de local de trabalho especificada.

    Formato da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/reservation/update/{sys_id}

    URL padrão: /api/sn_wsd_rsv/reservation/update/{sys_id}

    Parâmetros de solicitação compatíveis

    Tabela 37. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor 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. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres
    Tabela 38. Parâmetros de consulta
    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 inicial e final.
    Valores válidos:
    • verdadeiro: ignora a validação da data de mudança.
    • falso: não ignore a validação da data de mudança.

    Tipo de dados: booliano

    Padrão: falso
    Tabela 39. Parâmetros do corpo da solicitação
    Nome Descrição
    terminar Obrigatório se o parâmetro shift não for 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 e impacto da privacidade do local.

    Valores válidos:
    • verdadeiro: a reserva é privada.
    • falso: a reserva não é privada.

    Tipo de dados: booliano

    Padrão: valor definido para privacidade nas propriedades do sistema.
    local Obrigatório.
    Sys_id do local a ser reservado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    requested_for Sys_id ou endereço de e-mail do usuário para o qual a reserva está sendo feita. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    shift
    Sys_id do turno a ser associado à reserva. Localizado na tabela Turno [sn_wsd_core_shift]. Se este parâmetro for passado, o parâmetro end não será necessário.

    Para obter informações adicionais sobre reservas baseadas em turno, consulte Habilitar reserva baseada em turno.

    Tipo de dados: cadeia de caracteres
    iniciar 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.

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

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

    Códigos de status

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

    Tabela 42. Códigos de status
    Código de 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": "String",
  "sys_id": "String",
  "type_of_change": "String"
}
    resultado.local_id Sys_id do registro do local de reserva. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    resultado.sys_id Sys_id do registro de reserva modificado. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres
    resultado.tipo_de_mudança Tipo de informações atualizadas 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"

    Retornar resultados:

    {
  "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 da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/reservation/add

    URL padrão: /api/sn_wsd_rsv/reservation/add

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres
    Tabela 44. Parâmetros de consulta
    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 inicial e final.
    Valores válidos:
    • verdadeiro: ignora a validação da data de mudança.
    • falso: não ignore a validação da data de mudança.

    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/Amsterdã. Esta validação verifica se a hora de início e a hora de término coincidem no mesmo dia.

    Tipo de dados: cadeia de caracteres

    Padrão: fuso horário do usuário
    Tabela 45. Parâmetros do corpo da solicitação
    Nome Descrição
    terminar Obrigatório se o parâmetro shift não for 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 e impacto da privacidade do local.

    Valores válidos:
    • verdadeiro: a reserva é privada.
    • falso: a reserva não é privada.

    Tipo de dados: booliano

    Padrão: valor definido para privacidade nas propriedades do sistema.
    local Obrigatório.
    Sys_id do local a ser reservado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    requested_for Sys_id ou endereço de e-mail do usuário para o qual a reserva está sendo feita. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    módulo_reservavel Obrigatório. Sys_id do módulo reservável a ser associado à reserva. Um módulo reservável define os itens do local de trabalho necessários para uma reserva. Localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module].

    Tipo de dados: cadeia de caracteres
    shift
    Sys_id do turno a ser associado à reserva. Localizado na tabela Turno [sn_wsd_core_shift]. Se este parâmetro for passado, o parâmetro end não será necessário.

    Para obter informações adicionais sobre reservas baseadas em turno, consulte Habilitar reserva baseada em turno.

    Tipo de dados: cadeia de caracteres
    iniciar 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.

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

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

    Códigos de status

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

    Tabela 48. Códigos de status
    Código de 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. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres

    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"

    Retornar resultados:

    "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 da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/reservation/quick_reserve

    URL padrão: /api/sn_wsd_rsv/reservation/quick_reserve

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres
    Tabela 50. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 51. Parâmetros do corpo da solicitação
    Nome Descrição
    terminar Obrigatório se o parâmetro shift não for 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 os parâmetros start e end.
    Valores válidos:
    • verdadeiro: ignora a validação da data de mudança. Defina como verdadeiro quando as datas de início e término forem as mesmas.
    • falso: não ignore a validação da data de mudança.

    Tipo de dados: booliano
    reference_location_id Obrigatório. Sys_id do local, próximo ao qual o usuário deseja reservar um local. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    módulo_reservavel Obrigatório. Sys_id do módulo reservável a ser associado à reserva. Um módulo reservável define os itens do local de trabalho necessários para uma reserva. Localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module].

    Tipo de dados: cadeia de caracteres
    shift
    Sys_id do turno a ser associado à reserva. Localizado na tabela Turno [sn_wsd_core_shift]. Se este parâmetro for passado, o parâmetro end não será necessário.

    Para obter informações adicionais sobre reservas baseadas em turno, consulte Habilitar reserva baseada em turno.

    Tipo de dados: cadeia de caracteres
    iniciar 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.

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

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

    Códigos de status

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

    Tabela 54. Códigos de status
    Código de 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. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres

    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"

    Retornar resultados:

    "result": {
  "sys_id": "4b036a9e474b0150003a4587746d43b1"
}