API de solicitação de serviço extra do WSD

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

    • A API de solicitação de serviço extraWorkplace Service Delivery (WSD) permite que você gerencie solicitações de serviço extra para reservas.

    Para acessar essa API, o solicitante deve ter a função sn_wsd_core.workplace_user.

    Esta API é executada no namespace sn_wsd_rsv .

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

    Serviço extra do WSD - GET /sn_wsd_rsv/extra_service/list_loc_layouts

    Retorna os detalhes sobre os layouts de local associados a um local de trabalho especificado.

    Formato de URL

    URL com controle de versões: /api/sn_wsd_rsv/{api_version}/extra_service/list_loc_layouts

    URL padrão: /api/sn_wsd_rsv/extra_service/list_loc_layouts

    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
    local Obrigatório. Sys_id do local de trabalho para o qual os detalhes do layout do local serão retornados.

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

    Tipo de dados: cadeia de caracteres
    Tabela 3. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum Obrigatório.

    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 resposta. Tipos compatíveis: application/json ou application/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.
    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.
    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 dos layouts associados ao local de trabalho especificado.

    Tipo de dados: matriz de objetos

    "result": [
  {
    "capacity": Number,
    "cleanup_duration": "String",
    "image": {Object},
    "is_default": Boolean,
    "max_capacity": Number,
    "name": "String",
    "preparation_duration": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    resultado.capacidade Número de pessoas que participarão da reunião.

    Tipo de dados: número
    resultado.cleanup_duration Quantidade de tempo necessária para limpar o reservável para este layout.

    Tipo de dados: número

    Unidade: milissegundos
    resultado.imagem 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.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.image.sys_id Sys_id do registro de imagem associado.

    Tipo de dados: cadeia de caracteres
    resultado.é_padrão Sinalizador que indica se o layout associado é o padrão para o reservável.
    Valores válidos:
    • verdadeiro: padrão.
    • falso: não é padrão.

    Tipo de dados: booliano
    result.name Nome do layout do local.

    Tipo de dados: cadeia de caracteres
    resultado.max_capacity Número máximo de pessoas que o layout associado ao reservável pode acomodar.

    Tipo de dados: número
    resultado.preparação_duração Quantidade de tempo necessária para preparar o layout do local associado.

    Tipo de dados: número

    Unidade: milissegundos
    resultado.short_description Breve descrição do layout do local.

    Tipo de dados: cadeia de caracteres
    resultado.sys_id Sys_id do layout do local.

    Localizado na tabela Layout [sn_wsd_rsv_layout].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    "http://instance.servicenow.com/api/sn_wsd_rsv/extra_service/list_loc_layouts&location=d2716d4adb7210106c731dcd13961994" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Retornar resultados:

    {
  "result": [
    {
      "sys_id": "f4fee556534301103cf7ddeeff7b12ed",
      "name": "Test",
      "short_description": "test",
      "is_default": false,
      "image": {
        "sys_id": "9648a7c5531301103cf7ddeeff7b1286",
        "link": "9648a7c5531301103cf7ddeeff7b1286.iix"
      },
      "capacity": null,
      "max_capacity": null,
      "preparation_duration": 172800000,
      "cleanup_duration": 86400000
    }
  ]
}

    Serviço extra do WSD - GET /api/sn_wsd_rsv/extra_service/list_loc_standard_services

    Retorna os detalhes sobre os serviços padrão associados a um local de trabalho especificado.

    Formato de URL

    URL com controle de versões: /api/sn_wsd_rsv/{api_version}/extra_service/list_loc_standard_services

    URL padrão: /api/sn_wsd_rsv/extra_service/list_loc_standard_services

    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
    local Obrigatório. Sys_id do local de trabalho para o qual os serviços padrão do layout de local serão retornados.

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

    Tipo de dados: cadeia de caracteres
    Tabela 9. 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 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.
    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.
    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.padrão_serviços
    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.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
    resultado.padrão_serviços.short_description Breve descrição do serviço padrão.

    Tipo de dados: cadeia de caracteres
    result.standard_services.sys_id Sys_id do registro de serviço padrão. Localizado na tabela Serviço padrão [sn_wsd_rsv_standard_service].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint para obter os serviços padrão.

    "http://instance.servicenow.com/api/sn_wsd_rsv/extra_service/list_loc_standard_services&location=d2716d4adb7210106c731dcd13961994" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Retornar resultados:

    {
  "result": [
    {
      "sys_id": "9b01458edb7650106c731dcd13961945",
      "name": "Flip chart",
      "short_description": "Flip chart with paper sheets",
      "font_awesome_icon": "fa-calendar-o"
    },
    {
      "sys_id": "abd0c18edb7650106c731dcd13961965",
      "name": "Projector screen",
      "short_description": "Connect laptop to screen (HDMI and DVI)",
      "font_awesome_icon": "fa-caret-square-o-right"
    },
    {
      "sys_id": "9841858edb7650106c731dcd1396193c",
      "name": "Whiteboard",
      "short_description": "Whiteboard and markers",
      "font_awesome_icon": "fa-pencil-square-o"
    }
  ]
}