API de pesquisa do WSD

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

    • A API de pesquisaWorkplace Service Delivery (WSD) fornece endpoints para pesquisa de locais disponíveis e itens do local de trabalho, como reserváveis, módulos reserváveis e turnos disponíveis.

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

    Esta API é executada no namespace sn_wsd_rsv.

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

    Pesquisa do WSD - GET /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ões: /api/sn_wsd_rsv/{api_version}/search/availability

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres
    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 no parâmetro start.

    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.
    • false: não retorna todos os slots livres.

    Tipo de dados: booliano

    Padrão: falso
    ids_reserváveis Obrigatório. Lista separada por vírgulas de sys_ids reserváveis para avaliar a disponibilidade. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    ids_reserva Lista separada por vírgulas de sys_ids de reserva existentes. Passe este parâmetro se quiser editar as reservas associadas. Localizado na tabela Reserva do local de trabalho [sn_wsd_rsv_reservation].

    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
    reservable_module Obrigatório. Sys_id do módulo reservável a ser incluído na pesquisa. Um módulo reservável agrupa tipos semelhantes de itens do local de trabalho. Localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module].

    Tipo de dados: cadeia de caracteres
    programação_exibição_obj Detalhes sobre a exibição de programação a ser retornada. Passe este objeto se você precisar de dados de disponibilidade de 24 horas para reservas que duram mais de um dia. Os resultados retornados conterão somente horários disponíveis e reservas para a data especificada.

    Para que esta funcionalidade funcione corretamente, os parâmetros ignore_same_day_validation e include_reservations_within_days devem ser definidos como verdadeiros.

    Tipo de dados: objeto

    "schedule_view_obj": {
  "schedule_view_date": "String",
  "timezone": "String"
}
    schedule_view_obj.schedule_view_date Data para a qual iniciar o retorno da disponibilidade de reserva. Esta data deve estar no fuso horário especificado no parâmetro schedule_view_obj.timezone.

    Tipo de dados: cadeia de caracteres

    Formato: AAAA-MM-DD
    schedule_view_obj.fuso horário Fuso horário do edifício 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 Obrigatório se os módulos reserváveis especificados forem baseados em um turno.
    Sys_id do turno a ser associado à reserva. Localizado na tabela Turno [sn_wsd_core_shift]. Se este parâmetro for passado, o parâmetro end não será necessário.

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

    Tipo de dados: cadeia de caracteres
    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 no parâmetro end.

    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

    Cabeçalhos

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

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

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

    Códigos de status

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

    Tabela 6. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    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 recuperá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"
  }
]
    resultado.HorasDisponíveis Lista de datas/horas em que o reservável associado está disponível.

    Tipo de dados: matriz
    resultado.edifício 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 Exiba o valor 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 do edifício associado.

    Tipo de dados: cadeia de caracteres
    resultado.campus Detalhes sobre o campus associado ao reservável.

    Tipo de dados: objeto

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    resultado.campus.display_value Exiba o número 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
    resultado.campus.sys_id Sys_id do registro associado. Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: cadeia de caracteres
    resultado.e-mail Endereço de e-mail do reservável associado.

    Tipo de dados: cadeia de caracteres
    resultado.piso Detalhes sobre o piso associado ao reservável.

    Tipo de dados: objeto

    "floor": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    resultado.piso.exibição_valor Exiba o número do andar no qual 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
    resultado.piso.sys_id Sys_id do registro associado na tabela Piso [sn_wsd_core_floor].

    Tipo de dados: cadeia de caracteres
    resultado.está_disponível 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
    resultado.reservas 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. Localizado na tabela cmdb_ci.

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

    Isso indica que o local reservável associado já está reservado para o intervalo de tempo de pesquisa especificado.

    Valores possíveis:
    • verdadeiro: colisão.
    • falso: sem colisão.

    Tipo de dados: booliano
    resultado.reservas.local Detalhes sobre o local da reserva.

    Tipo de dados: objeto

    "location": {
  "location": "String",
  "timezone": {Object}
}
    resultado.reservas.local.local Sys_id do registro de local associado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    result.reservas.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 Exibe o valor do fuso horário ao qual este local pertence.

    Tipo de dados: cadeia de caracteres
    result.reservas.location.timezone.value Valor interno para o 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.reservas.requested_for Detalhes sobre a pessoa para quem a reserva foi solicitada em nome de.

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres
    result.reservas.requested_for.sys_id Sys_id do usuário para o qual a reserva está sendo solicitada. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    resultado.reservas.propósito_reserva Detalhes sobre a finalidade da reserva.

    Tipo de dados: objeto

    "reservation_purpose": {
  "display_value": "String,"
  "value": "String"
}
    result.reservations.reservation_propósito.​display_value Exiba o valor para a finalidade da reserva, como Reunião da empresa.

    Tipo de dados: cadeia de caracteres
    resultado.reservas.propósito_reserva.valor Valor interno para fins de reserva, como company_meeting.

    Tipo de dados: cadeia de caracteres
    resultado.reservas.início Data e hora de início da reserva.

    Tipo de dados: cadeia de caracteres

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

    Tipo de dados: objeto

    "state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservas.state.display_value Exibe o valor do estado atual da reserva, como confirmado.

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

    Tipo de dados: cadeia de caracteres
    resultado.reservas.assunto Assunto da reserva.

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

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint. Observação: 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"

    Retornar resultados:

    {
  "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 do WSD - GET /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ões: /api/sn_wsd_rsv/{api_version}/search/best_match

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

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. 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 no parâmetro start.

    Tipo de dados: cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    include_reservável_propósitos Sinalizador que indica se a finalidade de reservar o local de trabalho deve ser retornada para cada reservável nos resultados de retorno. Essas informações estão localizadas na tabela Finalidade reservável [sn_wsd_rsv_reservable_purpose].
    Valores válidos:
    • verdadeiro: retorna as finalidades reserváveis.
    • falso: não retorne as finalidades reserváveis.

    Tipo de dados: booliano

    Padrão: falso
    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.
    • false: não retorna todos os slots livres.

    Tipo de dados: booliano

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

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

    Valores válidos:
    • verdadeiro: retorna as informações de serviços padrão.
    • false: 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. Nessa consulta, você deve especificar o sys_id do edifício e pode especificar parâmetros como piso, área, capacidade, serviços padrão e reservable_purposes.

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

    For example: q=building=94e264cedb3650106c731dcd13961919​^floorINfc7368cedb3650106c731dcd13961902​^capacity>=1​^standard_services=55c0818edb7650106c731dcd13961904​^reservable_purposes=d6e5c7cd1ba4e01051848489cc4bcb81

    Você pode localizar essas informações nas seguintes tabelas:
    • Edifício: sn_wsd_core_building
    • Andar: sn_wsd_core_payment
    • Área: sn_wsd_core_area
    • Serviços padrão: sn_wsd_rsv_standard_service
    • Finalidades reserváveis: sn_wsd_rsv_reservable_propósito

    Tipo de dados: cadeia de caracteres
    reservable_module Obrigatório. Sys_id do módulo reservável a ser incluído na pesquisa. Um módulo reservável agrupa tipos semelhantes de itens do local de trabalho. Localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module].

    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 no parâmetro end.

    Tipo de dados: cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    intervalo_de_tempo Sys_id de um registro de intervalo de tempo para o qual estamos tentando procurar o reservável mais adequado. Localizado na tabela Intervalo de tempo [sn_wsd_rsv_time_slot].

    Tipo de dados: cadeia de caracteres

    Padrão: Nenhum
    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

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

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

    Códigos de status

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

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

    Parâmetros do corpo da resposta

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

    Tipo de dados: objeto

    "result": { 
  "floorsOfSelectedBuilding": [Array],
  "hasMore": Boolean,
  "nextItemIndex": Number,
  "reservableContainers": [Array],
  "reservableUnits": [Array]
}
    resultado.andaresDeSelecionadoEdifício Detalhes sobre os andares nos quais o reservável está localizado.

    Tipo de dados: matriz de objetos

    "floorsOfSelectedBuilding": [
  {
    "display_value": "String",
    "external_id": "String",
    "name": "String",
    "sys_id": "String"
  }
]
    resultado.andaresDeSelecionadoEdifício.exibição_valor Exiba o número do andar no qual o reservável reside, como 12.

    Tipo de dados: cadeia de caracteres
    resultado.andaresDeSelecionadoPrédio.id_externo Identificador externo do piso.

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

    Tipo de dados: cadeia de caracteres
    resultado.andaresOfSelectedBuilding.sys_id Sys_id do registro associado na tabela Piso [sn_wsd_core_floor].

    Tipo de dados: cadeia de caracteres
    result.hasMais Sinalizador que indica se há mais reserváveis nos resultados retornados.
    Valores possíveis:
    • verdadeiro: mais reserváveis disponíveis.
    • falso: não há mais reserváveis disponíveis.

    Tipo de dados: booliano
    resultado.nextItemIndex Índice do próximo registro reservável a ser buscado. 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 collection_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 Exiba o valor 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 do edifício associado.

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

    Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: objeto

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableContainers.campus.​display_value Exiba o número 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. Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: cadeia de caracteres
    result.reservableContainers.capacity Número máximo de ocupantes para o reservável.

    Tipo de dados: número
    result.reservableContainers.display_value Exiba o valor do contêiner reservável.

    Tipo de dados: cadeia de caracteres
    resultado.contêineres-reservados.piso Detalhes sobre o piso associado ao contêiner reservável.

    Tipo de dados: objeto

    "floor": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableContainers. PISO.​display_value Exiba o número do andar no qual 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 na tabela Piso [sn_wsd_core_floor].

    Tipo de dados: cadeia de caracteres
    result.reservableContainers.image Detalhes sobre uma imagem que representa o layout do reservável associado.

    Localizado na tabela Imagens [db_image].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.reservableContainers.image.link Link para uma imagem que representa o layout deste reservável. Localizado na tabela Imagens [db_image].

    Tipo de dados: cadeia de caracteres
    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 de contêiner associado. A tabela na qual reside pode ser configurada para qualquer tipo de contêiner. Por padrão, ele está na tabela Área [sn_wsd_core_area].

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

    "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 em que o módulo reservável está localizado. Localizado na tabela Área [sn_wsd_core_area].

    Tipo de dados: objeto

    "area": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.area.display_value Exibe o valor da área do módulo reservável.

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.area.sys_id Sys_id do registro da área associada 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
    resultado.unidadesreservadas.edifício Detalhes sobre o edifício no qual o reservável está localizado. Localizado na tabela Edifício [sn_wsd_core_building].

    Tipo de dados: objeto

    "building": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.building.display_value Exiba o valor do edifício.

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

    Tipo de dados: cadeia de caracteres
    resultado.unidadesreservadas.campus
    Detalhes sobre o campus no qual o reservável está localizado.

    Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: objeto

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.campus.display_value Exiba o número 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. Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: cadeia de caracteres
    resultado.unidadesreservadas.capacidade Número máximo de ocupantes para o 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
    resultado.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
    resultado.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
    resultado.UnidadesDeReservas.andares
    Detalhes sobre o piso em que o reservável está localizado.

    Localizado na tabela Piso [sn_wsd_core_payment].

    Tipo de dados: objeto

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}
    resultado.unidades_reserva.andar.exibição_valor Exiba o número do andar no qual o reservável reside, como 12.

    Tipo de dados: cadeia de caracteres
    resultado.UnidadesDeReserva.piso.SYS_ID Sys_id do registro associado na tabela Piso [sn_wsd_core_floor].

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.image Detalhes sobre uma imagem que representa o layout do reservável associado.

    Localizado na tabela Imagens [db_image].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.reservableUnits.image.link Link para uma imagem que representa o layout deste reservável. Localizado na tabela Imagens [db_image].

    Tipo de dados: cadeia de caracteres
    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 do retorno.
    Valores válidos:
    • verdadeiro: incluído nos resultados do retorno.
    • falso: não incluído nos resultados do retorno.

    Tipo de dados: booliano
    resultado.unidades_reservadas.está_disponível 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
    resultado.unidades_reservadas.é_favorito Sinalizador que indica se o reservável está sinalizado como um dos favoritos do usuário associado.
    Valores válidos:
    • verdadeiro: Favorito.
    • false: não é um favorito.

    Tipo de dados: booliano
    resultado.unidades_reservadas.é_reservado Sinalizador que indica se é possível reservar este reservável.
    Nota:
    Se o parâmetro de consulta include_unavailable_items estiver definido como verdadeiro, os locais indisponíveis também serão retornados. Nesse caso, se um local já estiver reservado, o parâmetro is_available será falso, mas is_reservable será verdadeiro.
    Valores válidos:
    • verdadeiro: disponível para reserva.
    • falso: não disponível para reserva.

    Tipo de dados: booliano
    result.reservableUnits.is_reserved 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.

    Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    "location_type": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableunits.location_type.​display_value Exiba o valor do tipo de local.

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

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.location_type.sys_id Sys_id do registro associado na tabela Tipo de espaço [sn_wsd_core_space_type].

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.name Nome do reservável.

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

    Tipo de dados: cadeia de caracteres
    resultado.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.
    • false: 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:
    • verdadeiro: check-in necessário.
    • false: o check-in não é necessário.

    Tipo de dados: booliano
    resultado.unidades_reserva.propósitos_reserva Detalhes sobre a finalidade de reservar o reservável associado.

    Tipo de dados: matriz de objetos

    "reservable_purposes": [
  {
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.reservableunits.reservable_propósitos.​nome Nome do reservável.

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.reservable_propósitos.​short_description Breve descrição do reservável.

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.reservable_propósitos.​sys_id Sys_id do registro de finalidade reservável. Localizado na tabela Finalidade reservável [sn_wsd_rsv_reservable_purpose].

    Tipo de dados: cadeia de caracteres
    resultado.reservableUnits.reservas Detalhes sobre as reservas associadas ao reservável. Preenchido somente se o parâmetro de consulta include_reservations_within_days for verdadeiro e o parâmetro reservation_ids contiver IDs de reserva, o que significa que já existem 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. Localizado na tabela cmdb_ci.

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

    Isso indica que o local reservável associado já está reservado para o intervalo de tempo de pesquisa especificado.

    Valores possíveis:
    • verdadeiro: colisão.
    • falso: sem colisão.

    Tipo de dados: booliano
    resultado.reservableunits.reservations.location Detalhes sobre o local da reserva.

    Tipo de dados: objeto

    "location": {
  "location": "String",
  "timezone": {Object}
}
    result.reservableunits.reservations.location.​location Sys_id do registro de local associado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    result.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 Exibe o valor do fuso horário ao qual este local pertence.

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

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

    Tipo de dados: objeto

    "requested_for": {
  "name": "String",
  "sys_id": "String"
}
    result.reservableunits.reservations.​requested_for.name Nome do usuário para quem 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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservableunits.reservations.​reservation_propósito Detalhes sobre a finalidade da reserva.

    Tipo de dados: objeto

    "reservation_purpose": {
  "display_value": "String,"
  "value": "String"
}
    result.reservableunits.reservations.​reservation_purpose.display_value Exiba o valor para a finalidade da reserva, como Reunião da empresa.

    Tipo de dados: cadeia de caracteres
    result.reservableunits.reservations.​reservation_propósito.value Valor interno para fins de 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
    resultado.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 Exibe o valor do estado atual da reserva, como confirmado.

    Tipo de dados: cadeia de caracteres
    result.reservableunits.reservations.state.value Valor interno para o estado atual da reserva, como 2.

    Tipo de dados: cadeia de caracteres
    result.reservableunits.reservations.subject Assunto da reserva.

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

    Tipo de dados: cadeia de caracteres
    resultado.unidades_reserva.quantidade_reserva Número máximo de vezes que o reservável associado pode ser reservado ao mesmo tempo. Este valor é usado ao atribuir espaços de bairro a uma área.

    Tipo de dados: inteiro
    result.reservableUnits.showPrivacyOption 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 reside o reservável.

    Localizado na tabela Site [sn_wsd_core_site].

    "site": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableunits.site.display_value Exiba o valor do site.

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.site.sys_id Sys_id do registro do site associado na tabela Site [sn_wsd_core_site].

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.standard_services
    Serviços padrão associados, como bloco de listras, 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. Localizado na tabela Serviço padrão [sn_wsd_rsv_standard_service].

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.sys_id Sys_id do registro reservável. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.tableName Nome da tabela na qual reside o registro reservável.

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

    Retornar resultados:

    {
  "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 do WSD - GET /api/sn_wsd_rsv/search/overlapping_reservation

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

    Formato de URL

    URL com controle de versões: /api/sn_wsd_rsv/{api_version}/search/overlapping_reservation

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

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. 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: AAA-MM-DDTHH:MM:SSZ
    padrão_recorrente Detalhes sobre o padrão recorrente da reserva.

    Tipo de dados: objeto

    "recurring_pattern": {
  "duration": Number,
  "options": {Object},
  "repeats": "String",
  "startDate":"String"
}
    padrão_recorrente.duração Período de tempo para verificar.

    Tipo de dados: número

    Unidade: segundos
    padrão_recorrente.opções Detalhes sobre as opções associadas à reserva recorrente.

    Tipo de dados: objeto

    "options": {
  "count": Number,
  "daysOfWeek": "String",
  "every": Number
}
    recorrente_padrão.opções.contagem Número de vezes que o padrão é repetido.

    Tipo de dados: número
    padrão_recorrente.opções.diasDaSemana Dias da semana para verificar se há sobreposições.
    Valores válidos:
    • 1 = segunda-feira
    • 2 = Terça-feira
    • 3 = Quarta-feira
    • 4 = Quinta-feira
    • 5 = Sexta-feira
    • 6 = sábado
    • 7 = domingo

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

    Tipo de dados: cadeia de caracteres
    padrão_recorrente.opções.todos Intervalo de repetição de padrão a ser verificado. Por exemplo, se este valor for 2, ele verificará o padrão de repetição com base na seleção no parâmetro repeats, como em dias alternados ou em semanas alternadas.

    Tipo de dados: número
    padrão_recorrente.opções.repetições Padrão de repetição para a verificação de sobreposição de reserva.
    Valores possíveis: (diferencia maiúsculas de minúsculas)
    • diariamente
    • mensal
    • semanal
    • anual

    Tipo de dados: cadeia de caracteres
    reservable_id Sys_id do módulo reservável para verificar se há reservas sobrepostas. Localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module].

    Tipo de dados: cadeia de caracteres
    reserva_id Sys_id da reserva para verificar se há sobreposição. Este valor é necessário no fluxo de edição de primários de vários/grupos. Localizado na tabela Reserva do local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres
    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: permite reservas baseadas em turno.
    • falso: não permite reservas baseadas em turno.

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

    Tipo de dados: cadeia de caracteres
    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: AAA-MM-DDTHH:MM:SSZ
    user_id Obrigatório. Sys_id do usuário para verificar se há reservas sobrepostas. Localizado na tabela Usuário [sys_user].

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

    Cabeçalhos

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

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

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

    Códigos de status

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

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

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

    Nome Descrição
    resultado(s) Detalhes dos resultados da verificação de sobreposição.

    Tipo de dados: objeto

    "results": {
  "isOverlapped": Boolean,
  "reservableId": "String"
}
    resultados.estáSobreposto Sinalizador que indica se existe uma reserva sobreposta.

    Valores válidos:

    • verdadeiro: existe uma reserva sobreposta.
    • false: a reserva sobreposta não existe.

    Tipo de dados: booliano
    result.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 uma sobreposição de reserva para um usuário específico e para um período específico denotado pelos parâmetros start e end.

    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'

    Retornar resultados:

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

    Pesquisa do WSD - GET /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ões: /api/sn_wsd_rsv/{api_version}/search/reservable

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

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. 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 no parâmetro start.

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

    Tipo de dados: cadeia de caracteres ou matriz
    ignore_same_day_validation Sinalizador que indica se a pesquisa de reserva ignora a mudança da validação de data entre os parâmetros inicial e final.
    Valores válidos:
    • verdadeiro: 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_reservável_propósitos Sinalizador que indica se a finalidade de reservar o local de trabalho deve ser retornada para cada reservável nos resultados de retorno. Essas informações estão localizadas na tabela Finalidade reservável [sn_wsd_rsv_reservable_purpose].
    Valores válidos:
    • verdadeiro: retorna as finalidades reserváveis.
    • falso: não retorne as finalidades reserváveis.

    Tipo de dados: booliano

    Padrão: falso
    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.
    • false: não retorna todos os slots livres.

    Tipo de dados: booliano

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

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

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

    Tipo de dados: booliano

    Padrão: falso
    next_by_location_id Obrigatório se o parâmetro rsv_path estiver definido como navegador_near_a_person. Sys_id do local a ser usado na consulta codificada. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    bairro

    Obrigatório se o parâmetro rsv_path estiver definido como navegador_by_nook.

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

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

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

    Tipo de dados: cadeia de caracteres
    próximo_item_índice Í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. Nessa consulta, você deve especificar o sys_id do edifício e pode especificar parâmetros como piso, área, capacidade, serviços padrão e reservable_purposes.

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

    For example: q=building=94e264cedb3650106c731dcd13961919​^floorINfc7368cedb3650106c731dcd13961902​^capacity>=1​^standard_services=55c0818edb7650106c731dcd13961904​^reservable_purposes=d6e5c7cd1ba4e01051848489cc4bcb81

    Você pode localizar essas informações nas seguintes tabelas:
    • Edifício: sn_wsd_core_building
    • Andar: sn_wsd_core_payment
    • Área: sn_wsd_core_area
    • Serviços padrão: sn_wsd_rsv_standard_service
    • Finalidades reserváveis: sn_wsd_rsv_reservable_propósito

    Tipo de dados: cadeia de caracteres
    reservable_module Obrigatório. Sys_id do módulo reservável a ser incluído na pesquisa. Um módulo reservável agrupa tipos semelhantes de itens do local de trabalho. Localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module].

    Tipo de dados: cadeia de caracteres
    ids_reserva Lista separada por vírgulas de sys_ids de reserva existentes. Passe este parâmetro se quiser editar as reservas associadas. Localizado na tabela Reserva do local de trabalho [sn_wsd_rsv_reservation].

    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
    rsv_path Caminho de reserva a ser aplicado à pesquisa.
    Valores válidos:
    • navegador_all: pesquisa todos os reserváveis.
    • browser_by_area: pesquisa os reserváveis próximos a um local específico. Um identificador de área deve ser passado na consulta codificada (parâmetroq ).
    • navegador_by_nível: pesquisa os reserváveis próximos ao bairro especificado no parâmetro neighborhood.
    • navegador_near_a_person: pesquisa os reserváveis próximos ao local de trabalho da pessoa especificada no parâmetro near_by_location_id.

    Tipo de dados: cadeia de caracteres

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

    Para que esta funcionalidade funcione corretamente, os parâmetros ignore_same_day_validation e include_reservations_within_days devem ser definidos como verdadeiros.

    Tipo de dados: objeto

    "schedule_view_obj": {
  "schedule_view_date": "String",
  "timezone": "String"
}
    schedule_view_obj.schedule_view_date Data para a qual iniciar o retorno da disponibilidade de reserva. Esta data deve estar no fuso horário especificado no parâmetro schedule_view_obj.timezone.

    Tipo de dados: cadeia de caracteres

    Formato: AAAA-MM-DD
    schedule_view_obj.fuso horário Fuso horário do edifício 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 no parâmetro end.

    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. Localizado na tabela Turno [sn_wsd_core_shift]. Se este parâmetro for passado, o parâmetro end não será necessário.

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

    Tipo de dados: cadeia de caracteres
    class_by Ordem de classificação desejada dos itens reserváveis retornados.
    Valores válidos:
    • a_z: ordem de classificação crescente.
    • favoritos_primeiro: classificado pelos reserváveis favoritos do usuário no local de trabalho favorito, 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

    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/xml ou, text/xml.

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

    Códigos de status

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

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

    Parâmetros do corpo da resposta

    Nome Descrição
    resultado Retorna resultados para a 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. Se os parâmetros include_standard_services ou include_reservable_purposes forem definidos como falsos, standard_services e reservable_purposes serão matrizes vazias.

    Tipo de dados: objeto

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

    Localizado na tabela Piso [sn_wsd_core_payment].

    Tipo de dados: objeto

    "floors": [
  {
    "display_value": "String",
    "sys_id": "String"
  }
]
    resultado.filtro.andares.exibição_valor Exiba o número do andar no qual o reservável reside, como 12.

    Tipo de dados: cadeia de caracteres
    resultado.filtro.andares.sys_id Sys_id do registro associado na tabela Piso [sn_wsd_core_floor].

    Tipo de dados: cadeia de caracteres
    result.filter.standard_services Preenchido somente se o parâmetro include_standard_services estiver definido como verdadeiro.
    Serviços padrão associados, como bloco de listras, 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. Localizado na tabela Serviço padrão [sn_wsd_rsv_standard_service].

    Tipo de dados: cadeia de caracteres
    result.filter.reservable_propósitos Detalhes sobre a finalidade de reservar o 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_propósitos.​short_description Breve descrição do reservável.

    Tipo de dados: cadeia de caracteres
    result.filter.reservable_propósitos.sys_id Sys_id do registro de finalidade reservável. Localizado na tabela Finalidade reservável [sn_wsd_rsv_reservable_purpose].

    Tipo de dados: cadeia de caracteres
    result.hasMais Sinalizador que indica se há mais reserváveis nos resultados retornados.
    Valores possíveis:
    • verdadeiro: mais reserváveis disponíveis.
    • falso: não há mais reserváveis disponíveis.

    Tipo de dados: booliano
    resultado.nextFavIndex Índice do próximo favorito reservável para o usuário. Use este valor ao paginar os reserváveis favoritos do usuário.

    Tipo de dados: número
    resultado.nextItemIndex Índice do próximo registro reservável a ser buscado. 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 collection_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 Exiba o valor 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 do edifício associado.

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

    Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: objeto

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableContainers.campus.​display_value Exiba o número 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. Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: cadeia de caracteres
    result.reservableContainers.capacity Número máximo de ocupantes para o reservável.

    Tipo de dados: número
    result.reservableContainers.display_value Exiba o valor do contêiner reservável.

    Tipo de dados: cadeia de caracteres
    resultado.contêineres-reservados.piso Detalhes sobre o piso associado ao contêiner reservável.

    Tipo de dados: objeto

    "floor": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableContainers. PISO.​display_value Exiba o número do andar no qual 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 na tabela Piso [sn_wsd_core_floor].

    Tipo de dados: cadeia de caracteres
    result.reservableContainers.image Link para uma imagem que representa o layout deste reservável. Localizado na tabela Imagens [db_image].

    Tipo de dados: cadeia de caracteres
    result.reservableContainers.image.link Link para uma imagem que representa o layout deste reservável. Localizado na tabela Imagens [db_image].

    Tipo de dados: cadeia de caracteres
    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 de contêiner associado. A tabela na qual reside pode ser configurada para qualquer tipo de contêiner. Por padrão, ele está na tabela Área [sn_wsd_core_area].

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

    "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 em que o módulo reservável está localizado. Localizado na tabela Área [sn_wsd_core_area].

    Tipo de dados: objeto

    "area": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.area.display_value Exibe o valor da área do módulo reservável.

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.area.sys_id Sys_id do registro da área associada 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
    resultado.unidadesreservadas.edifício Detalhes sobre o edifício no qual o reservável está localizado. Localizado na tabela Edifício [sn_wsd_core_building].

    Tipo de dados: objeto

    "building": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.building.display_value Exiba o valor do edifício.

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

    Tipo de dados: cadeia de caracteres
    resultado.unidadesreservadas.campus
    Detalhes sobre o campus no qual o reservável está localizado.

    Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: objeto

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.campus.display_value Exiba o número 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. Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: cadeia de caracteres
    resultado.unidadesreservadas.capacidade Número máximo de ocupantes para o reservável.

    Tipo de dados: número
    resultado.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
    resultado.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
    resultado.UnidadesDeReservas.andares
    Detalhes sobre o piso em que o reservável está localizado.

    Localizado na tabela Piso [sn_wsd_core_payment].

    Tipo de dados: objeto

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}
    resultado.unidades_reserva.andar.exibição_valor Exiba o número do andar no qual o reservável reside, como 12.

    Tipo de dados: cadeia de caracteres
    resultado.UnidadesDeReserva.piso.SYS_ID Sys_id do registro associado na tabela Piso [sn_wsd_core_floor].

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.image Detalhes sobre uma imagem que representa o layout do reservável associado.

    Localizado na tabela Imagens [db_image].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.reservableUnits.image.link Link para uma imagem que representa o layout deste reservável. Localizado na tabela Imagens [db_image].

    Tipo de dados: cadeia de caracteres
    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 do retorno.
    Valores válidos:
    • verdadeiro: incluído nos resultados do retorno.
    • falso: não incluído nos resultados do retorno.

    Tipo de dados: booliano
    resultado.unidades_reservadas.está_disponível 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
    resultado.unidades_reservadas.é_favorito Sinalizador que indica se o reservável está sinalizado como um dos favoritos do usuário associado.
    Valores válidos:
    • verdadeiro: Favorito.
    • false: não é um favorito.

    Tipo de dados: booliano
    resultado.unidades_reservadas.é_reservado Sinalizador que indica se é possível reservar este reservável.
    Nota:
    Se o parâmetro de consulta include_unavailable_items estiver definido como verdadeiro, os locais indisponíveis também serão retornados. Nesse caso, se um local já estiver reservado, o parâmetro is_available será falso, mas is_reservable será verdadeiro.
    Valores válidos:
    • verdadeiro: disponível para reserva.
    • falso: não disponível para reserva.

    Tipo de dados: booliano
    result.reservableUnits.is_reserved 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.

    Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    "location_type": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableunits.location_type.​display_value Exiba o valor do tipo de local.

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

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.location_type.sys_id Sys_id do registro associado na tabela Tipo de espaço [sn_wsd_core_space_type].

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.name Nome do reservável.

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

    Tipo de dados: cadeia de caracteres
    resultado.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.
    • false: 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:
    • verdadeiro: check-in necessário.
    • false: o check-in não é necessário.

    Tipo de dados: booliano
    resultado.unidades_reserva.propósitos_reserva Detalhes sobre a finalidade de reservar o reservável associado.

    Tipo de dados: matriz de objetos

    "reservable_purposes": [
  {
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.reservableunits.reservable_propósitos.​nome Nome do reservável.

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.reservable_propósitos.​short_description Breve descrição do reservável.

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.reservable_propósitos.​sys_id Sys_id do registro de finalidade reservável. Localizado na tabela Finalidade reservável [sn_wsd_rsv_reservable_purpose].

    Tipo de dados: cadeia de caracteres
    resultado.reservableUnits.reservas Detalhes sobre as reservas associadas ao reservável. Preenchido somente se o parâmetro de consulta include_reservations_within_days for verdadeiro e o parâmetro reservation_ids contiver IDs de reserva, o que significa que já existem 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. Localizado na tabela cmdb_ci.

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

    Isso indica que o local reservável associado já está reservado para o intervalo de tempo de pesquisa especificado.

    Valores possíveis:
    • verdadeiro: colisão.
    • falso: sem colisão.

    Tipo de dados: booliano
    resultado.reservableunits.reservations.location Detalhes sobre o local da reserva.

    Tipo de dados: objeto

    "location": {
  "location": "String",
  "timezone": {Object}
}
    result.reservableunits.reservations.location.​location Sys_id do registro de local associado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    result.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 Exibe o valor do fuso horário ao qual este local pertence.

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

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

    Tipo de dados: objeto

    "requested_for": {
  "name": "String",
  "sys_id": "String"
}
    result.reservableunits.reservations.​requested_for.name Nome do usuário para quem 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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservableunits.reservations.​reservation_propósito Detalhes sobre a finalidade da reserva.

    Tipo de dados: objeto

    "reservation_purpose": {
  "display_value": "String,"
  "value": "String"
}
    result.reservableunits.reservations.​reservation_purpose.display_value Exiba o valor para a finalidade da reserva, como Reunião da empresa.

    Tipo de dados: cadeia de caracteres
    result.reservableunits.reservations.​reservation_propósito.value Valor interno para fins de 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
    resultado.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 Exibe o valor do estado atual da reserva, como confirmado.

    Tipo de dados: cadeia de caracteres
    result.reservableunits.reservations.state.value Valor interno para o estado atual da reserva, como 2.

    Tipo de dados: cadeia de caracteres
    result.reservableunits.reservations.subject Assunto da reserva.

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

    Tipo de dados: cadeia de caracteres
    resultado.unidades_reserva.quantidade_reserva Número máximo de vezes que o reservável associado pode ser reservado ao mesmo tempo. Este valor é usado ao atribuir espaços de bairro a uma área.

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

    Localizado na tabela Site [sn_wsd_core_site].

    "site": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableunits.site.display_value Exiba o valor do site.

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.site.sys_id Sys_id do registro do site associado na tabela Site [sn_wsd_core_site].

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.standard_services
    Serviços padrão associados, como bloco de listras, 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. Localizado na tabela Serviço padrão [sn_wsd_rsv_standard_service].

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.sys_id Sys_id do registro reservável. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    result.reservableUnits.tableName Nome da tabela na qual reside o registro reservável.

    Tipo de dados: cadeia de caracteres
    resultado.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. Observação: 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"

    Retornar resultados:

    {
  "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 do WSD - GET /api/sn_wsd_rsv/search/shift/{building_id}/{module_id}

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

    Aplicável somente se o campo apple_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ões: /api/sn_wsd_rsv/{api_version}/search/shift/{building_id}/{module_id}

    URL padrão: /api/sn_wsd_rsv/search/shift/{building_id}/{module_id}

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres
    edifício_id Sys_id do edifício a ser incluído na consulta de pesquisa. Localizado na tabela Edifício [sn_wsd_core_building].

    Tipo de dados: cadeia de caracteres
    module-id Sys_id do módulo reservável a ser incluído na consulta de pesquisa. Localizado na tabela Módulo reservável [sn_wsd_core_reservable_module]. 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 26. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 27. Parâmetros do corpo da solicitação
    Nome Descrição
    end_date Mude a data e hora de término do turno para incluir na consulta codificada.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd hh:mm:ss
    start_date Mude a data e hora de início para incluir 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/xml ou, text/xml.

    Padrão: application/json
    Tabela 29. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

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

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

    Parâmetros do corpo da resposta

    Nome Descrição
    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 para o 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 por 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"

    Retornar resultados:

    {
  "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 do 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ões: /api/sn_wsd_rsv/{api_version}/search/availability_score

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

    Parâmetros de solicitação compatíveis

    Tabela 31. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. 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
    Tabela 33. Parâmetros do corpo da solicitação
    Nome Descrição
    recorrentePattern Obrigatório se o parâmetro startEndDateTimes não for 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"
}
    PadrãoDeRecorrente.duração Obrigatório. Período de tempo durante o qual o reservável deve estar disponível.

    Tipo de dados: número

    Unidade: milissegundos
    PadrãoDeRecorrente.rótulo Descrição do padrão recorrente, como Repete diariamente, 5 vezes.

    Tipo de dados: cadeia de caracteres
    PadrãoRecorrente.opções Opções de disponibilidade para a reserva recorrente a ser pesquisada.

    Tipo de dados: objeto

    "options": {
  "count": Number,
  "daysOfWeek": "String",
  "endDate": "String",
  "every": Number
}
    recorrentePattern.options.count Obrigatório se endDate não for aprovado. Se ambos forem aprovados, count será usado. Número de vezes para repetir o padrão de reunião.

    Tipo de dados: número
    padrãorecorrente.opções.diasDaSemana Obrigatório se o parâmetro recurringPattern.repeats estiver definido como semanal. Dias da semana em que o reservável é necessário.
    Valores válidos:
    • 1 = segunda-feira
    • 2 = Terça-feira
    • 3 = Quarta-feira
    • 4 = Quinta-feira
    • 5 = Sexta-feira
    • 6 = sábado
    • 7 = domingo

    Por exemplo, para especificar terça, quinta e sexta-feira, passe 245 (sem delimitador). Se repeat for semanal, count for 5 e daysOfWeek for 245, nos resultados retornados, o total será igual a count*daysOfWeek.length (5*3=15).

    Tipo de dados: cadeia de caracteres
    padrãorecorrente.opções.datatérmino Obrigatório se recurringPattern.options.count não for aprovado. Se ambos forem aprovados, count será 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
    padrãorecorrente.opções.todos Intervalo de repetição de padrão. Por exemplo, se este valor for 2, repita o padrão alternativamente com base na seleção no parâmetro repeats, como em dias alternados ou em semanas alternadas.

    Tipo de dados: número
    recorrentePattern.repeats Obrigatório. Padrão de repetição para o reservável.
    Valores válidos (diferencia maiúsculas de minúsculas):
    • diariamente
    • mensal
    • semanal
    • anual

    Tipo de dados: cadeia de caracteres
    recorrentePattern.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
    IDsReserváveis Obrigatório. Lista de sys_ids dos reserváveis a serem incluídos na pontuação de disponibilidade. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: matriz
    TipoReservável 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):
    • local
    • configuration_item

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

    Tipo de dados: matriz de objetos

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

    Padrão: deve especificar o parâmetro recurringPattern.
    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/json ou 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

    Códigos de status

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

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

    Parâmetros do corpo da resposta

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

    Tipo de dados: objeto

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

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

    Tipo de dados: cadeia de caracteres
    resultado.total Número total de reserváveis que atendem 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\": \"\",
      \"every\": 1
    },
    \"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"

    Retornar resultados:

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