API de turno do WSD

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 3 min. de leitura

    • A API de turnoWorkplace Service Delivery (WSD) fornece um endpoint que retorna períodos de turno para uma data e hora especificadas.

    Para acessar essa 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 Workplace Reservation Management, consulte Workplace Reservation Management.

    Turno do WSD - GET /api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

    Retorna o período do turno para uma data/hora e turno especificados.

    Formato de URL

    URL com controle de versões: /api/sn_wsd_rsv/{api_version}/wsd_shift/{shift_id}/timespan

    URL padrão: /api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

    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. 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 o qual recuperar o período. Localizado na tabela Turno [sn_wsd_core_shift].

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

    Tipo de dados: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    tentativa_inicial_inicial

    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 do turno.

    Valores válidos:
    • verdadeiro: se o turno especificado incluir a data/hora especificada no parâmetro start, retorne a data/hora de início especificada como o início do período.
    • 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

    Padrão: fuso horário do usuário
    Tabela 3. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum

    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
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 6. Códigos de status
    Código de 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 período 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 período 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 período 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"

    Retornar resultados:

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