WSD Presence API

. Presença de WSD A API permite que os usuários gerenciem a programação de presença no escritório, incluindo rotinas semanais, exceções únicas e visibilidade do colaborador.

Esta API é compatível com Prestação de serviços no local de trabalho(WSD) Experiência do concierge, permitindo que os funcionários comuniquem sua participação planejada no escritório aos colegas. Use esta API para as seguintes ações:

• Recupere os dados de presença completos de um usuário autenticado, incluindo sua rotina semanal no escritório, exceções agendadas e, opcionalmente, informações de presença de colaboradores.
• Gerencie rotinas semanais no escritório para que os funcionários possam definir uma programação recorrente.
• Crie e gerencie exceções únicas que substituem a rotina para uma data específica.
• Exiba e gerencie colaboradores para habilitar o planejamento coordenado no escritório.

Um usuário autenticado é alguém que está conectado ou cujas credenciais estão incluídas na solicitação de API. Call endpoints em qualquer ordem; cada um opera de forma independente.

. Presença de WSD A API pertence ao namespace sn_wsd_concierge. . API de reserva do WSD OBTENHA /user/context o endpoint pode retornar dados de programação de presença do Presença de WSD API quando o plug-in de concierge está ativo.

Requisitos

. Presença de WSD A API requer:

• A função sn_wsd_core.workplace_user atribuída ao usuário.
• . Prestação de serviços no local de trabalho Plug-in Core (com.sn_wsd_core) ativado.
• Pelo menos um registro de usuário deve existir em sys_user com a função sn_wsd_core.workplace_user atribuída.

Presença do WSD - EXCLUA /api/sn_wsd_concierge/v1/presence/colaborador/

Remove um colaborador da lista de visibilidade de presença do usuário autenticado. Use este endpoint quando um usuário não quiser mais acompanhar a presença de um colega no escritório.

Um usuário autenticado é alguém que está conectado ou cujas credenciais estão incluídas na solicitação de API. O colaborador é identificado pelo sys_id.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge//presence/colaborador/(colaborador_id)

URL padrão: /api/sn_wsd_concierge/presence/colaborador/

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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
colaborador_id	Sys_id do colaborador a ser removido da lista de visibilidade do usuário. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)

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 da 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, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.

Tabela 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

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. Parâmetro de caminho collaborator_id ausente ou inválido.
404	Não encontrado. O colaborador especificado 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 (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém resultados da solicitação. Tipo de dados: Objeto "result": { "message": "String" }
mensagem.resultado	Mensagem de confirmação indicando o número de colaboradores removidos. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo remove um colaborador específico da lista de visibilidade de presença do usuário autenticado.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator/usr1a2b3c4d5e6" \
--request DELETE \
--header "Accept: application/json" \
--user "username:password"

Corpo da resposta.

{
  "result": {
    "message": "1 collaborator(s) removed"
  }
}

Presença do WSD - EXCLUA /api/sn_wsd_concierge/v1/presence/exception/

Exclui uma exceção de presença específica identificada por seu sys_id. Use este endpoint quando um usuário quiser remover uma substituição única e reverter para sua rotina semanal regular para essa data.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge//presence/exception/(exception_id)

URL padrão: /api/sn_wsd_concierge/presence/exception/

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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
exception_id	Necessário. Sys_id da exceção de presença a ser excluída. Tabela: Exceções de presença do funcionário (sn_wsd_concierge_employee_presence_exception) Tipo de dados: Cadeia de caracteres

Tabela 8. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)

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 da 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, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.

Tabela 11. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

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. Parâmetro de caminho exception_id ausente ou inválido.
404	Não encontrado. A exceção especificada não foi encontrada.
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 (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém resultados da solicitação. Tipo de dados: Objeto "result": { "message": "String" }
mensagem.resultado	Mensagem de confirmação indicando que a exceção foi excluída. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo exclui a exceção exc1a2b3c4d5e6, revertendo essa data para a rotina semanal regular do usuário.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception/exc1a2b3c4d5e6" \
--request DELETE \
--header "Accept: application/json" \
--user "username:password"

Corpo da resposta.

{
  "result": {
    "message": "Exception deleted successfully"
  }
}

Presença do WSD - OBTENHA /api/sn_wsd_concierge/v1/presence/colaborador

Recupera a lista de colaboradores do usuário autenticado junto com os dados de presença, a rotina e as exceções de cada colaborador. Use este endpoint para exibir os cronogramas de presença dos colegas no escritório, permitindo o planejamento coordenado no escritório.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge//presence/colaborador

URL padrão: /api/sn_wsd_concierge/presence/collaborator

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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
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 da REST API compatíveis .

Tabela 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

Tabela 18. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
404	Não encontrado. O usuário 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 (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém resultados da solicitação. Tipo de dados: Objeto "result": { "count": Number, "collaborators": [Array] }
contagem.resultado	Número total de colaboradores retornados. Tipo de dados: Número
colaboradores.resultado	Lista de colaboradores com seus dados de presença. Se um colaborador tiver a privacidade habilitada, privacy_enabledé verdadeiro com nulo routinee vazio exceptions. Tipo de dados: Matriz de objetos "collaborators": [ { "sys_id": "String", "name": "String", "privacy_enabled": Boolean, "routine": {Object}, "exceptions": [Array] } ]
resultado.colaboradores.sys_id	Sys_id do registro de usuário do colaborador. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
result.collaborators.name	Nome de exibição do colaborador conforme ele aparece no registro sys_user. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
colaboradores.privacy_enabled	Booliano. Sinalizador que indica se o colaborador habilitou a privacidade em seus dados de presença. Valores válidos: verdadeiro : A rotina e as exceções do colaborador estão ocultas. routineserá nulo e. exceptionsserá uma matriz vazia. falso : Os dados de presença do colaborador estão visíveis. Tipo de dados: Booliano
colaboradores.resultado.rotina	Rotina semanal do colaborador no escritório. Contém um sinalizador booliano para cada dia da semana que indica a participação planejada no escritório. Exibido verdadeiro quando o colaborador planeja estar no escritório nesse dia, e. falso quando a participação não é planejada. Tipo de dados: Objeto "routine": { "monday": "Boolean", "tuesday": "Boolean", "wednesday": "Boolean", "thursday": "Boolean", "friday": "Boolean", "saturday": "Boolean", "sunday": "Boolean" }
resultado.colaboradores.exceções	Exceções de presença única do colaborador. Retorna uma matriz vazia se privacy_enabled é verdadeiro . Tipo de dados: Matriz de objetos "exceptions": [ { "sys_id": "String", "date": "String", "in_office": "Boolean", "origin": "String", "location": "String" } ]
resultado.colaboradores.exceções.sys_id	Sys_id do registro de exceção. Tabela: Exceções de presença do funcionário (sn_wsd_concierge_employee_presence_exception) Tipo de dados: Cadeia de caracteres
result.collaborators.exceptions.date	Data à qual esta exceção se aplica. Esta é a data em que a rotina do usuário está sendo substituída. Formato: aaaa-MM-dd Tipo de dados: Cadeia de caracteres
result.collaborators.exceptions.in_office	Sinalizador que indica se o usuário estará no escritório nesta data. Isso substitui o que a rotina semanal especifica para esse dia da semana. Valores válidos: verdadeiro : O usuário estará no escritório. falso : O usuário não estará no escritório Tipo de dados: Cadeia de caracteres
origem.colaboradores.exceções.resultado.colaboradores	Origem que criou a exceção. Valores válidos: usuário : Criado manualmente pelo funcionário. sistema : Criado automaticamente pela plataforma. manual : Criado por um administrador ou em nome do usuário. Tipo de dados: Cadeia de caracteres
local.result.colaboradores.exceções.local	Nome ou identificador do local do escritório em que o usuário estará nesta data. Relevante somente quando no_escritório é verdadeiro . Pode ser uma cadeia de caracteres vazia quando o usuário é remoto. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera todos os colaboradores e seus dados de presença do usuário autenticado.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

Corpo da resposta.

{
  "result": {
    "count": 2,
    "collaborators": [
      {
        "sys_id": "usr1a2b3c4d5e6", "name": "Jane Smith", "privacy_enabled": false,
        "routine": {
          "monday": true, "tuesday": true, "wednesday": false,
          "thursday": true, "friday": false, "saturday": false, "sunday": false
        },
        "exceptions": [
          { "sys_id": "exc1a2b3c", "date": "2026-03-10", "in_office": true, "origin": "user", "location": "Building B" }
        ]
      },
      { "sys_id": "usr7f8g9h0i1j2", "name": "John Doe", "privacy_enabled": true, "routine": null, "exceptions": [] }
    ]
  }
}

Presença do WSD - OBTER /api/sn_wsd_concierge/v1/presence/exception

Recupera exceções de presença para o usuário autenticado. As exceções podem ser filtradas por um intervalo de datas ou por um sys_id de exceção específico. Use este endpoint quando precisar exibir substituições únicas na rotina semanal de um usuário.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge//presence/exception

URL padrão: /api/sn_wsd_concierge/presence/exception

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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 20. Parâmetros de consulta

Nome	Descrição
exception_id	Sys_id de uma exceção específica a ser recuperada. Quando fornecido, substitui o filtro de intervalo de datas e retorna somente a exceção correspondente. Tabela: Exceções de presença do funcionário (sn_wsd_concierge_employee_presence_exception) Tipo de dados: Cadeia de caracteres
exception_start_date	Data de início para filtrar exceções. Formato: aaaa-MM-dd Tipo de dados: Cadeia de caracteres Padrão: Hoje
exception_end_date	Data de término para filtrar exceções. Formato: aaaa-MM-dd Tipo de dados: Cadeia de caracteres Padrão: Hoje mais de 3 meses

Tabela 21. Solicitar parâmetros do corpo (XML ou JSON)

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 da REST API compatíveis .

Tabela 22. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.

Tabela 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

Tabela 24. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Formato de data inválido para exception_start_date ou exception_end_date.
404	Não encontrado. A exceção especificada não foi encontrada.
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 (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém resultados da solicitação. Tipo de dados: Objeto "result": { "exceptions": [Array] }
exceções.resultado	Lista de exceções de presença correspondentes aos critérios de filtro. Tipo de dados: Matriz de objetos "exceptions": [ { "sys_id": "sys_id", "date": "String", "in_office": String, "origin": "String", "location": "String" } ]
result.exceptions.date	Data à qual esta exceção se aplica. Esta é a data em que a rotina do usuário está sendo substituída. Formato: Formato aaaa-MM-dd Tipo de dados: Cadeia de caracteres
result.exceptions.in_office	Sinalizador que indica se o usuário estará no escritório nesta data. Isso substitui o que a rotina semanal especifica para esse dia da semana. Valores válidos: verdadeiro : O usuário estará no escritório. falso : O usuário não estará no escritório Tipo de dados: Cadeia de caracteres
local.result.exceptions.location	O nome ou identificador do local do escritório em que o usuário estará nesta data. Relevante somente quando no_escritório é verdadeiro . Pode ser uma cadeia de caracteres vazia quando o usuário é remoto. Tipo de dados: Cadeia de caracteres
origem.resultado.exceções.	Origem que criou a exceção. Valores válidos: usuário : Criado manualmente pelo funcionário. sistema : Criado automaticamente pela plataforma. manual : Criado por um administrador ou em nome do usuário. Tipo de dados: Cadeia de caracteres
sys_id.exceptions.sys_id	Sys_id do registro de exceção. Tabela: Exceções de presença do funcionário (sn_wsd_concierge_employee_presence_exception) Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera todas as exceções do primeiro semestre de 2026.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception?exception_start_date=2026-01-01&exception_end_date=2026-06-30" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

Corpo da resposta.

{
  "result": {
    "exceptions": [
      { "sys_id": "exc1a2b3c4d5e6", "date": "2026-02-14", "in_office": true, "origin": "user", "location": "Building A" },
      { "sys_id": "exc7f8g9h0i1j2", "date": "2026-03-17", "in_office": false, "origin": "system", "location": "" }
    ]
  }
}

Presença do WSD - OBTENHA /api/sn_wsd_concierge/v1/presence

Recupera os dados de presença completos do usuário autenticado, incluindo sua rotina semanal no escritório, exceções de presença agendada e, opcionalmente, informações de presença de seus colaboradores.

Use este endpoint para obter uma exibição holística da presença planejada de um usuário no escritório. Você também pode consultar dados de presença de outro usuário fornecendo o sys_id, sujeito às configurações de privacidade.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge//presence

URL padrão: /api/sn_wsd_concierge/presence

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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 26. Parâmetros de consulta

Nome	Descrição
user_id	Sys_id do usuário de destino cujos dados de presença serão recuperados. Se não for fornecido, retornará dados de presença do usuário autenticado. Nota: As consultas entre usuários retornam 401 não autorizados, a menos que o chamador tenha permissão explícita. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
exception_start_date	Data de início para filtrar exceções de presença. Formato: aaaa-MM-dd Tipo de dados: Cadeia de caracteres Padrão: Hoje
exception_end_date	Data de término para filtrar exceções de presença. Formato: aaaa-MM-dd Tipo de dados: Cadeia de caracteres Padrão: Hoje e 3 meses
incluir	Dados relacionados a serem incluídos na resposta. Somente valor válido: colaboradores Tipo de dados: Cadeia de caracteres

Tabela 27. Solicitar parâmetros do corpo (XML ou JSON)

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 da REST API compatíveis .

Tabela 28. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.

Tabela 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

Tabela 30. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Formato de data inválido para exception_start_date ou exception_end_date ou formato user_id inválido.
401	Não autorizado. O usuário autenticado não tem permissão para exibir os dados de presença do usuário de destino. Retornado quando user_id é fornecido e não corresponde ao usuário autenticado.
404	Não encontrado. O usuário especificado não foi encontrado.
500	Erro Interno do servidor. Ocorreu um erro inesperado ao processar a solicitação.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém resultados da resposta. "result": { "routine": {Object}, "exceptions": [Array], "collaborators": [Array] }
rotina.resultado	Rotina semanal no escritório para o usuário. Contém um sinalizador booliano para cada dia da semana que indica a participação planejada no escritório. Exibido verdadeiro quando o usuário autenticado planeja estar no escritório naquele dia, e. falso quando a participação não é planejada. Tipo de dados: Objeto "routine": { "monday": "Boolean", "tuesday": "Boolean", "wednesday": "Boolean", "thursday": "Boolean", "friday": "Boolean", "saturday": "Boolean", "sunday": "Boolean" }
exceções.resultado	Lista de exceções de presença única que substituem a rotina do usuário em datas específicas. Tipo de dados: Matriz de objetos "exceptions": [ { "sys_id": "String", "date": "String", "in_office": "Boolean", "origin": "String", "location": "String" } ]
sys_id.exceptions.sys_id	Sys_id do registro de exceção. Tabela: Exceções de presença do funcionário (sn_wsd_concierge_employee_presence_exception) Tipo de dados: Cadeia de caracteres
result.exceptions.date	Data à qual esta exceção se aplica, no formato aaaa-MM-dd. Esta é a data em que a rotina do usuário está sendo substituída. Tipo de dados: Cadeia de caracteres
result.exceptions.in_office	Sinalizador que indica se o usuário estará no escritório nesta data. Isso substitui o que a rotina semanal especifica para esse dia da semana. Valores válidos: verdadeiro : O usuário estará no escritório. falso : O usuário não estará no escritório Tipo de dados: Cadeia de caracteres
origem.resultado.exceções.	Origem que criou a exceção. Valores válidos: usuário : Criado manualmente pelo funcionário. sistema : Criado automaticamente pela plataforma. manual : Criado por um administrador ou em nome do usuário. Tipo de dados: Cadeia de caracteres
local.result.exceptions.location	O nome ou identificador do local do escritório em que o usuário estará nesta data. Relevante somente quando no_escritório é verdadeiro . Pode ser uma cadeia de caracteres vazia quando o usuário é remoto. Tipo de dados: Cadeia de caracteres
colaboradores.resultado	Lista de colaboradores e seus dados de presença. Retornado somente quando colaboradores especificado. Se um colaborador tiver a privacidade habilitada, privacy_enabledé verdadeiro com nulo routinee vazio exceptions. Tipo de dados: Matriz de objetos "collaborators": [ { "sys_id": "String", "name": "String", "privacy_enabled": Boolean, "routine": {Object}, "exceptions": [Array] } ]
resultado.colaboradores.sys_id	Sys_id do registro de usuário do colaborador. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
result.collaborators.name	O nome de exibição do colaborador conforme ele aparece no registro sys_user. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
colaboradores.privacy_enabled	Booliano. Sinalizador que indica se o colaborador habilitou a privacidade em seus dados de presença. Valores válidos: verdadeiro : A rotina e as exceções do colaborador estão ocultas. routineserá nulo e. exceptionsserá uma matriz vazia. falso : Os dados de presença do colaborador estão visíveis. Tipo de dados: Booliano
colaboradores.resultado.rotina	A rotina semanal do colaborador no escritório. Contém um sinalizador booliano para cada dia da semana que indica a participação planejada no escritório. Exibido verdadeiro quando o colaborador planeja estar no escritório naquele dia, e. falso quando a participação não é planejada. Tipo de dados: Objeto "routine": { "monday": "Boolean", "tuesday": "Boolean", "wednesday": "Boolean", "thursday": "Boolean", "friday": "Boolean", "saturday": "Boolean", "sunday": "Boolean" }
resultado.colaboradores.exceções	As exceções de presença única do colaborador. Segue a mesma estrutura do usuário autenticado exceptionsparâmetro. Retorna uma matriz vazia se privacy_enabled é verdadeiro . Tipo de dados: Matriz de objetos "exceptions": [ { "sys_id": "String", "date": "String", "in_office": "Boolean", "origin": "String", "location": "String" } ]

Solicitação de curl

Este exemplo recupera os dados de presença completa do usuário autenticado, incluindo cronogramas do colaborador, para exceções no 1o trimestre de 2026.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence?include=collaborators&exception_start_date=2026-01-01&exception_end_date=2026-03-31" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

Corpo da resposta.

{
  "result": {
    "routine": {
      "monday": true,  "tuesday": false, "wednesday": true,
      "thursday": true, "friday": false, "saturday": false, "sunday": false
    },
    "exceptions": [
      {
        "sys_id": "a1b2c3d4e5f6",
        "date": "2026-02-14",
        "in_office": true,
        "origin": "user",
        "location": "Building A"
      }
    ],
    "collaborators": [
      {
        "sys_id": "f6e5d4c3b2a1",
        "name": "Jane Smith",
        "privacy_enabled": false,
        "routine": {
          "monday": true, "tuesday": true, "wednesday": false,
          "thursday": true, "friday": false, "saturday": false, "sunday": false
        },
        "exceptions": []
      }
    ]
  }
}

Presença do WSD - OBTER /api/sn_wsd_concierge/v1/presence/rotina

Recupera somente a rotina semanal no escritório do usuário autenticado. Esta é uma alternativa leve para OBTER /presence quando você só precisa da programação de rotina sem exceções ou colaboradores.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge//presence/rotina

URL padrão: /api/sn_wsd_concierge/presence/routine

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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 32. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 33. Solicitar parâmetros do corpo (XML ou JSON)

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 da REST API compatíveis .

Tabela 34. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.

Tabela 35. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

Tabela 36. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
404	Não encontrado. O usuário ou a rotina 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 (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém resultados da solicitação. Tipo de dados: Objeto "result": { "user_id": "String", "routine": {Object} }
result.user_id	Sys_id do usuário cuja rotina é retornada. Tabela: Usuário [sys_id] Tipo de dados: Cadeia de caracteres
rotina.resultado	Programação semanal recorrente no escritório do usuário. Contém um sinalizador booliano para cada dia da semana que indica a participação planejada no escritório. Exibido verdadeiro quando o usuário planeja estar no escritório naquele dia, e. falso quando a participação não é planejada. Tipo de dados: Objeto "routine": { "monday": Boolean, "tuesday": Boolean, "wednesday": Boolean, "thursday": Boolean, "friday": Boolean, "saturday": Boolean, "sunday": Boolean }

Solicitação de curl

Este exemplo recupera a rotina semanal no escritório para o usuário autenticado.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine" \
--request GET \
--header "Accept: application/json" \
--user "username:password"

Corpo da resposta. Mostra que a rotina do usuário mostra a presença no escritório de segunda a quinta-feira.

{
  "result": {
    "user_id": "a1b2c3d4e5f6g7h8",
    "routine": {
      "monday": true,  "tuesday": true,  "wednesday": true,
      "thursday": true, "friday": false, "saturday": false, "sunday": false
    }
  }
}

Presença do WSD - PATCH /api/sn_wsd_concierge/v1/presence/rotina

Atualiza parcialmente a rotina semanal no escritório do usuário autenticado. Use este endpoint quando um usuário precisar ajustar dias específicos sem redefinir a programação inteira.

Somente os dias fornecidos no corpo da solicitação são atualizados. Todos os outros dias permanecem inalterados.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge//presence/rotina

URL padrão: /api/sn_wsd_concierge/presence/routine

Parâmetros de solicitação compatíveis

Tabela 37. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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 38. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 39. Solicitar parâmetros do corpo (XML ou JSON)

Nome

Descrição

rotina

Necessário. A rotina semanal do usuário autenticado. Contém um sinalizador booliano para cada dia da semana que indica a participação planejada no escritório. Exibido verdadeiro quando o usuário autenticado planeja estar no escritório naquele dia, e. falso quando a participação não é planejada. Os dias omitidos na solicitação permanecem inalterados. Um objeto de rotina vazio é aceito como não op. Tipo de dados: Objeto "routine": { "monday": "Boolean", "tuesday": "Boolean", "wednesday": "Boolean", "thursday": "Boolean", "friday": "Boolean", "saturday": "Boolean", "sunday": "Boolean" }

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 da REST API compatíveis .

Tabela 40. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.
Tipo de conteúdo	Formato de dados do corpo da solicitação: Aplicação/json.

Tabela 41. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

Tabela 42. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Corpo da solicitação ausente, formato inválido ou nenhum campo de dia válido fornecido.
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 (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém resultados da solicitação. Tipo de dados: Objeto "result": { "message": "String", "result": {Object} }
mensagem.resultado	Mensagem de confirmação indicando que a rotina foi atualizada. Tipo de dados: Cadeia de caracteres
resultado.resultado	Contém o objeto de rotina atualizado completo com todos os sete dias, incluindo dias inalterados. Tipo de dados: Objeto "result": { "routine": {Object} }
rotina.resultado	Rotina semanal no escritório. Contém um sinalizador booliano para cada dia da semana em que verdadeiro indica presença no escritório, e. falso indica que não há presença. Tipo de dados: Objeto "routine": { "monday": "Boolean", "tuesday": "Boolean", "wednesday": "Boolean", "thursday": "Boolean", "friday": "Boolean", "saturday": "Boolean", "sunday": "Boolean" }

Solicitação de curl

Este exemplo atualiza somente sexta-feira e sábado para verdadeiro, deixando todos os outros dias inalterados.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
  "routine": { "friday": true, "saturday": true }
}'

Corpo da resposta.

{
  "result": {
    "message": "Routine updated successfully",
    "result": {
      "routine": {
        "monday": true, "tuesday": true, "wednesday": true,
        "thursday": true, "friday": true, "saturday": true, "sunday": false
      }
    }
  }
}

Presença do WSD - POST /api/sn_wsd_concierge/v1/presence/colaborador

Adiciona um ou mais colaboradores à lista de visibilidade de presença do usuário autenticado. Os colaboradores podem exibir os dados de presença uns dos outros. Use este endpoint para criar uma equipe ou grupo de colegas cuja participação no escritório você deseja acompanhar.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge//presence/colaborador

URL padrão: /api/sn_wsd_concierge/presence/collaborator

Parâmetros de solicitação compatíveis

Tabela 43. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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 44. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 45. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
colaborador_ids	Necessário. Matriz não vazia de valores sys_id que identificam usuários a serem adicionados como colaboradores. Tabela: Usuário [sys_user] Tipo de dados: Matriz de cadeias de caracteres "collaborator_ids": ["String", "String"]

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 da REST API compatíveis .

Tabela 46. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.
Tipo de conteúdo	Formato de dados do corpo da solicitação: Aplicação/json.

Tabela 47. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

Tabela 48. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Collaborator_ids ausente, matriz vazia ou formato sys_id inválido.
404	Não encontrado. Um ou mais sys_ids do colaborador não foram encontrados na tabela sys_user.
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 (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém resultados da solicitação. Tipo de dados: Objeto result": { "message": "String", "collaborators": [Array] }
mensagem.resultado	Mensagem de confirmação indicando que os colaboradores foram adicionados. Tipo de dados: Cadeia de caracteres
colaboradores.resultado	Lista de colaboradores recém-adicionados com seus dados de presença. Tipo de dados: Matriz de objetos "collaborators": [ { "sys_id": "String", "name": "String", "privacy_enabled": Boolean, "routine": {Object}, "exceptions": [Array] } ]
resultado.colaboradores.sys_id	Sys_id do registro de usuário do colaborador. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
result.collaborators.name	O nome de exibição do colaborador conforme ele aparece no registro sys_user. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
colaboradores.privacy_enabled	Booliano. Sinalizador que indica se o colaborador habilitou a privacidade em seus dados de presença. Valores válidos: Verdadeiro: A rotina e as exceções do colaborador estão ocultas. routineserá nulo e. exceptionsserá uma matriz vazia. Falso: Os dados de presença do colaborador estão visíveis. Tipo de dados: Booliano
colaboradores.resultado.rotina	A rotina semanal do colaborador no escritório. Contém um sinalizador booliano para cada dia da semana que indica a participação planejada no escritório. Exibido verdadeiro quando o colaborador planeja estar no escritório naquele dia, e. falso quando a participação não é planejada. Tipo de dados: Objeto "routine": { "monday": "Boolean", "tuesday": "Boolean", "wednesday": "Boolean", "thursday": "Boolean", "friday": "Boolean", "saturday": "Boolean", "sunday": "Boolean" }
resultado.colaboradores.exceções	As exceções de presença única do colaborador. Retorna uma matriz vazia se privacy_enabled é verdadeiro . Tipo de dados: Matriz de objetos "exceptions": [ { "sys_id": "String", "date": "String", "in_office": "Boolean", "origin": "String", "location": "String" } ]
resultado.colaboradores.exceções.sys_id	Sys_id do registro de exceção. Tabela: Exceções de presença do funcionário (sn_wsd_concierge_employee_presence_exception) Tipo de dados: Cadeia de caracteres
result.collaborators.exceptions.date	Data à qual esta exceção se aplica. Esta é a data em que a rotina do usuário está sendo substituída. Formato: Formato aaaa-MM-dd Tipo de dados: Cadeia de caracteres
result.collaborators.exceptions.in_office	Sinalizador que indica se o usuário estará no escritório nesta data. Isso substitui o que a rotina semanal especifica para esse dia da semana. Valores válidos: verdadeiro : O usuário estará no escritório. falso : O usuário não estará no escritório Tipo de dados: Cadeia de caracteres
origem.colaboradores.exceções.resultado.colaboradores	Origem que criou a exceção. Valores válidos: usuário : Criado manualmente pelo funcionário. sistema : Criado automaticamente pela plataforma. manual : Criado por um administrador ou em nome do usuário. Tipo de dados: Cadeia de caracteres
local.result.colaboradores.exceções.local	O nome ou identificador do local do escritório em que o usuário estará nesta data. Relevante somente quando no_escritório é verdadeiro . Pode ser uma cadeia de caracteres vazia quando o usuário é remoto. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo adiciona dois usuários como colaboradores fornecendo seus sys_ids.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
  "collaborator_ids": ["usr1a2b3c4d5e6", "usr7f8g9h0i1j2"]
}'

Corpo da resposta.

{
  "result": {
    "message": "Collaborator(s) added successfully",
    "collaborators": [
      {
        "sys_id": "usr1a2b3c4d5e6", "name": "Jane Smith", "privacy_enabled": false,
        "routine": { "monday": true, "tuesday": true, "wednesday": false, "thursday": true, "friday": false, "saturday": false, "sunday": false },
        "exceptions": []
      },
      { "sys_id": "usr7f8g9h0i1j2", "name": "John Doe", "privacy_enabled": true, "routine": null, "exceptions": [] }
    ]
  }
}

Presença do WSD - POST /api/sn_wsd_concierge/v1/presence/exception

Cria uma exceção de presença única para o usuário autenticado em uma data específica. Use este endpoint quando um usuário planeja estar no escritório em um dia em que normalmente trabalha remotamente, ou vice-versa.

As exceções substituem a rotina semanal do usuário para essa data.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge/[api_version]/presence/exception

URL padrão: /api/sn_wsd_concierge/presence/exception

Parâmetros de solicitação compatíveis

Tabela 49. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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 50. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 51. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
exceção	Necessário. Objeto de exceção que define a substituição de presença única. Tipo de dados: Objeto "exception": { "date": "String", "in_office": "Boolean", "location": "String", "origin": "String". "sys_id": "String" }
data.exceção	Data da exceção. Formato: aaaa-MM-dd Tipo de dados: Cadeia de caracteres
exception.in_office	Sinalizador que indica se o usuário estará no escritório nesta data. Valores possíveis: verdadeiro : O usuário estará no escritório. falso : O usuário não estará no escritório. Tipo de dados: Booliano
local.exceção	Nome ou identificador do local do escritório para esta exceção. Tipo de dados: Cadeia de caracteres
origem.exceção	Origem da exceção. Valores válidos: usuário : Criado manualmente pelo funcionário. sistema : Criado automaticamente pela plataforma. manual : Criado por um administrador ou em nome do usuário. Tipo de dados: Cadeia de caracteres
sys_id.exception.sys_id	Sys_id da exceção existente a ser atualizada. Tabela: Exceções de presença do funcionário (sn_wsd_concierge_employee_presence_exception) 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 da REST API compatíveis .

Tabela 52. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.
Tipo de conteúdo	Formato de dados do corpo da solicitação: Aplicação/json.

Tabela 53. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

Tabela 54. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Data do campo obrigatório ausente ou formato de data inválido.
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 (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém o resultado da solicitação. Tipo de dados: Objeto "result": { "message": "String", "result": {Object} }
mensagem.resultado	Mensagem de confirmação indicando que a exceção foi adicionada. Tipo de dados: Cadeia de caracteres
resultado.resultado	Objeto que contém as exceções criadas. Tipo de dados: Objeto "result": { "exceptions": [Array] }
exceções.resultado	Matriz que contém detalhes sobre as exceções criadas. Tipo de dados: Matriz de objetos "exceptions": [ { "date": "String", "location": "String", "in_office": Boolean, "origin": "String", "sys_id": "String" } ]
result.result.exceptions.date	Data à qual esta exceção se aplica, no formato aaaa-MM-dd. Esta é a data em que a rotina do usuário está sendo substituída. Tipo de dados: Cadeia de caracteres
result.result.exceptions.in_office	Sinalizador que indica se o usuário estará no escritório nesta data. Isso substitui o que a rotina semanal especifica para esse dia da semana. Valores válidos: verdadeiro : O usuário estará no escritório. falso : O usuário não estará no escritório Tipo de dados: Cadeia de caracteres
resultado.resultado.exceções.local	O nome ou identificador do local do escritório em que o usuário estará nesta data. Relevante somente quando no_escritório é verdadeiro . Pode ser uma cadeia de caracteres vazia quando o usuário é remoto. Tipo de dados: Cadeia de caracteres
resultado.resultado.exceções.origem	Origem que criou a exceção. Valores válidos: usuário : Criado manualmente pelo funcionário. sistema : Criado automaticamente pela plataforma. manual : Criado por um administrador ou em nome do usuário. Tipo de dados: Cadeia de caracteres
result.result.exceptions.sys_id	Sys_id do registro de exceção. Tabela: Exceções de presença do funcionário (sn_wsd_concierge_employee_presence_exception) Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo cria uma exceção de presença para 14 de fevereiro de 2026, marcando o usuário como no escritório no prédio A.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
  "exception": {
    "date": "2026-02-14",
    "in_office": true,
    "location": "Building A - Floor 3",
    "origin": "user"
  }
}'

Corpo da resposta.

{
  "result": {
    "message": "Exception added successfully",
    "result": {
      "exceptions": [
        {
          "sys_id": "a1b2c3d4e5f6g7h8",
          "date": "2026-02-14",
          "in_office": true,
          "origin": "user",
          "location": "Building A - Floor 3"
        }
      ]
    }
  }
}

Presença de WSD - POST /api/sn_wsd_concierge/v1/presence/rotina

Cria uma nova rotina semanal no escritório para o usuário autenticado. Use este endpoint quando um usuário estiver configurando sua rotina de presença pela primeira vez.

Todos os sete dias da semana devem ser fornecidos como valores boolianos.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge//presence/rotina

URL padrão: /api/sn_wsd_concierge/presence/routine

Parâmetros de solicitação compatíveis

Tabela 55. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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
rotina	Necessário. Rotina semanal no escritório para o usuário. Contém um sinalizador booliano para cada dia da semana que indica a participação planejada no escritório. Exibido verdadeiro quando o usuário planeja estar no escritório naquele dia, e. falso quando a participação não é planejada. Todos os dias são obrigatórios. Tipo de dados: Objeto "routine": { "monday": "Boolean", "tuesday": "Boolean", "wednesday": "Boolean", "thursday": "Boolean", "friday": "Boolean", "saturday": "Boolean", "sunday": "Boolean" }

Tabela 56. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 57. Solicitar parâmetros do corpo (XML ou JSON)

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 da REST API compatíveis .

Tabela 58. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.
Tipo de conteúdo	Formato de dados do corpo da solicitação: Aplicação/json.

Tabela 59. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

Tabela 60. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Campos obrigatórios ausentes ou tipo de dados inválido. Todos os sete dias devem ser fornecidos como valores boolianos.
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 (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém resultados da solicitação. Tipo de dados: Objeto "result": { "message": "String", "result": {Object} }
mensagem.resultado	Mensagem de confirmação indicando que a rotina foi criada. Tipo de dados: Cadeia de caracteres
resultado.resultado	Contém o objeto de rotina criado com todos os sete dias. Tipo de dados: Objeto "result": { "routine": {Object} }
rotina.resultado	Rotina semanal do usuário no escritório. Contém um sinalizador booliano para cada dia da semana que indica a participação planejada no escritório. Exibido verdadeiro quando o usuário planeja estar no escritório naquele dia, e. falso quando a participação não é planejada. Tipo de dados: Objeto "routine": { "monday": "Boolean", "tuesday": "Boolean", "wednesday": "Boolean", "thursday": "Boolean", "friday": "Boolean", "saturday": "Boolean", "sunday": "Boolean" }

Solicitação de curl

Este exemplo cria uma rotina semanal no escritório de segunda a quinta-feira.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
  "routine": {
    "monday": true, "tuesday": true, "wednesday": true,
    "thursday": true, "friday": false, "saturday": false, "sunday": false
  }
}'

Corpo da resposta.

{
  "result": {
    "message": "Routine created successfully",
    "result": {
      "routine": {
        "monday": true, 
        "tuesday": true, 
        "wednesday": true,
        "thursday": true, 
        "friday": false, 
        "saturday": false,
        "sunday": false
      }
    }
  }
}

Presença do WSD - COLOQUE /api/sn_wsd_concierge/v1/presence/exception

Atualiza uma exceção de presença existente cancelando-a e criando uma substituição. A exceção original é identificada por seu sys_id. Use este endpoint quando um usuário precisar alterar os detalhes de uma exceção criada anteriormente.

Formato de URL

URL com controle de versão: /api/sn_wsd_concierge//presence/exception

URL padrão: /api/sn_wsd_concierge/presence/exception

Parâmetros de solicitação compatíveis

Tabela 61. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint para acessar. 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 62. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 63. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
exceção	Necessário. Objeto de exceção que contém os detalhes atualizados. . sys_ide. in_officeos campos são obrigatórios. Tipo de dados: Objeto "exception": { "date": "String", "in_office": "Boolean", "location": "String", "origin": "String", "sys_id": "String" }
data.exceção	Data da exceção. Formato: aaaa-MM-dd Tipo de dados: Cadeia de caracteres
exception.in_office	Necessário. Sinalizador que indica se o usuário estará no escritório nesta data. Valores possíveis: verdadeiro : O usuário estará no escritório. falso : O usuário não estará no escritório. Tipo de dados: Booliano
local.exceção	Nome ou identificador do local do escritório para esta exceção. Tipo de dados: Cadeia de caracteres
origem.exceção	Origem da exceção. Valores válidos: usuário : Criado manualmente pelo funcionário. sistema : Criado automaticamente pela plataforma. manual : Criado por um administrador ou em nome do usuário. Tipo de dados: Cadeia de caracteres Padrão: Usuário
sys_id.exception.sys_id	Necessário. Sys_id da exceção existente a ser atualizada. Tabela: Exceções de presença do funcionário (sn_wsd_concierge_employee_presence_exception) 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 da REST API compatíveis .

Tabela 64. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json, application/xml, ou text/xml.
Autorização	Credenciais de autenticação. Compatível com autenticação básica ou autenticação baseada em sessão.
Tipo de conteúdo	Formato de dados do corpo da solicitação: Aplicação/json.

Tabela 65. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta: Aplicação/json.

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 REST API códigos de resposta HTTP .

Tabela 66. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Campos obrigatórios sys_id ou in_office ausentes.
404	Não encontrado. A exceção especificada não foi encontrada ou o usuário não tem permissão para modificá-la.
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 (JSON ou XML)

Nome	Descrição
resultado	Objeto que contém resultados da solicitação. Tipo de dados: Objeto "result": { "message": "String", "result": {Object} }
mensagem.resultado	Mensagem de confirmação indicando que a exceção foi atualizada. Tipo de dados: Cadeia de caracteres
resultado.resultado	Contém as exceções atualizadas. Tipo de dados: Objeto "result": { "exceptions": [Array] }
resultado.resultado.exceções	Lista de exceções de presença. Tipo de dados: Matriz de objetos "exceptions": [ { "sys_id": "sys_id", "date": "String", "in_office": String, "origin": "String", "location": "String" } ]
result.result.exceptions.sys_id	Sys_id do registro de exceção. Tabela: Exceções de presença do funcionário (sn_wsd_concierge_employee_presence_exception) Tipo de dados: Cadeia de caracteres
result.exceptions.date	Data à qual esta exceção se aplica, no formato aaaa-MM-dd. Esta é a data em que a rotina do usuário está sendo substituída. Tipo de dados: Cadeia de caracteres
result.exceptions.in_office	Sinalizador que indica se o usuário estará no escritório nesta data. Isso substitui o que a rotina semanal especifica para esse dia da semana. Valores válidos: verdadeiro : O usuário estará no escritório. falso : O usuário não estará no escritório Tipo de dados: Cadeia de caracteres
origem.resultado.exceções.	Origem que criou a exceção. Valores válidos: usuário : Criado manualmente pelo funcionário. sistema : Criado automaticamente pela plataforma. manual : Criado por um administrador ou em nome do usuário. Tipo de dados: Cadeia de caracteres
local.result.exceptions.location	O nome ou identificador do local do escritório em que o usuário estará nesta data. Relevante somente quando no_escritório é verdadeiro . Pode ser uma cadeia de caracteres vazia quando o usuário é remoto. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo atualiza uma exceção existente para mudar o status do usuário para remoto (não no escritório) na mesma data.

curl "https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception" \
--request PUT \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{
  "exception": {
    "sys_id": "exc1a2b3c4d5e6",
    "in_office": false,
    "date": "2026-02-14",
    "location": "",
    "origin": "user"
  }
}'

Corpo da resposta.

{
  "result": {
    "message": "Exception updated successfully",
    "result": {
      "exceptions": [
        { "sys_id": "exc9k0l1m2n3o4", "date": "2026-02-14", "in_office": false, "origin": "user", "location": "" }
      ]
    }
  }
}