API de serviço extra do WSD

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 12 min. de leitura

    • A API de serviço extraPrestação de serviços no local de trabalho (WSD) fornece endpoints para recuperar serviços extras, como layouts de local e serviços padrão de um local de trabalho.

    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.

    Solicitação de serviço extra do WSD - PATCH /api/sn_wsd_rsv/wsd_extra_service_request/reservation/{sys_id}

    Retorna as solicitações de serviço extra associadas a uma única reserva.

    Nota:
    Este endpoint não funciona para reservas de grupo ou múltiplas.

    Formato da URL

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

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

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do registro de reserva para o qual os detalhes da solicitação de serviço extra serão retornados.

    Tipo de dados: cadeia de caracteres

    Tabela: reserva de local de trabalho [sn_wsd_rsv_reservation]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

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

    Códigos de status

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

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. O sys_id de reserva está ausente, é inválido ou não existe.
    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 Detalhes sobre a solicitação de serviço extra especificada.

    Tipo de dados: objeto

    "result": {
  "reservableId": "String",
  "reservationId": "String",
  "serviceCategories": {Object},
  "serviceTimes": {Object}
}
    result.reservableId
    Sys_id do local de trabalho em que a reserva é criada.

    Tipo de dados: cadeia de caracteres

    Tabela: local de trabalho [sn_wsd_core_workplace_location]
    result.reservationId Sys_id da reserva para a qual os detalhes da solicitação de serviço extra serão retornados.

    Tipo de dados: cadeia de caracteres

    Tabela: reserva de local de trabalho [sn_wsd_rsv_reservation].
    result.serviceCategories Detalhes sobre a categoria de serviço dos serviços extras associados.

    Tipo de dados: objeto

    "serviceCategories": {
  "String": {
    "categoryFriendlyName": "String",
    "categoryCurrencyCode": "String",
    "comment": "String",
    "flexibleServices": [Array],
    "serviceTimes": {Object}
  }
}
    result.serviceCategories.category​Name Nome amigável da categoria do serviço de local de trabalho ou serviço extra, como Organização de espaço.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.​categoryCurrencyCode Código da moeda usado para calcular o custo do item de serviço ou serviço extra do local de trabalho.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.comment
    Comentários sobre a categoria de serviço.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices Detalhes sobre cada um dos itens de serviço do local de trabalho ou serviço extra solicitado para a reserva.

    Tipo de dados: matriz de objetos

    "flexibleServices": [
  {
    "capacity": Number,
    "capacityEnabled": Boolean,
    "category": "String",
    "categoryComment": "String",
    "categoryFriendlyName": "String",
    "comment": "String",
    "currencyCode": "String",
    "deliveryTime": "String",
    "flexibleServiceId": "String",
    "flexibleServiceName": "String",
    "maxCapacity": Number,
    "quantity": Number,
    "quantityEnabled": Boolean,
    "requestId": "String",
    "serviceItemImage": "String",
    "servicePrice": Number,
    "serviceTimes": {Object},
    "state": {Object},
    "subCategory": {Object},
    "totalPrice": Number,
  }
]
    result.serviceCategories.flexibleServices.​capacity Capacidade solicitada ao solicitar o item de serviço do local de trabalho.

    Tipo de dados: número
    result.serviceCategories.flexibleServices.​capacityEnabled Sinalizador que indica se o usuário que está criando a reserva pode especificar a capacidade do local de trabalho.
    Valores possíveis:
    • verdadeiro: o usuário pode especificar a capacidade.
    • falso: o usuário não pode especificar a capacidade.

    Tipo de dados: booliano
    result.serviceCategories.flexibleServices.​category Sys_id da categoria do serviço de local de trabalho ou serviço extra associado à reserva.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​categoryComment Comentários adicionais sobre a categoria.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​categoryCustomlyName Nome amigável da categoria do serviço de local de trabalho ou serviço extra, como Organização de espaço.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​comment
    Comentários adicionais sobre o item de serviço do local de trabalho ou serviço extra.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​currencyCode Código da moeda usado para calcular o custo do item de serviço ou serviço extra associado ao local de trabalho.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​deliveryTime
    Tempo de entrega do item de serviço no local de trabalho ou serviço extra.

    Tipo de dados: cadeia de caracteres

    Formato: UTC - yyyy-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    result.serviceCategories.flexibleServices.​flexibleServiceId
    Sys_id do serviço extra ou item de serviço do local de trabalho.

    Tipo de dados: cadeia de caracteres

    Tabela: item de serviço do local de trabalho [sn_wsd_case_workplace_service_item]
    result.serviceCategories.flexibleServices.​flexibleServiceName Nome do serviço extra associado ou item de serviço do local de trabalho.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​maxCapacity Capacidade máxima do local de trabalho que pode ser solicitada.

    Tipo de dados: número
    result.serviceCategories.flexibleServices.​quantity
    Número de itens de serviço extra solicitados.

    Tipo de dados: número
    result.serviceCategories.flexibleServices.​quantityEnabled Sinalizador que indica se o usuário que está criando a reserva pode especificar a quantidade de itens de serviço.
    Valores possíveis:
    • verdadeiro: o usuário pode especificar a quantidade.
    • falso: o usuário não pode especificar a quantidade.

    Tipo de dados: booliano
    result.serviceCategories.flexibleServices.​requestId Sys_id do serviço extra ou item de serviço do local de trabalho.

    Tipo de dados: cadeia de caracteres

    Tabela: Solicitar serviço [sn_wsd_case_service_item_request]
    result.serviceCategories.flexibleServices.​serviceItemImage Nome do arquivo da imagem em miniatura do item de serviço do local de trabalho.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​servicePrice Custo do item de serviço do local de trabalho ou serviço extra.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​serviceTimes Detalhes sobre o tempo necessário para preparar e limpar o item de serviço do local de trabalho.

    Tipo de dados: objeto

    "serviceTimes": {
  "endCleanup": "String",
  "endPreparation": "String",
  "startCleanup": "String",
  "startPreparation": "String"
}
    result.serviceCategories.flexibleServices.​serviceTimes.endCleanup Data e hora em que a limpeza do item de serviço do local de trabalho terminará.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​serviceTimes.endPreparation Data e hora em que a preparação do item de serviço do local de trabalho terminará.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​serviceTimes.startCleanup Data e hora em que a limpeza do item de serviço do local de trabalho será iniciada.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​serviceTimes.startPreparation Data e hora em que a preparação do item de serviço do local de trabalho será iniciada.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.state Detalhes sobre o estado atual do item de serviço do local de trabalho associado.

    Tipo de dados: objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    result.serviceCategories.flexibleServices.state.​display_value Valor de exibição do estado do item de serviço do local de trabalho, como Aberto.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.state.​value Valor interno do estado do item de serviço do local de trabalho, como Aberto.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​subCategory Detalhes sobre a subcategoria do item de serviço associado ao local de trabalho.

    Tipo de dados: objeto

    "subCategory": {
  "display_value": "String",
  "value": "String"
}
    result.serviceCategories.flexibleServices.​subCategory.display_value Valor de exibição da subcategoria do item de serviço do local de trabalho ou serviço extra, como layout de cadeira, bebidas ou suporte de TI.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​subCategory.value Valor interno da subcategoria do item de serviço do local de trabalho ou serviço extra, como cadeira_layout, bebidas ou IT_support.

    Tipo de dados: cadeia de caracteres
    result.serviceCategories.flexibleServices.​total_Price Custo total do item de serviço do local de trabalho ou serviço extra para a reserva.

    Tipo de dados: número
    result.ServiceTimes Detalhes sobre o tempo necessário para preparar e limpar o item de serviço do local de trabalho.

    Tipo de dados: objeto

    "serviceTimes": {
  "endCleanup": "String",
  "endPreparation": "String",
  "startCleanup": "String",
  "startPreparation": "String"
}
    result.ServiceTimes.endCleanup Data e hora em que a limpeza do item de serviço do local de trabalho terminará.

    Tipo de dados: cadeia de caracteres
    result.serviceTimes.endPreparation Data e hora em que a preparação do item de serviço do local de trabalho terminará.

    Tipo de dados: cadeia de caracteres
    result.ServiceTimes.startCleanup Data e hora em que a limpeza do item de serviço do local de trabalho será iniciada.

    Tipo de dados: cadeia de caracteres
    result.serviceTimes.startPreparation Data e hora em que a preparação do item de serviço do local de trabalho será iniciada.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo de código mostra como solicitar os detalhes dos serviços extras ou itens de serviço do local de trabalho para uma reserva.

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/wsd_extra_service_request/reservation/383e36c1536f01103cf7ddeeff7b1245" \
--request GET \
--header "Accept:application/json" \
--user "username": "password"

    Retornar resultados:

    {
  "result": {
    "reservationId": "383e36c1536f01103cf7ddeeff7b1245",
    "serviceTimes": {
      "startPreparation": "2022-05-17T11:45:00ZZ",
      "endPreparation": "2022-05-17T12:00:00ZZ",
      "startCleanup": "2022-05-17T13:00:00ZZ",
      "endCleanup": "2022-05-17T13:15:00ZZ"
    },
    "reservableId": "02000d4edb7650106c731dcd13961914",
    "serviceCategories": {
      "50723fbf07100110c9b36b6e0ad300b4": {
        "serviceTimes": {
          "startPreparation": "2022-05-17T11:45:00Z",
          "endPreparation": "2022-05-17T12:00:00Z",
          "startCleanup": "2022-05-17T13:00:00Z",
          "endCleanup": "2022-05-17T13:15:00Z"
        },
        "flexibleServices": [
          {
            "requestId": "743eb605536f01103cf7ddeeff7b126b",
            "category": "50723fbf07100110c9b36b6e0ad300b4",
            "categoryComment": "test2",
            "subCategory": {
              "value": "chair_layout",
              "display_value": "Chair layout"
            },
            "categoryFriendlyName": "Space arrangement",
            "servicePrice": 0,
            "serviceItemImage": "4c6a0d7107600110c9b36b6e0ad300fc.iix",
            "currencyCode": "GBP",
            "totalPrice": 0,
            "flexibleServiceId": "21e2c08407600110c9b36b6e0ad3007c",
            "flexibleServiceName": "Theater Style",
            "deliveryTime": "2022-05-17 12:00:00",
            "comment": "test1",
            "quantity": 1,
            "capacity": 1,
            "quantityEnabled": false,
            "capacityEnabled": true,
            "maxCapacity": null,
            "state": {
              "value": "2",
              "display_value": "Work in Progress"
            },
            "serviceTimes": {
              "startPreparation": "2022-05-17T11:45:00Z",
              "endPreparation": "2022-05-17T12:00:00Z",
              "startCleanup": "2022-05-17T13:00:00Z",
              "endCleanup": "2022-05-17T13:15:00Z"
            }
          }
        ],
        "comment": "test2",
        "categoryFriendlyName": "Space arrangement",
        "categoryCurrencyCode": "GBP"
      }
    }
  }
}

    Solicitação de serviço extra do WSD - PATCH /api/sn_wsd_rsv/wsd_extra_service_request/submit

    Adiciona uma nova solicitação de serviço extra ou atualiza uma solicitação de serviço extra existente para uma reserva única especificada.

    Nota:
    Este endpoint não funciona para reservas de grupo ou múltiplas.

    Formato da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/wsd_extra_service_request/submit

    URL padrão: /api/sn_wsd_rsv/wsd_extra_service_request/submit

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Parâmetros do corpo da solicitação
    Nome Descrição
    ReserveDateTimeChanged Sinalizador que indica se a data e a hora da reserva foram alteradas.
    Valores válidos:
    • verdadeiro: a data e a hora da reserva foram alteradas.
    • falso: a data e a hora da reserva não foram alteradas.

    Tipo de dados: booliano

    Padrão: falso
    IdReservável Obrigatório.
    Sys_id do local de trabalho em que a reserva é criada.

    Tipo de dados: cadeia de caracteres

    Tabela: local de trabalho [sn_wsd_core_workplace_location]
    ID da reserva Obrigatório. Sys_id da reserva à qual as solicitações de serviço extras serão adicionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: reserva de local de trabalho [sn_wsd_rsv_reservation]
    serviceCategories Obrigatório. Lista de itens de serviço do local de trabalho ou serviços extras a serem adicionados à reserva.

    Tipo de dados: matriz de objetos

    "serviceCategories": [
  {
    "category": "String",
    "comment": "String",
    "flexibleServices": [Array]
  }
]
    serviceCategories.category Obrigatório. Sys_id ou nome do serviço de local de trabalho a ser adicionado à reserva.

    Tipo de dados: cadeia de caracteres

    Tabela: serviço no local de trabalho [sn_wsd_case_workplace_service]
    serviceCategories.comentário Obrigatório.
    Comentários sobre a categoria de serviço.

    Tipo de dados: cadeia de caracteres
    serviceCategories.flexibleServices Obrigatório. Detalhes sobre cada um dos itens de serviço do local de trabalho ou serviço extra a serem adicionados ou cancelados da reserva.

    Tipo de dados: matriz de objetos

    "flexibleServices": [
  {
    "cancelFlag": Boolean,
    "comment": "String",
    "deliveryTime": "String",
    "extraServiceRequestId": "String",
    "flexibleServiceId": "String",
    "quantity": Number
  }
]
    serviceCategories.flexibleServices.cancelFlag Sinalizador que indica se a solicitação de serviço extra especificada deve ser cancelada.
    Valores possíveis:
    • verdadeiro: exclua a solicitação de serviço extra associada.
    • falso: nenhuma operação.

    Tipo de dados: booliano

    Padrão: falso
    serviceCategories.flexibleServices.comment Obrigatório.
    Comentários adicionais sobre o item de serviço do local de trabalho ou serviço extra.

    Tipo de dados: cadeia de caracteres
    serviceCategories.flexibleServices.​deliveryTime Obrigatório.
    Tempo de entrega do item de serviço no local de trabalho ou serviço extra.

    Tipo de dados: cadeia de caracteres

    Formato: UTC - yyyy-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    serviceCategories.flexibleServices.​extraServiceRequestId Sys_id da solicitação de serviço extra existente. Forneça este parâmetro para atualizar uma solicitação de serviço extra existente.

    Tipo de dados: cadeia de caracteres

    Tabela: Solicitar itens de serviço [sn_wsd_case_service_item_request]
    serviceCategories.flexibleServices.​flexibleServiceId Obrigatório. Sys_id do serviço extra ou item de serviço do local de trabalho.

    Tipo de dados: cadeia de caracteres

    Tabela: item de serviço do local de trabalho [sn_wsd_case_workplace_service_item]
    serviceCategories.flexibleServices.​quantity Obrigatório.
    Número de itens de serviço extra solicitados.

    Tipo de dados: número

    Cabeçalhos

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

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

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

    Códigos de status

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

    Tabela 12. Códigos de status
    Código do 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 Retornar resultados para a solicitação.

    Tipo de dados: objeto

    "result": {
  "extraServiceRequests": [Array],
  "reservableId": "String",
  "reservationId": "String",
  "success": Boolean
}
    result.extraServiceRequests Detalhes sobre a solicitação de serviço extra adicionada ou cancelada.

    Tipo de dados: matriz de objeto

    "extraServiceRequests": [
  {
    "flexibleServiceId": "String",
    "requestId": "String"
    }
]
    result.extraServiceRequests.flexibleServiceId Sys_id da solicitação de item de serviço extra que foi adicionada à reserva.

    Tipo de dados: cadeia de caracteres

    Tabela: item de serviço do local de trabalho [sn_wsd_case_workplace_service_item]
    result.extraServiceRequests.requestId Sys_id do item de serviço extra que foi adicionado à solicitação.

    Tipo de dados: cadeia de caracteres

    Tabela: Solicitar itens de serviço [sn_wsd_case_service_item_request]
    result.reservableId
    Sys_id do local de trabalho em que a reserva é criada.

    Tipo de dados: cadeia de caracteres

    Tabela: local de trabalho [sn_wsd_core_workplace_location]
    result.reservationId Sys_id da reserva para a qual a solicitação de serviço extra foi adicionada.

    Tipo de dados: cadeia de caracteres

    Tabela: reserva de local de trabalho [sn_wsd_rsv_reservation]
    resultado.sucesso Sinalizador que indica se a solicitação de serviço extra foi adicionada à reserva com sucesso.
    Valores possíveis:
    • verdadeiro: adicionado com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano

    Solicitação de cURL

    O exemplo de código a seguir mostra como adicionar uma solicitação de item de serviço extra a uma reserva.

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/wsd_extra_service_request/submit" \
--request POST \
--header "Accept:application/json" \
--header "Concept-Type:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "reservationId": "2dc2efdf531701103cf7ddeeff7b1227",
    "reservableId": "02000d4edb7650106c731dcd13961914",
    "extraServiceRequests": [
      {
        "requestId": "bea46dbc53e701103cf7ddeeff7b1236",
        "flexibleServiceId": "e2ecf7b307500110c9b36b6e0ad30033"
      }
],
    "success": true
  }
}