WSD Shift API

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

    • . Prestação de serviços no local de trabalho(WSD) Turno A API fornece um endpoint que retorna períodos de tempo de turno para uma data e hora especificadas.

    Para acessar esta API, o solicitante deve ter a função sn_wsd_core.workplace_user e os plug-ins Gestão de segurança no local de trabalho (sn_wsd_core) e Gestão de reservas no local de trabalho (sn_wsd_rsv) devem estar ativados.

    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 .

    WSD Shift - OBTER /api/sn_wsd_rsv/wsd_shift//timeespan

    Retorna o intervalo de tempo do turno para uma data/hora e turno especificados.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//wsd_shift//tiespan

    URL padrão: /api/sn_wsd_rsv/wsd_shift//timeespan

    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
    shift_id Sys_id do turno para recuperar o período de tempo.

    Para obter informações adicionais sobre reservas baseadas em turno, consulte Habilitar reserva baseada em turno .

    Tipo de dados: Cadeia de caracteres

    Tabela: Shift [sn_wsd_core_shift]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    attempt_earlier_start Sinalizador que indica se uma hora de início antecipada deve ser definida se o valor de início especificado estiver dentro do período de tempo do turno.
    Valores válidos:
    • Verdadeiro: Se o turno especificado incluir a data/hora especificada em startretorna a data/hora de início especificada como o início do período de tempo.
    • Falso: Retorna o intervalo de tempo do turno conforme definido no registro associado.

    Tipo de dados: Booliano

    Padrão: falso
    início Obrigatório. Data e hora do início dos períodos de tempo do turno a serem retornados.

    Formato: UTC - aaaa-mm-ddThh:mm:ssZ, como 2022-05-23T08:00:00Z
    fuso horário Fuso horário a ser usado ao qualificar os períodos de tempo do turno, como ECT ou PST. Também retorna os períodos de tempo do turno neste fuso horário.

    Formato: UTC

    Tipo de dados: Cadeia de caracteres

    Fuso horário do usuário
    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 solicitação. Tipos compatíveis: application/json, application/xmlou, text/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 Detalhes sobre o intervalo de tempo do turno que correspondeu aos critérios de pesquisa.

    Tipo de dados: Objeto

    "result":{
  "end": "String",
  "start": "String"
}
    resultado.término Data e hora de término do intervalo de tempo do turno no fuso horário especificado.

    Formato: UTC: aaaa-MM-ddThh:mm:ssZ, como 2022-05-23T08:00:00Z

    Tipo de dados: Cadeia de caracteres
    resultado.início Data e hora de início do intervalo de tempo do turno no fuso horário especificado.

    Formato: UTC: aaaa-MM-ddThh:mm:ssZ, como 2022-05-23T08:00:00Z

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo de código a seguir mostra como recuperar o intervalo de tempo de um turno.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/wsd_shift/e5d23acfdb42a01097acc9003996193a/timespan?attempt_earlier_start=true&start=2022-05-23T08:00:00Z&timezone=ECT" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Resultados de retorno:

    {
  "result": {
    "start": "2022-05-23T08:00:00Z",
    "end": "2022-05-23T15:00:00Z"
  }
}