API de pesquisa WSD

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

    • . Prestação de serviços no local de trabalho(WSD) Pesquisa A API fornece endpoints para pesquisar locais e itens do local de trabalho disponíveis, como reserváveis, módulos reserváveis e turnos disponíveis.

    Para acessar esta API, o solicitante deve ter a função sn_wsd_core.workplace_user e os plug-ins Gestão de segurança no local de trabalho (sn_wsd_core) e Gestão de reservas no local de trabalho (sn_wsd_rsv) devem estar ativados.

    Esta API é executada no sn_wsd_rsv namespace.

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

    Pesquisa WSD - OBTENHA /api/sn_wsd_rsv/search/availability

    Verifica se os reserváveis especificados estão disponíveis para os horários especificados.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//search/availability

    URL padrão: /api/sn_wsd_rsv/search/availability

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: Cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    término Obrigatório. Hora de término a ser usada para pesquisar módulos reserváveis disponíveis. Este valor deve ser posterior ao valor especificado em startparâmetro.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    include_reservations_within_days Sinalizador que indica se todos os slots livres de horários disponíveis devem ser retornados na resposta para cada reservável para o dia inteiro.
    Valores válidos:
    • Verdadeiro: Retorna todos os slots livres.
    • Falso: Não retorna todos os slots livres.

    Tipo de dados: Booliano

    Padrão: falso
    reserable_ids Obrigatório. Lista separada por vírgulas de sys_ids reserváveis para avaliar a disponibilidade.

    Tipo de dados: Cadeia de caracteres

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    reservation_ids Lista separada por vírgulas de sys_ids de reserva existentes. Passe este parâmetro se quiser editar as reservas associadas.

    O tempo bloqueado para esses sys_ids para os reserváveis correspondentes é tratado como disponível.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    reservable_module Obrigatório. Sys_id do módulo reservável a ser incluído na pesquisa. . módulo reservável agrupa tipos semelhantes de itens do local de trabalho.

    Tipo de dados: Cadeia de caracteres

    Tabela: Módulo reservável [sn_wsd_rsv_reservable_module]
    schedule_view_obj Detalhes sobre a exibição de programação a ser retornada. Passe este objeto se precisar de dados de disponibilidade de 24 horas para reservas que abrangem mais de um dia. Os resultados retornados conterão somente horários e reservas disponíveis para a data especificada.

    Para que esta funcionalidade funcione corretamente, os parâmetros ignore_same_day_validatione. include_reservations_within_daysdeve ser definido como verdadeiro .

    Tipo de dados: Objeto

    "schedule_view_obj": {
  "schedule_view_date": "String",
  "timezone": "String"
}
    schedule_view_obj.schedule_view_date Data para a qual começar a retornar a disponibilidade da reserva. Esta data deve estar no fuso horário especificado em schedule_view_obj.timezoneparâmetro.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DD
    schedule_view_obj.timezone Criar fuso horário a ser usado para determinar os dados de disponibilidade de reserva a serem retornados. Por exemplo: EUA/Pacífico.

    Tipo de dados: Cadeia de caracteres
    shift Necessário se os módulos reserváveis especificados forem baseados em um turno.
    Sys_id do turno a ser associado à reserva. Se este parâmetro for passado, o endo parâmetro não é necessário.

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Shift [sn_wsd_core_shift]
    início Obrigatório. Hora de início a ser usada para pesquisar módulos reserváveis disponíveis. Este valor deve ser anterior ao valor especificado em endparâmetro.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    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/xmlou, 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    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 Lista de todos os reutilizáveis disponíveis para os horários especificados.

    Tipo de dados: Matriz de objetos

    "result": [
  {
    "availableTimes": [Array],
    "building": {Object},
    "campus": {Object},
    "email": "String",
    "floor": {Object},
    "is_available": Boolean,
    "name": "String",
    "reservations": [Array],
    "sys_id": "String"
  }
]
    AvailableTempos Lista de datas/horas em que o reservável associado está disponível.

    Tipo de dados: Matriz
    resultado.criação Detalhes sobre o edifício associado ao reservável.

    Tipo de dados: Objeto

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

    Tipo de dados: Cadeia de caracteres
    result.building.name Nome do edifício.

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

    Tipo de dados: Cadeia de caracteres
    result.campus Detalhes sobre o campus associado ao reservável.

    Tipo de dados: Objeto

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.campus.display_value Número de exibição do Campus no qual o reservável reside, como East Bay.

    Tipo de dados: Cadeia de caracteres
    result.campus.name Nome do campus.

    Tipo de dados: Cadeia de caracteres
    result.campus.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Campus [sn_wsd_core_campus]
    resultado.e-mail Endereço de e-mail do reservável associado.

    Tipo de dados: Cadeia de caracteres
    resultado.andar Detalhes sobre o andar associado ao reservável.

    Tipo de dados: Objeto

    "floor": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    floor.display_value Número de exibição do andar em que o reservável reside, como 12.

    Tipo de dados: Cadeia de caracteres
    result.floor.name Nome do andar no qual o reservável reside.

    Tipo de dados: Cadeia de caracteres
    result.floor.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Andar [sn_wsd_core_floor]
    result.is_available Sinalizador que indica se o reservável está disponível para reserva.
    Valores válidos:
    • Verdadeiro: Disponível para reserva.
    • Falso: Não disponível para reserva.

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

    Tipo de dados: Cadeia de caracteres
    result.reservations Detalhes sobre a reserva associada.

    Tipo de dados: Matriz de objetos

    "reservations": [
  {
    "configuration_item": "String",
    "end": "String",
    "is_collided": Boolean,
    "location": {Object},
    "number": "String",
    "requested_for": {Object},
    "reservation_purpose": {Object},
    "start": "String",
    "state": {Object},
    "subject": "String",
    "sys_id": "String"
  }
]
    result.reservations.configuration_item Itens de configuração correspondentes à reserva.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item de configuração [cmdb_ci]
    resultado.reservations.end Data e hora de término da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC: aaaa-MM-DDThh:mm:ssZ, como 2021-02-05T18:00:00Z
    result.reservations.is_collided Sinalizador que indica se a reserva colide com a hora de início e término da pesquisa.

    Indica que o local reservável associado já está reservado para o período de pesquisa especificado.

    Valores possíveis:
    • Verdadeiro: Colisão.
    • Falso: Sem colisão.

    Tipo de dados: Booliano
    result.reservations.location Detalhes sobre o local da reserva.

    Tipo de dados: Objeto

    "location": {
  "location": "String",
  "timezone": {Object}
}
    result.reservations.location.location Sys_id do registro de local associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    result.reservations.location.timezone Detalhes sobre o fuso horário associado ao local.

    Tipo de dados: Objeto

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    Result.reservations.location.timezone.​DisplayValue Valor de exibição do fuso horário ao qual este local pertence.

    Tipo de dados: Cadeia de caracteres
    result.reservations.location.timezone.value Valor interno do fuso horário ao qual este local pertence.

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

    Tipo de dados: Cadeia de caracteres
    result.reservations.requested_for Detalhes sobre a pessoa para quem a reserva foi solicitada em nome.

    Tipo de dados: Objeto

    "requested_for": {
  "name": "String",
  "sys_id": "String"
}
    result.reservations.requested_for.name Nome do usuário para o qual a reserva foi solicitada.

    Tipo de dados: Cadeia de caracteres
    result.reservations.requested_for.sys_id Sys_id do usuário para o qual a reserva está sendo solicitada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    result.reservations.reservation_purpose Detalhes sobre a finalidade da reserva.

    Tipo de dados: Objeto

    "reservation_purpose": {
  "display_value": "String",
  "value": "String"
}
    result.reservations.reservation_purpose.​display_value Valor de exibição para a finalidade da reserva, como Reunião da empresa.

    Tipo de dados: Cadeia de caracteres
    result.reservations.reservation_purpose.value Valor interno para a finalidade da reserva, como company_meeting.

    Tipo de dados: Cadeia de caracteres
    result.reservations.start Data e hora de início da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC - aaaa-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    result.reservations.state Detalhes sobre o estado da reserva do local.

    Tipo de dados: Objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    result.reservations.state.display_value Valor de exibição do estado atual da reserva, como Confirmado.

    Tipo de dados: Cadeia de caracteres
    result.reservations.state.value Valor interno do estado atual da reserva, como 2.

    Tipo de dados: Cadeia de caracteres
    result.reservations.assunto Assunto da reserva.

    Tipo de dados: Cadeia de caracteres
    result.reservations.sys_id Obrigatório.
    Sys_id do registro de reserva.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]

    Solicitação de curl

    O exemplo de código a seguir mostra como chamar este endpoint. Quebras de linha foram adicionadas aos parâmetros de consulta para facilitar a leitura.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/availability?
reservable_module=5db44502dbb650106c731dcd13961937&
start=2023-10-12T11:00:00Z&
end=2023-10-15T12:00:00Z&
reservable_ids=adb35f1977220110b3d7be377b5a99fc&
reservation_ids=undefined&
shift=undefined&
schedule_view_obj={"schedule_view_date":"2023-10-12","timezone":"Europe/Paris"}&
timezone=Europe/Paris&
include_reservations_within_days=true&
ignore_same_day_validation=true&
include_unavailable_items=true"  \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Resultados de retorno:

    {
  "result": [
    {
      "sys_id": "fe1f744edb7650106c731dcd139619ca",
      "email": null,
      "name": "Aspen",
      "is_available": true,
      "availableTimes": [
        [
          "2022-04-23 07:00:00",
          "2022-04-23 08:30:00"
        ],
        [
          "2022-04-23 09:30:00",
          "2022-04-23 23:00:00"
        ],
        [
          "2022-04-24 00:00:00",
          "2022-04-24 06:59:59"
        ]
      ],
      "floor": {
        "sys_id": "2f554296dbba10106c731dcd139619ed",
        "display_value": "Floor 2",
        "name": "Floor 2"
      },
      "building": {
        "sys_id": "94e264cedb3650106c731dcd13961919",
        "display_value": "CAL-B1",
        "name": "CAL-B1"
      },
      "campus": {
        "sys_id": "82b2a0cedb3650106c731dcd139619e9",
        "display_value": "California Campus",
        "name": "California Campus"
      },
      "reservations": [
        {
          "sys_id": "5fe65830874bc9106342b846dabb352b",
          "number": "WRES0001001",
          "location": {
            "location": "fe1f744edb7650106c731dcd139619ca",
            "timezone": {
              "value": "US/Pacific",
              "displayValue": "US/Pacific"
            }
          },
          "configuration_item": null,
          "start": "2022-04-23T08:30:00Z",
          "end": "2022-04-23T09:30:00Z",
          "subject": null,
          "reservation_purpose": {
            "value": "meeting",
            "display_value": "Meeting"
          },
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "is_collided": false,
          "requested_for": {
            "sys_id": "2de07e1887cb89106342b846dabb35fe",
            "name": "Workplace User"
          }
        }
      ]
    }
  ]
}

    Pesquisa WSD - OBTENHA /api/sn_wsd_rsv/search/best_match

    Pesquisa a melhor correspondência de item reservável com base nos critérios de pesquisa fornecidos.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//search/best_match

    URL padrão: /api/sn_wsd_rsv/search/best_match

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: Cadeia de caracteres
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    best_match_count Número de reserváveis com melhor correspondência a serem retornados.

    Tipo de dados: Número

    Padrão: 1
    término Obrigatório. Hora de término a ser usada para pesquisar módulos reserváveis disponíveis. Este valor deve ser posterior ao valor especificado em startparâmetro.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    include_reservable_purposes Sinalizador que indica se retornar a finalidade de reservar o local do local de trabalho para cada reservável nos resultados de retorno.
    Valores válidos:
    • Verdadeiro: Retorna as finalidades reserváveis.
    • Falso: Não retorna as finalidades reserváveis.

    Tipo de dados: Booliano

    Padrão: falso

    Tabela: Finalidade reservável [sn_wsd_rsv_reservable_purpose]
    include_reservations_within_days Sinalizador que indica se todos os slots livres de horários disponíveis devem ser retornados na resposta para cada reservável para o dia inteiro.
    Valores válidos:
    • Verdadeiro: Retorna todos os slots livres.
    • Falso: Não retorna todos os slots livres.

    Tipo de dados: Booliano

    Padrão: falso
    include_standard_​services Sinalizador que indica se as informações de serviços padrão devem ser retornadas na resposta. Essas informações estão localizadas na tabela Serviço padrão [sn_wsd_rsv_standard_service].

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

    Valores válidos:
    • 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
    q Obrigatório. Consulta codificada a ser usada para filtrar os resultados de retorno da pesquisa. Nesta consulta, você deve especificar o sys_id do edifício e especificar parâmetros como andar, área, capacidade, serviços padrão e reservable_purposes.

    Todos os parâmetros aprovados devem ser sys_ids, exceto capacidade, que é um número.

    Por exemplo: ​​1 ​​

    Você pode localizar essas informações nas seguintes tabelas:
    • Área: sn_wsd_core_area
    • Construção: sn_wsd_core_building
    • Andar: sn_wsd_core_floor
    • Finalidades reserváveis: sn_wsd_rsv_reservable_purpose
    • Serviços padrão: sn_wsd_rsv_standard_service

    Tipo de dados: Cadeia de caracteres
    reservable_module Obrigatório. Sys_id do módulo reservável a ser incluído na pesquisa. . módulo reservável agrupa tipos semelhantes de itens do local de trabalho.

    Tipo de dados: Cadeia de caracteres

    Tabela: Módulo reservável [sn_wsd_rsv_reservable_module]
    início Obrigatório. Hora de início a ser usada para pesquisar módulos reserváveis disponíveis. Este valor deve ser anterior ao valor especificado em endparâmetro.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    time_slot Sys_id de um registro de intervalo de tempo para o qual estamos tentando procurar o melhor reservável correspondente.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Intervalo de tempo [sn_wsd_rsv_time_slot]
    fuso horário Fuso horário preferencial, como Europa/Amsterdã.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum
    Tabela 9. Parâmetros do corpo da solicitação
    Cabeçalho 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 resposta. Tipos compatíveis: application/jsonou application/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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    resultado Retornar resultados para a melhor correspondência reservável.

    Tipo de dados: Objeto

    "result": { 
  "floorsOfSelectedBuilding": [Array],
  "hasMore": Boolean,
  "nextItemIndex": Number,
  "reservableContainers": [Array],
  "reservableUnits": [Array]
}
    FloorsOfSelecionado Detalhes sobre os andares em que o reservável está localizado.

    Tipo de dados: Matriz de objetos

    "floorsOfSelectedBuilding": [
  {
    "display_value": "String",
    "external_id": "String",
    "name": "String",
    "sys_id": "String"
  }
]
    FloorsOfSelectedBuilding.display_value Número de exibição do andar em que o reservável reside, como 12.

    Tipo de dados: Cadeia de caracteres
    FloorsOfSelectedBuilding.external_id Identificador externo do andar.

    Tipo de dados: Cadeia de caracteres
    result.floorsOfSelectedBuilding.name Nome do andar no qual o reservável reside.

    Tipo de dados: Cadeia de caracteres
    FloorsOfSelectedBuilding.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Andar [sn_wsd_core_floor]
    Resultado.temMais Sinalizador que indica se há mais reserváveis nos resultados de retorno.
    Valores possíveis:
    • Verdadeiro: Mais reserváveis disponíveis.
    • Falso: Não há mais reserváveis disponíveis.

    Tipo de dados: Booliano
    NextItemIndex Índice do próximo registro reservável a ser obtido. Use este valor ao paginar por meio de registros reserváveis.

    Tipo de dados: Número
    Result.reservableContainers Retornado somente para módulos reserváveis cujo campo selection_type está definido como contêiner . Um contêiner é um agrupamento de itens semelhantes, como um grupo de mesas.

    Tipo de dados: Matriz de objetos

    "reservableContainers": [
  {
    "building": {Object},
    "campus": {Object},
    "capacity": Number,
    "display_value": "String",
    "floor": {Object},
    "image": {Object}
    "sys_id": "String"
  } 
]
    Result.reservableContainers.building Detalhes sobre o edifício associado ao contêiner reservável.

    Tipo de dados: Objeto

    "building": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    Result.reservableContainers.building.​Display_value Valor de exibição do edifício.

    Tipo de dados: Cadeia de caracteres
    result.reservableContainers.building.name Nome do edifício.

    Tipo de dados: Cadeia de caracteres
    Result.reservableContainers.building.sys_id Sys_id do registro de edifício associado.

    Tipo de dados: Cadeia de caracteres
    result.reservableContainers.campus
    Detalhes sobre o campus no qual o reservável está localizado.

    Tipo de dados: Objeto

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}

    Tabela: Campus [sn_wsd_core_campus]
    result.reservableContainers.campus.​Display_value Número de exibição do Campus no qual o reservável reside, como East Bay.

    Tipo de dados: Cadeia de caracteres
    result.reservableContainers.campus.name Nome do campus.

    Tipo de dados: Cadeia de caracteres
    result.reservableContainers.campus.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Campus [sn_wsd_core_campus]
    result.reservableContainers.capacity Número máximo de ocupantes do reservável.

    Tipo de dados: Número
    Result.reservableContainers.display_value Valor de exibição do contêiner reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservableContainers.floor Detalhes sobre o andar associado ao contêiner reservável.

    Tipo de dados: Objeto

    "floor": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    Result.reservableContainers.floor.​Display_value Número de exibição do andar em que o reservável reside, como 12.

    Tipo de dados: Cadeia de caracteres
    result.reservableContainers.floor.name Nome do andar no qual o reservável reside.

    Tipo de dados: Cadeia de caracteres
    Result.reservableContainers.floor.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Andar [sn_wsd_core_floor]
    Result.reservableContainers.image Detalhes sobre uma imagem que representa o layout do reservável associado.

    Tipo de dados: Objeto

    "image": {
  "link": "String",
  "sys_id": "String"
}

    Tabela: Imagens [db_image]
    result.reservableContainers.image.link Link para uma imagem que representa o layout deste reservável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Imagens [db_image]
    Result.reservableContainers.image.sys_id Sys_id do registro de imagem associado.

    Tipo de dados: Cadeia de caracteres
    Result.reservableContainers.sys_id Sys_id do registro do contêiner associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: A tabela na qual ele reside pode ser configurada para qualquer tipo de contêiner. Por padrão, ele está na tabela Área [sn_wsd_core_area].
    Result.reservableUnits Detalhes sobre as unidades reserváveis que correspondem aos critérios de pesquisa especificados. Uma unidade reservável é um único item reservável, como uma mesa ou uma cadeira.

    Tipo de dados: Matriz de objetos

    "reservableUnits": [
  {
    "area": "String",
    "availableTimes": [Array],
    "building": {Object},
    "campus": {Object},
    "capacity": "String",
    "defaultPrivacyValue": Boolean,
    "description": "String",
    "email": "String",
    "external_id": "String",
    "floor": {Object},
    "image": {Object},
    "includedInResult": Boolean,
    "is_available": Boolean,
    "is_favorite": Boolean,
    "is_reservable": "String",
    "is_reserved": Boolean,
    "is_selected": Boolean,
    "location_type": {Object},
    "name": "String",
    "number": "String",
    "order": "String",
    "require_approval": Boolean,
    "requires_check_in": Boolean,
    "reservable_quantity": "String",
    "showPrivacyOption": Boolean,
    "site": {Object},
    "standard_services": [Array],
    "tableName": "String",
    "title": "String",
    “reservable_purposes”: [Array],
    "reservations": [Array],
    "sys_id": "String"
  }
]
    Result.reservableUnits.area Detalhes sobre a área na qual o módulo reservável está localizado.

    Tipo de dados: Objeto

    "area": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Área [sn_wsd_core_area]
    Result.reservableUnits.area.display_value Valor de exibição da área do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.area.sys_id Sys_id do registro de área associado ao reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.AvailableTimes Lista de datas/horas em que o reservável associado está disponível.

    Tipo de dados: Matriz
    Result.reservableUnits.building Detalhes sobre o edifício no qual o reservável está localizado.

    Tipo de dados: Objeto

    "building": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Criando [sn_wsd_core_building]
    Result.reservableUnits.building.display_value Valor de exibição do edifício.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.building.sys_id Sys_id do registro de edifício associado.

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.campus
    Detalhes sobre o campus no qual o reservável está localizado.

    Tipo de dados: Objeto

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Campus [sn_wsd_core_campus]
    result.reservableUnits.campus.display_value Número de exibição do Campus no qual o reservável reside, como East Bay.

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.campus.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Campus [sn_wsd_core_campus]
    result.reservableUnits.capacity Número máximo de ocupantes do reservável.

    Tipo de dados: Número
    result.reservableUnits.defaultPrivacyValue Sinalizador que indica a configuração de privacidade padrão do reservável.

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

    Valores possíveis:
    • Verdadeiro: A configuração de privacidade do reservável pode ser substituída.
    • Falso: A configuração de privacidade do reservável não pode ser substituída.

    Tipo de dados: Booliano
    result.reservableUnits.description Breve descrição do reservável.

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.email Endereço de e-mail do reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.external_id ID externo do reservável usado para sincronizar um espaço mapeado no CMS. Este valor só será preenchido se houver um mapa associado a este local.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.floor
    Detalhes sobre o andar em que o reservável está localizado.

    Tipo de dados: Objeto

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Andar [sn_wsd_core_floor]
    Result.reservableUnits.floor.display_value Número de exibição do andar em que o reservável reside, como 12.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.floor.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Andar [sn_wsd_core_floor]
    Result.reservableUnits.image Detalhes sobre uma imagem que representa o layout do reservável associado.

    Tipo de dados: Objeto

    "image": {
  "link": "String",
  "sys_id": "String"
}

    Tabela: Imagens [db_image]
    result.reservableUnits.image.link Link para uma imagem que representa o layout deste reservável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Imagens [db_image]
    Result.reservableUnits.image.sys_id Sys_id do registro de imagem associado.

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.includedInResult Sinalizador que indica se o reservável atual está incluído nos resultados de retorno.
    Valores válidos:
    • Verdadeiro: Incluído nos resultados de retorno.
    • Falso: Não incluído nos resultados de retorno.

    Tipo de dados: Booliano
    Result.reservableUnits.is_available Sinalizador que indica se o reservável está disponível para reserva.
    Valores válidos:
    • Verdadeiro: Disponível para reserva.
    • Falso: Não disponível para reserva.

    Tipo de dados: Booliano
    Result.reservableUnits.is_favorite Sinalizador que indica se o reservável está sinalizado como um dos favoritos do usuário associado.
    Valores válidos:
    • Favorito.
    • Falso: Não é um favorito.

    Tipo de dados: Booliano
    Result.reservableUnits.is_reservable Sinalizador que indica se é possível reservar este reservável.
    Nota:
    . include_unavailable_itemso parâmetro de consulta está definido como verdadeiro, locais indisponíveis também são retornados. Nesse caso, se um local já estiver reservado, o is_availableo parâmetro é falso, mas is_reservableverdadeiro.
    Valores válidos:
    • Verdadeiro: Disponível para reserva.
    • Falso: Não disponível para reserva.

    Tipo de dados: Booliano
    Result.reservableUnits.is_reservated Sinalizador que indica se o reservável já está reservado.
    Valores válidos:
    • Verdadeiro: Disponível para reserva.
    • Falso: Já reservado.

    Tipo de dados: Booliano
    Result.reservableUnits.is_selected Sinalizador que indica se o reservável já está reservado.
    Valores válidos:
    • Verdadeiro: Disponível para reserva.
    • Falso: Já reservado.

    Tipo de dados: Booliano
    Result.reservableUnits.location_type Detalhes sobre o tipo de local do reservável, como local de trabalho/mesa, café ou academia.

    Tipo de dados: Objeto

    "location_type": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    Result.reservableUnits.location_type.​Display_value Valor de exibição do tipo de local.

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.location_type.name Nome do tipo de local, como porão ou armazenamento. Igual ao valor de exibição.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.location_type.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Tipo de espaço [sn_wsd_core_space_type]
    result.reservableUnits.name Nome do reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.Number Identificador exclusivo do reservável. Este valor é mais legível do que o sys_id.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.order Número do pedido do reservável.

    Tipo de dados: Número
    Result.reservableUnits.require_approval Sinalizador que indica se a reserva do reservável requer uma aprovação.
    Valores possíveis:
    • Verdadeiro: Aprovação necessária.
    • Falso: A aprovação não é necessária.

    Tipo de dados: Booliano
    Result.reservableUnits.requires_check_in Sinalizador que indica se o reservável requer que o usuário faça check-in.
    Valores válidos:
    • Check-in necessário.
    • Check-in não é necessário.

    Tipo de dados: Booliano
    ReservableUnits.reservable_purposes Detalhes sobre a finalidade da reserva do reservável associado.

    Tipo de dados: Matriz de objetos

    "reservable_purposes": [
  {
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    Result.reservableUnits.reservable_purposes.​Nome Nome do reservável.

    Tipo de dados: Cadeia de caracteres
    ReservableUnits.reservable_purposes.​Short_description Breve descrição do reservável.

    Tipo de dados: Cadeia de caracteres
    ReservableUnits.reservable_purposes.​Sys_id Sys_id do registro de finalidade reservável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Finalidade reservável [sn_wsd_rsv_reservable_purpose]
    Result.reservableUnits.reservations Detalhes sobre as reservas associadas ao reservável. Preenchido somente se include_reservations_within_dayso parâmetro de consulta é verdadeiro e reservation_idsO parâmetro contém IDs de reserva, o que significa que já há reservas presentes para este reservável.

    Tipo de dados: Matriz de objetos

    "reservations": [
  {
    "configuration_item": "String",
    "end": "String",
    "is_collided": Boolean,
    "location": {Object},
    "number": "String",
    "requested_for": {Object},
    "reservation_purpose": {Object},
    "start": "String",
    "state": {Object},
    "subject": "String",
    "sys_id": "String"
  }
]
    Result.reservableUnits.reservations.​Configuration_item Itens de configuração correspondentes à reserva.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item de configuração [cmdb_ci]
    Result.reservableUnits.reservations.end Data e hora de término da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC: aaaa-MM-DDThh:mm:ssZ, como 2021-02-05T18:00:00Z
    Result.reservableUnits.reservations.is_collided Sinalizador que indica se a reserva colide com a hora de início e término da pesquisa.

    Indica que o local reservável associado já está reservado para o período de pesquisa especificado.

    Valores possíveis:
    • Verdadeiro: Colisão.
    • Falso: Sem colisão.

    Tipo de dados: Booliano
    Result.reservableUnits.reservations.location Detalhes sobre o local da reserva.

    Tipo de dados: Objeto

    "location": {
  "location": "String",
  "timezone": {Object}
}
    Result.reservableUnits.reservations.location.​Localização Sys_id do registro de local associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    Result.reservableUnits.reservations.location.​Fuso horário Detalhes sobre o fuso horário associado ao local.

    Tipo de dados: Objeto

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    Result.reservableUnits.reservations.location.​Timezone.displayValue Valor de exibição do fuso horário ao qual este local pertence.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.location.​Timezone.value Valor interno do fuso horário ao qual este local pertence.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.number Identificador exclusivo do reservável. Este valor é mais legível do que o sys_id.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.​Requested_for Detalhes sobre a pessoa para quem a reserva foi solicitada em nome.

    Tipo de dados: Objeto

    "requested_for": {
  "name": "String",
  "sys_id": "String"
}
    Result.reservableUnits.reservations.​requested_for.name Nome do usuário para o qual a reserva foi solicitada.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.​Requested_for.sys_id Sys_id do usuário para o qual a reserva está sendo solicitada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    ReservableUnits.reservations. Reservation​_purpose Detalhes sobre a finalidade da reserva.

    Tipo de dados: Objeto

    "reservation_purpose": {
  "display_value": "String",
  "value": "String"
}
    ReservableUnits.reservations. Reservation​_purpose.display_value Valor de exibição para a finalidade da reserva, como Reunião da empresa.

    Tipo de dados: Cadeia de caracteres
    ReservableUnits.reservations. Reservation​_purpose.value Valor interno para a finalidade da reserva, como company_meeting.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.start Data e hora de início da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC - aaaa-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    Result.reservableUnits.reservations.state Detalhes sobre o estado da reserva do local.

    Tipo de dados: Objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    Result.reservableUnits.reservations.state.​Display_value Valor de exibição do estado atual da reserva, como Confirmado.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.state.value Valor interno do estado atual da reserva, como 2.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.Assunto Assunto da reserva.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.sys_id Obrigatório.
    Sys_id do registro de reserva.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    ReservableUnits.reservable_quantity Número máximo de vezes que o reservável associado pode ser reservado para o mesmo horário. Este valor é usado ao atribuir espaços de bairro a uma área.

    Tipo de dados: Inteiro
    UnitesreservableUnits.showPrivacyOpção Sinalizador que indica se um funcionário pode substituir as configurações de privacidade do reservável associado.

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

    Valores válidos:
    • Verdadeiro: As configurações de privacidade podem ser substituídas.
    • Falso: A configuração de privacidade não pode ser substituída.

    Tipo de dados: Booliano
    result.reservableUnits.site Detalhes sobre o site onde o reservável reside.

    Tipo de dados: Objeto

    "site": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Site [sn_wsd_core_site]
    Result.reservableUnits.site.display_value Valor de exibição do site.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.site.sys_id Sys_id do registro do site associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Site [sn_wsd_core_site]
    Result.reservableUnits.standard_services
    Serviços padrão associados, como flipchart, tela de projetor, quadro branco e marcadores.

    Tipo de dados: Matriz de objetos

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

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.standard_services.name Nome do ícone de miniatura associado ao serviço padrão.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.standard_services.​Short_description Breve descrição do serviço padrão.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.standard_services.sys_id Sys_id do registro de serviço padrão.

    Tipo de dados: Cadeia de caracteres

    Tabela: Serviço padrão [sn_wsd_rsv_standard_service]
    Result.reservableUnits.sys_id Sys_id do registro reservável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    Result.reservableUnits.tablename Nome da tabela na qual o registro reservável reside.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.title Título do reservável.

    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/search/best_match?q=building%3D9e0364cedb3650106c731dcd1396192b&start=2023-01-04T07%3A00%3A00Z&time_slot=d5331cf2dbb5f01038e42b24ca961906&end=2023-01-04T17%3A00%3A00Z&best_match_count=1&reservable_module=2b636b7e1b4e60103523ff751a4bcbe2&timezone=Europe%2FAmsterdam" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Resultados de retorno:

    {
  "result": {
    "hasMore": false,
    "reservableUnits": [
      {
        "sys_id": "fe1f744edb7650106c731dcd139619ca",
        "external_id": null,
        "email": null,
        "name": "Aspen",
        "title": "Aspen",
        "description": "A room with large windows, dark leather seats and a large wooden table.",
        "image": {
          "sys_id": "41c74902dbb650106c731dcd13961944",
          "link": "41c74902dbb650106c731dcd13961944.iix"
        },
        "number": "ROOM0000903",
        "site": {
          "sys_id": "628eec06db7650106c731dcd139619dd",
          "display_value": "North America"
        },
        "campus": {
          "sys_id": "82b2a0cedb3650106c731dcd139619e9",
          "display_value": "California Campus"
        },
        "building": {
          "sys_id": "94e264cedb3650106c731dcd13961919",
          "display_value": "CAL-B1"
        },
        "floor": {
          "sys_id": "2f554296dbba10106c731dcd139619ed",
          "display_value": "Floor 2"
        },
        "area": null,
        "capacity": "16",
        "reservable_quantity": null,
        "location_type": {
          "sys_id": "20713b83eb512010b89bfdfc9c522899",
          "display_value": "Room",
          "name": "Room"
        },
        "order": null,
        "requires_check_in": null,
        "is_reservable": "1",
        "tableName": "sn_wsd_core_room",
        "require_approval": false,
        "standard_services": [
          {
            "sys_id": "abd0c18edb7650106c731dcd13961965",
            "name": "Projector screen",
            "short_description": "Connect laptop to screen (HDMI and DVI)",
            "font_awesome_icon": "fa-caret-square-o-right"
          }
        ],
        "reservable_purposes": [
          {
            "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
            "name": "Board room",
            "short_description": null
          }
        ],
        "is_available": true,
        "reservations": [
          {
            "sys_id": "5fe65830874bc9106342b846dabb352b",
            "number": "WRES0001001",
            "location": {
              "location": "fe1f744edb7650106c731dcd139619ca",
              "timezone": {
                "value": "US/Pacific",
                "displayValue": "US/Pacific"
              }
            },
            "configuration_item": null,
            "start": "2022-04-23T08:30:00Z",
            "end": "2022-04-23T09:30:00Z",
            "subject": null,
            "reservation_purpose": {
              "value": "meeting",
              "display_value": "Meeting"
            },
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "is_collided": false,
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User"
            }
          },
          {
            "sys_id": "af075c30874bc9106342b846dabb3572",
            "number": "WRES0001002",
            "location": {
              "location": "fe1f744edb7650106c731dcd139619ca",
              "timezone": {
                "value": "US/Pacific",
                "displayValue": "US/Pacific"
              }
            },
            "configuration_item": null,
            "start": "2022-04-23T23:00:00Z",
            "end": "2022-04-24T00:00:00Z",
            "subject": null,
            "reservation_purpose": {
              "value": "meeting",
              "display_value": "Meeting"
            },
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "is_collided": false,
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User"
            }
          }
        ],
        "availableTimes": [
          [
            "2022-04-23 07:00:00",
            "2022-04-23 08:30:00"
          ],
          [
            "2022-04-23 09:30:00",
            "2022-04-23 23:00:00"
          ],
          [
            "2022-04-24 00:00:00",
            "2022-04-24 06:59:59"
          ]
        ],
        "is_favorite": false
      }
    ],
    "reservableContainers": [],
    "nextItemIndex": -1,
    "floorsOfSelectedBuilding": [
      {
        "sys_id": "2f554296dbba10106c731dcd139619ed",
        "display_value": "Floor 2",
        "external_id": null,
        "name": "Floor 2"
      }
    ]
  }
}{
  "result": {
    "hasMore": false,
    "reservableUnits": [
      {
        "sys_id": "32f2a98adb7210106c731dcd13961972",
        "external_id": null,
        "wsd_email": null,
        "name": "B1-03-04",
        "title": "B1-03-04",
        "description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
        "image": {
          "sys_id": "57b42dcadb7210106c731dcd13961945",
          "link": "57b42dcadb7210106c731dcd13961945.iix"
        },
        "number": "SPCE0009018",
        "site": {
          "sys_id": "b17220cedb3650106c731dcd1396197a",
          "display_value": "Western Europe"
        },
        "campus": {
          "sys_id": "44d2e0cedb3650106c731dcd13961988",
          "display_value": "Amsterdam Campus"
        },
        "building": {
          "sys_id": "9e0364cedb3650106c731dcd1396192b",
          "display_value": "AMS-B1"
        },
        "floor": {
          "sys_id": "5373a8cedb3650106c731dcd1396198a",
          "display_value": "Floor 3"
        },
        "area": {
          "sys_id": "410ff04edb7650106c731dcd13961973",
          "display_value": "Desks C1"
        },
        "capacity": "1",
        "reservable_quantity": null,
        "location_type": {
          "sys_id": "5f017383eb512010b89bfdfc9c5228c8",
          "display_value": "Workspace/Desk",
          "name": "Workspace/Desk"
        },
        "order": null,
        "requires_check_in": null,
        "is_reservable": "1",
        "tableName": "sn_wsd_core_space",
        "require_approval": false,
        "is_available": true,
        "reservations": [],
        "availableTimes": [
          [
            "2023-01-04 07:00:00",
            "2023-01-04 17:00:00"
          ]
        ],
        "showPrivacyOption": false,
        "defaultPrivacyValue": false,
        "container": {
          "sys_id": "410ff04edb7650106c731dcd13961973",
          "display_value": "Desks C1",
          "floor": {
            "sys_id": "5373a8cedb3650106c731dcd1396198a",
            "display_value": "Floor 3",
            "name": "Floor 3"
          },
          "building": {
            "sys_id": "9e0364cedb3650106c731dcd1396192b",
            "display_value": "AMS-B1",
            "name": "AMS-B1"
          },
          "campus": {
            "sys_id": "44d2e0cedb3650106c731dcd13961988",
            "display_value": "Amsterdam Campus",
            "name": "Amsterdam Campus"
          },
          "capacity": 6,
          "image": {
            "sys_id": "d52c27b21b8e60103523ff751a4bcb49",
            "link": "d52c27b21b8e60103523ff751a4bcb49.iix"
          }
        },
        "includedInResult": true,
        "is_favorite": true
      }
    ],
    "reservableContainers": [
      {
        "sys_id": "410ff04edb7650106c731dcd13961973",
        "display_value": "Desks C1",
        "floor": {
          "sys_id": "5373a8cedb3650106c731dcd1396198a",
          "display_value": "Floor 3",
          "name": "Floor 3"
        },
        "building": {
          "sys_id": "9e0364cedb3650106c731dcd1396192b",
          "display_value": "AMS-B1",
          "name": "AMS-B1"
        },
        "campus": {
          "sys_id": "44d2e0cedb3650106c731dcd13961988",
          "display_value": "Amsterdam Campus",
          "name": "Amsterdam Campus"
        },
        "capacity": 6,
        "image": {
          "sys_id": "d52c27b21b8e60103523ff751a4bcb49",
          "link": "d52c27b21b8e60103523ff751a4bcb49.iix"
        }
      }
    ],
    "nextItemIndex": -1,
    "floorsOfSelectedBuilding": [
      {
        "sys_id": "5373a8cedb3650106c731dcd1396198a",
        "display_value": "Floor 3",
        "external_id": null,
        "name": "Floor 3"
      }
    ]
  }

    Pesquisa WSD - OBTENHA /api/sn_wsd_rsv/search/overlapping_reservation

    Determina se existe uma reserva sobreposta com base nos parâmetros aprovados.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//search/overlapping_reservation

    URL padrão: /api/sn_wsd_rsv/search/overlapping_reservation

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: Cadeia de caracteres
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    término Obrigatório. Hora de término a ser usada para verificar se há reservas sobrepostas.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DDTHH:MM:SSZ
    recorrente_pattern Detalhes sobre o padrão recorrente da reserva.

    Tipo de dados: Objeto

    "recurring_pattern": {
  "duration": Number,
  "options": {Object},
  "repeats": "String",
  "startDate":"String"
}
    recurring_pattern.duration Período de verificação.

    Tipo de dados: Número

    Unidade: segundos
    recurring_pattern.options Detalhes sobre as opções associadas à reserva recorrente.

    Tipo de dados: Objeto

    "options": {
  "count": Number,
  "daysOfWeek": "String",
  "every": Number
}
    recorrente_pattern.options.count Número de vezes que o padrão é repetido.

    Tipo de dados: Número
    Recorrente_pattern.options.daysOfWeek Dias da semana para verificar se há sobreposição.
    Valores válidos:
    • Segunda-feira. 1
    • Terça-feira. 2
    • Quarta-feira 3
    • 4: Quinta-feira
    • Sexta-feira 5
    • Sábado. 6
    • Domingo: 7

    Por exemplo, para especificar terça-feira, quinta-feira e sexta-feira, passe 245 (sem delimitador).

    Tipo de dados: Cadeia de caracteres
    recurring_pattern.options.every Intervalo de repetição do padrão a ser verificado. Por exemplo, se este valor for 2 ele verifica o padrão de repetição com base na seleção no repeatsparâmetro, como a cada dois dias ou a cada duas semanas.

    Tipo de dados: Número
    recurring_pattern.options.repeats Padrão repetido para a verificação de sobreposição de reserva.
    Valores possíveis: (Diferencia maiúsculas de minúsculas)
    • diariamente
    • mensal
    • semanalmente
    • anual

    Tipo de dados: Cadeia de caracteres
    reserable_id Sys_id do módulo reservável para verificar se há reservas sobrepostas.

    Tipo de dados: Cadeia de caracteres

    Tabela: Módulo reservável [sn_wsd_rsv_reservable_module]
    reservation_id Sys_id da reserva para verificar se há sobreposição. Este valor é necessário no fluxo de edição de pais de vários/grupos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    shift_info_object Detalhes do turno para verificar se há sobreposição.

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

    Tipo de dados: Objeto

    "shift_info_object": {
  "applyToShift": Boolean,
  "shift": "String",
  "timezone": "String"
}
    Shift_info_object.applyToShift Sinalizador que indica se as reservas baseadas em turno estão habilitadas para o módulo reservável.
    Valores válidos:
    • Verdadeiro: Permitir reservas baseadas em turno.
    • Falso: Não permitir reservas baseadas em turno.

    Tipo de dados: Booliano
    shift_info_object.shift Sys_id do turno a ser associado à reserva. Se este parâmetro for passado, o endo parâmetro não é necessário.

    Tipo de dados: Cadeia de caracteres

    Tabela:Shift [sn_wsd_core_shift]
    shift_info_object.timezone Fuso horário do turno para verificar se há sobreposição.

    Tipo de dados: Cadeia de caracteres
    início Obrigatório. Hora de início a ser usada para verificar se há reservas sobrepostas.

    Tipo de dados: Cadeia de caracteres

    FORMATO: YYY-MM-DDTHH:MM:SSZ
    user_id Obrigatório. Sys_id do usuário para verificar se há reservas sobrepostas.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

    Padrão: application/json
    Tabela 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 18. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

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

    Nome Descrição
    resultados Detalhes dos resultados da verificação de sobreposição.

    Tipo de dados: Objeto

    "results": {
  "isOverlapped": Boolean,
  "reservableId": "String"
}
    IsSobplantado Sinalizador que indica se existe uma reserva sobreposta.

    Valores válidos:

    • Verdadeiro: Existe reserva sobreposta.
    • Falso: A reserva sobreposta não existe.

    Tipo de dados: Booliano
    Results.reservableId No caso de uma reserva de grupo, o sys_id do reservável para o qual ocorre a sobreposição.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo de código a seguir mostra como verificar se há uma sobreposição de reserva para um usuário específico e por um período de tempo específico indicado pelo starte. endparâmetros.

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/search/overlapping_reservation?user_id=2e617fecc3d365101e38b23bb00131ec&end=2023-06-19T8:00:00Z&start=2023-06-19T07:00:00Z" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Resultados de retorno:

    {
"results": {
  "isOverlapped": True,
  "reservableId": ""
  }
}

    Pesquisa WSD - OBTER /api/sn_wsd_rsv/search/reservable

    Pesquisa itens reserváveis disponíveis usando uma configuração de modelo reservável especificada.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//search/reservable

    URL padrão: /api/sn_wsd_rsv/search/reservable

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: Cadeia de caracteres
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    término Obrigatório. Hora de término a ser usada para pesquisar módulos reserváveis disponíveis. Este valor deve ser posterior ao valor especificado em startparâmetro.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    exclude_reservablesLista de um ou mais sys_ids de reserváveis a serem excluídos dos resultados da pesquisa.

    Tipo de dados: Cadeia de caracteres ou Matriz

    Tabela: A tabela na qual esses sys_ids estão localizados é especificada no campo reservable_table na tabela Módulo reservável [sn_wsd_rsv_reservable_module]. Pode ser a tabela Espaço [sn_wsd_core_space] ou Sala [sn_wsd_core_room].
    ignore_same_day_validation Sinalizador que indica se a pesquisa de reserva ignora a mudança da validação de data entre os parâmetros de início e término.
    Valores válidos:
    • Verdadeiro: Ignore 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
    include_reservable_purposes Sinalizador que indica se retornar a finalidade de reservar o local do local de trabalho para cada reservável nos resultados de retorno.
    Valores válidos:
    • Verdadeiro: Retorna as finalidades reserváveis.
    • Falso: Não retorna as finalidades reserváveis.

    Tipo de dados: Booliano

    Padrão: falso

    Tabela: Finalidade reservável [sn_wsd_rsv_reservable_purpose]
    include_reservations_within_days Sinalizador que indica se todos os slots livres de horários disponíveis devem ser retornados na resposta para cada reservável para o dia inteiro.
    Valores válidos:
    • Verdadeiro: Retorna todos os slots livres.
    • Falso: Não retorna todos os slots livres.

    Tipo de dados: Booliano

    Padrão: falso
    include_standard_​services Sinalizador que indica se as informações de serviços padrão devem ser retornadas na resposta. Essas informações estão localizadas na tabela Serviço padrão [sn_wsd_rsv_standard_service].

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

    Valores válidos:
    • 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
    near_by_location_id Necessário se rsv_patho parâmetro está definido como browse_near_a_person . Sys_id do local a ser usado na consulta codificada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    bairro

    Necessário se rsv_path o parâmetro está definido como browse_by_vizinhança .

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

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

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Vizinhança [sn_wsd_spcmgmt_neightory]
    next_item_index Índice do próximo item a ser recuperado. Passe este parâmetro ao paginar os resultados de retorno.

    Tipo de dados: Número

    Padrão: 0
    page_size Número máximo de registros a serem retornados nos resultados de retorno.

    Tipo de dados: Número

    Padrão: 6
    q Obrigatório. Consulta codificada a ser usada para filtrar os resultados de retorno da pesquisa. Nesta consulta, você deve especificar o sys_id do edifício e especificar parâmetros como andar, área, capacidade, serviços padrão e reservable_purposes.

    Todos os parâmetros aprovados devem ser sys_ids, exceto capacidade, que é um número.

    Por exemplo: ​​1 ​​

    Você pode localizar essas informações nas seguintes tabelas:
    • Área: sn_wsd_core_area
    • Construção: sn_wsd_core_building
    • Andar: sn_wsd_core_floor
    • Finalidades reserváveis: sn_wsd_rsv_reservable_purpose
    • Serviços padrão: sn_wsd_rsv_standard_service

    Tipo de dados: Cadeia de caracteres
    reservable_module Obrigatório. Sys_id do módulo reservável a ser incluído na pesquisa. . módulo reservável agrupa tipos semelhantes de itens do local de trabalho.

    Tipo de dados: Cadeia de caracteres

    Tabela: Módulo reservável [sn_wsd_rsv_reservable_module]
    reservation_ids Lista separada por vírgulas de sys_ids de reserva existentes. Passe este parâmetro se quiser editar as reservas associadas.

    O tempo bloqueado para esses sys_ids para os reserváveis correspondentes é tratado como disponível.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    rsv_path Caminho de reserva a ser aplicado à pesquisa.
    Valores válidos:
    • Browse_all: Pesquisar todos os reserváveis.
    • Browse_by_area: PESQUISE os reserváveis perto de um local específico. Um identificador de área deve ser passado na consulta codificada ( qparâmetro).
    • Browse_by_vizinhança: PESQUISE os reserváveis próximos ao bairro especificado em neighborhoodparâmetro.
    • Browse_next_a_person: PESQUISE os reserváveis próximos ao local do local de trabalho da pessoa especificada em near_by_location_idparâmetro.

    Tipo de dados: Cadeia de caracteres

    Padrão: Browse_all
    schedule_view_obj Detalhes sobre a exibição de programação a ser retornada. Passe este objeto se precisar de dados de disponibilidade de 24 horas para reservas que abrangem mais de um dia. Os resultados retornados conterão somente horários e reservas disponíveis para a data especificada.

    Para que esta funcionalidade funcione corretamente, os parâmetros ignore_same_day_validatione. include_reservations_within_daysdeve ser definido como verdadeiro .

    Tipo de dados: Objeto

    "schedule_view_obj": {
  "schedule_view_date": "String",
  "timezone": "String"
}
    schedule_view_obj.schedule_view_date Data para a qual começar a retornar a disponibilidade da reserva. Esta data deve estar no fuso horário especificado em schedule_view_obj.timezoneparâmetro.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DD
    schedule_view_obj.timezone Criar fuso horário a ser usado para determinar os dados de disponibilidade de reserva a serem retornados. Por exemplo: EUA/Pacífico.

    Tipo de dados: Cadeia de caracteres
    início Obrigatório. Hora de início a ser usada para pesquisar módulos reserváveis disponíveis. Este valor deve ser anterior ao valor especificado em endparâmetro.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    shift
    Sys_id do turno a ser associado à reserva. Se este parâmetro for passado, o endo parâmetro não é necessário.

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Shift [sn_wsd_core_shift]
    sort_by Ordem de classificação desejada dos itens reserváveis retornados.
    Valores válidos:
    • A_z: Ordem de classificação crescente.
    • Favorites_first: Classificado pelos reserváveis do local de trabalho favorito do usuário primeiro, em ordem crescente para o restante.
    • z_A: Ordem de classificação decrescente.

    Tipo de dados: Cadeia de caracteres

    Padrão: A_z
    fuso horário Fuso horário preferencial, como Europa/Amsterdã.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum
    Tabela 21. 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 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xmlou, text/xml.

    Padrão: application/json
    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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 24. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    resultado Retornar resultados da pesquisa especificada.

    Tipo de dados: Objeto

    "result": { 
  "filter": {Object},
  "hasMore": Boolean,
  "nextFavIndex": Number,
  "nextItemIndex": Number,
  "reservableContainers": [Array],
  "reservableUnits": [Array],
  "totalProcessed": Number
}
    resultado.filtro Detalhes sobre os andares, serviços padrão e finalidades reserváveis dos reserváveis. . include_standard_servicesou include_reservable_purposesos parâmetros são definidos como falso, standard_servicese. reservable_purposesmatrizes vazias.

    Tipo de dados: Objeto

    "filter": {
   "floors": [Array],
   "reservable_purposes": [Array],
   "standard_services": [Array]
}
    result.filter.andares
    Detalhes sobre o andar em que o reservável está localizado.

    Tipo de dados: Objeto

    "floors": [
  {
    "display_value": "String",
    "sys_id": "String"
  }
]
    result.filter.floors.display_value Número de exibição do andar em que o reservável reside, como 12.

    Tipo de dados: Cadeia de caracteres
    result.filter.floors.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Andar [sn_wsd_core_floor]
    result.filter.standard_services Preenchido somente se include_standard_serviceso parâmetro está definido como verdadeiro.
    Serviços padrão associados, como flipchart, tela de projetor, quadro branco e marcadores.

    Tipo de dados: Matriz de objetos

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

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

    Tipo de dados: Cadeia de caracteres
    result.filter.standard_services.short_description Breve descrição do serviço padrão.

    Tipo de dados: Cadeia de caracteres
    result.filter.standard_services.sys_id Sys_id do registro de serviço padrão.

    Tipo de dados: Cadeia de caracteres

    Tabela: Serviço padrão [sn_wsd_rsv_standard_service]
    result.filter.reservable_purposes Detalhes sobre a finalidade da reserva do reservável associado.

    Tipo de dados: Matriz de objetos

    "reservable_purposes": [
  {
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.filter.reservable_purposes.name Nome do reservável.

    Tipo de dados: Cadeia de caracteres
    result.filter.reservable_purposes.​short_description Breve descrição do reservável.

    Tipo de dados: Cadeia de caracteres
    result.filter.reservable_purposes.sys_id Sys_id do registro de finalidade reservável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Finalidade reservável [sn_wsd_rsv_reservable_purpose]
    Resultado.temMais Sinalizador que indica se há mais reserváveis nos resultados de retorno.
    Valores possíveis:
    • Verdadeiro: Mais reserváveis disponíveis.
    • Falso: Não há mais reserváveis disponíveis.

    Tipo de dados: Booliano
    NextFavIndex Índice do próximo favorito reservável para o usuário. Use este valor ao paginar por meio dos reserváveis favoritos do usuário.

    Tipo de dados: Número
    NextItemIndex Índice do próximo registro reservável a ser obtido. Use este valor ao paginar por meio de registros reserváveis.

    Tipo de dados: Número
    Result.reservableContainers Retornado somente para módulos reserváveis cujo campo selection_type está definido como contêiner . Um contêiner é um agrupamento de itens semelhantes, como um grupo de mesas.

    Tipo de dados: Matriz de objetos

    "reservableContainers": [
  {
    "building": {Object},
    "campus": {Object},
    "capacity": Number,
    "display_value": "String",
    "floor": {Object},
    "image": {Object}
    "sys_id": "String"
  } 
]
    Result.reservableContainers.building Detalhes sobre o edifício associado ao contêiner reservável.

    Tipo de dados: Objeto

    "building": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    Result.reservableContainers.building.​Display_value Valor de exibição do edifício.

    Tipo de dados: Cadeia de caracteres
    result.reservableContainers.building.name Nome do edifício.

    Tipo de dados: Cadeia de caracteres
    Result.reservableContainers.building.sys_id Sys_id do registro de edifício associado.

    Tipo de dados: Cadeia de caracteres
    result.reservableContainers.campus
    Detalhes sobre o campus no qual o reservável está localizado.

    Tipo de dados: Objeto

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}

    Tabela: Campus [sn_wsd_core_campus]
    result.reservableContainers.campus.​Display_value Número de exibição do Campus no qual o reservável reside, como East Bay.

    Tipo de dados: Cadeia de caracteres
    result.reservableContainers.campus.name Nome do campus.

    Tipo de dados: Cadeia de caracteres
    result.reservableContainers.campus.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Campus [sn_wsd_core_campus]
    result.reservableContainers.capacity Número máximo de ocupantes do reservável.

    Tipo de dados: Número
    Result.reservableContainers.display_value Valor de exibição do contêiner reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservableContainers.floor Detalhes sobre o andar associado ao contêiner reservável.

    Tipo de dados: Objeto

    "floor": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    Result.reservableContainers.floor.​Display_value Número de exibição do andar em que o reservável reside, como 12.

    Tipo de dados: Cadeia de caracteres
    result.reservableContainers.floor.name Nome do andar no qual o reservável reside.

    Tipo de dados: Cadeia de caracteres
    Result.reservableContainers.floor.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Andar [sn_wsd_core_floor]
    Result.reservableContainers.image Link para uma imagem que representa o layout deste reservável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Imagens [db_image]
    result.reservableContainers.image.link Link para uma imagem que representa o layout deste reservável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Imagens [db_image]
    Result.reservableContainers.image.sys_id Sys_id do registro de imagem associado.

    Tipo de dados: Cadeia de caracteres
    Result.reservableContainers.sys_id Sys_id do registro do contêiner associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: A tabela na qual ele reside pode ser configurada para qualquer tipo de contêiner. Por padrão, ele está na tabela Área [sn_wsd_core_area].
    Result.reservableUnits Detalhes sobre as unidades reserváveis que correspondem aos critérios de pesquisa especificados. Uma unidade reservável é um único item reservável, como uma mesa ou uma cadeira.

    Tipo de dados: Matriz de objetos

    "reservableUnits": [
  {
    "area": "String",
    "availableTimes": [Array],
    "building": {Object},
    "campus": {Object},
    "capacity": "String",
    "defaultPrivacyValue": Boolean,
    "description": "String",
    "email": "String",
    "external_id": "String",
    "floor": {Object},
    "image": {Object},
    "includedInResult": Boolean,
    "is_available": Boolean,
    "is_favorite": Boolean,
    "is_reservable": "String",
    "is_reserved": Boolean,
    "is_selected": Boolean,
    "location_type": {Object},
    "name": "String",
    "number": "String",
    "order": "String",
    "require_approval": Boolean,
    "requires_check_in": Boolean,
    "reservable_quantity": "String",
    "showPrivacyOption": Boolean,
    "site": {Object},
    "standard_services": [Array],
    "tableName": "String",
    "title": "String",
    “reservable_purposes”: [Array],
    "reservations": [Array],
    "sys_id": "String"
  }
]
    Result.reservableUnits.area Detalhes sobre a área na qual o módulo reservável está localizado.

    Tipo de dados: Objeto

    "area": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Área [sn_wsd_core_area]
    Result.reservableUnits.area.display_value Valor de exibição da área do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.area.sys_id Sys_id do registro de área associado ao reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.AvailableTimes Lista de datas/horas em que o reservável associado está disponível.

    Tipo de dados: Matriz
    Result.reservableUnits.building Detalhes sobre o edifício no qual o reservável está localizado.

    Tipo de dados: Objeto

    "building": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Criando [sn_wsd_core_building]
    Result.reservableUnits.building.display_value Valor de exibição do edifício.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.building.sys_id Sys_id do registro de edifício associado.

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.campus
    Detalhes sobre o campus no qual o reservável está localizado.

    Tipo de dados: Objeto

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Campus [sn_wsd_core_campus]
    result.reservableUnits.campus.display_value Número de exibição do Campus no qual o reservável reside, como East Bay.

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.campus.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Campus [sn_wsd_core_campus]
    result.reservableUnits.capacity Número máximo de ocupantes do reservável.

    Tipo de dados: Número
    result.reservableUnits.description Breve descrição do reservável.

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.email Endereço de e-mail do reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.external_id ID externo do reservável usado para sincronizar um espaço mapeado no CMS. Este valor só será preenchido se houver um mapa associado a este local.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.floor
    Detalhes sobre o andar em que o reservável está localizado.

    Tipo de dados: Objeto

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Andar [sn_wsd_core_floor]
    Result.reservableUnits.floor.display_value Número de exibição do andar em que o reservável reside, como 12.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.floor.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Andar [sn_wsd_core_floor]
    Result.reservableUnits.image Detalhes sobre uma imagem que representa o layout do reservável associado.

    Tipo de dados: Objeto

    "image": {
  "link": "String",
  "sys_id": "String"
}

    Tabela: Imagens [db_image]
    result.reservableUnits.image.link Link para uma imagem que representa o layout deste reservável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Imagens [db_image]
    Result.reservableUnits.image.sys_id Sys_id do registro de imagem associado.

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.includedInResult Sinalizador que indica se o reservável atual está incluído nos resultados de retorno.
    Valores válidos:
    • Verdadeiro: Incluído nos resultados de retorno.
    • Falso: Não incluído nos resultados de retorno.

    Tipo de dados: Booliano
    Result.reservableUnits.is_available Sinalizador que indica se o reservável está disponível para reserva.
    Valores válidos:
    • Verdadeiro: Disponível para reserva.
    • Falso: Não disponível para reserva.

    Tipo de dados: Booliano
    Result.reservableUnits.is_favorite Sinalizador que indica se o reservável está sinalizado como um dos favoritos do usuário associado.
    Valores válidos:
    • Favorito.
    • Falso: Não é um favorito.

    Tipo de dados: Booliano
    Result.reservableUnits.is_reservable Sinalizador que indica se é possível reservar este reservável.
    Nota:
    . include_unavailable_itemso parâmetro de consulta está definido como verdadeiro, locais indisponíveis também são retornados. Nesse caso, se um local já estiver reservado, o is_availableo parâmetro é falso, mas is_reservableverdadeiro.
    Valores válidos:
    • Verdadeiro: Disponível para reserva.
    • Falso: Não disponível para reserva.

    Tipo de dados: Booliano
    Result.reservableUnits.is_reservated Sinalizador que indica se o reservável já está reservado.
    Valores válidos:
    • Verdadeiro: Disponível para reserva.
    • Falso: Já reservado.

    Tipo de dados: Booliano
    Result.reservableUnits.is_selected Sinalizador que indica se o reservável já está reservado.
    Valores válidos:
    • Verdadeiro: Disponível para reserva.
    • Falso: Já reservado.

    Tipo de dados: Booliano
    Result.reservableUnits.location_type Detalhes sobre o tipo de local do reservável, como local de trabalho/mesa, café ou academia.

    Tipo de dados: Objeto

    "location_type": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    Result.reservableUnits.location_type.​Display_value Valor de exibição do tipo de local.

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.location_type.name Nome do tipo de local, como porão ou armazenamento. Igual ao valor de exibição.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.location_type.sys_id Sys_id do registro associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Tipo de espaço [sn_wsd_core_space_type]
    result.reservableUnits.name Nome do reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.Number Identificador exclusivo do reservável. Este valor é mais legível do que o sys_id.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.order Número do pedido do reservável.

    Tipo de dados: Número
    Result.reservableUnits.require_approval Sinalizador que indica se a reserva do reservável requer uma aprovação.
    Valores possíveis:
    • Verdadeiro: Aprovação necessária.
    • Falso: A aprovação não é necessária.

    Tipo de dados: Booliano
    Result.reservableUnits.requires_check_in Sinalizador que indica se o reservável requer que o usuário faça check-in.
    Valores válidos:
    • Check-in necessário.
    • Check-in não é necessário.

    Tipo de dados: Booliano
    ReservableUnits.reservable_purposes Detalhes sobre a finalidade da reserva do reservável associado.

    Tipo de dados: Matriz de objetos

    "reservable_purposes": [
  {
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    Result.reservableUnits.reservable_purposes.​Nome Nome do reservável.

    Tipo de dados: Cadeia de caracteres
    ReservableUnits.reservable_purposes.​Short_description Breve descrição do reservável.

    Tipo de dados: Cadeia de caracteres
    ReservableUnits.reservable_purposes.​Sys_id Sys_id do registro de finalidade reservável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Finalidade reservável [sn_wsd_rsv_reservable_purpose]
    Result.reservableUnits.reservations Detalhes sobre as reservas associadas ao reservável. Preenchido somente se include_reservations_within_dayso parâmetro de consulta é verdadeiro e reservation_idsO parâmetro contém IDs de reserva, o que significa que já há reservas presentes para este reservável.

    Tipo de dados: Matriz de objetos

    "reservations": [
  {
    "configuration_item": "String",
    "end": "String",
    "is_collided": Boolean,
    "location": {Object},
    "number": "String",
    "requested_for": {Object},
    "reservation_purpose": {Object},
    "start": "String",
    "state": {Object},
    "subject": "String",
    "sys_id": "String"
  }
]
    Result.reservableUnits.reservations.​Configuration_item Itens de configuração correspondentes à reserva.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item de configuração [cmdb_ci]
    Result.reservableUnits.reservations.end Data e hora de término da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC: aaaa-MM-DDThh:mm:ssZ, como 2021-02-05T18:00:00Z
    Result.reservableUnits.reservations.is_collided Sinalizador que indica se a reserva colide com a hora de início e término da pesquisa.

    Indica que o local reservável associado já está reservado para o período de pesquisa especificado.

    Valores possíveis:
    • Verdadeiro: Colisão.
    • Falso: Sem colisão.

    Tipo de dados: Booliano
    Result.reservableUnits.reservations.location Detalhes sobre o local da reserva.

    Tipo de dados: Objeto

    "location": {
  "location": "String",
  "timezone": {Object}
}
    Result.reservableUnits.reservations.location.​Localização Sys_id do registro de local associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    Result.reservableUnits.reservations.location.​Fuso horário Detalhes sobre o fuso horário associado ao local.

    Tipo de dados: Objeto

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    Result.reservableUnits.reservations.location.​Timezone.displayValue Valor de exibição do fuso horário ao qual este local pertence.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.location.​Timezone.value Valor interno do fuso horário ao qual este local pertence.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.number Identificador exclusivo do reservável. Este valor é mais legível do que o sys_id.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.​Requested_for Detalhes sobre a pessoa para quem a reserva foi solicitada em nome.

    Tipo de dados: Objeto

    "requested_for": {
  "name": "String",
  "sys_id": "String"
}
    Result.reservableUnits.reservations.​requested_for.name Nome do usuário para o qual a reserva foi solicitada.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.​Requested_for.sys_id Sys_id do usuário para o qual a reserva está sendo solicitada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    ReservableUnits.reservations. Reservation​_purpose Detalhes sobre a finalidade da reserva.

    Tipo de dados: Objeto

    "reservation_purpose": {
  "display_value": "String",
  "value": "String"
}
    ReservableUnits.reservations. Reservation​_purpose.display_value Valor de exibição para a finalidade da reserva, como Reunião da empresa.

    Tipo de dados: Cadeia de caracteres
    ReservableUnits.reservations. Reservation​_purpose.value Valor interno para a finalidade da reserva, como company_meeting.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.start Data e hora de início da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC - aaaa-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    Result.reservableUnits.reservations.state Detalhes sobre o estado da reserva do local.

    Tipo de dados: Objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    Result.reservableUnits.reservations.state.​Display_value Valor de exibição do estado atual da reserva, como Confirmado.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.state.value Valor interno do estado atual da reserva, como 2.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.Assunto Assunto da reserva.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.reservations.sys_id Obrigatório.
    Sys_id do registro de reserva.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    ReservableUnits.reservable_quantity Número máximo de vezes que o reservável associado pode ser reservado para o mesmo horário. Este valor é usado ao atribuir espaços de bairro a uma área.

    Tipo de dados: Inteiro
    result.reservableUnits.site Detalhes sobre o site onde o reservável reside.

    Tipo de dados: Objeto

    "site": {
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Site [sn_wsd_core_site]
    Result.reservableUnits.site.display_value Valor de exibição do site.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.site.sys_id Sys_id do registro do site associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Site [sn_wsd_core_site]
    Result.reservableUnits.standard_services
    Serviços padrão associados, como flipchart, tela de projetor, quadro branco e marcadores.

    Tipo de dados: Matriz de objetos

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

    Tipo de dados: Cadeia de caracteres
    result.reservableUnits.standard_services.name Nome do ícone de miniatura associado ao serviço padrão.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.standard_services.​Short_description Breve descrição do serviço padrão.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.standard_services.sys_id Sys_id do registro de serviço padrão.

    Tipo de dados: Cadeia de caracteres

    Tabela: Serviço padrão [sn_wsd_rsv_standard_service]
    Result.reservableUnits.sys_id Sys_id do registro reservável.

    Tipo de dados: Cadeia de caracteres

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    Result.reservableUnits.tablename Nome da tabela na qual o registro reservável reside.

    Tipo de dados: Cadeia de caracteres
    Result.reservableUnits.title Título do reservável.

    Tipo de dados: Cadeia de caracteres
    Resultado.totalProcessado Número total de registros processados.

    Tipo de dados: Número

    Solicitação de curl

    Este exemplo mostra como pesquisar reserváveis usando este endpoint. Quebras de linha foram adicionadas aos parâmetros de consulta para facilitar a leitura.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/reservable?
reservable_module=d9864189c3653910977396cb05013100&
start=2023-10-12T10:30:00Z&
end=2023-10-13T11:30:00Z&
include_standard_services=true&
include_reservable_purposes=true&
include_reservations_within_days=true&
include_unavailable_items=true&
near_by_location_id=undefined&
timezone=Europe/Paris&
page_size=6&
sort_by=a_z&
view=schedule&
rsv_path=browse_all&
ignore_same_day_validation=true&
schedule_view_obj={"schedule_view_date":"2023-10-12","timezone":"Europe/Paris"}&
q=building=dea39b1977220110b3d7be377b5a9955\
--request GET \
--header "Accept:application/json" 
--user "username":"password"

    Resultados de retorno:

    {
  "result": {
    "hasMore": true,
    "reservableUnits": [
      {
        "sys_id": "fe1f744edb7650106c731dcd139619ca",
        "external_id": null,
        "email": null,
        "name": "Aspen",
        "title": "Aspen",
        "description": "A room with large windows, dark leather seats and a large wooden table.",
        "image": {
          "sys_id": "41c74902dbb650106c731dcd13961944",
          "link": "41c74902dbb650106c731dcd13961944.iix"
        },
        "number": "ROOM0000903",
        "site": {
          "sys_id": "628eec06db7650106c731dcd139619dd",
          "display_value": "North America"
        },
        "campus": {
          "sys_id": "82b2a0cedb3650106c731dcd139619e9",
          "display_value": "California Campus"
        },
        "building": {
          "sys_id": "94e264cedb3650106c731dcd13961919",
          "display_value": "CAL-B1"
        },
        "floor": {
          "sys_id": "2f554296dbba10106c731dcd139619ed",
          "display_value": "Floor 2"
        },
        "area": null,
        "capacity": "16",
        "reservable_quantity": null,
        "location_type": {
          "sys_id": "20713b83eb512010b89bfdfc9c522899",
          "display_value": "Room",
          "name": "Room"
        },
        "order": null,
        "requires_check_in": null,
        "is_reservable": "1",
        "tableName": "sn_wsd_core_room",
        "require_approval": false,
        "standard_services": [
          {
            "sys_id": "9b01458edb7650106c731dcd13961945",
            "name": "Flip chart",
            "short_description": "Flip chart with paper sheets",
            "font_awesome_icon": "fa-calendar-o"
          }
        ],
        "reservable_purposes": [
          {
            "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
            "name": "Board room",
            "short_description": null
          }
        ],
        "is_available": true,
        "reservations": [
          {
            "sys_id": "5fe65830874bc9106342b846dabb352b",
            "number": "WRES0001001",
            "location": {
              "location": "fe1f744edb7650106c731dcd139619ca",
              "timezone": {
                "value": "US/Pacific",
                "displayValue": "US/Pacific"
              }
            },
            "configuration_item": null,
            "start": "2022-04-23T08:30:00Z",
            "end": "2022-04-23T09:30:00Z",
            "subject": null,
            "reservation_purpose": {
              "value": "meeting",
              "display_value": "Meeting"
            },
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "is_collided": false,
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User"
            }
          }
        ],
        "availableTimes": [
          [
            "2022-04-23 07:00:00",
            "2022-04-23 08:30:00"
          ],
          [
            "2022-04-23 09:30:00",
            "2022-04-23 23:00:00"
          ]
        ],
       "is_reserved": true,
       "is_selected": true,
        "includedInResult": true,
        "is_favorite": false
      }
    ],
    "reservableContainers": [],
    "nextItemIndex": -1,
    "filter": {
      "floors": [],
      "standard_services": [
        {
          "sys_id": "9b01458edb7650106c731dcd13961945",
          "name": "Flip chart",
          "short_description": "Flip chart with paper sheets",
          "font_awesome_icon": "fa-calendar-o"
        }
      ],
      "reservable_purposes": [
        {
          "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
          "name": "Board room",
          "short_description": null
        }
      ]
    },
    "totalProcessed": 2,
    "nextFavIndex": 0
  }
}

    Pesquisa de WSD - OBTER /api/sn_wsd_rsv/search/shift/

    Retorna uma consulta codificada que você pode usar para pesquisar turnos disponíveis na tabela Shift [sn_wsd_core_shift].

    Aplicável somente se o campo appy_to_shift no módulo reservável especificado estiver habilitado. Caso contrário, a cadeia de caracteres de consulta codificada retornada ficará vazia.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//search/shift/(building_id)/(module_id)

    URL padrão: /api/sn_wsd_rsv/search/shift/

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: Cadeia de caracteres
    building_id Sys_id do edifício a ser incluído na consulta de pesquisa.

    Tipo de dados: Cadeia de caracteres

    Tabela: Criando [sn_wsd_core_building]
    module-id Sys_id do módulo reservável a ser incluído na consulta de pesquisa. Um módulo reservável agrupa tipos semelhantes de itens do local de trabalho, como cadeiras ou mesas.

    Tipo de dados: Cadeia de caracteres

    Tabela: Módulo reservável [sn_wsd_core_reservable_module]
    Tabela 26. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 27. Parâmetros do corpo da solicitação
    Nome Descrição
    end_date Data e hora de término do turno a serem incluídas na consulta codificada.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd hh:mm:ss
    start_date Data e hora de início do turno a serem incluídas na consulta codificada.

    Tipo de dados: Cadeia de caracteres

    Formato: 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 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/xmlou, text/xml.

    Padrão: 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 30. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    resultado Consulta codificada a ser usada para adquirir os turnos disponíveis especificados.

    Tipo de dados: Objeto

    "result": { 
  "moduleHasShift": Boolean,
  "query": "String"
}
    ModuleHasShift Sinalizador que indica se o módulo reservável especificado tem turnos habilitados.
    Valores válidos:
    • Verdadeiro: O módulo reservável tem turnos habilitados.
    • Falso: O módulo reservável não tem turnos habilitados. Nenhuma consulta codificada retornada.

    Tipo de dados: Booliano
    consulta Consulta codificada a ser usada para recuperar informações de turno do módulo reservável especificado.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo de código a seguir mostra como usar este endpoint para obter uma consulta codificada de turno.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/shift/94e264cedb3650106c731dcd13961919/fc71f64fdb42a01097acc900399619a8?start_date=2022-04-23 16:00:00&end_date=2022-04-28 16:00:00"  \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Resultados de retorno:

    {
  "result": { 
    "moduleHasShift" : true,
    "query" : "active=true^state=2^building=94e264cedb3650106c731dcd13961919^building.is_reservable=true^building.active=true^floorISEMPTY^ORfloor.is_reservable=true^floorISEMPTY^ORfloor.active=true^start<=2022-04-26 16:00:00^ORstartISEMPTY^end>=2022-04-28 16:00:00^ORendISEMPTY^start<=2022-04-28 16:00:00^ORstartISEMPTY^end>=2022-04-28 16:00:00^ORendISEMPTY"
  }
}

    Pesquisa WSD - POST /api/sn_wsd_rsv/search/availability_score

    Retorna uma pontuação de disponibilidade para itens reserváveis para intervalos de tempo especificados.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//search/availability_score

    URL padrão: /api/sn_wsd_rsv/search/availability_score

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: Cadeia de caracteres
    Tabela 32. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 33. Parâmetros do corpo da solicitação
    Nome Descrição
    Pattern recurring Necessário se startEndDateTimeso parâmetro não foi especificado. Padrão recorrente a ser usado para pesquisar reserváveis que estão disponíveis para os eventos recorrentes especificados.

    Tipo de dados: Objeto

    "recurringPattern": {
  "duration": Number,
  "label": "String",
  "options": {Object},
  "repeats": "String",
  "startDate": "String"
}
    RecurringPattern.Duração Obrigatório. Período durante o qual o reservável deve estar disponível.

    Tipo de dados: Número

    Unidade: Milissegundos
    RecurringPattern.label Descrição do padrão recorrente, como Repete diariamente, 5 vezes .

    Tipo de dados: Cadeia de caracteres
    RecurringPattern.options Opções de disponibilidade para a reserva recorrente pesquisar.

    Tipo de dados: Objeto

    "options": {
  "count": Number,
  "daysOfWeek": "String",
  "endDate": "String"
}
    RecurringPattern.options.count Necessário se endDatenão foi aprovado. Se ambos forem aprovados, counté usado. Número de vezes para repetir o padrão de reunião.

    Tipo de dados: Número
    RecurringPattern.options.daysOfWeek Necessário se recurringPattern.repeatso parâmetro está definido como semanalmente . Dias da semana em que o reservável é necessário.
    Valores válidos:
    • Segunda-feira. 1
    • Terça-feira. 2
    • Quarta-feira 3
    • 4: Quinta-feira
    • Sexta-feira 5
    • Sábado. 6
    • Domingo: 7

    Por exemplo, para especificar terça-feira, quinta-feira e sexta-feira, passe 245 (sem delimitador). Se repeaté semanal, counté 5, e. daysOfWeeké 245, então nos resultados de retorno, o total é igual a. Count*daysOfWeek.length (5*3-15).

    Tipo de dados: Cadeia de caracteres
    RecurringPattern.options.endDate Necessário se recurringPattern.options.countnão foi aprovado. Se ambos forem aprovados, counté usado. Data e hora de término da recorrência da reunião, como "2022-07-08T14:00:00Z".

    Tipo de dados: Cadeia de caracteres

    Formato: UTC aaaa-mm-dd hh:mm:ss
    RecurringPattern.Repetições Obrigatório. Padrão de repetição para reservável.
    Valores válidos (diferencia maiúsculas de minúsculas):
    • diariamente
    • mensal
    • semanalmente
    • anual

    Tipo de dados: Cadeia de caracteres
    RecurringPattern.startDate Obrigatório. Data e hora de início do padrão recorrente, como "2022-07-08T14:00:00Z".

    Tipo de dados: Cadeia de caracteres

    Formato: UTC aaaa-mm-dd hh:mm:ss
    ReservableIds Obrigatório. Lista de sys_ids dos reserváveis a serem incluídos na pontuação de disponibilidade.

    Tipo de dados: Matriz

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    ReservableType Obrigatório. Tipo de reservável a ser incluído na pontuação de disponibilidade. Usado para refinar a pesquisa.
    Valores válidos (diferencia maiúsculas de minúsculas):
    • configuration_item
    • local

    Tipo de dados: Cadeia de caracteres
    StartEndDateTime Lista de datas e horas de início e término no fuso horário do usuário para pesquisar.

    Tipo de dados: Matriz de objetos

    "startEndDateTimes": [
  {
    "end": "String",
    "start": "String"
  }
]

    Padrão: Deve especificar recurringPatternparâmetro.
    StartEndDateTimes.end Data e hora de término do reservável.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd hh:mm:ss
    StartEndDateTimes.start Data e hora de início do reservável.

    Tipo de dados: Cadeia de caracteres

    Formato: 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 34. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 36. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    resultado Retornar resultados para a pontuação de disponibilidade especificada.

    Tipo de dados: Objeto

    "result": {
  "reservable_sys_id": {Object}
}
    reservable_sys_id Detalhes sobre a pontuação de disponibilidade.

    Tipo de dados: Objeto

    "reservable_sys_id": {
  "available": Number,
  "score": "String",
  "total": Number
}
    reservable_sys_id.available Número de reserváveis disponíveis que atenderam aos critérios de pesquisa especificados.

    Tipo de dados: Número
    resultado.reservable_sys_id.score Pontuação de disponibilidade. Número de reserváveis disponíveis sobre o número total de reserváveis que atenderam aos critérios de pesquisa especificados. Por exemplo, se availableé 2 e. totalé 4, o. scoreo valor é 2/4.

    Tipo de dados: Cadeia de caracteres
    result.reservable_sys_id.total Número total de reserváveis que atenderam aos critérios de pesquisa especificados.

    Tipo de dados: Número

    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/search/availability_score" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"reservableType\": \"location\",
  \"reservableIds\": [
    \"fe1f744edb7650106c731dcd139619ca\",
    \"5eafb44edb7650106c731dcd13961943\"
  ],
  \"recurringPattern\": {
    \"duration\": 3600000,
    \"repeats\": \"daily\",
    \"options\": {
      \"count\": 150,
      \"daysOfWeek\": \"\",
    },
    \"label\": \"Repeats daily, 5 times\",
    \"startDate\": \"2022-04-26T14:00:00Z\"
  },
  \"startEndDateTimes\": [
    {
      \"start\": \"2022-07-05 14:00:00\",
      \"end\": \"2022-07-05 15:00:00\"
    },
    {
      \"start\": \"2022-07-06 14:00:00\",
      \"end\": \"2022-07-06 15:00:00\"
    }
  ]
}" \
--user "username":"password"

    Resultados de retorno:

    {
  "result": {
    "fe1f744edb7650106c731dcd139619ca": {
      "available": 2,
      "total": 2,
      "score": "2/2"
    },
    "5eafb44edb7650106c731dcd13961943": {
      "available": 2,
      "total": 2,
      "score": "2/2"
    }
  }