API de reserva recorrente do WSD

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

    • . Prestação de serviços no local de trabalho(WSD) Reserva recorrente A API fornece endpoints para gerenciar reservas que ocorrem ao mesmo tempo, mas têm datas diferentes.

    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 .

    Reserva recorrente de WSD - OBTER /api/sn_wsd_rsv/recorrente_reservation/list/

    Retorna a reserva recorrente especificada.

    Se mais de seis ocorrências de reunião recorrentes estiverem disponíveis para a reserva, você poderá paginar as ocorrências usando os parâmetros de consulta. Você também pode especificar registros de ocorrência que não serão retornados.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//recurring_reservation/list/(parent_id)

    URL padrão: /api/sn_wsd_rsv/recorrente_reservation/list/

    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
    parent_id Sys_id do registro de reserva primário recorrente.

    Quando uma reserva recorrente é criada, um registro primário recorrente e um ou mais registros de reserva secundários são criados. Os registros de reserva contêm um campo chamado reservation_subtipo, que indica o tipo de registro de reserva. Para registros primários recorrentes, este campo é definido como "Primário recorrente". Para registros secundários, este campo é definido como "Ocorrência".

    Em um registro secundário, o sys_id do registro primário recorrente associado está no campo source_reservation.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    end_index Ao paginar por meio de um conjunto de registros recorrentes, o número de registro baseado em zero no qual parar de retornar registros de ocorrência.
    Nota:
    Se o número de ocorrências recorrentes for menor que seis, o endpoint retornará todas as ocorrências, caso contrário, retornará as seis primeiras ocorrências. Para recuperar as ocorrências além de seis, você deve passar o parâmetro end_index de acordo.

    Tipo de dados: Número
    occorence_sys_id Sys_id de um registro de ocorrência na série recorrente não retornar.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    start_index Ao paginar por meio de um conjunto de registros recorrentes, o número de registro baseado em zero no qual começar a retornar registros de ocorrência.

    Tipo de dados: Número

    Padrão: 0
    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 Retornar resultados da reserva recorrente solicitada.

    Tipo de dados: Objeto

    "result": {
  "occurencesTotalCount": "String",
  "reservation": {Object}
}
    Result.OccurcesTotalCount Número total de ocorrências de reunião na série recorrente.

    Tipo de dados: Cadeia de caracteres
    resultado.reserva Detalhes sobre a reserva recorrente solicitada.

    Tipo de dados: Objeto

    "reservation": {
  "active": Boolean,
  "attendees": [Array],
  "check_in_state": {Object},
  "edit_restriction": {Object},
  "end": "String",
  "external_ical": "String",
  "external_id": "String",
  "is_parent": Boolean,
  "last_updated_sub_source": {Object},
  "location": {Object},
  "notification_custom_message": "String",
  "notification_recipients": [Array],
  "number": "String",
  "number_of_attendees": Number,
  "opened_by": {Object},
  "recording_details": [Array],
  "recurring_pattern": {Object},
  "requested_for": {Object},
  "reservable_module": {Object},
  "sensitivity": {Object},
  "shift": {Object},
  "source": {Object},
  "source_icon": {Object},
  "source_reservation": {Object},
  "source_reservation_requester": {Object},
  "start": "String",
  "state": {Object},
  "subject": "String",
  "sub_source": {Object},
  "sync_state": {Object},
  "sys_created_on": "String",
  "sys_id": "String",
  "sys_updated_on": "String",
  "virtual_meeting": "String"
}
    result.reservation.active Sinalizador que indica se a reserva está ativa.
    Valores válidos:
    • Verdadeiro: A reserva está ativa.
    • Falso: A reserva está inativa.

    Tipo de dados: Booliano
    reservation.results Lista de participantes da reserva.

    Tipo de dados: Matriz de objetos

    "attendees": [
  {
    "avatar": "String",
    "displayValue": "String",
    "display_value": "String",
    "email": "String",
    "initials": "String",
    "label": "String",
    "name": "String",
    "sys_id": "String",
    "table": "String",
    "user_name": "String",
    "value": "String"
  }
]
    resultado.reserva.participantes.avatar Sys_id do avatar associado ao participante.

    Tipo de dados: Cadeia de caracteres

    Tabela: Anexos [sys_attachment]
    Result.reservation.attendentes.displayValue Valor de exibição do participante.

    Tipo de dados: Cadeia de caracteres
    result.reservation.attendentes.display_value Valor de exibição do participante. Igual a displayValue.

    Tipo de dados: Cadeia de caracteres
    result.reservation.attendees.email Endereço de e-mail do participante.

    Tipo de dados: Cadeia de caracteres
    result.reservation.attendees.initials Iniciais do participante.

    Tipo de dados: Cadeia de caracteres
    result.reservation.attendees.name Nome do participante.

    Tipo de dados: Cadeia de caracteres
    result.reservation.attendentes.sys_id Sys_id do registro do participante.

    Tipo de dados: Cadeia de caracteres
    result.reservation.participes.table Tabela na qual o registro de participante existe.

    Tipo de dados: Cadeia de caracteres
    result.reservation.attendees.user_name Nome de usuário do participante.

    Tipo de dados: Cadeia de caracteres
    resultado.reserva.participantes.valor Valor interno do participante.

    Tipo de dados: Cadeia de caracteres
    result.reservation.check_in_state Detalhes sobre o estado de check-in da reserva.

    Tipo de dados: Objeto

    "check_in_state": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.check_in_state.​display_value Valor de exibição do estado de check-in atual da reserva, como Em andamento ou Concluído.

    Tipo de dados: Cadeia de caracteres
    result.reservation.check_in_state.value Valor interno do estado de check-in atual da reserva, como 2.

    Tipo de dados: Cadeia de caracteres
    result.reservation.edit_restriction Descrição das restrições de edição do usuário para a reserva, como no_restrictions, service_only ou fully_restricted.

    Tipo de dados: Objeto

    "edit_restriction": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.edit_restriction.display_​value Valor de exibição das restrições de edição da reserva, como Sem restrição .

    Tipo de dados: Cadeia de caracteres
    result.reservation.edit_restriction.value Valor interno para as restrições de edição da reserva, como no_restriction .

    Tipo de dados: Cadeia de caracteres
    resultado.reservation.end Data e hora de término da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC: aaaa-MM-DDThh:mm:ssZ, como 2021-02-05T18:00:00Z
    result.reservation.external_ical Identificação externa exclusiva do iCalendar da reserva. Use este valor para identificar a reserva quando esta for uma reserva relacionada à sincronização de calendário.

    Tipo de dados: Cadeia de caracteres
    result.reservation.external_id Identificação externa exclusiva da reserva. Use este valor para identificar a reserva quando esta for uma reserva relacionada à sincronização de calendário.

    Tipo de dados: Cadeia de caracteres
    result.reservation.is_parent Sinalizador que indica se esta reserva é uma reserva primária.
    Valores possíveis:
    • Verdadeiro: Reserva primária.
    • Falso: Não é uma reserva primária.

    Tipo de dados: Booliano
    result.reservation.last_updated_sub_source Detalhes sobre a última subfonte atualizada para a reserva. As suborigens são usadas ao integrar reservas com um calendário externo. Este objeto contém informações como "ServiceNow_workplace_service_delivery", "google_calendar" ou "microsoft_exchange".

    Tipo de dados: Objeto

    "last_updated_sub_source": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.last_updated_sub_source.​display_value Valor de exibição da última suborigem atualizada da reserva, como ServiceNow Workplace Service Delivery ou Google Agenda . Usado ao integrar a reserva com um serviço externo, como o Google Agenda ou o Microsoft Outlook.

    Tipo de dados: Cadeia de caracteres
    result.reservation.last_updated_sub_source.​valor Valor interno da última subfonte atualizada da reserva, como servicenow_workplace_service_delivery ou google_calendar . Usado ao integrar a reserva com um serviço externo, como o Google Agenda ou o Microsoft Outlook.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location Detalhes sobre o local associado à reserva.

    Tipo de dados: Objeto

    "location": {
  "area": {Object},
  "building": {Object},
  "campus": {Object},
  "capacity": Number,
  "description": "String",
  "display_value": "String",
  "email": "String",
  "floor": {Object},
  "label_value": "String",
  "name": "String",
  "number": "String",
  "number_of_attendees": Boolean,
  "region": {Object},
  "requested_for": {Object},
  "reservable_module": {Object},
  "reservation": {Object},
  "site": {Object},
  "state": {Object},
  "sys_id": "String"
}
    result.reservation.location.area Detalhes sobre a área associada ao local.

    Tipo de dados: Objeto

    "area": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
    result.reservation.location.area.active Sinalizador que indica se a área está ativa.
    Valores válidos:
    • Verdadeiro: A área está ativa.
    • Falso: A área está inativa.

    Tipo de dados: Booliano
    result.reservation.location.area.display_value Valor de exibição da área à qual este local pertence, como Mesa A2.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.area.sys_id Sys_id da área à qual este local pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Área [sn_wsd_core_area]
    result.reservation.location.building Detalhes sobre o edifício associado ao local.

    Tipo de dados: Objeto

    "building": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
    result.reservation.location.building.active Sinalizador que indica se o edifício está ativo.
    Valores válidos:
    • Verdadeiro: O edifício está ativo.
    • Falso: O edifício está inativo.

    Tipo de dados: Booliano
    result.reservation.location.building.​display_value Valor de exibição do edifício ao qual este local pertence, como AMS - BLD1.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.building.sys_id Sys_id do edifício ao qual este local pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Criando [sn_wsd_core_building]
    result.reservation.location.building.timezone Detalhes do fuso horário do edifício.

    Tipo de dados: Objeto

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    result.reservation.location.building.timezone.​display_value Valor de exibição do fuso horário no qual o edifício associado reside.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.building.timezone.​valor Valor interno do fuso horário ao qual este local pertence.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.campus Detalhes sobre o campus associado ao local.

    Tipo de dados: Objeto

    "campus": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
    result.reservation.location.campus.active Sinalizador que indica se o campus está ativo.
    Valores válidos:
    • Verdadeiro: O campus está ativo.
    • Falso: O campus está inativo.

    Tipo de dados: Booliano
    result.reservation.location.campus.​display_value Valor de exibição do campus ao qual este local pertence, como Campus de Amsterdã.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.campus.sys_id Sys_id do campus ao qual este local pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Campus [sn_wsd_core_campus]
    result.reservation.location.capacity Número máximo de ocupantes do local.

    Tipo de dados: Número
    result.reservation.location.description Breve descrição do local.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.display_value Valor a ser exibido na IU deste local.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.email Endereço de e-mail do local.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.floor Detalhes sobre o andar associado ao local.

    Tipo de dados: Objeto

    "floor": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
    result.reservation.location.floor.active Sinalizador que indica se o andar está ativo.
    Valores válidos:
    • Verdadeiro: O andar está ativo.
    • Falso: O andar está inativo.

    Tipo de dados: Booliano
    result.reservation.location.floor.display_value Valor de exibição do andar ao qual este local pertence, como primeiro andar.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.floor.sys_id Sys_id do andar ao qual este local pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Andar [sn_wsd_core_floor]
    result.reservation.location.label_value Tipo de valor especificado em nameParâmetro, como Nome da sala.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.name Nome do local.

    Tipo de dados: Cadeia de caracteres
    resultado.reservation.location.number Número da reserva.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.number_of_​participantes Número de participantes da reserva.

    Tipo de dados: Número
    result.reservation.location.reservable_module Detalhes sobre o módulo reservável associado à reserva.

    Tipo de dados: Objeto

    "reservable_module": {
  "inline_title": "String",
  "name": "String",
  "sys_id": "String",
  "title": "String"
}
    result.reservation.location.reservable_module.​inline_title Título em linha do módulo reservável. O título aparece alinhado com o texto descritivo no portal de serviços do Workplace.

    Tipo de dados: Cadeia de caracteres
    result.reservable.location.reservable_module.​nome Nome do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.reservable_module.​sys_id Sys_id do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.reservable_module.​título Título do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.region Detalhes sobre a região associada ao local.

    Tipo de dados: Objeto

    "region": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
    result.reservation.location.region.active Sinalizador que indica se a região está ativa.
    Valores válidos:
    • Verdadeiro: A região está ativa.
    • Falso: A região está inativa.

    Tipo de dados: Booliano
    result.reservation.location.region.​display_value Valor de exibição da região à qual este local pertence, como Europa.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.region.sys_id Sys_id da região à qual este local pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Região [sn_wsd_core_region]
    result.reservation.location.reservation Detalhes sobre a reserva associada ao local.

    Tipo de dados: Objeto

    "reservation": {
  "active": Boolean,
  "number": "String",
  "number_of_attendees": Number,
  "requested_for": {Object},
  "state": {Object},
  "sys_id": "String"
}
    result.reservation.location.reservation.active Sinalizador que indica se a reserva está ativa.
    Valores válidos:
    • Verdadeiro: A reserva está ativa.
    • Falso: A reserva está inativa.

    Tipo de dados: Booliano
    resultado.reservation.location.reservation.number Número da reserva.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.reservation.​number_of_attendentes Número de participantes da reserva.

    Tipo de dados: Número
    result.reservation.location.reservation.​requested_for Detalhes sobre a pessoa para quem a reserva foi solicitada em nome.

    Tipo de dados: Objeto

    "requested_for": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
    result.reservation.location.reservation.​requested_for.name Nome do usuário para o qual a reserva foi solicitada.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.reservation.​requested_for.sys_id Sys_id do usuário Solicitado para.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    result.reservation.location.reservation.​requested_for.user_name Nome de usuário para o qual a reserva foi solicitada.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.reservation.​estado Detalhes sobre o estado da reserva do local.

    Tipo de dados: Objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.location.reservation.​.state.display_value Valor de exibição do estado atual da reserva, como Confirmado.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.reservation.​.state.value Valor interno do estado atual da reserva, como 2.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.site Site ao qual o local pertence.

    Tipo de dados: Objeto

    "site": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}

    Tabela: Site [sn_wsd_core_site]
    result.reservation.location.site.active Sinalizador que indica se o site está ativo.
    Valores válidos:
    • Verdadeiro: O site está ativo.
    • Falso: O site está inativo.

    Tipo de dados: Booliano
    result.reservation.location.site.display_value Valor de exibição do site ao qual este local pertence, como Europa Ocidental.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.site.sys_id Sys_id do site ao qual este local pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Site [sn_wsd_core_site]
    result.reservation.location.standard_services Serviços disponíveis padrão.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.state Detalhes sobre o estado da reserva do local.

    Tipo de dados: Objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.location.state.display_value Valor de exibição do estado atual da reserva, como Confirmado.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.state.value Valor interno do estado atual da reserva, como 2.

    Tipo de dados: Cadeia de caracteres
    result.reservation.location.sys_id Sys_id do registro de local associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    result.reservation.notification_custom_​mensagem Mensagem personalizada para a notificação enviada aos destinatários listados em reservation.notification_recipients.

    Tipo de dados: Cadeia de caracteres
    result.reservation.notification_recipients Lista de destinatários que recebem notificação sobre a reserva.

    Tipo de dados: Matriz de objetos

    "notification_recipients":[
  {
    "name": "String",
    "sys_id": "String",
    "user_name": "String"
  }
]
    result.reservation.notification_recipients.name Nome do destinatário.

    Tipo de dados: Cadeia de caracteres
    result.reservation.notification_recipients.sys_id Sys_id do destinatário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    result.reservation.notification_recipients.​user_name Nome de usuário do destinatário.

    Tipo de dados: Cadeia de caracteres
    número.reservation.result Número exclusivo do registro de reserva. Você pode usar este valor para consultar a reserva.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    result.reservation.number_of_attenes Número de participantes nesta reserva.

    Tipo de dados: Número
    result.reservation.opened_by Detalhes sobre o usuário que criou a reserva.

    Tipo de dados: Objeto

    "opened_by": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
    result.reservation.opened_by.avatar Avatar do usuário que abriu a reserva.

    Tipo de dados: Cadeia de caracteres
    Result.reservation.opened_by.displayValue Valor de exibição do aberto pelo usuário.

    Tipo de dados: Cadeia de caracteres
    result.reservation.opened_by.display_value Valor de exibição do aberto pelo usuário.

    Tipo de dados: Cadeia de caracteres
    result.reservation.opened_by.email Endereço de e-mail do usuário que abriu a reserva.

    Tipo de dados: Cadeia de caracteres
    result.reservation.opened_by.initials Iniciais do usuário que abriu a reserva.

    Tipo de dados: Cadeia de caracteres
    result.reservation.opened_by.name Nome do usuário que abriu a reserva.

    Tipo de dados: Cadeia de caracteres
    result.reservation.opened_by.user_name Nome de usuário do usuário que abriu a reserva.

    Tipo de dados: Cadeia de caracteres
    result.reservation.opened_by.value Valor interno do usuário que abriu a reserva.

    Tipo de dados: Cadeia de caracteres
    result.reservation.recording_details Detalhes sobre as gravações associadas à reserva (reunião).

    Tipo de dados: Matriz de objetos

    "recording_details": [
  "recording_url": "String"
]
    recording_details.recording_details.​recording_url URL das gravações associadas à reserva.

    Tipo de dados: Cadeia de caracteres
    result.reservation.recurring_pattern Detalhes sobre o padrão recorrente da reserva.

    Tipo de dados: Objeto

    "recurring_pattern": {
  "amountOfDates": "String",
  "duration": Number,
  "label": "String",
  "options": {Object},
  "repeats": "String",
  "startDate":"String",
  "startDateGdt": {Object}
}
    Result.reservation.Recurring_pattern.​AmountOfDates Número de datas para as quais os reserváveis são reservados.

    Tipo de dados: Cadeia de caracteres
    result.reservation.recurring_pattern.duration
    Período de tempo para reservar o reservável.

    Tipo de dados: Número

    Unidade: segundos
    result.reservation.recurring_pattern.label Nome descritivo da reserva recorrente.

    Tipo de dados: Cadeia de caracteres
    result.reservation.recurring_pattern.options Detalhes sobre as opções associadas à reserva recorrente.

    Tipo de dados: Objeto

    "options": {
  "count": Number,
  "daysOfWeek": "String",
  "every": Number,
  "endDate": "String"
  "endDateGdt": {Object}
}
    result.reservation.recurring_pattern.options.​contagem

    Número de vezes para repetir o padrão.

    Tipo de dados: Número
    Result.reservation.recurring_pattern.options.​DaysOfWeek

    Dias da semana em que o reservável é necessário.

    Valores válidos:
    • Segunda-feira. 1
    • Terça-feira. 2
    • Quarta-feira 3
    • 4: Quinta-feira
    • Sexta-feira 5
    • Sábado. 6
    • Domingo: 7

    Por exemplo, para especificar terça-feira, quinta-feira e sexta-feira, passe 245 (sem delimitador). Se repeats. semanalmente , count. 5 e daysOfWeek. 245 em seguida, nos resultados de retorno, o total é igual a. Count*daysOfWeek.length (5*3-15).

    Tipo de dados: Cadeia de caracteres
    result.reservation.recurring_pattern.options.​a cada Intervalo de repetição do padrão. Por exemplo, o valor "2" indica que o padrão se repete a cada 2 dias ou 2 meses, dependendo do valor de repeatspropriedade.
    Nota:
    Esta configuração não se aplica a intervalos de repetição semanais. Você pode definir repeatspropriedade para diariamente e este valor para 14 para intervalos de repetição quinzenais.

    Tipo de dados: Número

    Valor padrão: 1

    Result.reservation.recurring_pattern.options.​EndDate Data e hora de término da recorrência da reunião, como "2022-07-08T14:00:00Z".

    Tipo de dados: Cadeia de caracteres

    Formato: UTC aaaa-mm-dd hh:mm:ss
    Result.reservation.recurring_pattern.options.​EndDateGdt Data e hora de término da recorrência da reunião.

    Tipo de dados: Cadeia de caracteres

    Formato: GDT, como "2022-07-08T14:00:00Z"
    result.reservation.recurring_pattern.repeats

    Padrão de repetição para reservável.

    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • diariamente
    • mensal
    • semanalmente
    Nota:
    O intervalo de repetição do padrão é definido em options.everypropriedade. O único intervalo de repetição válido para padrões semanais é um.

    Tipo de dados: Cadeia de caracteres
    Result.reservation.Recurring_pattern.StartDate
    Data e hora de início do padrão recorrente, como "2022-07-08T14:00:00Z".

    Tipo de dados: Cadeia de caracteres

    Formato: UTC aaaa-mm-dd hh:mm:ss
    result.reservation.recurring_pattern. ​StartDateGdt
    Data e hora de início do padrão recorrente, como "2022-07-08T14:00:00Z".

    Tipo de dados: Cadeia de caracteres

    Formato: UTC aaaa-mm-dd hh:mm:ss
    result.reservation.requested_for Detalhes sobre o usuário do qual a reserva foi feita em nome.

    Tipo de dados: Objeto

    "requested_for": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
    result.reservation.requested_for.avatar Avatar do usuário do qual a reserva foi feita em nome.

    Tipo de dados: Cadeia de caracteres
    Result.reservation.requested_for.displayValue Valor de exibição do usuário do qual a reserva foi feita em nome.

    Tipo de dados: Cadeia de caracteres
    result.reservation.requested_for.display_value Valor de exibição do usuário do qual a reserva foi feita em nome. Igual ao displayValue.

    Tipo de dados: Cadeia de caracteres
    result.reservation.requested_for.email Endereço de e-mail do usuário do qual a reserva foi feita em nome.

    Tipo de dados: Cadeia de caracteres
    result.reservation.requested_for.initials Iniciais do usuário do qual a reserva foi feita em nome.

    Tipo de dados: Cadeia de caracteres
    result.reservation.requested_for.label Rótulo do usuário para o qual a reserva foi feita em nome.

    Tipo de dados: Cadeia de caracteres
    result.reservation.requested_for.name Nome do usuário do qual a reserva foi feita em nome.

    Tipo de dados: Cadeia de caracteres
    resultado.rservation.requested_for.sys_id Sys_id_of do usuário do qual a reserva foi feita em nome.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    resultado.rservation.requested_for.table Tabela que contém o registro do usuário.

    Tipo de dados: Cadeia de caracteres
    result.reservation.requested_for.user_name Nome de usuário do usuário do qual a reserva foi feita em nome.

    Tipo de dados: Cadeia de caracteres
    result.reservation.requested_for.value Valor interno do usuário do qual a reserva foi feita em nome.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module Detalhes do módulo reservável solicitado.

    Tipo de dados: Objeto

    "reservable_module": {
  "allow_invitees": Boolean,
  "allow_whole_day": Boolean,
  "apply_to_shift": Boolean,
  "browse_by_area_enabled": Boolean,
  "browse_near_a_person_enabled": Boolean,
  "buildingSysIds": [Array],
  "checkin_before_minutes": Number,
  "display_number_of_attendees": Boolean,
  "display_on_behalf_of": Boolean,
  "display_sensitivity": Boolean,
  "display_value": "String",
  "enable_browse_by_area": Boolean,
  "enable_browse_near_a_person": Boolean,
  "enable_facet_filter": Boolean,
  "enable_group_reservations": Boolean,
  "enable_ical_generation": Boolean,
  "font_awesome_icon": "String",
  "inline_title": "String",      
  "layout_mapping": {Object},
  "max_days_in_future": Number,
  "max_occurrences": Number,
  "name": "String",
  "override_approval_policy": "String",
  "require_cancel_notes": Boolean,
  "require_cc_dept_check": Boolean,
  "require_subject": Boolean,
  "reservable_columns": [Array],
  "reservable_container_field": "String",
  "reservable_filter": "String",
  "reservable_quantity_field": "String",
  "reservable_table": "String",
  "reservable_type": "String",
  "reservable_views": [Array],
  "reservation_paths": [Array],
  "search_limit": Number,
  "selection_type": "String",
  "short_description": "String",
  "show_map_view": Boolean,
  "sys_id": "String",
  "timeSlots": [Array],
  "title": "String",
  "virtual_meeting_provider": {Object}
}
    result.reservable_module.​allow_invites Sinalizador que indica se os funcionários podem adicionar convidados à reserva.
    Valores válidos:
    • Verdadeiro: Permitir que os funcionários adicionem convidados à reserva.
    • Falso: Não permita que os funcionários adicionem convidados à reserva.

    Tipo de dados: Booliano
    result.reservable_module.​allow_whole_day Sinalizador que indica se os usuários podem reservar o reservável para o dia inteiro.
    Valores válidos:
    • Verdadeiro: Permitir que os usuários reservem o dia inteiro.
    • Falso: Não permita que os usuários reservem para o dia inteiro.

    Tipo de dados: Booliano
    result.reservable_module.​apply_to_shift Sinalizador que indica se as reservas baseadas em turno estão habilitadas para o módulo reservável.
    Valores válidos:
    • Verdadeiro: Permitir reservas baseadas em turno.
    • Falso: Não permitir reservas baseadas em turno.

    Tipo de dados: Booliano
    result.reservable_module.​browse_by_area_enabled Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por área.
    Valores válidos:
    • Verdadeiro: Permitir que os usuários pesquisem módulos reserváveis por área.
    • Falso: Não permitir que os usuários pesquisem módulos reserváveis por área.

    Tipo de dados: Booliano
    result.reservable_module.​browse_next_a_person_enabled Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada.
    Valores válidos:
    • Verdadeiro: Permitir que os usuários pesquisem módulos reserváveis próximos a uma pessoa.
    • Falso: Não permita que os usuários naveguem por módulos reserváveis próximos a uma pessoa.

    Tipo de dados: Booliano
    Result.reservable_module.​BuildingSysIds Lista de sys_ids dos edifícios associados ao módulo reservável.

    Tipo de dados: Matriz de cadeias de caracteres
    result.reservable_module.​check-in_before_minutes Tempo antes do início de uma reserva que um usuário pode fazer check-in em sua reserva.

    Unidade: Minutos

    Tipo de dados: Número
    result.reservable_module.​display_number_of_attendentes Sinalizador que indica se os usuários podem especificar o número de participantes na reserva.
    Valores válidos:
    • Verdadeiro: Os usuários podem especificar o número de participantes.
    • Falso: Os usuários não podem especificar o número de exibição de participantes.

    Tipo de dados: Booliano
    result.reservable_module.​display_on_beemend_of Sinalizador que indica se as reservas podem ser feitas em nome de outra pessoa.
    Valores válidos:
    • Verdadeiro: Em nome do compatível.
    • Falso: Em nome de não compatível.

    Tipo de dados: Booliano
    result.reservable_module.​display_sensitivity Sinalizador que indica se os usuários podem definir a sensibilidade da reserva, como normal ou privado.
    Valores válidos:
    • Verdadeiro: Capaz de definir a sensibilidade.
    • Falso: Não é possível definir a sensibilidade. O padrão é Normal.

    Tipo de dados: Booliano
    result.reservable_module.​display_value Valor de exibição do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module. enable​_browse_by_area Sinalizador que indica se os usuários podem pesquisar módulos reserváveis por área. Igual a browse_by_area_enabled.
    Valores válidos:
    • Verdadeiro: Permitir que os usuários pesquisem módulos reserváveis por área.
    • Falso: Não permitir que os usuários pesquisem módulos reserváveis por área.

    Tipo de dados: Booliano
    result.reservable_module. enable_​browse_next_a_person Sinalizador que indica se os usuários podem pesquisar módulos reserváveis localizados por uma pessoa especificada. Igual a browse_near_a_person_enabled.
    Valores válidos:
    • Verdadeiro: Permitir que os usuários pesquisem módulos reserváveis próximos a uma pessoa.
    • Falso: Não permita que os usuários naveguem por módulos reserváveis próximos a uma pessoa.

    Tipo de dados: Booliano
    result.reservable_module. enable​_aspect_filter Sinalizador que indica se a filtragem de aspecto em itens do local de trabalho está habilitada. Quando habilitadas, as opções de filtro exibidas são baseadas nos resultados da pesquisa. Somente os itens que estão disponíveis no resultado da pesquisa gerado estão disponíveis para os usuários para seleção no filtro.
    Valores válidos:
    • Verdadeiro: Os filtros de aspecto estão habilitados.
    • Falso: Os filtros de aspecto não estão habilitados.

    Tipo de dados: Booliano
    result.reservable_module. enable​_group_reservations Sinalizador que indica se os usuários podem fazer uma reserva de grupo.
    Valores válidos:
    • Verdadeiro: Capaz de fazer reservas de grupo.
    • Falso: Não é possível fazer reservas de grupo.

    Tipo de dados: Booliano
    result.reservable_module. enable​_ical_generation Sinalizador que indica se os usuários podem gerar um iCalendar para a reserva.
    Valores válidos:
    • Verdadeiro: Geração de iCalendar permitida.
    • Geração de iCalendar não é permitida.

    Tipo de dados: Booliano
    result.reservable_module.​font_awesome_icon Nome do ícone de fonte anexado ao módulo reservável.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​inline_title Título em linha do módulo reservável. O título aparece alinhado com o texto descritivo no portal de serviços do Workplace.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​layout_mapping Detalhes sobre a estrutura do mapeamento de layout de locais. Use esses dados para organizar as informações na IU.

    Tipo de dados: Objeto

    "layout_mapping": {
  "body": [Array],
  "description": [Array],
  "image": "String",
  "subtitle": [Array],
  "subtitle_asc": [Array],
  "title": [Array]
}
    result.reservable_module.​layout_mapping.body Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Matriz de objetos

    "body": [
  {
    "field": "String",
    "field_to_display": "String",
    "icon": "String",
    "label": "String"
  }
]
    result.reservable_module.​layout_mapping.body.field Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​layout_mapping.body.field_to_display Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​layout_mapping.body.icon Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​layout_mapping.body.label Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​layout_mapping.description Espaço reservado para mapear os dados de IU de front-end. Descrição do mapeamento de layout.

    Tipo de dados: Matriz
    result.reservable_module.​layout_mapping.image Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​layout_mapping.subtitle Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Matriz
    result.reservable_module.​layout_mapping.subtitle_asc Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Matriz
    result.reservable_module.​layout_mapping.title Espaço reservado para mapear os dados de IU de front-end.

    Tipo de dados: Matriz
    result.reservable_module.​max_days_in_future Número máximo de dias no futuro que um usuário pode reservar o módulo reservável.

    Tipo de dados: Número
    result.reservable_module.​max_occurnces Número máximo de ocorrências de reserva recorrentes se houver reservas recorrentes disponíveis para o módulo reservável.

    Tipo de dados: Número
    result.reservation.reservable_module.name Nome do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​override_approval_policy Opção para especificar como implementar a política de aprovação.
    Opções:
    • Nenhuma substituição: A política de aprovação é implementada conforme definido em Requer aprovação campo de um espaço ou sala de trabalho.
    • Sempre exigir aprovação: A política de aprovação é necessária independentemente do que está definido em Requer aprovação campo de um espaço ou sala de trabalho.
    • Nunca exigir aprovação: A política de aprovação é removida independentemente do que está definido em Requer aprovação l campo de um espaço ou sala de trabalho.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​require_cancel_notes Sinalizador que indica se os usuários devem inserir uma anotação de cancelamento antes de cancelar um módulo reservável.
    Valores válidos:
    • Observação de cancelamento necessária.
    • Nota de cancelamento não necessária.

    Tipo de dados: Booliano
    result.reservable_module.​require_cc_dept_check Sinalizador que indica se há uma incompatibilidade de centro de custos ou departamento entre o item do espaço e o usuário conectado.
    Valores válidos:
    • Verdadeiro: Verifique se há incompatibilidade.
    • Falso: Não verifique se há incompatibilidade.

    Tipo de dados: Booliano
    result.reservable_module.​require_subject Sinalizador que indica se o usuário deve inserir um assunto ao fazer a reserva.
    Valores válidos:
    • Verdadeiro: Assunto obrigatório.
    • Falso: O assunto não é necessário.

    Tipo de dados: Booliano
    reservable_module.reservable_module.​reservable_columns Lista de colunas de um reservável.

    Tipo de dados: Matriz

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    reservable_module.reservable_module.​reservable_container_field Nível do contêiner, como um grupo de mesas em uma área específica.

    Tipo de dados: Cadeia de caracteres
    reservable_module.reservable_module.​reservable_filter Condições de filtro usadas para filtrar itens reserváveis na tabela reservável associada. A tabela reservável é um campo na tabela Módulo reservável [sn_wsd_rsv_reservable_module]. Essas condições de filtro foram aplicadas à tabela contida na tabela reservável do campo.

    Tipo de dados: Cadeia de caracteres
    reservable_module.reservable_module.​reservable_quantity_field Quantidade reservável de todos os espaços. A quantidade é usada ao atribuir espaços de vizinhança a uma área. Para obter informações adicionais, consulte Atribua espaços de vizinhança a uma área .

    Tipo de dados: Cadeia de caracteres
    reservable_module.reservable_module.​reservable_table Tabela que contém os itens reserváveis do local de trabalho.

    Tipo de dados: Cadeia de caracteres
    reservable_module.reservable.reservable​_module. reservable_type Item reservável, como local.

    Tipo de dados: Cadeia de caracteres
    reservable_module.reservable_module.​reservable_views Detalhes sobre as diferentes exibições associadas ao módulo reservável, como exibição de cartão ou exibição de programação.

    Tipo de dados: Objeto

    "reservable_views": {
  "iconClass": "String",
  "isDefault": Boolean,
  "label": "String",
  "order": Number,
  "type": "String"
}

    Tabela: Exibição reservável [sn_wsd_rsv_reservable_view]
    Reservable_module.reservable.reservable​_views.iconClass Classe de ícone da exibição reservável.

    Tipo de dados: Cadeia de caracteres
    Reservable_module.reservable.reservable​_views.isDefault Sinalizador que indica se esta exibição reservável deve ser o padrão para módulos reserváveis.
    Valores válidos:
    • Verdadeiro: Torna o padrão.
    • Falso: Não torna o padrão.

    Tipo de dados: Booliano
    result.reservable_module. reservable​_views.label Nome da exibição reservável.

    Tipo de dados: Cadeia de caracteres
    reservable_module.reservable_module.​reservable_views.order Ordem na qual as exibições são exibidas para o módulo reservável na IU. O número de ordem inferior vem primeiro na IU. No caso do mesmo número de pedido, ele é atribuído a uma ordenação aleatória.

    Tipo de dados: Número
    reservable_module.reservable_module.​reservable_views.type Nome de back-end da exibição reservável. Usado para processamento interno.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module. reservation​_paths Caminhos de reserva associados aos módulos reserváveis, como Pesquisar tudo, Navegar próximo a uma pessoa.

    Tipo de dados: Matriz de objetos

    "reservation_paths": [
  {
    "displayValue": "String",
    "value": "String"
  }
]
    result.reservable_module. reservation​_paths.display_value Valor de exibição do caminho de reserva, como "Navegar próximo a uma pessoa".

    Tipo de dados: Cadeia de caracteres
    result.reservable_module. reservable_​paths.value Valor interno do caminho de reserva, como "browse_next_a_person".

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​search_limit Número máximo de resultados de pesquisa a serem retornados quando um usuário pesquisa um local de trabalho.

    Tipo de dados: Número
    result.reservable_module.​selection_type

    Tipo de seleção a ser exibida nos resultados da pesquisa.

    Pode ser uma das seguintes opções:
    • Unidade específica: O resultado da pesquisa exibe cada item do local de trabalho.
    • Contêiner: O resultado da pesquisa exibe o primário ou contêiner dos itens do local de trabalho.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​short_description Breve descrição do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​show_map_view Sinalizador que indica se a exibição de mapa deve ser habilitada para módulos reserváveis.
    Valores válidos:
    • Verdadeiro: Habilitar exibição de mapa.
    • Falso: Não habilite a exibição de mapa.

    Tipo de dados: Booliano
    result.reservable_module.sys_id Sys_id do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    Result.reservable_module.timesLots Detalhes sobre os intervalos de tempo associados a um módulo reservável.

    Tipo de dados: Matriz de objetos

    [
  {
    "name": "String",
    "short_description": "String",
    "slot_end": "String",
    "slot_start": "String",
    "sys_id": "String"
  }
]
    Result.reservable_module.​timeSlots.name Nome do intervalo de tempo.

    Tipo de dados: Cadeia de caracteres
    Result.reservable_module.​TimesLots.short_description Breve descrição do intervalo de tempo.

    Tipo de dados: Cadeia de caracteres
    Result.reservable_module.​TimesLots.slot_end Hora de término do intervalo de tempo.

    Tipo de dados: Cadeia de caracteres
    Result.reservable_module.​TimesLots.slot_start Hora de início do slot.

    Tipo de dados: Cadeia de caracteres
    Result.reservable_module.​TimesLots.sys_id Sys_id do registro do intervalo de tempo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Intervalo de tempo [sn_wsd_rsv_time_slot]
    result.reservable_module.title Título do módulo reservável.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​virtual_meeting_provider Detalhes sobre o provedor virtual associado ao módulo reservável.

    Tipo de dados: Objeto

    "virtual_meeting_provider": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservable_module.​virtual_meeting_provider.display_value Valor de exibição do provedor de reunião virtual.

    Tipo de dados: Cadeia de caracteres
    result.reservable_module.​virtual_meeting_provider.sys_id Sys_id do provedor de reunião virtual.

    Tipo de dados: Cadeia de caracteres
    ReservaçãoResultado.reservaçãoAcl Detalhes das verificações de níveis de controle de acesso (ACL) do usuário definidas na reserva associada.

    Tipo de dados: Objeto

    "reservationAcl": {
  "read": Boolean,
  "write": {Object}
}
    result.reservation.reservationAcl.read Sinalizador que indica se o usuário pode ler esta reserva.
    Valores válidos:
    • Verdadeiro: Verifique se o usuário pode ler a reserva.
    • Falso: Não verifique se o usuário pode ler a reserva.

    Tipo de dados: Booliano
    ReservationAcl.reservationAcl.write Detalhes sobre os recursos de gravação do usuário para a reserva associada.

    Tipo de dados: Objeto

    "write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
    ReservationAcl.write.allFields Sinalizador que indica se o usuário pode gravar em todos os campos especificados em reservationACL.write.fieldsobjeto. Se o usuário só tiver acesso a alguns campos específicos, somente esses campos serão verdadeiros em reservationACL.write.fieldsobjeto.
    Valores válidos:
    • Verdadeiro: Verifique se o usuário pode gravar em todos os campos especificados em reservationACL.write.fieldsobjeto.
    • Falso: Não verifique se o usuário pode gravar em todos os campos especificados em reservationACL.write.fieldsobjeto

    Tipo de dados: Booliano
    ReservationAcl.write.fields.result.reservation.reservationAcl Detalhes dos controles de acesso em vários campos da reserva.

    Tipo de dados: Objeto

    "fields": {
  "location": Boolean,
  "number_of_attendees": Boolean,
  "requested_for": Boolean,
  "sensitivity": Boolean,
  "subject": Boolean
}
    Result.reservationAcl.write.fields.​Local Sinalizador que indica se o usuário pode gravar nos campos de local nesta reserva.
    Valores válidos:
    • Verdadeiro: Verifique se o usuário pode gravar nos campos de local.
    • Falso: Não verifique se o usuário pode gravar nos campos de local.

    Tipo de dados: Booliano
    Result.reservationAcl.write.fields.​Number_of_attendentes Sinalizador que indica se o usuário pode gravar nos campos Número de participantes nesta reserva.
    Valores válidos:
    • Verdadeiro: Verifique se o usuário pode gravar no campo Número de participantes.
    • Falso: Não verifique se o usuário pode gravar no campo Número de participantes.

    Tipo de dados: Booliano
    Result.reservationAcl.write.fields.​Requested_for Sinalizador que indica se o usuário pode gravar nos campos Solicitado para nesta reserva.
    Valores válidos:
    • Verdadeiro: Verifique se o usuário pode gravar no campo Solicitado para.
    • Falso: Não verifique se o usuário pode gravar no campo Solicitado para.

    Tipo de dados: Booliano
    Result.reservationAcl.write.fields.​Sensibilidade Sinalizador que indica se o usuário pode gravar nos campos de confidencialidade nesta reserva.
    Valores válidos:
    • Verdadeiro: Verifique se o usuário pode gravar no campo de sensibilidade.
    • Falso: Não verifique se o usuário pode gravar no campo de sensibilidade.

    Tipo de dados: Booliano
    Result.reservationAcl.write.fields.​Assunto Sinalizador que indica se o usuário pode gravar nos campos de assunto nesta reserva.
    Valores válidos:
    • Verdadeiro: Verifique se o usuário pode gravar no campo Assunto.
    • Falso: Não verifique se o usuário pode gravar nos campos de assunto.

    Tipo de dados: Booliano
    Result.reservationAcl.write.record Sinalizador que indica se o usuário pode gravar todo o registro de reserva.
    Valores válidos:
    • Verdadeiro: Verifique se o usuário pode gravar todo o registro de reserva.
    • Falso: Não verifique se o usuário pode gravar todo o registro de reserva.

    Tipo de dados: Booliano
    result.reservation.reservation_purpose Detalhes sobre a finalidade da reserva.

    Tipo de dados: Objeto

    "reservation_purpose": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.reservation_purpose.​display_value Valor de exibição para a finalidade da reserva, como Reunião da empresa.

    Tipo de dados: Cadeia de caracteres
    result.reservation.reservation_purpose.value Valor interno para a finalidade da reserva, como company_meeting.

    Tipo de dados: Cadeia de caracteres
    result.reservation.reservation_type Detalhes sobre o tipo de reserva.

    Tipo de dados: Objeto

    "reservation_type": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.reservation_type.​display_value Valor de exibição do tipo de reserva, como Espaço.

    Tipo de dados: Cadeia de caracteres
    result.reservation.reservation_type.value Valor interno para o tipo de reserva, como espaço.

    Tipo de dados: Cadeia de caracteres
    result.reservation.reservation_subtipo Detalhes sobre o subtipo da reserva. Os subtipos indicam o tipo de reserva, como único, vários primários, vários secundários, primário recorrente, ou ocorrência.

    Tipo de dados: Objeto

    "reservation_subtype": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.reservation_subtipo.​display_value Valor de exibição do subtipo da reserva, como Simples.

    Tipo de dados: Cadeia de caracteres
    result.reservation.reservation_subtype.value Valor interno para o subtipo da reserva, como único.

    Tipo de dados: Cadeia de caracteres
    result.reservation.sensitivity Detalhes sobre a confidencialidade da reserva.

    Tipo de dados: Objeto

    "sensitivity": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.sensitivity.display_value Valor de exibição da sensibilidade da reserva, como alto ou baixo.

    Tipo de dados: Cadeia de caracteres
    result.reservation.sensitivity.value Valor interno para a sensibilidade da reserva, como 1 ou 3.

    Tipo de dados: Cadeia de caracteres
    resultado.reservation.turno Detalhes sobre o turno aplicado à reserva.

    Tipo de dados: Objeto

    "shift": {
  "display_value": "String",
  "name": "String",
  "shiftDetails": "String",
  "sys_id": "String"
}
    result.reservation.shift.display_value Valor de exibição do turno.

    Tipo de dados: Cadeia de caracteres
    result.reservation.shift.name Nome do turno. Igual a display_value.

    Tipo de dados: Cadeia de caracteres
    Result.reservation.shift.shiftDetails Detalhes do turno.

    Tipo de dados: Cadeia de caracteres
    result.reservation.shift.sys_id Sys_id do registro de turno.

    Tipo de dados: Cadeia de caracteres

    Tabela: Shift [sn_wsd_core_shift]
    result.reservation.source Detalhes sobre a origem da reserva, como Serviços do local de trabalho ou Google Mail.

    Tipo de dados: Objeto

    "source": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.source.display_value Valor de exibição da origem da reserva, como Serviços do local de trabalho.

    Tipo de dados: Cadeia de caracteres
    result.reservation.source.value Valor interno da origem da reserva, como serviceNow.

    Tipo de dados: Cadeia de caracteres
    result.reservation.source_icon Detalhes sobre a origem do ícone usado na reserva. Este ícone é usado na IU.

    Tipo de dados: Objeto

    "source_icon": {
  "classNames": "String",
  "imgSrc": "String",
  "tooltip": "String"
}
    Result.reservation.source_icon.classNames Nomes de classe separados por vírgulas para o ícone de origem.

    Tipo de dados: Cadeia de caracteres
    Result.reservation.source_icon.imgSrc Nome da origem da imagem para o ícone de origem. Este ícone é armazenado na tabela Imagens [db_image].

    Tipo de dados: Cadeia de caracteres
    result.reservation.source_icon.tooltip Dica de ferramenta associada ao ícone de origem.

    Tipo de dados: Cadeia de caracteres
    result.reservation.source_reservation Reserva de origem da reserva atual. Por exemplo, para reservas recorrentes, a reserva primária recorrente é a origem da série de reservas de ocorrência.

    Tipo de dados: Objeto

    "source_reservation": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservation.source_reservation.​display_value Valor de exibição da reserva de origem.

    Tipo de dados: Cadeia de caracteres
    result.reservation.source_reservation.name Nome da reserva de origem.

    Tipo de dados: Cadeia de caracteres
    result.reservation.source_reservation.sys_id Sys_id do registro de reserva de origem.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    ​solicitante result.reservation.source_reservation_ Usuário que solicitou a reserva recorrente.

    Tipo de dados: Objeto

    "source_reservation": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
    result.reservation.source_reservation_​requester.name Nome do solicitante de reserva recorrente.

    Tipo de dados: Cadeia de caracteres
    result.reservation.source_reservation_​requester.sys_id Sys_id do usuário que solicitou a reserva recorrente.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    result.reservation.source_reservation_​requester.user_name Nome de usuário do solicitante de reserva recorrente.

    Tipo de dados: Cadeia de caracteres
    resultado.reservation.start Data e hora de início da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC - aaaa-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    result.reservation.state Detalhes sobre o estado da reserva.

    Tipo de dados: Objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.state.display_value Valor de exibição do estado atual da reserva, como Confirmado.

    Tipo de dados: Cadeia de caracteres
    result.reservation.state.value Valor interno do estado atual da reserva, como 2.

    Tipo de dados: Cadeia de caracteres
    resultado.reservation.assunto Assunto da reserva.

    Tipo de dados: Cadeia de caracteres
    result.reservation.sub_source Detalhes sobre a suborigem da reserva. A suborigem especifica de onde a reserva se originou, como Google Agenda ou Microsoft Exchange.

    Tipo de dados: Objeto

    "sub_source": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.sub_source.display_value Valor de exibição da suborigem da reserva, como Google Agenda.

    Tipo de dados: Cadeia de caracteres
    result.reservation.sub_source.value Valor interno do campo de suborigem da reserva, como google_calendar.

    Tipo de dados: Cadeia de caracteres
    result.reservation.sync_state Detalhes sobre o estado de sincronização de uma reserva de outro serviço, como "sync_enfileied" ou "Synchronized".

    Tipo de dados: Objeto

    "sync_state": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.sync_state.display_value Valor de exibição do estado de sincronização atual da reserva, como Sincronizado.

    Tipo de dados: Cadeia de caracteres
    result.reservation.sync_state.value Valor interno do estado de sincronização atual da reserva, como Sincronizado.

    Tipo de dados: Cadeia de caracteres
    result.reservation.sys_created_on Data e hora em que a reserva foi criada.

    Tipo de dados: Cadeia de caracteres
    result.reservation.sys_id
    Sys_id do registro de reserva.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    Result.reservation.sys_updated_on Data e hora em que a reserva foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres
    result.reservation.virtual_meeting URL do link da reunião virtual.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo de código a seguir mostra como recuperar uma reserva recorrente específica.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/recurring_reservation/list/d98a381587b789506342b846dabb3563" \
--request GET \
--header "Accept:application/json" \
--user "username": "password"

    Resultados de retorno:

    {
  "result": {
    "reservations": [
      {
        "sys_id": "198a381587b789506342b846dabb3565",
        "number": "WRES0001247",
        "location": {
          "sys_id": "fe1f744edb7650106c731dcd139619ca",
          "name": "Aspen",
          "description": "A room with large windows, dark leather seats and a large wooden table.",
          "display_value": "Aspen",
          "capacity": 16,
          "label_value": "Room name",
          "email": null,
          "reservable_module": {
            "sys_id": "c31241cedb7650106c731dcd13961917",
            "name": "Meeting rooms",
            "title": "Meeting rooms",
            "inline_title": "meeting room"
          },
          "region": {
            "sys_id": "3752ac8edb3650106c731dcd139619e0",
            "display_value": "Americas",
            "active": true
          },
          "site": {
            "sys_id": "628eec06db7650106c731dcd139619dd",
            "display_value": "North America",
            "active": true
          },
          "campus": {
            "sys_id": "82b2a0cedb3650106c731dcd139619e9",
            "display_value": "California Campus",
            "active": true
          },
          "building": {
            "sys_id": "94e264cedb3650106c731dcd13961919",
            "display_value": "CAL-B1",
            "active": true,
            "timezone": {
              "value": "US/Pacific",
              "displayValue": "US/Pacific"
            }
          },
          "floor": {
            "sys_id": "2f554296dbba10106c731dcd139619ed",
            "display_value": "Floor 2",
            "active": true
          },
          "area": {
            "sys_id": "",
            "display_value": "",
            "active": false
          },
          "reservation": {
            "sys_id": "198a381587b789506342b846dabb3565",
            "number_of_attendees": 1,
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User",
              "user_name": "workplace_user"
            },
            "number": "WRES0001247",
            "active": true
          },
          "number_of_attendees": 1,
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "number": "WRES0001247",
          "requested_for": {
            "sys_id": "2de07e1887cb89106342b846dabb35fe",
            "name": "Workplace User",
            "user_name": "workplace_user"
          }
        },
        "start": "2022-06-11T13:00:00Z",
        "end": "2022-06-11T14:00:00Z",
        "sys_created_on": "2022-05-30T07:06:37Z",
        "sys_updated_on": "2022-05-30T07:06:40Z",
        "source_reservation": {
          "sys_id": "d98a381587b789506342b846dabb3563",
          "display_value": "WRES0001246",
          "name": "WRES0001246"
        },
        "check_in_state": {
          "value": "not_required",
          "display_value": "Not required"
        },
        "external_id": null,
        "external_ical": null,
        "active": true,
        "state": {
          "value": "confirmed",
          "display_value": "Confirmed"
        },
        "sensitivity": {
          "value": "normal",
          "display_value": "Normal"
        },
        "reservation_type": {
          "value": "space",
          "display_value": "Space"
        },
        "reservation_subtype": {
          "value": "occurrence",
          "display_value": "Occurrence"
        },
        "reservation_purpose": {
          "value": "meeting",
          "display_value": "Meeting"
        },
        "attendees": null,
        "number_of_attendees": 1,
        "is_parent": false,
        "subject": "Rec 1",
        "virtual_meeting": null,
        "recording_details": [],
        "sync_state": {
          "value": "not_required",
          "display_value": "Synchronization not required"
        },
        "sub_source": {
          "value": "servicenow_workplace_service_delivery",
          "display_value": "ServiceNow Workplace Service Delivery"
        },
        "last_updated_sub_source": {
          "value": "servicenow_workplace_service_delivery",
          "display_value": "ServiceNow Workplace Service Delivery"
        },
        "reservable_module": {
          "sys_id": "c31241cedb7650106c731dcd13961917",
          "name": "Meeting rooms",
          "title": "Meeting rooms",
          "inline_title": "meeting room",
          "font_awesome_icon": "fa-building",
          "reservable_table": "sn_wsd_core_room",
          "reservable_filter": "active=true^is_reservable=true^building!=6c0364cedb3650106c731dcd13961927^building.is_reservable=true^floor.is_reservable=true^EQ",
          "short_description": "Reserve a meeting room",
          "reservable_type": "location",
          "require_subject": "1",
          "require_cancel_notes": true,
          "virtual_meeting_provider": {
            "sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
            "display_value": "Template"
          },
          "allow_invitees": "1",
          "display_number_of_attendees": "1",
          "display_on_behalf_of": "1",
          "display_sensitivity": "1",
          "max_days_in_future": "180",
          "allow_recurring": "1",
          "allow_whole_day": "1",
          "require_whole_day": null,
          "selection_type": "unit",
          "reservable_container_field": null,
          "reservable_quantity_field": null,
          "apply_to_shift": null,
          "max_occurrences": "180",
          "enable_facet_filter": false,
          "search_limit": 10000,
          "enable_ical_generation": "1",
          "enable_group_reservations": null,
          "enable_browse_near_a_person": "1",
          "enable_browse_by_area": "1",
          "enable_floor_search": "1",
          "display_value": "Meeting rooms",
          "browse_near_a_person_enabled": true,
          "browse_by_area_enabled": true,
          "reservable_columns": [
            "sys_id",
            "external_id",
            "email",
            "name",
            "title",
            "description",
            "image",
            "number",
            "site",
            "campus",
            "building",
            "floor",
            "area",
            "capacity",
            "reservable_quantity",
            "location_type",
            "order",
            "requires_check_in",
            "is_reservable"
          ],
          "layout_mapping": {
            "title": [
              "name"
            ],
            "description": [
              "description"
            ],
            "subtitle": [
              "campus",
              "building",
              "floor",
              "area"
            ],
            "subtitle_asc": [
              "area",
              "floor",
              "building",
              "campus"
            ],
            "image": "image",
            "body": [
              {
                "label": "Capacity",
                "icon": "fa-users",
                "field": "capacity",
                "field_to_display": ""
              },
              {
                "label": "Standard services",
                "icon": "fa-check",
                "field": "standard_services",
                "field_to_display": "name"
              },
              {
                "label": "Reservable purposes",
                "icon": "fa-tags",
                "field": "reservable_purposes",
                "field_to_display": "name"
              }
            ]
          },
          "timeSlots": [],
          "buildingSysIds": [
            "4703a4cedb3650106c731dcd13961945",
            "6c0364cedb3650106c731dcd13961927",
            "94e264cedb3650106c731dcd13961919",
            "9e0364cedb3650106c731dcd1396192b"
          ],
          "reservable_views": [
            {
              "type": "card",
              "label": "Card view",
              "iconClass": "fa-th-large",
              "isDefault": true,
              "order": "1"
            },
            {
              "type": "schedule",
              "label": "Schedule view",
              "iconClass": "fa-calendar-o",
              "isDefault": false,
              "order": "2"
            }
          ],
          "checkin_before_minutes": 30,
          "reservation_paths": [
            {
              "value": "browse_all",
              "displayValue": "Browse all",
              "availableFor": true
            },
            {
              "value": "browse_favorites",
              "displayValue": "Browse favorites",
              "availableFor": false
            },
            {
              "value": "browse_near_a_person",
              "displayValue": "Browse near a person",
              "availableFor": true
            },
            {
              "value": "browse_by_area",
              "displayValue": "Browse by area",
              "availableFor": true
            }
          ],
          "override_approval_policy": "never_required"
        },
        "notification_recipients": null,
        "notification_custom_message": null,
        "opened_by": {
          "sys_id": "2de07e1887cb89106342b846dabb35fe",
          "value": "2de07e1887cb89106342b846dabb35fe",
          "displayValue": "Workplace User",
          "display_value": "Workplace User",
          "name": "Workplace User",
          "user_name": "workplace_user",
          "table": "sys_user",
          "avatar": null,
          "initials": "WU",
          "email": "workplace_user@example.com",
          "label": ""
        },
        "requested_for": {
          "sys_id": "2de07e1887cb89106342b846dabb35fe",
          "value": "2de07e1887cb89106342b846dabb35fe",
          "displayValue": "Workplace User",
          "display_value": "Workplace User",
          "name": "Workplace User",
          "user_name": "workplace_user",
          "table": "sys_user",
          "avatar": null,
          "initials": "WU",
          "email": "workplace_user@example.com",
          "label": ""
        },
        "edit_restriction": {
          "value": "no_restriction",
          "display_value": "No restriction"
        },
        "source": {
          "value": "servicenow",
          "display_value": "Workplace Services"
        },
        "source_reservation_requester": {
          "sys_id": "2de07e1887cb89106342b846dabb35fe",
          "name": "Workplace User",
          "user_name": "workplace_user"
        },
        "source_icon": {
          "classNames": "fa fa-calendar-check-o",
          "tooltip": "Reservation is confirmed",
          "imgSrc": ""
        },
        "shift": null,
        "recurring_pattern": {
          "duration": "3600000",
          "repeats": "daily",
          "options": {
            "count": 3,
            "daysOfWeek": "",
            "every": 1,
            "endDate": "2022-06-13 14:00:00",
            "endDateGdt": {}
          },
          "label": "Repeats daily, 3 times",
          "startDate": "2022-06-11 13:00:00",
          "startDateGdt": "{}",
          "amountOfDates": "3"
        },
        "reservationAcl": {
          "write": {
            "record": true,
            "fields": {
              "subject": true,
              "sensitivity": true,
              "requested_for": true,
              "number_of_attendees": true,
              "location": true
            },
            "allFields": true
          },
          "read": true
        }
      }
    ],
    "occurencesTotalCount": "1"
  }
}

    Reserva recorrente de WSD - PATCH /api/sn_wsd_rsv/recorrente_reservation/cancel_series/

    Cancela uma reserva de série recorrente especificada inteira ou uma ocorrência de reunião específica na série.

    Nota:
    Você não pode excluir várias ocorrências de reunião em uma única chamada.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//recurring_reservation/cancel_series/

    URL padrão: /api/sn_wsd_rsv/recurring_reservation/cancel_series/

    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
    sys_id Para cancelar a série inteira, passe o sys_id do registro de reserva primário recorrente.

    Para cancelar uma ocorrência específica da série, passe o sys_id da ocorrência da série.

    O registro primário recorrente tem a coluna reservation_subtype definida como Primário recorrente . Os registros de ocorrência individual têm o campo reservation_subtipo definido como Ocorrência .

    Para obter os detalhes da reserva primária recorrente do registro de ocorrência, consulte o sys_id do campo source_reservation do registro de ocorrência.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    cancel_notes Motivo para cancelar a reserva.

    Tipo de dados: Cadeia de caracteres
    Tabela 9. 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 10. 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
    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 Retornar resultados da solicitação de cancelamento de reserva recorrente.

    Tipo de dados: Objeto

    "result": {
  "failedToCancelOccurrenceReservations": [Array],
  "seriesId": "String",
  "success": Boolean,
  "successCanceledOccurrences": [Array],
  "user_msg": "String"
}
    FailedToCancelOccurrenceReservations Lista de sys_ids dos registros de ocorrência de reunião individuais que não puderam ser cancelados.

    Tipo de dados: Matriz de cadeias de caracteres
    result.seriesId Sys_id do primário recorrente quando toda a série é cancelada ou o sys_id de uma ocorrência específica se uma única ocorrência for cancelada.

    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: Falha na operação.

    Tipo de dados: Booliano
    FailedToCancelOccurrenceReservations Lista de sys_ids dos registros de ocorrência de reunião individuais que foram cancelados com sucesso.

    Tipo de dados: Matriz de cadeias de caracteres
    result.user_msg Mensagem sobre a solicitação.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo de código a seguir mostra como cancelar uma reserva recorrente inteira.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/recurring_reservation/cancel_series/f64983a347274550003a4587746d43b8" \
--request PATCH \
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--user "username":"password"

    Resultados de retorno:

    {
  "result": {
    "failedToCancelOccurrenceReservations": [],
    "successCanceledOccurrences": [
      "cb4983a347274550003a4587746d43bd",
      "cf4983a347274550003a4587746d43ba"
    ],
    "user_msg": "Your Recurring reservation has been canceled successfully!",
    "seriesId": "f64983a347274550003a4587746d43b8",
    "success": true
  }
}

    Reserva recorrente de WSD - POST /api/sn_wsd_rsv/recorrente_reservation/create_series

    Cria reservas de local de trabalho para o mesmo horário, mas datas diferentes, como semanalmente, mensalmente ou a cada duas semanas.

    Formato de URL

    URL com controle de versão: /api/sn_wsd_rsv//recuring_reservation/create_series

    URL padrão: /api/sn_wsd_rsv/recorrente_reservation/create_series

    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. Parâmetros do corpo da solicitação
    Nome Descrição
    Pattern recurring Detalhes sobre o padrão recorrente da reserva.

    Tipo de dados: Objeto

    "recurringPattern": {
  "duration": Number,
  "label": "String",
  "options": {Object},
  "repeats": "String",
  "startDate": "String"
}
    RecurringPattern.Duração Necessário se não for uma reserva baseada em turno.
    Período de tempo para reservar o reservável.

    Tipo de dados: Número

    Unidade: segundos
    RecurringPattern.label Nome descritivo da reserva recorrente.

    Tipo de dados: Cadeia de caracteres
    RecurringPattern.options Obrigatório.
    Detalhes sobre as opções definidas para o padrão recorrente.

    Tipo de dados: Objeto

    "options": {
  "count": Number,
  "daysOfWeek": "String",
  "every": Number,
  "endDate": "String"
}
    RecurringPattern.options.count Necessário se não for uma reserva baseada em turno; ignorado para reservas baseadas em turno.

    Número de vezes para repetir o padrão.

    Tipo de dados: Número
    RecurringPattern.options.daysOfWeek Necessário se repeatso parâmetro está definido como semanalmente .

    Dias da semana em que o reservável é necessário.

    Valores válidos:
    • Segunda-feira. 1
    • Terça-feira. 2
    • Quarta-feira 3
    • 4: Quinta-feira
    • Sexta-feira 5
    • Sábado. 6
    • Domingo: 7

    Por exemplo, para especificar terça-feira, quinta-feira e sexta-feira, passe 245 (sem delimitador). Se repeats. semanalmente , count. 5 e daysOfWeek. 245 em seguida, nos resultados de retorno, o total é igual a. Count*daysOfWeek.length (5*3-15).

    Tipo de dados: Cadeia de caracteres
    RecurringPattern.options.every Intervalo de repetição do padrão. Por exemplo, o valor "2" indica que o padrão se repete a cada 2 dias ou 2 meses, dependendo do valor de repeatspropriedade.
    Nota:
    Esta configuração não se aplica a intervalos de repetição semanais. Você pode definir repeatspropriedade para diariamente e este valor para 14 para intervalos de repetição quinzenais.

    Tipo de dados: Número

    Valor padrão: 1

    RecurringPattern.options.endDate Data e hora de término da recorrência da reunião, como "2022-07-08T14:00:00Z".

    Tipo de dados: Cadeia de caracteres

    Formato: UTC aaaa-mm-dd hh:mm:ss
    RecurringPattern.Repetições Necessário se não for uma reserva baseada em turno.

    Padrão de repetição para reservável.

    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • diariamente
    • mensal
    • semanalmente
    Nota:
    O intervalo de repetição do padrão é definido em options.everypropriedade. O único intervalo de repetição válido para padrões semanais é um.

    Tipo de dados: Cadeia de caracteres
    RecurringPattern.startDate Obrigatório.
    Data e hora de início do padrão recorrente, como "2022-07-08T14:00:00Z".

    Tipo de dados: Cadeia de caracteres

    Formato: UTC aaaa-mm-dd hh:mm:ss
    reserva Detalhes sobre a reserva recorrente a ser criada.

    Tipo de dados: Objeto

    "reservation": {
  "is_private": Boolean,
  "location": "String",
  "reservable_module": "String",
  "shift": "String",
  "subject": "String"
}
    reservation.is_private 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 de privacidade do local e impacto .

    Valores válidos:
    • Verdadeiro: A reserva é privada.
    • Falso: A reserva não é privada.

    Tipo de dados: Booliano

    Valor definido para privacidade nas propriedades do sistema.
    reservation.location Obrigatório.
    Sys_id do local a ser reservado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Local do local de trabalho [sn_wsd_core_workplace_location]
    reservable_module Obrigatório. Sys_id do módulo reservável a ser associado à reserva. . 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]
    reservation.shift
    Sys_id do turno a ser associado à reserva. Se este parâmetro for passado, o endo parâmetro não é 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: Shift [sn_wsd_core_shift]
    assunto.reservation 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 resposta. Tipos compatíveis: application/jsonou application/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 Retornar resultados da criação ou atualização de várias reservas.

    Tipo de dados: Objeto

    "result": {
  "isValid": Boolean,
  "parent": "String",
  "successfulReservations": [Array],
  "unSuccessfulReservations": [Array]
}
    Result.isValid 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.primário Sys_id da reserva primária que foi atualizada.

    Tipo de dados: Cadeia de caracteres
    Result.successfulReservations Lista de reservas que foram atualizadas com sucesso.

    Tipo de dados: Matriz de objetos

    "successfulReservations": [
  {
    "collision": Boolean,
    "end": "String",
    "error": "String",
    "inserted": Boolean,
    "start": "String"
    "sys_id": "String"
  }
]
    Result.successfulReservations.collision Sinalizador que indica se uma reserva já existe para o horário especificado e colide com a reserva atual.
    Valores possíveis:
    • Verdadeiro: Colisão.
    • Falso: Sem colisão.

    Tipo de dados: Booliano
    Reservas.Bem-sucedidas.Fim Data e hora de término da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC: aaaa-MM-DDThh:mm:ssZ, como 2021-02-05T18:00:00Z
    Result.successfulReservations.ERROR Mensagem de erro se houve um problema ao criar a reserva.

    Tipo de dados: Cadeia de caracteres
    result.successfulReservations.inserted Sinalizador que indica se a reserva foi inserida com sucesso. Quando uma reserva é adicionada.
    Valores possíveis:
    • Inserido com sucesso.
    • Falso: Falha na operação.

    Tipo de dados: Booliano
    ResultadosReservas.Bem-sucedidas.início Data e hora de início da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC - aaaa-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    Result.successfulReservations.sys_id Sys_id da reserva que foi criada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]
    Resultado.Reservas sem sucesso Lista de reservas que não foram atualizadas com sucesso.

    Tipo de dados: Matriz de objetos

    "unSuccessfulReservations": [
  {
    "collision": Boolean,
    "end": "String",
    "error": "String",
    "inserted": Boolean,
    "start": "String"
    "sys_id": "String"
  }
]
    UnSuccessfulReservations.collision Sinalizador que indica se uma reserva já existe para o horário especificado e colide com a reserva atual.
    Valores possíveis:
    • Verdadeiro: Colisão.
    • Falso: Sem colisão.

    Tipo de dados: Booliano
    Reservas.Sem Sucesso.Término Data e hora de término da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC: aaaa-MM-DDThh:mm:ssZ, como 2021-02-05T18:00:00Z
    ResultDeSuccessfulReservations.ERROR Mensagem de erro se houve um problema ao criar a reserva.

    Tipo de dados: Cadeia de caracteres
    result.unSuccessfulReservations.inserted Sinalizador que indica se a reserva foi inserida com sucesso. Quando uma reserva é adicionada.
    Valores possíveis:
    • Inserido com sucesso.
    • Falso: Falha na operação.

    Tipo de dados: Booliano
    InSuccessfulReservations.start Data e hora de início da reserva.

    Tipo de dados: Cadeia de caracteres

    Formato: UTC - aaaa-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    UnSuccessfulReservations.sys_id
    Sys_id do registro de reserva.

    Tipo de dados: Cadeia de caracteres

    Tabela: Reserva do local de trabalho [sn_wsd_rsv_reservation]

    Solicitação de curl

    O exemplo de código a seguir mostra como criar uma reserva recorrente diária por dois dias consecutivos.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/recurring_reservation/create_series" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"reservation\": {
        \"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
        \"subject\": \"Test-123\",
        \"reservation_purpose\": \"meeting\",
        \"timezone\": \"US/Pacific\",
        \"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
        \"location\": \"6a11a94adb7210106c731dcd1396194e\",
        \"attendees\": \"6816f79cc0a8016401c5a33be04be441\",
        \"is_private\": false
    },
    \"recurringPattern\": {
        \"duration\": 3600000,
        \"repeats\": \"daily\",
        \"options\": {
            \"count\": 2,
            \"daysOfWeek\": \"\",
            \"every\": 1
        },
        \"label\": \"Repeats daily, 2 times\",
        \"startDate\": \"2023-01-12T12:00:00Z\"
    }
}" \

    Resultados de retorno:

    {
  "result": {
    "isValid": true,
    "parent": "1e5f65ca87586550cfaa99b73cbb3513",
    "successfulReservations": [
      {
        "inserted": true,
        "collision": false,
        "sys_id": "9e5f65ca87586550cfaa99b73cbb3517",
        "error": null,
        "start": "2023-01-13T12:00:00Z",
        "end": "2023-01-13T13:00:00Z"
      }
    ],
    "unSuccessfulReservations": [
      {
        "inserted": true,
        "collision": true,
        "sys_id": "5e5f65ca87586550cfaa99b73cbb3515",
        "error": null,
        "start": "2023-01-12T12:00:00Z",
        "end": "2023-01-12T13:00:00Z"
      }
    ]
  }
}