API de reserva recorrente do WSD

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 44 min. de leitura

    • A API de reserva recorrentePrestação de serviços no local de trabalho (WSD) 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 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 Gestão de reservas do local de trabalho, consulte Workplace Reservation Management.

    Reserva recorrente do WSD - GET /api/sn_wsd_rsv/recurring_reservation/list/{parent_id}

    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 que os registros de ocorrência não sejam retornados.

    Formato da URL

    URL com controle de versões: /api/sn_wsd_rsv/{api_version}/recurring_reservation/list/{parent_id}

    URL padrão: /api/sn_wsd_rsv/recurring_reservation/list/{parent_id}

    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. Somente especifique este valor 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ária recorrente. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Quando uma reserva recorrente é criada, um registro primário recorrente e um ou mais registros de reserva secundária são criados. Os registros de reserva contêm um campo chamado reserva_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 2. Parâmetros de consulta
    Nome Descrição
    end_index Ao paginar por meio de um conjunto de registros recorrente, 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 inferior a seis, o endpoint retornará todas as ocorrências, caso contrário, ele retornará as primeiras seis 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
    sys_id_ocorrência Sys_id de um registro de ocorrência na série recorrente a não retornar. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].
    start_index Ao paginar por meio de um conjunto de registros recorrente, o número de registro baseado em zero no qual os registros de ocorrência começam a ser retornados.

    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/xml ou, 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de 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 Retornar resultados para a reserva recorrente solicitada.

    Tipo de dados: objeto

    "result": {
 "occurencesTotalCount": "String",
 "reservation": {Object}
}
    result.occurencesTotalCount 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": {OObject},
  "source_reservation_requester": {Object},
  "start": "String",
  "state": {OObject},
  "sys_created_on": "String",
  "sys_id": "String",
  "sys_updated_on": "String",
  "subject": "String",
  "sub_source": {Object},
  "sync_state": {Object},
  "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
    resultado.reserva.participantes 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. Localizado na tabela Anexos [sys_attachment].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.displayValue Valor de exibição para o participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.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
    resultado.reserva.participantes.iniciais Iniciais do participante.

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

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.sys_id Sys_id_of do registro do participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.tabela Tabela na qual existe o registro do participante.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.participantes.nome_usuário 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
    resultado.reserva.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 para o estado de check-in atual da reserva, como Em andamento ou concluído.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.check_in_state.value Valor interno para o 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 full_restricted.

    Tipo de dados: objeto

    "edit_restriction": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.edit_restriction.display_​value Valor de exibição para as 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.reserva.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
    resultado.reserva.externo_ical Identificação iCalendar 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.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
    resultado.reserva.é_primário Sinalizador que indica se esta reserva é uma reserva primária.
    Valores possíveis:
    • verdadeiro: reserva primária.
    • falso: não há uma reserva primária.

    Tipo de dados: booliano
    result.reservation.last_updated_sub_source Detalhes sobre a última suborigem atualizada da reserva. 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 Prestação de serviços no local de trabalho da ServiceNow ou Google Calendar. Usado ao integrar a reserva com um serviço externo, como o calendário do Google ou o Microsoft Outlook.

    Tipo de dados: cadeia de caracteres
    result.reservation.last_updated_sub_source.​value Valor interno da última suborigem atualizada da reserva, como servicenow_workplace_service_delivery ou google_calendar. Usado ao integrar a reserva com um serviço externo, como o calendário do Google ou o Microsoft Outlook.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local 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,
  "reservable_module": {Object},
  "region": {Object},
  "reservation": {Object},
  "site": {Object},
  "requested_for": {Object},
  "state": {Object},
  "sys_id": "String",
}
    resultado.reserva.local.área 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. Localizado na tabela Área [sn_wsd_core_area].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.edifício 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. Localizado na tabela edifício [sn_wsd_core_building].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.prédio.fuso horário Detalhes do fuso horário do edifício.
    "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.​value Valor interno para o fuso horário ao qual este local pertence.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.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 Amsterdã.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.campus.sys_id Sys_id do campus ao qual este local pertence. Localizado na tabela Campus [sn_wsd_core_campus].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.capacidade Número máximo de ocupantes do local.

    Tipo de dados: número
    resultado.reserva.local.descrição Breve descrição do local.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.exibição_valor Valor a ser exibido na IU para este local.

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

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.piso 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 piso está ativo.
    Valores válidos:
    • verdadeiro: o piso está ativo.
    • falso: o piso está inativo.

    Tipo de dados: booliano
    resultado.reserva.local.piso.valor_de_exibição Valor de exibição do andar ao qual este local pertence, como Primeiro andar.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.piso.sys_id Sys_id do andar ao qual este local pertence. Localizado na tabela Piso [sn_wsd_core_chão].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.rótulo_valor Tipo de valor especificado no parâmetro name, como Nome da sala.

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

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.número 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.reservation.location.reservable_module.​name 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.​title Título do módulo reservável.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.região 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. Localizado na tabela Região [sn_wsd_core_region].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.reserva 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.reserva.local.reserva.número Número da reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.reserva.​número_de_participantes 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.

    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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservation.location.reservation.​requested_for.user_name Nome de usuário do usuário para o qual a reserva foi solicitada.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.reserva.​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 para o estado atual da reserva, como confirmado.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.reserva.​.estado.valor Valor interno para o estado atual da reserva, como 2.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.site Site ao qual o local pertence. Localizado na tabela Site [sn_wsd_core_site].

    Tipo de dados: objeto

    "site": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String",
}
    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. Localizado na tabela Site [sn_wsd_core_site].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.padrão_serviços
    resultado.reserva.local.estado 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 para o estado atual da reserva, como confirmado.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.local.estado.valor Valor interno para o estado atual da reserva, como 2.

    Tipo de dados: cadeia de caracteres
    result.reservation.location.sys_id Sys_id do registro de local associado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    result.reservation.notification_custom_​message 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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservation.notification_recipients.​user_name Nome de usuário do destinatário.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.número Número exclusivo do registro de reserva. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation]. Você pode usar este valor para consultar a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.número_de_participantes Número de participantes nesta reserva.

    Tipo de dados: número
    resultado.reserva.aberto_por 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"
}
    resultado.reserva.aberto_por.avatar Avatar do usuário que abriu a reserva.

    Tipo de dados: cadeia de caracteres
    result.reservation.opened_by.displayValue Valor de exibição de aberto pelo usuário.

    Tipo de dados: cadeia de caracteres
    result.reservation.opened_by.display_value Valor de exibição de 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
    resultado.reserva.aberto_por.iniciais 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
    resultado.reserva.aberto_por.nome_usuário Nome de usuário do usuário que abriu a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.aberto_por.valor 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

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

    Tipo de dados: cadeia de caracteres
    resultado.reserva.padrão_recorrente 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.​count

    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:
    • 1 = Segunda-feira
    • 2 = Terça-feira
    • 3 = Quarta-feira
    • 4 = Quinta-feira
    • 5 = Sexta-feira
    • 6 = Sábado
    • 7 = Domingo

    Por exemplo, para especificar terça, quinta e sexta-feira, passe 245 (sem delimitador). Se repeats for semanal, count for 5e daysOfWeek for 245, nos resultados retornados, o total será igual a count*daysOfWeek.length (5*3=15).

    Tipo de dados: cadeia de caracteres
    result.reservation.recurring_pattern.options.​every Intervalo de repetição de padrão. Por exemplo, o valor '2' indica que o padrão se repete a cada 2 dias ou 2 meses, dependendo do valor da propriedade repeats.
    Nota:
    Esta configuração não se aplica a intervalos de repetição semanais. Você pode definir a propriedade repeats como diária e este valor como 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, como "2022-07-08T14:00:00Z".

    Tipo de dados: cadeia de caracteres

    Formato: UTC aaaa-mm-dd hh:mm:ss
    result.reservation.recurring_pattern.repeats

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

    Valores válidos: (diferencia maiúsculas de minúsculas)
    • diariamente
    • mensal
    • semanal
    Nota:
    O intervalo de repetição de padrão é definido na propriedade options.every. 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
    resultado.reserva.solicitada_para Detalhes sobre o usuário para o qual a reserva foi feita.

    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"
}
    resultado.reserva.solicitado_para.avatar Avatar do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    result.reservation.requested_for.displayValue Valor de exibição do usuário para o qual a reserva foi feita.

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

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

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitada_para.iniciais Iniciais do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitada_para.rótulo Rótulo para o 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 para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    result.rservation.requested_for.sys_id Sys_id_of do usuário para o qual a reserva foi feita. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.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 para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.solicitado_para.valor Valor interno do usuário para o qual a reserva foi feita.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.módulo_reservado 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": {JSON 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.reservation.reservable_module.​allow_invitees Sinalizador que indica se os funcionários podem adicionar convidados à reserva.
    Valores válidos:
    • verdadeiro: permite que os funcionários adicionem convidados à reserva.
    • falso: não permite que os funcionários adicionem convidados à reserva.

    Tipo de dados: booliano
    result.reservation.reservable_module.​allow_whole_day Sinalizador que indica se os usuários podem reservar o reservável pelo dia inteiro.
    Valores válidos:
    • verdadeiro: permite que os usuários reservem o dia inteiro.
    • falso: não permite que os usuários reservem o dia inteiro.

    Tipo de dados: booliano
    result.reservation.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: permite reservas baseadas em turno.
    • falso: não permite reservas baseadas em turno.

    Tipo de dados: booliano
    result.reservation.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: permite que os usuários pesquisem módulos reserváveis por área.
    • falso: não permite que os usuários pesquisem módulos reserváveis por área.

    Tipo de dados: booliano
    result.reservation.reservable_module.​browse_near_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: permite que os usuários naveguem pelos módulos reserváveis próximos a uma pessoa.
    • falso: não permite que os usuários naveguem pelos módulos reserváveis perto de uma pessoa.

    Tipo de dados: booliano
    result.reservation.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.reservation.reservable_module.​checkin_before_minutes Quantidade de tempo antes do início de uma reserva em que um usuário pode fazer check-in na reserva.

    Unidade: minutos

    Tipo de dados: número
    result.reservation.reservable_module.​display_number_of_appers 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.reservation.reservable_module.​display_on_behalf_of Sinalizador que indica se as reservas podem ser feitas em nome de outra pessoa.
    Valores válidos:
    • verdadeiro: em nome de com suporte.
    • falso: em nome de sem suporte.

    Tipo de dados: booliano
    result.reservation.reservable_module.​display_sensibility Sinalizador que indica se os usuários podem definir a confidencialidade da reserva, como normal ou privada.
    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.reservation.reservable_module.​display_value Valor de exibição do módulo reservável.

    Tipo de dados: cadeia de caracteres
    result.reservation.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: permite que os usuários pesquisem módulos reserváveis por área.
    • falso: não permite que os usuários pesquisem módulos reserváveis por área.

    Tipo de dados: booliano
    result.reservation.reservable_module.​enable_browse_near_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: permite que os usuários naveguem pelos módulos reserváveis próximos a uma pessoa.
    • falso: não permite que os usuários naveguem pelos módulos reserváveis perto de uma pessoa.

    Tipo de dados: booliano
    result.reservation.reservable_module.​enable_facet_filter Sinalizador que indica se a filtragem de aspecto nos itens do local de trabalho está habilitada. Quando habilitadas, as opções de filtro que aparecem 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 selecionarem 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.reservation.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.reservation.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.
    • falso: a geração de iCalendar não é permitida.

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

    Tipo de dados: cadeia de caracteres
    result.reservation.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.reservation.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.reservation.reservable_module.​layout_mapping.body Espaço reservado para mapear os dados da IU de front-end.

    Tipo de dados: matriz de objetos

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

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

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

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

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

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

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

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

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

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

    Tipo de dados: número
    result.reservation.reservable_module.​max_occurrences 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.reservation.reservable_module.​override_approval_policy Opção para especificar como implementar a política de aprovação. Estas são as opções:
    • Sem substituição: a política de aprovação é implementada conforme definido no campo Requer aprovação de um espaço ou sala de local de trabalho.
    • Sempre exigir aprovação: a política de aprovação é necessária independentemente do que está definido no campo Requer aprovação de um espaço ou sala de local de trabalho.
    • Nunca exigir aprovação: a política de aprovação é removida independentemente do que está definido no campo Requer aprovaçãol de um espaço ou sala de local de trabalho.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​require_cancel_notes Sinalizador que indica se os usuários devem inserir uma nota de cancelamento antes de cancelar um módulo reservável.
    Valores válidos:
    • verdadeiro: aviso de cancelamento necessário.
    • falso: nota de cancelamento não necessária.

    Tipo de dados: booliano
    result.reservation.reservable_module.​require_cc_dept_check Sinalizador que indica se deve ser verificado 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á uma incompatibilidade.
    • falso: não verifica se há incompatibilidade.

    Tipo de dados: booliano
    result.reservation.reservable_module.​require_subject Sinalizador que indica se o usuário deve inserir um assunto ao fazer a reserva.
    Valores válidos:
    • verdadeiro: assunto necessário.
    • falso: o assunto não é necessário.

    Tipo de dados: booliano
    result.reservation.reservable_module.​reservable_columns Lista das colunas de um reservável. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: matriz
    result.reservation.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
    result.reservation.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 no campo Tabela reservável.

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

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

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​reservable_type Tipo do item reservável, como local.

    Tipo de dados: cadeia de caracteres
    result.reservation.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.

    Localizado na tabela Exibição reservável [sn_wsd_rsv_reservable_view].

    Tipo de dados: objeto

    "reservable_views": {
  "iconClass": "String",
  "isDefault": Boolean,
  "label": "String",
  "order": Number,
  "type": "String"
}
    result.reservation.reservable_module.​reservable_views.iconClass Classe de ícone da exibição reservável.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​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: tornar padrão.
    • falso: não tornar padrão.

    Tipo de dados: booliano
    result.reservation.reservable_module.​reservable_views.label Nome da exibição reservável.

    Tipo de dados: cadeia de caracteres
    result.reservation.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 de o mesmo número de ordem, ele é atribuído à ordem aleatória.

    Tipo de dados: número
    result.reservation.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.reservation.reservable_module.​reservation_paths Caminhos de reserva associados aos módulos reserváveis, como Procurar tudo, Procurar próximo a uma pessoa.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​reservation_paths.value Valor interno para o caminho da reserva, como "browse_near_a_person".

    Tipo de dados: cadeia de caracteres
    result.reservation.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.reservation.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 todos os itens do local de trabalho.
    • Contêiner: o resultado da pesquisa exibe o primário ou o contêiner dos itens do local de trabalho.

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

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​show_map_view Sinalizador que indica se a exibição do mapa deve ser habilitada para módulos reserváveis.
    Valores válidos:
    • verdadeiro: habilitar exibição de mapa.
    • falso: não habilita a exibição do mapa.

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

    Tipo de dados: cadeia de caracteres
    result.reservation.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.reservation.reservable_module.​timeSlots.name Nome do intervalo de tempo.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.short_description Breve descrição do intervalo de tempo.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.slot_end Hora de término do intervalo de tempo.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.slot_start Hora de início do slot.

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.​timeSlots.sys_id Sys_id do registro do intervalo de tempo.

    Localizado na tabela Intervalo de tempo [sn_wsd_rsv_time_slot].

    Tipo de dados: cadeia de caracteres
    result.reservation.reservable_module.title Título do módulo reservável.

    Tipo de dados: cadeia de caracteres
    result.reservation.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.reservation.reservable_module.​virtual_meeting_provider.display_value Valor de exibição do provedor de reunião virtual.

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

    Tipo de dados: cadeia de caracteres
    result.reservation.reservationAcl 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 deve ser verificado se o usuário pode ler esta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode ler a reserva.
    • falso: não verifica se o usuário pode ler a reserva.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write Detalhes sobre as capacidades de gravação do usuário para a reserva associada.

    Tipo de dados: objeto

    "write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
    result.reservation.reservationAcl.write.allFields Sinalizador que indica se deve ser verificado se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields. Se o usuário só tiver acesso a alguns campos específicos, somente esses campos serão verdadeiros no objeto reservationACL.write.fields.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields.
    • falso: não verifica se o usuário pode gravar em todos os campos especificados no objeto reservationACL.write.fields

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields 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.reservation.reservationAcl.write.fields.​location Sinalizador que indica se o usuário deve verificar se 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 verifica se o usuário pode gravar nos campos de local.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​número_de_participantes Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de número de participantes nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de número de participantes.
    • falso: não verifica se o usuário pode gravar no campo de número de participantes.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​requested_for Sinalizador que indica se o usuário deve verificar se pode gravar nos campos solicitados nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo solicitado para.
    • falso: não verifica se o usuário pode gravar no campo solicitado para.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​sensibilidade Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de confidencialidade nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de confidencialidade.
    • falso: não verifica se o usuário pode gravar no campo de confidencialidade.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.fields.​assunto Sinalizador que indica se o usuário deve verificar se pode gravar nos campos de assunto nesta reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar no campo de assunto.
    • falso: não verifica se o usuário pode gravar nos campos de assunto.

    Tipo de dados: booliano
    result.reservation.reservationAcl.write.record Sinalizador que indica se deve ser verificado se o usuário pode gravar em todo o registro de reserva.
    Valores válidos:
    • verdadeiro: verifique se o usuário pode gravar em todo o registro de reserva.
    • falso: não verifica se o usuário pode gravar em todo o registro de reserva.

    Tipo de dados: booliano
    resultado.reserva.propósito_de_reserva Detalhes sobre a finalidade da reserva.

    Tipo de dados: objeto

    "reservation_purpose": {
  "display_value": "String,"
  "value": "String"
}
    resultado.reserva.reserva_propósito.​display_value Valor de exibição para fins de reserva, como reunião da empresa.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_propósito.valor Valor interno para fins de reserva, como company_meeting.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.tipo_de_reserva Detalhes sobre o tipo da reserva.

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres
    resultado.reserva.tipo_de_reserva.valor Valor interno para o tipo de reserva, como espaço.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_subtipo Detalhes sobre o subtipo da reserva. Os subtipos indicam o tipo de reserva, como única, primária múltipla, secundária múltipla, primária recorrente ou ocorrência.

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_subtipo.valor Valor interno para o subtipo da reserva, como único.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sensibilidade Detalhes sobre a confidencialidade da reserva.

    Tipo de dados: objeto

    "sensitivity": {
  "display_value": "String,"
  "value": "String"
}
    resultado.reserva.sensibilidade.display_value Valor de exibição para a confidencialidade da reserva, como alta ou baixa.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sensibilidade.valor Valor interno para a confidencialidade da reserva, como 1 ou 3.

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

    Tipo de dados: objeto

    "shift": {
  "display_value": "String",
  "name": "String",
  "shiftDetails": "String",
  "sys_id": "String"
}
    result.reserva.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
    Resultado.reserva.turno.DetalhesDeMundo Detalhes do turno.

    Tipo de dados: cadeia de caracteres
    result.reservation.shift.sys_id Sys_id do registro de turno. Localizado na tabela Turno [sn_wsd_core_shift].

    Tipo de dados: cadeia de caracteres
    resultado.reserva.origem Detalhes sobre a origem da reserva, como Serviços de 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 para a origem da reserva, como Serviços de local de trabalho.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.valor.origem Valor interno para a 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írgula 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 da ferramenta associada ao ícone de origem.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reserva_origem 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. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres
    result.reservation.source_reservation_​solicitante O 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 da 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. Localizado na tabela Usuário [sys_user].

    Tipo de dados: cadeia de caracteres
    result.reservation.source_reservation_​requester.user_name Nome de usuário do solicitante da reserva recorrente.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.início Data e hora de início da reserva.

    Tipo de dados: cadeia de caracteres

    Formato: UTC - yyyy-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    resultado.reserva.estado 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 para o estado atual da reserva, como confirmado.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.estado.valor Valor interno para o estado atual da reserva, como 2.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.assunto Assunto da reserva.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sub_origem Detalhes sobre a suborigem da reserva. A suborigem especifica a origem da reserva, como Google Calendar ou Microsoft Exchange.

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sub_origem.valor Valor interno do campo de suborigem da reserva, como google_calendar.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sincronização_estado Detalhes sobre o estado de sincronização de uma reserva de outro serviço, como "sync_enqueued" ou "synchronized".

    Tipo de dados: objeto

    "sync_state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.sync_state.display_value Valor de exibição para o 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
    resultado.reserva.sys_created_on Data e hora em que a reserva foi criada.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.sys_id
    Sys_id do registro de reserva. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres
    Resultado.reserva.sys_updated_on Data e hora em que a reserva foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres
    resultado.reserva.reunião_virtual 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"

    Retornar resultados:

    {
  "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 do WSD - PATCH /api/sn_wsd_rsv/recurring_reservation/cancel_series/{sys_id}

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

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

    Formato da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/recurring_reservation/cancel_series/{sys_id}

    URL padrão: /api/sn_wsd_rsv/recurring_reservation/cancel_series/{sys_id}

    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 acessada. Por exemplo, v1 ou v2. Somente especifique este valor 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ária recorrente. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    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 reserva_subtype definida como Primário recorrente. Os registros de ocorrências individuais têm o campo reserva_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 8. Parâmetros de consulta
    Nome Descrição
    cancel_notas Motivo do cancelamento da 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/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 12. 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 Retornar resultados para a solicitação de cancelamento de reserva recorrente.

    Tipo de dados: objeto

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

    Tipo de dados: matriz de cadeias de caracteres
    resultado.seriesId Sys_id do primário recorrente quando a série inteira é cancelada ou o sys_id de uma ocorrência específica se uma única ocorrência é 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
    result.failedToCancelOccurrenceReservations Lista de sys_ids dos registros de ocorrência de reunião individual que foram cancelados com sucesso.

    Tipo de dados: matriz de cadeias de caracteres
    resultado.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"

    Retornar resultados:

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

    Reserva recorrente do WSD - POST /api/sn_wsd_rsv/recurring_reservation/create_series

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

    Formato da URL

    URL com controle de versão: /api/sn_wsd_rsv/{api_version}/recurring_reservation/create_series

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

    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 acessada. Por exemplo, v1 ou v2. Somente especifique este valor 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
    PadrãoRecorrente Detalhes sobre o padrão recorrente da reserva.

    Tipo de dados: objeto

    "recurringPattern": {
  "duration": Number,
  "label": "String",
  "options": {Object},
  "repeats": "String",
  "startDate": "String"
}
    PadrãoRecorrente.duração Obrigató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
    Rótulo.PadrãoRecorrente Nome descritivo da reserva recorrente.

    Tipo de dados: cadeia de caracteres
    RecursingPattern.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"
  }
    RecorrentePadrão.opções.contagem Obrigató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
    PadrãoRecorrente.opções.diasDaSemana Obrigatório se o parâmetro repeats estiver definido como semanalmente.

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

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

    Por exemplo, para especificar terça, quinta e sexta-feira, passe 245 (sem delimitador). Se repeats for semanal, count for 5e daysOfWeek for 245, nos resultados retornados, o total será igual a count*daysOfWeek.length (5*3=15).

    Tipo de dados: cadeia de caracteres
    recorrentePattern.options.every Intervalo de repetição de padrão. Por exemplo, o valor '2' indica que o padrão se repete a cada 2 dias ou 2 meses, dependendo do valor da propriedade repeats.
    Nota:
    Esta configuração não se aplica a intervalos de repetição semanais. Você pode definir a propriedade repeats como diária e este valor como 14 para intervalos de repetição quinzenais.

    Tipo de dados: número

    Valor padrão: 1

    recorrentePadrão.opções.DataTérmino 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
    PadrãoRecorrente.repetidos Obrigatório se não for uma reserva baseada em turno.

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

    Valores válidos: (diferencia maiúsculas de minúsculas)
    • diariamente
    • mensal
    • semanal
    Nota:
    O intervalo de repetição de padrão é definido na propriedade options.every. O único intervalo de repetição válido para padrões semanais é um.

    Tipo de dados: cadeia de caracteres
    PadrãoRecorrente.DiaDeInício 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"
}
    reserva.é_privado 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 e impacto da privacidade do local.

    Valores válidos:
    • verdadeiro: a reserva é privada.
    • falso: a reserva não é privada.

    Tipo de dados: booliano

    Padrão: valor definido para privacidade nas propriedades do sistema.
    reserva.local Obrigatório.
    Sys_id do local a ser reservado. Localizado na tabela Local do local de trabalho [sn_wsd_core_workplace_location].

    Tipo de dados: cadeia de caracteres
    reserva.módulo_reservado Obrigatório. Sys_id do módulo reservável a ser associado à reserva. Um módulo reservável define os itens do local de trabalho necessários para uma reserva. Localizado na tabela Módulo reservável [sn_wsd_rsv_reservable_module].

    Tipo de dados: cadeia de caracteres
    reserva.turno
    Sys_id do turno a ser associado à reserva. Localizado na tabela Turno [sn_wsd_core_shift]. Se este parâmetro for passado, o parâmetro end não será necessário.

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

    Tipo de dados: cadeia de caracteres
    reserva.assunto 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/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 18. 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 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
}
    resultado.éVálido 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
    resultado.Reservasbem-sucedidas Lista das 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"
  }
]
    resultado.Reservas.Sucesso.Colisão Sinalizador que indica se uma reserva já existe para o tempo especificado e colide com a reserva atual.
    Valores possíveis:
    • verdadeiro: colisão.
    • falso: nenhuma colisão.

    Tipo de dados: booliano
    resultado.reservas.bem-sucedidas.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
    resultado.Reservas.Sucesso.erro Mensagem de erro se houver um problema ao criar a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.Reservas.Sucesso.Inserido Sinalizador que indica se a reserva foi inserida com sucesso. Como quando uma reserva é adicionada.
    Valores possíveis:
    • verdadeiro: inserido com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    resultado.reservas.bem-sucedidas.início Data e hora de início da reserva.

    Tipo de dados: cadeia de caracteres

    Formato: UTC - yyyy-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    result.successfulReservations.sys_id Sys_id da reserva que foi criada. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres
    result.unSuccessfulReservations Lista das reservas que foram atualizadas sem sucesso.

    Tipo de dados: matriz de objetos

    "unSuccessfulReservations": [
  {
    "collision": Boolean,
    "end": "String",
    "error": "String",
    "inserted": Boolean,
    "start": "String"
    "sys_id": "String"
  }
]
    result.unSuccessfulReservations.collision Sinalizador que indica se uma reserva já existe para o tempo especificado e colide com a reserva atual.
    Valores possíveis:
    • verdadeiro: colisão.
    • falso: nenhuma colisão.

    Tipo de dados: booliano
    result.unSuccessfulReservations.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.unSuccessfulReservations.error Mensagem de erro se houver um problema ao criar a reserva.

    Tipo de dados: cadeia de caracteres
    resultado.ReservasSemÊxito.Inserido Sinalizador que indica se a reserva foi inserida com sucesso. Como quando uma reserva é adicionada.
    Valores possíveis:
    • verdadeiro: inserido com sucesso.
    • falso: falha na operação.

    Tipo de dados: booliano
    result.unSuccessfulReservations.start Data e hora de início da reserva.

    Tipo de dados: cadeia de caracteres

    Formato: UTC - yyyy-mm-ddThh:mm:ssZ, como 2021-02-05T18:00:00Z
    result.unSuccessfulReservations.sys_id
    Sys_id do registro de reserva. Localizado na tabela Reserva de local de trabalho [sn_wsd_rsv_reservation].

    Tipo de dados: cadeia de caracteres

    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\"
    }
}" \

    Retornar resultados:

    {
  "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"
      }
    ]
  }
}