API Convidados de reserva do WSD

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 11 min. de leitura

    • . Prestação de serviços no local de trabalho(WSD) Convidados da reserva A API fornece endpoints para adicionar convidados a reservas, buscar convidados de uma reserva e reatribuir convidados de uma reserva.

    Para acessar esta API, o solicitante deve ter a função sn_wsd_core.workplace_user e o plug-in Gestão de reservas do local de trabalho (sn_wsd_rsv) deve estar ativado.

    Esta API é executada no sn_wsd_rsv namespace.

    Para obter informações adicionais sobre Gestão de reservas do local de trabalho, consulte Gestão de reservas do local de trabalho .

    Convidados de reserva do WSD - OBTER /api/sn_wsd_rsv/wsd_reservation_invites/reservation/

    Recupera detalhes sobre os convidados associados a uma reserva especificada.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//wsd_reservation_invitees/reservation/

    URL padrão: /api/sn_wsd_rsv/reservation/

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. 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
    sys_id Sys_id da reserva para a qual os detalhes do convidado serão retornados.

    Tipo de dados: Cadeia de caracteres
    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/jsonou 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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 Retornar resultados para os convidados associados à reserva especificada.

    Tipo de dados: Objeto

    {
  "result": {
    "invitees": [Array],
    "reservationId": "String",
    "reservationSubType": "String",
    "success": Boolean
  }
}
    result.invitees Detalhes sobre os convidados associados à reserva.

    Tipo de dados: Matriz de objetos

    "invitees": [
  {
    "email": "String",
    "firstName": "String",
    "inviteeId": "String",
    "inviteState": {Object},
    "inviteeType": "String",
    "isVIP": Boolean,
    "isWifiRequired": Boolean,
    "isParkingRequired": Boolean,
    "lastName": "String",
    "licensePlate": "String",
    "location": {Object},
    "name": "String",
    "org": "String",
    "parkingType": "String",
    "phoneNumber": "String",
    "privateNotes": "String",
    "reservationId": "String",
    "reservationInviteeId": "String",
    "title": "String",
    "visitorType": "String"
  }
]
    result.invitees.email
    Endereço de e-mail do convidado.

    Tipo de dados: Cadeia de caracteres
    result.invitees.firstName Nome do convidado.

    Tipo de dados: Cadeia de caracteres
    result.invitees.inviteeId
    Sys_id do registro de usuário do funcionário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    result.invitees.inviteState Detalhes sobre o estado atual do convidado para a reserva.

    Tipo de dados: Objeto

    "inviteState": {
  "displayValue": "String",
  "value": "String"
}
    result.invitees.inviteState.displayValue Valor de exibição do estado do convidado, como Novo ou Removido.

    Tipo de dados: Cadeia de caracteres
    result.invitees.inviteState.value Valor interno para o estado do convidado.

    Tipo de dados: Cadeia de caracteres
    result.invitees.inviteeType
    Tipo de convidado.
    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • funcionário
    • visitante

    Tipo de dados: Cadeia de caracteres
    result.invitees.isVIP Sinalizador que indica se o convidado é classificado como VIP.
    Valores válidos:
    • Verdadeiro: O convidado é um VIP.
    • Falso: O convidado não é VIP.

    Tipo de dados: Booliano
    result.invitees.isWifiRequired Sinalizador que indica se a senha DO WI-FI deve ser fornecida ao visitante após a entrada.
    Valores válidos:
    • Verdadeiro: Forneça a senha DO WI-FI.
    • Falso: Não forneça a senha DO WI-FI.

    Tipo de dados: Booliano
    result.invitees.isParkingRequired Sinalizador que indica se o convidado precisa de estacionamento.
    Valores válidos:
    • Estacionamento necessário.
    • Estacionamento não é necessário.

    Tipo de dados: Booliano
    result.invitees.lastName Sobrenome do convidado.

    Tipo de dados: Cadeia de caracteres
    result.invitees.licensePlate Placa de licença do convidado.

    Tipo de dados: Cadeia de caracteres
    result.invitees.location Detalhes sobre o local do local de trabalho do convidado.

    Tipo de dados: Objeto

     "location": {
  "displayName": "String",
  "sysId": "String"
}
    result.invitees.location.displayName Nome de exibição do local de trabalho do convidado, como Dublin.

    Tipo de dados: Cadeia de caracteres
    result.invitees.location.sysId Sys_id do local de trabalho do convidado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Local do local de trabalho [sn_wsd_core_worplace_location]
    result.invitees.name Nome do convidado.

    Tipo de dados: Cadeia de caracteres
    result.invitees.org Organização do convidado.

    Tipo de dados: Cadeia de caracteres
    result.invitees.parkingType Tipo de estacionamento necessário para o convidado.
    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • ev_parking
    • nenhum
    • normal_parking
    • van_access_parking

    Tipo de dados: Cadeia de caracteres
    result.invitees.phoneNumber Número de telefone do convidado.

    Tipo de dados: Cadeia de caracteres
    result.invitees.privateNotes Anotações adicionais fornecidas pelo convidado.

    Tipo de dados: Cadeia de caracteres
    result.invitees.reservationId Sys_id da reserva à qual o convidado está associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    result.invitees.reservationInviteeId

    Sys_id do convidado da reserva para o visitante.

    Tipo de dados: Cadeia de caracteres

    Tabela: Convidado de reserva [sn_wsd_rsv_m2m_reservation_invitee]
    result.invitees.title Título do convidado.

    Tipo de dados: Cadeia de caracteres
    result.invitees.visitorType Tipo de convidado.
    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • cliente
    • prestador de serviços
    • friend_family
    • outros

    Tipo de dados: Cadeia de caracteres
    Result.reservationId Sys_id da reserva à qual o convidado está associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    Result.reservationSubType Subtipo do registro de reserva, como único ou vários secundários.

    Tipo de dados: Cadeia de caracteres
    resultado.sucesso Sinalizador que indica se a chamada foi bem-sucedida.
    Valores possíveis:
    • Verdadeiro: A chamada de endpoint foi bem-sucedida.
    • Falso: Falha na chamada de endpoint.

    Tipo de dados: Booliano

    Solicitação de curl

    O exemplo de código a seguir mostra como recuperar os convidados para uma reserva.

    curl 
"http://instance.servicenow.com/api/sn_wsd_rsv/wsd_reservation_invitees/reservation/17979dc9536b01103cf7ddeeff7b12b3" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Resultados de retorno:

    {
  "result": {
    "success": true,
    "reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
    "reservationSubType": "single",
    "invitees": [
      {
        "reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
        "location": {
          "sysId": "19efb84edb7650106c731dcd1396193c",
          "displayName": "Dublin"
        },
        "reservationInviteeId": "1f97d58d53e701103cf7ddeeff7b129a",
        "inviteeType": "employee",
        "inviteState": {
          "displayValue": "New",
          "value": "new"
        },
        "inviteeId": "6816f79cc0a8016401c5a33be04be441",
        "name": "System Administrator",
        "email": "admin@example.com"
      },
      {
        "reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
        "location": {
          "sysId": "19efb84edb7650106c731dcd1396193c",
          "displayName": "Dublin"
        },
        "reservationInviteeId": "8ee7ddc9536b01103cf7ddeeff7b1219",
        "inviteeType": "employee",
        "inviteState": {
          "displayValue": "New",
          "value": "new"
        },
        "inviteeId": "62826bf03710200044e0bfc8bcbe5df1",
        "name": "Abel Tuter",
        "email": "abel.tuter@example.com"
      },
      {
        "reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
        "location": {
          "sysId": "19efb84edb7650106c731dcd1396193c",
          "displayName": "Dublin"
        },
        "reservationInviteeId": "4ae7d10d536b01103cf7ddeeff7b126b",
        "inviteeType": "visitor",
        "inviteState": {
          "displayValue": "New",
          "value": "new"
        },
        "inviteeId": "86e7d10d536b01103cf7ddeeff7b1267",
        "firstName": "Visitor",
        "lastName": "User",
        "name": "Visitor User",
        "email": "visitoruser@example.com",
        "phoneNumber": "+919876543210",
        "isVIP": true,
        "parkingType": "normal_parking",
        "licensePlate": "1234",
        "isParkingRequired": true,
        "org": "Senow",
        "visitorType": "contractor",
        "title": "President",
        "isWifiRequired": true,
        "privateNotes": "Visiting"
      }
    ]
  }
}

    Convidados de reserva do WSD - POST /api/sn_wsd_rsv/wsd_reservation_invites/reassign

    Reatribui os convidados especificados de uma reserva para outra.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//wsd_reservation_invites/reassign

    URL padrão: /api/sn_wsd_rsv/wsd_reservation_invites/reassign

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. 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
    Nenhum(a)
    Tabela 9. Parâmetros do corpo da solicitação
    Nome Descrição
    ReservationId Obrigatório. Sys_id da reserva para a qual os convidados serão reatribuídos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    ReservationConvidados Lista de convidados a serem reatribuídos à reserva identificada no reservationIdparâmetro.

    Remove os convidados especificados de uma reserva anterior na qual eles estavam presentes de acordo com a tabela de convidados da reserva e os move para esta reserva.

    Tipo de dados: Matriz de cadeias de caracteres

    Tabela: Convidado de reserva [sn_wsd_rsv_m2m_reservation_invitee]

    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/xmlou, 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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 Detalhes sobre a reatribuição do convidado.

    Tipo de dados: Objeto

    "result": {
   "reservationInviteeIds": [Array],
   "success": Boolean
}
    ResultadoInviteIds.reservationInviteIds Lista de sys_ids dos convidados da reserva que foram reatribuídos à reserva especificada.

    Tipo de dados: Matriz de cadeias de caracteres
    resultado.sucesso Sinalizador que indica se os convidados foram reatribuídos à reserva.
    Valores possíveis:
    • Verdadeiro: Os convidados foram reatribuídos com sucesso.
    • Falso: Os convidados não foram reatribuídos.

    Tipo de dados: Booliano

    Solicitação de curl

    O exemplo de código a seguir mostra como reatribuir convidados a uma reserva.

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/wsd_reservation_invitees/reassign" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservationId\":\"3984e6c1532f01103cf7ddeeff7b129b\",
\"reservationInvitees\":{\"aa31427f531701103cf7ddeeff7b1243\",\"e231427f531701103cf7ddeeff7b1243\"}
}" \
--user 'username':'password'

    Resultados de retorno:

    {
  "result": {
    "success": true,
    "reservationInviteeIds": [
      "aa31427f531701103cf7ddeeff7b1243",
      "e231427f531701103cf7ddeeff7b1243"
    ]
  }
}

    Convidados de reserva do WSD - POST /api/sn_wsd_rsv/wsd_reservation_invites/submit

    Adiciona os convidados especificados a uma reserva especificada.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//wsd_reservation_invitees/submit

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

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. 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
    Nenhum(a)
    Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    convidados Lista de convidados a serem adicionados à reserva especificada.

    Tipo de dados: Objeto

    "invitees": [
  {
    "email": "String",
    "firstName": "String",
    "inviteeId": "String",
    "inviteeType": "String",
    "isVIP": Boolean,
    "isWifiRequired": Boolean,
    "lastName": "String",
    "licensePlate": "String",
    "org": "String",
    "parkingType": "String",
    "phone": "String",
    "privateNotes": "String",
    "title": "String",
    "visitorType": "String"
  }
]
    convidados.e-mail Necessário quando inviteeType"visitante".
    Endereço de e-mail do convidado.

    Tipo de dados: Cadeia de caracteres
    Convidados.FirstName Nome do convidado.

    Tipo de dados: Cadeia de caracteres
    invitees.inviteeId Necessário se inviteType"funcionário".
    Sys_id do registro de usuário do funcionário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    invitees.inviteeType Obrigatório.
    Tipo de convidado.
    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • funcionário
    • visitante

    Tipo de dados: Cadeia de caracteres
    Convidados.isVIP Sinalizador que indica se o convidado é classificado como VIP.
    Valores válidos:
    • Verdadeiro: O convidado é um VIP.
    • Falso: O convidado não é VIP.

    Tipo de dados: Booliano
    Convidados.isWifiRequired Sinalizador que indica se a senha DO WI-FI deve ser fornecida ao visitante após a entrada.
    Valores válidos:
    • Verdadeiro: Forneça a senha DO WI-FI.
    • Falso: Não forneça a senha DO WI-FI.

    Tipo de dados: Booliano
    Convidados.lastName Sobrenome do convidado.

    Tipo de dados: Cadeia de caracteres
    LicensePlate.licensePlate Placa de licença do convidado.

    Tipo de dados: Cadeia de caracteres
    invitees.org Organização do convidado.

    Tipo de dados: Cadeia de caracteres
    Convidados.parkingType Tipo de estacionamento necessário para o convidado.
    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • ev_parking
    • nenhum
    • normal_parking
    • van_access_parking

    Tipo de dados: Cadeia de caracteres
    convidados.telefone Número de telefone do convidado.

    Tipo de dados: Cadeia de caracteres
    Convidados.privateNotes Anotações adicionais fornecidas pelo convidado.

    Tipo de dados: Cadeia de caracteres
    convidados.título Título do convidado.

    Tipo de dados: Cadeia de caracteres
    Convidados.VisitorType Tipo de convidado.
    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • cliente
    • prestador de serviços
    • friend_family
    • outros

    Tipo de dados: Cadeia de caracteres
    ReservationId Obrigatório.
    Sys_id da reserva para a qual os convidados serão adicionados.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reservas do local de trabalho [sn_wsd_rsv_reservation]

    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/xmlou, 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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 Resultado da adição dos convidados à reserva.

    Tipo de dados: Objeto

    "result": {
  "reservationId": "String",
  "success": Boolean
}
    Result.reservationId Sys_id da reserva à qual o convidado foi adicionado.

    Tipo de dados: Cadeia de caracteres
    resultado.sucesso Sinalizador que indica se os convidados foram adicionados à reserva.
    Valores possíveis:
    • Verdadeiro: Os convidados foram adicionados com sucesso.
    • Falso: Convidados não foram adicionados.

    Tipo de dados: Booliano

    Solicitação de curl

    O exemplo de código a seguir mostra como adicionar um visitante e um funcionário a uma reserva.

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/v1/wsd_reservation_invitees/submit" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{[
  \"reservationId\": \"041c4a13532f01103cf7ddeeff7b12c0\",
  \"invitees\": [
  {
    \"inviteeType\": \"employee\",
    \"inviteeId\": \"62826bf03710200044e0bfc8bcbe5df1\"
  },
  {
    \"inviteeType\":  \"visitor\",
    \"email\": \"visitoruser@example.com\",
    \"firstName\": \"Visitor\",
    \"lastName\":\"User\",
    \"isVIP\":true,
    \"visitorType\":\"contractor\",
    \"title\": \"ServiceNow Developer\",
    \"phone\": \"+91 9876543210\",
    \"isWifiRequired\": true,
    \"parkingType\": \"ev_parking\",
    \"licensePlate\": \"TS00TS0000\",
    \"org\": \"ServiceNow\",
    \"privateNotes\": \"Remarks\"
  }
]}" \
--user 'username':'password'

    Resultados de retorno:

    {
  "result": {
    "success": true,
    "reservationId": "17979dc9536b01103cf7ddeeff7b12b3"
  }
}