API de reserva múltipla do WSD

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

    • A API de reserva múltiplaPrestação de serviços no local de trabalho (WSD) fornece endpoints para gerenciar reservas com vários locais de trabalho.

    Para acessar esta 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 Gestão de reservas do local de trabalho, consulte Workplace Reservation Management.

    Reserva múltipla do WSD – PATCH /api/sn_wsd_rsv/multi_reservation/cancel/{sys_id}

    Cancela uma reserva múltipla especificada.

    Formato da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/multi_reservation/cancel/{sys_id}

    URL padrão: /api/sn_wsd_rsv/multi_reservation/cancel/{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 da reserva múltipla a ser cancelada.

    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
    cancel_notas Motivo do cancelamento da reserva.

    Tipo de dados: cadeia de caracteres

    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
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a 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.
    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 dos resultados da solicitação de cancelamento.

    Tipo de dados: objeto

    "result": {
  "error": "String",
  "parent": "String",
  "success": Boolean,
  "successfulReservations": [Array],
  "unSuccessfulReservations": [Array]
}
    resultado.erro Mensagem que descreve o erro associado.

    Tipo de dados: cadeia de caracteres
    resultado.primário Sys_id da reserva primária. Um primário pode ter uma ou mais reservas secundárias associadas a ele.

    Tipo de dados: cadeia de caracteres
    resultado.sucesso Sinalizador que indica se a reserva foi cancelada com sucesso.
    Valores possíveis:
    • verdadeiro: cancelado com sucesso.
    • falso: a reserva não foi cancelada.

    Tipo de dados: booliano
    resultado.Reservasbem-sucedidas Detalhes sobre o cancelamento bem-sucedido da reserva múltipla.

    Tipo de dados: matriz de objetos

    "successfulReservations": [
  {
    "msg": "String",
    "success": Boolean,
    "sys_id": "String"
  }
]
    result.successfulReservations.msg Mensagem de cancelamento.

    Tipo de dados: cadeia de caracteres
    resultado.Reservas.sucesso.Sucesso Sinalizador que indica se a reserva foi cancelada com sucesso.
    Valores possíveis:
    • verdadeiro: cancelado com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    result.successfulReservations.sys_id Sys_id da reserva que foi cancelada.

    Tipo de dados: cadeia de caracteres

    Tabela: reserva de local de trabalho [sn_wsd_rsv_reservation]
    result.unSuccessfulReservations Detalhes sobre o cancelamento malsucedido da reserva múltipla.

    Tipo de dados: matriz de objetos

    "unSuccessfulReservations": [
  {
    "msg": "String",
    "success": Boolean,
    "sys_id": "String"
  }
]
    result.unSuccessfulReservations.msg Mensagem de cancelamento.

    Tipo de dados: cadeia de caracteres
    result.unSuccessfulReservations.success Sinalizador que indica se a reserva foi cancelada com sucesso.
    Valores possíveis:
    • verdadeiro: cancelado com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    result.unSuccessfulReservations.sys_id Sys_id da reserva que não foi cancelada.

    Tipo de dados: cadeia de caracteres

    Tabela: reserva de local de trabalho [sn_wsd_rsv_reservation]

    Solicitação de cURL

    O exemplo de código a seguir mostra como cancelar várias reservas.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/cancel/1b1fdf5987ab01506342b846dabb35ec" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"cancel_notes\":\"Meeting no longer needed.\"}" \ 
--user "username":"password’"

    Retornar resultados:

    {
  "result": {
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "msg": "Cancelled successfully.",
        "sys_id": "5b1f9f1d87ab01506342b846dabb35a4"
      },
      {
        "success": true,
        "msg": "Cancelled successfully.",
        "sys_id": "931f9f1d87ab01506342b846dabb35a0"
      }
    ],
    "unSuccessfulReservations": [],
    "error": null,
    "parent": "1b1fdf5987ab01506342b846dabb35ec"
  }
}

    Reserva múltipla do WSD - PATCH /api/sn_wsd_rsv/multi_reservation/update/{sys_id}

    Atualiza as reservas associadas a uma reserva múltipla em que a mesma reserva (reunião) tem vários locais de trabalho.

    Este endpoint pode lidar com quatro cenários de atualização diferentes:
    1. Atualize o conteúdo do registro de várias reservas, como assunto, data ou hora.
    2. Converta a reserva múltipla em uma única reserva com base no primário (reserva para um único local de trabalho).
    3. Converta uma única reserva (reserva para um único local de trabalho) em uma reserva múltipla.
    4. Adicione ou remova um local de trabalho de uma reserva múltipla existente.

    Formato da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/multi_reservation/update/{sys_id}

    URL padrão: /api/sn_wsd_rsv/multi_reservation/update/{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 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
    sys_id Sys_id da reserva a ser atualizada.
    • Reserva única para reserva múltipla: Sys_id da reserva única.

      Tabela: reserva de local de trabalho [sn_wsd_rsv_reservation]

    • Atualizar conteúdo de reserva múltipla: Sys_id do registro de reserva primário.

      Tabela: reserva de local de trabalho [sn_wsd_rsv_reservation]

    Para obter os detalhes de uma reserva primária múltipla do registro secundário, consulte o sys_id no campo source_reservation do registro secundário.

    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
    terminar Obrigatório se o parâmetro shift não for passado. Hora de término solicitada da reserva.

    Tipo de dados: cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    requested_for Sys_id ou endereço de e-mail do usuário para o qual a reserva está sendo feita.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    reserváveis Lista de detalhes sobre os reserváveis associados à reserva.

    Tipo de dados: matriz de objetos

    "reservables": [
  {
    "is_private": Boolean,
    "sys_id": "String"
  }
]
    reserváveis.são_privados Sinalizador que indica se a reserva é privada. Se for privada, a reserva não aparecerá para ninguém, exceto o proprietário.

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

    Valores válidos:
    • verdadeiro: a reserva é privada.
    • falso: a reserva não é privada.

    Tipo de dados: booliano

    Padrão: valor definido para privacidade nas propriedades do sistema.
    reserváveis.sys_id Sys_id do local no qual as reservas serão feitas.

    Tipo de dados: cadeia de caracteres

    Tabela: local de trabalho [sn_wsd_core_workplace_location]
    módulo_reservavel Obrigatório. Sys_id do módulo reservável a ser associado à reserva. Um módulo reservável define os itens do local de trabalho necessários para uma reserva.

    Tipo de dados: cadeia de caracteres

    Tabela: Módulo reservável [sn_wsd_rsv_reservable_module]
    shift
    Sys_id do turno a ser associado à reserva. 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

    Tabela: Turno [sn_wsd_core_shift]
    iniciar Obrigatório. Hora de início solicitada da reserva.

    Tipo de dados: cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    assunto
    Assunto da reunião associada à reserva.

    Tipo de dados: cadeia de caracteres

    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.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    resultado Retornar resultados da criação ou atualização de várias reservas.

    Tipo de dados: objeto

    "result": {
  "parent": "String",
  "success": Boolean,
  "successfulReservations": [Array],
  "unSuccessfulReservations": [Array]
}
    resultado.primário Sys_id da reserva primária. Um primário pode ter uma ou mais reservas secundárias associadas a ele.

    Tipo de dados: cadeia de caracteres
    resultado.sucesso Sinalizador que indica se a reserva foi criada com sucesso.
    Valores possíveis:
    • verdadeiro: criado com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    resultado.Reservasbem-sucedidas Lista das reservas que foram criadas com sucesso.

    Tipo de dados: matriz de objetos

    "successfulReservations": [
  {
    "cancelled": Boolean,
    "error": "String",
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String",
    "updated": Boolean
  }
]
    resultado.Reservas.bem-sucedidas.cancelado Sinalizador que indica se a reserva foi cancelada com sucesso.
    Valores possíveis:
    • verdadeiro: cancelado com sucesso.
    • falso: não cancelado.

    Tipo de dados: booliano
    resultado.Reservas.Sucesso.erro Mensagem de erro se houver um problema ao criar a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.ReservasBem-Sucedidas.inserir Sinalizador que indica se a reserva foi inserida com sucesso. Como quando uma reserva é adicionada.
    Valores possíveis:
    • verdadeiro: inserido com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    resultado.Reservas.Sucesso.Reservável Sys_id do local de trabalho para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres

    Tabela: local de trabalho [sn_wsd_core_workplace_location]
    resultado.Reservas.sucesso.Sucesso Sinalizador que indica se a operação associada foi bem-sucedida.
    Valores possíveis:
    • verdadeiro: a operação foi bem-sucedida.
    • falso: falha na operação.

    Tipo de dados: booliano
    result.successfulReservations.sys_id Sys_id da reserva que foi criada.

    Tipo de dados: cadeia de caracteres

    Tabela: reserva de local de trabalho [sn_wsd_rsv_reservation]
    resultado.Reservas.Sucesso.Atualização Sinalizador que indica se a reserva foi atualizada com sucesso.
    Valores possíveis:
    • verdadeiro: atualizado com sucesso.
    • falso: não atualizado.

    Tipo de dados: booliano
    result.unSuccessfulReservations Lista das reservas que não foram bem-sucedidas.

    Tipo de dados: matriz de objetos

    "unSuccessfulReservations": [
  {
    "cancelled": Boolean,
    "error": "String",
    "insert": Boolean
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String",
    "updated": Boolean
  }
]
    resultado.ReservasSemÊxito.Cancelado Sinalizador que indica se a reserva foi cancelada com sucesso.
    Valores possíveis:
    • verdadeiro: cancelado com sucesso.
    • falso: não cancelado.

    Tipo de dados: booliano
    result.unSuccessfulReservations.error Mensagem de erro se houver um problema ao criar a reserva.

    Tipo de dados: cadeia de caracteres
    result.unSuccessfulReservations.insert Sinalizador que indica se a reserva foi inserida com sucesso.
    Valores possíveis:
    • verdadeiro: inserido com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    result.unSuccessfulReservations.reservable Sys_id do local de trabalho para o qual a reserva estava tentando ser feita.

    Tipo de dados: cadeia de caracteres

    Tabela: local de trabalho [sn_wsd_core_workplace_location]
    result.unSuccessfulReservations.success Sinalizador que indica se a reserva foi criada com sucesso.
    Valores possíveis:
    • verdadeiro: criado com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    result.unSuccessfulReservations.sys_id Sys_id da reserva malsucedida.

    Sempre nulo.

    Tipo de dados: cadeia de caracteres
    result.unSuccessfulReservations.update Sinalizador que indica se a reserva foi atualizada com sucesso.
    Valores possíveis:
    • verdadeiro: atualizado com sucesso.
    • falso: não atualizado.

    Tipo de dados: booliano

    Solicitação de cURL

    O exemplo de código a seguir mostra como modificar o conteúdo de uma reserva múltipla existente.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"reservables\":[
        { 
            \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\" 
        }, 
        {
            \"sys_id\":\"02000d4edb7650106c731dcd13961914\"
        }
    ],
    \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
    \"subject\":\"Test 1\",
    \"start\":\"2022-05-27 13:00:00\",
    \"end\":\"2022-05-27 14:00:00\",
    \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "parent": "98ccb4348723cd106342b846dabb359a",
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "6cccb4348723cd106342b846dabb359d",
        "error": null,
        "reservable": "5eafb44edb7650106c731dcd13961943"
      },
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "error": null,
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      }
    ],
    "unSuccessfulReservations": []
  }
}

    Solicitação de cURL

    O exemplo de código a seguir mostra como adicionar um local de trabalho a uma reserva múltipla existente.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"reservables\":[
       { 
           \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
           \"is_private\": false 
       }, 
       {
           \"sys_id\":\"5eafb44edb7650106c731dcd13961943\",
           \"is_private\": false
       },
    {
           \"sys_id\":\"c4308d4edb7650106c731dcd1396194c\",
           \"is_private\": false
       }
   ],
   \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
   \"subject\":\"Test 1\",
   \"start\":\"2022-05-27 13:00:00\",
   \"end\":\"2022-05-27 14:00:00\",
   \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "parent": "98ccb4348723cd106342b846dabb359a",
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "6cccb4348723cd106342b846dabb359d",
        "error": null,
        "reservable": "5eafb44edb7650106c731dcd13961943"
      },
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "error": null,
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      },
      {
        "success": true,
        "inserted": true,
        "sys_id": "9e6d78748723cd106342b846dabb35a5",
        "error": null,
        "reservable": "c4308d4edb7650106c731dcd1396194c"
      }
    ],
    "unSuccessfulReservations": []
  }
}

    Solicitação de cURL

    O exemplo de código a seguir mostra como converter uma única reserva em uma reserva múltipla.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"reservables\":[
       { 
           \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
           \"is_private\": false
       }, 
       {
           \"sys_id\":\"5eafb44edb7650106c731dcd13961943\",
           \"is_private\": false
       }
   ],
   \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
   \"subject\":\"Test 1\",
   \"start\":\"2022-05-27 13:00:00\",
   \"end\":\"2022-05-27 14:00:00\",
   \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "success": true,
    "parent": "98ccb4348723cd106342b846dabb359a",
    "successfulReservations": [
      {
        "success": true,
        "inserted": true,
        "sys_id": "6cccb4348723cd106342b846dabb359d",
        "error": null,
        "reservable": "5eafb44edb7650106c731dcd13961943"
      },
      {
        "success": true,
        "insert": false,
        "update": true,
        "cancel": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      }
    ],
    "unSuccessfulReservations": [],
    "error": null
  }
}

    Solicitação de cURL

    O exemplo de código a seguir mostra como converter uma reserva múltipla em uma única reserva.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"reservables\":[
       { 
           \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
           \"is_private\": false
       }
   ],
   \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
   \"subject\":\"Test 1\",
   \"start\":\"2022-05-27 13:00:00\",
   \"end\":\"2022-05-27 14:00:00\",
   \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sys_id": "74af283c87ef8d106342b846dabb3592",
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "insert": false,
        "update": true,
        "cancel": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "reservable": "fe1f744edb7650106c731dcd139619ca",
        "error": ""
      },
      {
        "success": true,
        "insert": false,
        "update": true,
        "cancel": true,
        "sys_id": "3caf283c87ef8d106342b846dabb3596",
        "reservable": "5eafb44edb7650106c731dcd13961943"
      }
    ],
    "unSuccessfulReservations": [],
    "error": null
  }
}

    Reserva múltipla do WSD - POST /api/sn_wsd_rsv/multi_reservation/add

    Cria reservas de local de trabalho para o mesmo horário em diferentes locais de trabalho.

    Formato da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/multi_reservation/add

    URL padrão: /api/sn_wsd_rsv/multi_reservation/add

    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 13. 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 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Parâmetros do corpo da solicitação
    Nome Descrição
    terminar Obrigatório se o parâmetro shift não for passado. Hora de término solicitada da reserva.

    Tipo de dados: cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    requested_for Sys_id ou endereço de e-mail do usuário para o qual a reserva está sendo feita.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    reserváveis Lista de detalhes sobre os reserváveis associados à reserva.

    Tipo de dados: matriz de objetos

    "reservables": [
  {
    "is_private": Boolean,
    "sys_id": "String"
  }
]
    reserváveis.são_privados Sinalizador que indica se a reserva é privada. Se for privada, a reserva não aparecerá para ninguém, exceto o proprietário.

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

    Valores válidos:
    • verdadeiro: a reserva é privada.
    • falso: a reserva não é privada.

    Tipo de dados: booliano

    Padrão: valor definido para privacidade nas propriedades do sistema.
    reserváveis.sys_id Sys_id do local no qual as reservas serão feitas.

    Tipo de dados: cadeia de caracteres

    Tabela: local de trabalho [sn_wsd_core_workplace_location]
    módulo_reservavel Obrigatório. Sys_id do módulo reservável a ser associado à reserva. Um módulo reservável define os itens do local de trabalho necessários para uma reserva.

    Tipo de dados: cadeia de caracteres

    Tabela: Módulo reservável [sn_wsd_rsv_reservable_module]
    shift
    Sys_id do turno a ser associado à reserva. 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

    Tabela: Turno [sn_wsd_core_shift]
    iniciar Obrigatório. Hora de início solicitada da reserva.

    Tipo de dados: cadeia de caracteres

    Formato: UTC ou hora local (aaaa-mm-dd hh:mm:ss)
    assunto Obrigatório.
    Assunto da reunião associada à reserva.

    Tipo de dados: cadeia de caracteres

    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 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 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

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

    Parâmetros do corpo da resposta

    Nome Descrição
    resultado Retornar resultados da criação ou atualização de várias reservas.

    Tipo de dados: objeto

    "result": {
  "parent": "String",
  "success": Boolean,
  "successfulReservations": [Array],
  "unSuccessfulReservations": [Array]
}
    resultado.primário Sys_id da reserva primária. Um primário pode ter uma ou mais reservas secundárias associadas a ele.

    Tipo de dados: cadeia de caracteres
    resultado.sucesso Sinalizador que indica se a reserva foi criada com sucesso.
    Valores possíveis:
    • verdadeiro: criado com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    resultado.Reservasbem-sucedidas Lista das reservas que foram criadas com sucesso.

    Tipo de dados: matriz de objetos

    "successfulReservations": [
  {
    "error": "String",
    "inserted": Boolean,
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String"
  }
]
    resultado.Reservas.Sucesso.erro Mensagem de erro se houver um problema ao criar a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.Reservas.Sucesso.Inserido Sinalizador que indica se a reserva foi inserida com sucesso. Como quando uma reserva é adicionada.
    Valores possíveis:
    • verdadeiro: inserido com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    resultado.Reservas.Sucesso.Reservável Sys_id do local de trabalho para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres

    Tabela: local de trabalho [sn_wsd_core_workplace_location]
    resultado.Reservas.sucesso.Sucesso Sinalizador que indica se a reserva foi criada com sucesso.
    Valores possíveis:
    • verdadeiro: criado com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    result.successfulReservations.sys_id Sys_id da reserva que foi criada.

    Tipo de dados: cadeia de caracteres

    Tabela: reserva de local de trabalho [sn_wsd_rsv_reservation]
    result.unSuccessfulReservations Lista das reservas que não foram bem-sucedidas.

    Tipo de dados: matriz de objetos

    "unSuccessfulReservations": [
  {
    "error": "String",
    "inserted": Boolean,
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String"
  }
]
    result.unSuccessfulReservations.error Mensagem de erro se houver um problema ao criar a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.ReservasSemÊxito.Inserido Sinalizador que indica se a reserva foi inserida com sucesso.
    Valores possíveis:
    • verdadeiro: inserido com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    result.unSuccessfulReservations.reservable Sys_id do local de trabalho para o qual a reserva estava tentando ser feita.

    Tipo de dados: cadeia de caracteres

    Tabela: local de trabalho [sn_wsd_core_workplace_location]
    result.unSuccessfulReservations.success Sinalizador que indica se a reserva foi criada com sucesso.
    Valores possíveis:
    • verdadeiro: criado com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    result.unSuccessfulReservations.sys_id Sys_id da reserva malsucedida.

    Sempre nulo.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo de código mostra como reservar dois locais de trabalho diferentes para a mesma reserva.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/add" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"reservable_module\": \"c31241cedb7650106c731dcd13961917\",
    \"subject\": \"Test-123\",
    \"reservation_purpose\": \"meeting\",
    \"timezone\": \"US/Pacific\",
    \"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
    \"reservables\": [
        {
            \"sys_id\": \"fe1f744edb7650106c731dcd139619ca\",
            \"is_private\": false
        },
        {
            \"sys_id\": \"d1208d4edb7650106c731dcd1396194a\",
            \"is_private\": false
        }
    ],
    \"start\": \"2023-01-12T11:30:00Z\",
    \"end\": \"2023-01-12T12:30:00Z\",
    \"reservation_type\": \"space\"
}" \
--user "username":"password"

    Retornar resultados:

    {
  "result": {
    "success": true,
    "parent": "08e8a18687586550cfaa99b73cbb354f",
    "successfulReservations": [
      {
        "success": true,
        "inserted": true,
        "sys_id": "44e8a18687586550cfaa99b73cbb3552",
        "error": null,
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      },
      {
        "success": true,
        "inserted": true,
        "sys_id": "04e8a18687586550cfaa99b73cbb3555",
        "error": null,
        "reservable": "d1208d4edb7650106c731dcd1396194a"
      }
    ],
    "unSuccessfulReservations": []
  }
}