API reservável do WSD
A API reservável Prestação de serviços no local de trabalho ( WSD ) fornece endpoints para recuperar detalhes de um reservável, uma entidade que pode ser reservada, como um local de trabalho, de uma instância ServiceNow.
Para acessar esta API, o solicitante deve ter a função sn_wsd_core.workplace_user.
Esta API é executada no namespace sn_wsd_rsv. Para acessar esta API, o plug-in Workplace Reservation Management (sn_wsd_rsv) deve ser ativado.
Para obter informações adicionais sobre Gestão de reservas do local de trabalho, consulte Workplace Reservation Management.
WSD reservável - GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids}
Retorna os detalhes de um ou mais reserváveis especificados.
Formato da URL
URL com controle de versão: /api/sn_wsd_rsv/{api_version}/reservable/list_reservables/{sys_ids}
URL padrão: /api/sn_wsd_rsv/reservable/list_reservables/{sys_ids}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_ids | Sys_ids dos reserváveis cujos detalhes serão retornados. Se estiver especificando vários reserváveis, separe os sys_ids por vírgulas. Esses sys_ids estão localizados na tabela Local do local de trabalho [sn_wsd_core_workplace_location]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| include_flexible_services | Sinalizador que indica se os serviços flexíveis associados ao reservável em devem ser retornados para a resposta. Um serviço flexível é uma provisão adicional disponível com um item de local de trabalho reservável quando uma reserva é feita. Por exemplo, estilo Sala de aula - Filas de mesas dispostas com todos os participantes voltados para a frente da sala. Para obter informações adicionais sobre serviços flexíveis, consulte Criar um serviço flexível. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| include_layouts | Sinalizador que indica se as informações de layout do local devem ser retornadas na resposta. As informações de layout do local incluem itens como capacidade, capacidade máxima, preparação e duração da limpeza. Essas informações estão localizadas na tabela Layout do local [sn_wsd_rsv_m2m_location_layout]. Valores válidos:
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 de local de trabalho reservável quando a reserva é feita, como quadros brancos, monitores adicionais e serviços semelhantes. Para obter informações adicionais sobre serviços padrão, consulte Serviços padrão. Essas informações estão localizadas na tabela Serviço padrão [sn_wsd_rsv_standard_service]. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| reservable_module_sys_id | Obrigatório. Sys_id do módulo reservável. Um módulo reservável agrupa tipos semelhantes de itens do local de trabalho. Este sys_id está localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module]. Para obter informações adicionais sobre módulos reserváveis, consulte Configuração de um módulo reservável. Tipo de dados: cadeia de caracteres |
| reserva_início_hora | Hora de início da reserva para validar o prazo de serviços extras. Formato: formato UTC, aaaa-MM-dd HH:mm:ss Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| 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
| Nome | Descrição |
|---|---|
| resultado | Detalhes sobre cada reservável correspondente. Tipo de dados: matriz de objetos |
| result.allow_invitees | Sinalizador que indica se os funcionários podem adicionar convidados à reserva. Valores válidos:
Tipo de dados: booliano |
| result.area | Área onde o reservável está localizado. Essas informações estão localizadas na tabela Área [sn_wsd_core_area]. |
| result.area.display_value | Valor de exibição da área. Tipo de dados: cadeia de caracteres |
| result.area.sys_id | Sys_id do registro da área associada. Tipo de dados: cadeia de caracteres |
| resultado.edifício | Edifício onde o reservável está localizado. Essas informações estão localizadas na tabela Edifício [sn_wsd_core_building]. |
| result.building.display_value | Valor de exibição 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.edifício.fuso horário | Detalhes do fuso horário do edifício. |
| result.building.timezone.display_value | Valor de exibição do fuso horário no qual o edifício associado reside. Tipo de dados: cadeia de caracteres |
| result.building.timezone.value | Valor interno do fuso horário no qual o edifício associado reside. Tipo de dados: cadeia de caracteres |
| resultado.campus | Campus onde o reservável está localizado. Essas informações estão localizadas na tabela Campus [sn_wsd_core_campus]. |
| result.campus.display_value | Valor de exibição do campus. Tipo de dados: cadeia de caracteres |
| resultado.campus.sys_id | Sys_id do registro do campus associado. Tipo de dados: cadeia de caracteres |
| resultado.capacidade | Número de pessoas que o reservável pode acomodar. Tipo de dados: número |
| resultado.descrição | Descrição do reservável. Tipo de dados: cadeia de caracteres |
| resultado.exibir_número_de_participantes | Sinalizador que indica se os usuários podem especificar o número de participantes na reserva. Valores válidos:
Tipo de dados: booliano |
| resultado.display_on_behalf_of | Sinalizador que indica se as reservas podem ser feitas em nome de outra pessoa. Valores válidos:
Tipo de dados: booliano |
| resultado.exibição_sensibilidade | Sinalizador que indica se os usuários podem definir a confidencialidade da reserva, como normal ou privada. Valores válidos:
Tipo de dados: booliano |
| resultado.e-mail | Endereço de e-mail associado ao reservável. Tipo de dados: cadeia de caracteres |
| result.employee_override_privacy | Sinalizador que indica se os usuários podem substituir a configuração de privacidade do reservável associado. Para obter informações adicionais sobre essas configurações de privacidade, consulte Configurações e impacto da privacidade do local. Valores válidos:
|
| result.enable_group_reservations | Sinalizador que indica se os usuários podem fazer uma reserva de grupo. Valores válidos:
Tipo de dados: booliano |
| result.enable_reservation_privacy | Sinalizador que indica a configuração padrão de privacidade de reserva. Para obter informações adicionais sobre essas configurações de privacidade, consulte Location privacy settings and impact. Valores possíveis:
Tipo de dados: booliano |
| resultado.id_externo | ID externo do reservável. Tipo de dados: cadeia de caracteres |
| resultado.serviços_flexíveis | Preenchido somente se o parâmetro include_flexible_services estiver definido como verdadeiro e o plug-in de gestão de casos do local de trabalho estiver instalado. Descrição dos serviços flexíveis associados aos reserváveis. Pode haver um serviço flexível primário e vários serviços flexíveis secundários. Essas informações estão localizadas na tabela [sn_wsd_case_workplace_service_item]. |
| result.flexible_services.additional_text | Texto para solicitar que o usuário selecione serviços flexíveis adicionais. Tipo de dados: cadeia de caracteres |
| result.flexible_services.allow_only_single_service_item_selection | Sinalizador que indica se os usuários podem selecionar apenas um item de serviço entre o grupo de serviços flexíveis em uma reserva. Valores válidos:
Tipo de dados: booliano |
| resultado.serviços_flexíveis.categoria | Categoria dos serviços flexíveis. Tipo de dados: cadeia de caracteres |
| result.flexible_services.currency_code | Código da moeda usado para calcular o valor da moeda ao solicitar serviços flexíveis. Tipo de dados: cadeia de caracteres |
| resultado.serviços_flexíveis.serviço_flexível | Serviços flexíveis correspondentes a um serviço flexível primário. Essas informações estão localizadas na tabela [sn_wsd_case_workplace_service_item]. Tipo de dados: matriz de objetos |
| result.flexible_services.flexible_service.flexible_service | Detalhes de cada serviço flexível correspondente a um serviço flexível primário. Tipo de dados: matriz de objetos |
| result.flexible_services.flexible_service.flexible_service.additional_text | Texto usado para solicitar que um usuário selecione serviços flexíveis adicionais. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.capacity_enabled | Sinalizador que indica se a capacidade da sala deve aparecer na reserva. Se estiver definido como verdadeiro, quantity_enabled será sempre falso. Valores válidos:
Tipo de dados: booliano |
| result.flexible_services.flexible_service.flexible_service.category | Categoria do serviço flexível. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.category_label | Rótulo de categoria de serviço flexível. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.cleanup_duration | Quantidade de tempo necessária para limpar ou remover o serviço adicionado ao reservável. Tipo de dados: número Unidade: Milissegundos |
| result.flexible_services.flexible_service.flexible_service.image | Link para a imagem do serviço flexível. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.max_capacity | Número máximo de ocupantes que o reservável pode acomodar. Tipo de dados: número |
| result.flexible_services.flexible_service.flexible_service.name | Nome do serviço flexível. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.preparation_duration | Quantidade de tempo necessária para adicionar o serviço ao reservável. Tipo de dados: cadeia de caracteres Unidade: Milissegundos |
| result.flexible_services.flexible_service.flexible_service.price_per_unit | Detalhes do custo de adição do serviço flexível ao reservável. Tipo de dados: objeto |
| result.flexible_services.flexible_service.flexible_service.price_per_unit.code | Código da moeda a ser usado ao calcular o custo, como GBP ou USD. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.price_per_unit.value | Custo para cada unidade do serviço flexível na moeda definida no parâmetro de código. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.quantity_enabled | Sinalizador que indica se o campo de quantidade deve aparecer na reserva. Se estiver definido como verdadeiro, capacity_enabled será sempre falso. Valores válidos:
Tipo de dados: booliano |
| result.flexible_services.flexible_service.flexible_service.quantity_required | Sinalizador que indica se a quantidade é necessária. Valores válidos:
Tipo de dados: booliano |
result.flexible_services.flexible_service.flexible_service.short_description |
Breve descrição do serviço flexível. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.sub_category | Nome da subcategoria do serviço flexível, comochair_layout. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.sub_category_label | Rótulo de subcategoria do serviço flexível, como Layout da cadeira. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.sub_title | Nome do subtítulo do serviço flexível secundário. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.sys_id | Sys_id do serviço flexível. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.text | Texto usado para solicitar que um usuário selecione serviços flexíveis. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.title | Detalhes dos títulos a serem usados ao adicionar e editar o serviço flexível secundário na IU. Tipo de dados: objeto |
| result.flexible_services.flexible_service.flexible_service.title.add | Título usado ao adicionar um serviço flexível secundário na IU. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.flexible_service.title.edit | Título usado ao editar um serviço flexível secundário na IU. Tipo de dados: cadeia de caracteres |
| resultado.serviços_flexíveis.serviço_flexível.rótulo | Rótulo de serviço flexível. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.sub_category | Subcategoria dos serviços flexíveis primários, como cadeira adicional. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.sub_title | Nome do subtítulo do serviço flexível primário. Tipo de dados: cadeia de caracteres |
| resultado.serviços_flexíveis.serviço_flexível.texto | Texto usado para solicitar que um usuário selecione um serviço flexível primário. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.title | Detalhes dos títulos a serem usados ao adicionar e editar o serviço flexível primário na IU. Tipo de dados: objeto |
| result.flexible_services.flexible_service.title.adicionar | Título usado ao adicionar um serviço flexível primário na IU. Tipo de dados: cadeia de caracteres |
| result.flexible_services.flexible_service.title.editar | Título usado ao editar um serviço flexível primário na IU. Tipo de dados: cadeia de caracteres |
| resultado.piso | Detalhes sobre o piso no qual o reservável está localizado. Localizado na tabela Piso [sn_wsd_core_chão]. |
| resultado.piso.exibição_valor | Número de exibição do andar no qual o reservável reside, como 12. Tipo de dados: cadeia de caracteres |
| resultado.piso.sys_id | Sys_id do registro associado na tabela Piso. Tipo de dados: cadeia de caracteres |
| resultado.imagem | Detalhes sobre uma imagem que representa o reservável associado. Localizado na tabela Imagens [db_image]. |
| result.image.link | Link para uma imagem que representa o reservável. Tipo de dados: cadeia de caracteres |
| resultado.imagem.sys_id | Sys_id do registro de imagem associado. Tipo de dados: cadeia de caracteres |
| resultado.é_reservado | Sinalizador que indica se o serviço flexível pode ser reservado. Valores válidos:
Tipo de dados: booliano |
| layouts.resultados | Preenchido somente se o parâmetro include_layouts estiver definido como verdadeiro. Lista dos layouts associados ao reservável. Tipo de dados: matriz de objetos
|
| resultado.layouts.capacidade | Número de pessoas que participarão da reunião. Tipo de dados: número |
| result.layouts.cleanup_duration | Quantidade de tempo necessária para limpar o reservável para este layout. Tipo de dados: número Unidade: Milissegundos |
| resultado.layouts.imagem | Detalhes sobre uma imagem que representa o layout do reservável associado. Localizado na tabela Imagens [db_image]. |
| result.layouts.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.layouts.image.sys_id | Sys_id do registro de imagem associado. Tipo de dados: cadeia de caracteres |
| resultado.layouts.é_padrão | Sinalizador que indica se o layout associado é o padrão para o reservável. Valores válidos:
Tipo de dados: booliano |
| resultado.layouts.max_capacity | Número máximo de pessoas que o layout associado ao reservável pode acomodar. Tipo de dados: número |
| result.layouts.name | Nome do layout do local. Tipo de dados: cadeia de caracteres |
| result.layouts.preparation_duration | Quantidade de tempo necessária para preparar o layout do local associado. Tipo de dados: número Unidade: Milissegundos |
| resultado.layouts.short_description | Breve descrição do layout do local. Tipo de dados: cadeia de caracteres |
| result.layouts.sys_id | Sys_id do layout do local. Localizado na tabela Layout [sn_wsd_rsv_layout]. Tipo de dados: cadeia de caracteres |
| resultado.local_tipo | Detalhes sobre o tipo de local do reservável, como local de trabalho/mesa, café ou academia. Localizado na tabela Tipo de espaço [sn_wsd_core_space_type]. |
| result.location_type.display_value | Valor de exibição do tipo de local. Tipo de dados: cadeia de caracteres |
| result.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 |
| resultado.meetingProviders | Detalhes sobre os provedores de reunião virtual associados ao reservável. Essas informações estão localizadas na tabela Provedor de reunião virtual [sn_wsd_rsv_virtual_meeting_provider]. |
| result.meetingProviders.display_value | Valor de exibição do nome do provedor virtual. Tipo de dados: cadeia de caracteres |
| result.meetingProviders.value | Valor real do nome do provedor virtual no registro. Tipo de dados: cadeia de caracteres |
| resultado.TipoDeMódulo | Módulo reservável associado ao reservável, como mesas ou sala de reunião. Tipo de dados: cadeia de caracteres |
| result.name | Nome do reservável. Tipo de dados: cadeia de caracteres |
| resultado.número | Identificador exclusivo do reservável. Este valor é mais legível do que o sys_id. Tipo de dados: cadeia de caracteres |
| resultado.ordem | Número do pedido do reservável. Tipo de dados: número |
| resultado.requer_aprovação | Sinalizador que indica se a reserva do reservável requer uma aprovação. Valores possíveis:
Tipo de dados: booliano |
| resultado.requer_check_in | Sinalizador que indica se o reservável requer que o usuário faça check-in. Valores válidos:
Tipo de dados: booliano |
| resultado.requer_assunto | Sinalizador que indica se o usuário deve inserir um assunto ao fazer a reserva. Valores válidos:
Tipo de dados: booliano |
| resultado.quantidade_reservada | 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 |
| resultado.local | Detalhes sobre o site em que o reservável reside. Localizado na tabela Site [sn_wsd_core_site]. |
| resultado.site.display_value | Valor de exibição do site. Tipo de dados: cadeia de caracteres |
| resultado.serviços_padrão | Preenchido somente se o parâmetro include_standard_services estiver definido como verdadeiro. Serviços padrão associados, como Flip Chart, Tela do projetor, Quadro branco e marcadores. Tipo de dados: matriz de objetos
|
| result.standard_services.font_awesome_icon | Nome do ícone de miniatura associado ao serviço padrão. Tipo de dados: cadeia de caracteres |
| result.standard_services.name | Nome do serviço padrão. Tipo de dados: cadeia de caracteres |
| result.standard_services.short_description | Breve descrição do serviço padrão. Tipo de dados: cadeia de caracteres |
| result.standard_services.sys_id | Sys_id do registro de serviço padrão. Localizado na tabela Serviço padrão [sn_wsd_rsv_standard_service]. Tipo de dados: cadeia de caracteres |
| resultado.site.sys_id | Sys_id do registro do site associado na tabela Site [sn_wsd_core_site]. Tipo de dados: cadeia de caracteres |
| resultado.nomeTabela | Nome da tabela na qual o registro reservável reside. Tipo de dados: cadeia de caracteres |
| resultado.título | Título do reservável. Tipo de dados: cadeia de caracteres |
| resultado.tipo | Tipo de um reservável, como local. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
O exemplo de código a seguir mostra como chamar este endpoint.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/reservable/list_reservables/dad3df5977220110b3d7be377b5a99ce,3ed3139977220110b3d7be377b5a99d1?include_flexible_services=true&include_layouts=false&include_reservable_purposes=true&include_standard_services=true&reservable_module_sys_id=c31241cedb7650106c731dcd13961917" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Retornar resultados:
{
"result": [
{
"sys_id": "3e41e94adb7210106c731dcd1396198c",
"external_id": null,
"wsd_email": null,
"name": "A1-02-04",
"title": "A1-02-04",
"description": "General desk available for reservation.",
"image": null,
"number": "SPCE0009004",
"site": {
"sys_id": "628eec06db7650106c731dcd139619dd",
"display_value": "North America"
},
"campus": {
"sys_id": "82b2a0cedb3650106c731dcd139619e9",
"display_value": "California Campus"
},
"building": {
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"floor": {
"sys_id": "fc7368cedb3650106c731dcd13961902",
"display_value": "Floor 1"
},
"area": null,
"capacity": "1",
"reservable_quantity": null,
"location_type": {
"sys_id": "5f017383eb512010b89bfdfc9c5228c8",
"display_value": "Workspace/Desk"
},
"order": null,
"requires_check_in": null,
"is_reservable": "1",
"type": "location",
"moduleType": "Desks",
"meetingProviders": [],
"require_subject": false,
"allow_invitees": true,
"display_number_of_attendees": false,
"display_on_behalf_of": true,
"display_sensitivity": false,
"enable_group_reservations": false,
"enable_reservation_privacy": true,
"employee_override_privacy": true,
"tableName": "sn_wsd_core_space",
"require_approval": false
},
{
"sys_id": "fd41a94adb7210106c731dcd1396195a",
"external_id": null,
"wsd_email": null,
"name": "A1-02-03",
"title": "A1-02-03",
"description": "General desk available for reservation.",
"image": null,
"number": "SPCE0009003",
"site": {
"sys_id": "628eec06db7650106c731dcd139619dd",
"display_value": "North America"
},
"campus": {
"sys_id": "82b2a0cedb3650106c731dcd139619e9",
"display_value": "California Campus"
},
"building": {
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"floor": {
"sys_id": "fc7368cedb3650106c731dcd13961902",
"display_value": "Floor 1"
},
"area": null,
"capacity": "1",
"reservable_quantity": null,
"location_type": {
"sys_id": "5f017383eb512010b89bfdfc9c5228c8",
"display_value": "Workspace/Desk"
},
"order": null,
"requires_check_in": null,
"is_reservable": "1",
"type": "location",
"moduleType": "Desks",
"meetingProviders": [],
"require_subject": false,
"allow_invitees": true,
"display_number_of_attendees": false,
"display_on_behalf_of": true,
"display_sensitivity": false,
"enable_group_reservations": false,
"enable_reservation_privacy": true,
"employee_override_privacy": true,
"tableName": "sn_wsd_core_space",
"require_approval": false
}
]
}