Appointment em aberto

. Compromisso em aberto A API é uma API de telecomunicações que permite interagir com o aplicativo de reserva de compromisso. Use esta API para reservar compromissos e pesquisar intervalos de tempo disponíveis.

. Compromisso em aberto A API é um ServiceNow® A implementação da API aberta TMForum TMF646 API REST API e tem certificação de conformidade pelo TM Forum. Esta implementação é baseada em Especificação REST da API de compromisso TMF646 R16.0.1 .

Esta API requer os seguintes plug-ins disponíveis no ServiceNow Store.

• Agendamento de compromisso (com.snc.appointment_booking)
• Gestão de serviços de campo (com.snc.work_management)
• Gestão de serviços de campo para telecomunicações (com.sn_fsmt)
• Telecomunicações em aberto (com.sn_tmf_api)

Antes de usar esta API, a Configuração de Agendamentos e a Configuração de serviço devem ser configuradas. Uma tarefa para a qual o compromisso está sendo reservado deve existir.

Esta API é fornecida no sn_tmf_api namespace. O usuário chamador deve ter a função sn_tmf_api.appointment_integrator.

Compromisso em aberto - OBTENHA /api/sn_tmf_api/appointment/searchTimeSlot

Retorna intervalos de tempo que foram configurados na configuração do serviço de reserva de compromisso junto com sua disponibilidade.

Formato de URL

/api/sn_tmf_api/appointment/searchTimeSlot

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 2. Parâmetros de consulta

Nome	Descrição
catalog_id	Obrigatório. Sys_id do produtor de registro configurado com uma configuração de serviço de reserva de compromisso. Tipo de dados: Cadeia de caracteres Tabela: Produtor de registro [sc_cat_item_producer]
end_date	Obrigatório. Data e hora de término do período no qual você deseja pesquisar o compromisso. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 12:00:00 .
local	Sys_id do local do compromisso. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os locais, se não for especificado.
opened_for	Obrigatório. Sys_id do usuário para o qual o compromisso está sendo reservado. Tabela: Contato [customer_contact] Tipo de dados: Cadeia de caracteres
start_date	Obrigatório. Data e hora de início do período em que você deseja pesquisar o compromisso. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:00:00 .

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 resposta. Oferece suporte somente a 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.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
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
AvailableTimeSlot	Lista de intervalos de compromisso no bloco especificado de tempo solicitado. Tipo de dados: Matriz de objetos 'availableTimeSlot': [ { "available": Boolean, "end_date": "String", "end_date_display": "String", "end_dateUTC": "String", "start_date": "String", "start_date_display": "String", "start_dateUTC": "String" } ]
AvailableTimeSlot.Available	Sinalizador que indica se o intervalo de tempo associado está disponível. Valores possíveis: Verdadeiro: O intervalo de tempo está disponível. Falso: O intervalo de tempo não está disponível. Tipo de dados: Booliano
TimeSlot.end_date	Data e hora de término do compromisso associado. O fuso horário é baseado no valor em timeZoneparâmetro. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
TimeSlot.end_date_display	Exibir data e hora de término do compromisso associado. O fuso horário é baseado no valor em timeZoneparâmetro. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
TimeSlot.end_dateUTC	Data e hora de término do compromisso associado. Tipo de dados: Cadeia de caracteres Formato: UTC
TimeSlot.start_date	Data e hora de início do compromisso associado. Reflete o valor de timeZoneparâmetro. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
TimeSlot.start_date_display	Exibir data e hora de início do compromisso associado. Reflete o valor de timeZoneparâmetro. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
TimeSlot.start_dateUTC	Data e hora de início do compromisso associado. Tipo de dados: Cadeia de caracteres Formato: UTC
hasMore	Sinalizador que indica se há mais slots de compromisso para buscar depois de retornar o limite. O limite é especificado na propriedade Agendamento de compromisso, sn_apptmnt_booking.max_appointments_returned (padrão: 100). Consulte Appointment booking components para obter mais detalhes sobre esta propriedade. Valores possíveis: Verdadeiro: Mais slots de compromisso podem ser obtidos. Falso: Não há mais slots de compromisso disponíveis. Tipo de dados: Booliano
NoApptDisponível	Sinalizador que indica se há mais slots de compromisso disponíveis para a data e hora especificadas. Valores válidos: Verdadeiro: Mais slots de compromisso estão disponíveis para a data e hora especificadas. Falso: Não há mais slots de compromisso disponíveis para a data e hora especificadas. Tipo de dados: Booliano
Result de pesquisa	Resultados para disponibilidade de compromisso no intervalo de tempo de pesquisa designado. Valores possíveis: êxito falha Tipo de dados: Cadeia de caracteres
status	Status de conclusão da pesquisa de intervalos de tempo disponíveis. Por exemplo, Concluído. Tipo de dados: Cadeia de caracteres
fuso horário	Fuso horário usado ao reservar ou atualizar o intervalo de compromisso especificado. Tipo de data: Cadeia de caracteres Formato: Formato de país/cidade ou área, como EUA/Leste

Solicitação de curl

O exemplo de código a seguir mostra como chamar este endpoint.

curl --location --request GET 'https://instance.service-now.com/api/sn_tmf_api/appointment/searchTimeSlot?
start_date=2024-07-10 09:00:00&end_date=2024-07-20 23:00:00&catalog_id=ada50a93f0220210f8776517d8c8e776&
opened_for=51670151c35420105252716b7d40ddfe&location=f48b21850a0a0ba7004182b18099696d ' \
--user 'username':'password'

Resultado:

{
  "searchResult": "success",
  "status": "done",
  "availableTimeSlot": [
    {
      "start_date": "2024-07-10 09:00:00",
      "end_date": "2024-07-10 12:00:00",
      "start_date_display": "09:00",
      "end_date_display": "12:00",
      "start_dateUTC": "2024-07-10 16:00:00",
      "end_dateUTC": "2024-07-10 19:00:00",
      "available": false
    },
    {
      "start_date": "2024-07-11 13:00:00",
      "end_date": "2024-07-11 16:00:00",
      "start_date_display": "13:00",
      "end_date_display": "16:00",
      "start_dateUTC": "2024-07-11 20:00:00",
      "end_dateUTC": "2024-07-11 23:00:00",
      "available": true
    },
    {
      "start_date": "2024-07-12 09:00:00",
      "end_date": "2024-07-12 12:00:00",
      "start_date_display": "09:00",
      "end_date_display": "12:00",
      "start_dateUTC": "2024-07-12 16:00:00",
      "end_dateUTC": "2024-07-12 19:00:00",
      "available": true
    },
    {
      "start_date": "2024-07-12 13:00:00",
      "end_date": "2024-07-12 16:00:00",
      "start_date_display": "13:00",
      "end_date_display": "16:00",
      "start_dateUTC": "2024-07-12 20:00:00",
      "end_dateUTC": "2024-07-12 23:00:00",
      "available": true
    },
    {
      "start_date": "2024-07-19 13:00:00",
      "end_date": "2024-07-19 16:00:00",
      "start_date_display": "13:00",
      "end_date_display": "16:00",
      "start_dateUTC": "2024-07-19 20:00:00",
      "end_dateUTC": "2024-07-19 23:00:00",
      "available": true
    }
  ],
  "hasMore": false,
  "noApptAvailable": false,
  "timeZone": "US/Arizona"
}

Compromisso em aberto - POST /api/sn_tmf_api/appointment/appointment

Permite que você marque compromissos para uma ordem de serviço.

Formato de URL

/api/sn_tmf_api/appointment/appointment

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 8. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 9. Parâmetros do corpo da solicitação

Nome	Descrição
categoria	Obrigatório. Sys_id do produtor de registro configurado para a configuração do serviço de reserva de compromisso. Tipo de dados: Cadeia de caracteres Tabela: No campo Item do catálogo da tabela Configuração do serviço de agendamentos [sn_apptmnt_booking_service_config].
RelatedEntity	Obrigatório. Lista de ordens de serviço afetadas a serem associadas ao compromisso. Tipo de dados: Matriz de objetos "relatedEntity": [ { "@referredType": "String" "id": "String", } ]
ReferredEntity. Em referredType	Obrigatório. Tipo de item ou serviço. Somente valor válido: Ordem de serviço Tipo de dados: Cadeia de caracteres Tabela: Ordem de serviço [wm_order]
relatedEntity.id	Obrigatório. Sys_id da entidade relacionada. Tipo de dados: Cadeia de caracteres Tabela: Ordem de serviço [wm_order] Padrão: Retorna tudo se o sys_id não for fornecido.
RelatedEntity.role	Obrigatório. Descrição da função da entidade relacionada. Somente valor válido: Ordem de serviço Tipo de dados: Cadeia de caracteres Tabela: Ordem de serviço [wm_order]
RelatedParty	Obrigatório. Lista de contatos do compromisso. Cada contato é um objeto na matriz. A solicitação deve listar pelo menos um item que contém informações da conta do cliente. Tipo de dados: Matriz de objetos "relatedParty": [ { "@referredType": "String", "id": "String", "name": "String", "role": "String" } ]
RelatedParty. Em referredType	Tipo de cliente. Somente valor válido: Individual Tipo de dados: Cadeia de caracteres
relatedParty.id	Obrigatório. Sys_id ou external_id do contato associado à ordem de serviço. Tipo de dados: Cadeia de caracteres Tabela: Contato [customer_contact]
relatedParty.name	Nome do contato. Tipo de dados: Cadeia de caracteres Tabela: Contato [customer_contact]
RelatedParty.role	Obrigatório. Função do contato. Valores possíveis: Cliente: O contato tem uma função de cliente. Técnico: O contato tem uma função de técnico. Tipo de dados: Cadeia de caracteres Tabela: Contato [customer_contact]
RelatedPlace	Obrigatório. Lista de locais relacionados ao compromisso. Tipo de dados: Matriz de objetos "relatedPlace": [ { "@referredType": "String", "id": "String", "name": "String", "role": "String" } ]
RelatedPlace. Em referredType	Obrigatório. Tipo de local. Por exemplo, Cidade. Tipo de dados: Cadeia de caracteres Tabela: Locais [cmn_location]
relatedPlace.id	Obrigatório. Sys_id do local relacionado. Tipo de dados: Cadeia de caracteres Tabela: Locais [cmn_location]
relatedPlace.name	Nome do local relacionado ao contato. Por exemplo, 251 Reddy St, Darwin, CA 93522. Tipo de dados: Cadeia de caracteres Tabela: Locais [cmn_location]
RelatedPlace.role	Obrigatório. Descrição da função do local. Por exemplo, Ordem de serviço. Tipo de dados: Cadeia de caracteres
fuso horário	Obrigatório. Fuso horário a ser usado ao reservar o intervalo de compromisso especificado. Tipo de data: Cadeia de caracteres Formato: Formato de país/cidade ou área, como EUA/Leste
ValidFor	Obrigatório. Intervalo de datas para o qual o compromisso é válido. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Obrigatório. Data e hora de término do intervalo de tempo. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
ValidFor.startDateTime	Obrigatório. Data e hora de início do intervalo de tempo. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.

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. Oferece suporte somente a application/json.

Tabela 11. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte 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.
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
categoria	Sys_id do produtor de registro configurado para a configuração do serviço de reserva de compromisso. Tipo de dados: Cadeia de caracteres Armazenado em: Campo Item do catálogo da tabela Configuração do serviço de agendamentos [sn_apptmnt_booking_service_config].
creationDate	Data e hora em que o compromisso foi criado. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
href	Hiperlink para o registro do compromisso. Use este link em outra solicitação de API em aberto de compromisso para reagendar ou excluir o compromisso. Tipo de dados: Cadeia de caracteres
id	Sys_id do compromisso. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Configuração do serviço de agendamentos [sn_apptmnt_booking_service_config]
LastUpdate	Data e hora em que o compromisso foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
RelatedEntity	Detalhes sobre a entidade relacionada do compromisso. Tipo de dados: Matriz de objetos "relatedEntity": [ { "@referredType": "String", "id": "String", "role": "String" } ]
ReferredEntity. Em referredType	Tipo de item ou serviço. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Ordem de serviço [wm_order]
RelatedEntity.id	Sys_id da entidade relacionada. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Ordem de serviço [wm_order]
RelatedEntity.role	Descrição da função da entidade relacionada. Valor possível: Ordem de serviço Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Ordem de serviço [wm_order]
RelatedParty	Lista de contatos do compromisso. Cada contato é um objeto na matriz. Tipo de dados: Matriz de objetos "relatedParty": [ { "@referredType": "String", "id": "String", "name": " String", "role": "String" } ]
RelatedParty. Em referredType	Tipo de cliente. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
IdentidadeRelatedParty.id	Sys_id do contato do cliente associado à ordem de serviço. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
relatedParty.name	Nome do contato do cliente. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
RelatedParty.role	Função do contato do cliente. Valores possíveis: Cliente: O contato tem uma função de cliente. Técnico: O contato tem uma função de técnico. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
RelatedPlace	Detalhes do local do compromisso associado. Tipo de dados: Objeto "relatedPlace": { "@referredType": "String", "id": "String", "name": "String", "role": "String" }
RelatedPlace. Em referredType	Endereço geográfico do compromisso. Valor possível: GeographicLocation. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
RelatedPlace.id	Sys_id do local. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
relatedPlace.name	Nome do local relacionado ao contato. Por exemplo, 100 South Charles Street, Baltimore, MD. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
RelatedPlace.role	Função do local do compromisso como um endereço de intervenção. Valor possível: InterventionAddress Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
êxito	Sinalizador que indica se a solicitação foi bem-sucedida. Valores possíveis: Verdadeiro: Solicitação bem-sucedida. Falso: Falha na solicitação. Tipo de dados: Booliano
fuso horário	Fuso horário usado ao reservar ou atualizar o intervalo de compromisso especificado. Tipo de data: Cadeia de caracteres Formato: Formato de país/cidade ou área, como EUA/Leste
ValidFor	Intervalo de datas para o qual o compromisso é válido. Tipo de dados: Objeto "validFor": { "endDateTime": "String" "startDateTime": "String" }
ValidFor.endDateTime	Data e hora de término do compromisso. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
ValidFor.startDateTime	Data e hora de início do compromisso. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.

Solicitação de curl

O exemplo a seguir mostra como criar uma nova reserva de compromisso.

curl "https://instance.servicenow.com/api/sn_tmf_api/appointment/appointment" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"validFor\": {
    \"startDateTime\": \"2024-08-19 09:00:00\",
    \"endDateTime\": \"2024-08-19 11:00:00\"
  },
  \"category\": \"e4c1116b3b810300ce8a4d72f3efc40f\",
  \"relatedParty\": [
    {
      \"id\": \"eaf68911c35420105252716b7d40ddde\",
      \"name\": \"Sally Thomas\",
      \"role\": \"customer\",
      \"@referredType\": \"Individual\"
    }
  ],
  \"relatedPlace\": {
    \"id\": \"25ab9c4d0a0a0bb300f7dabdc0ca7c1c\",
    \"name\": \"100 South Charles Street, Baltimore,MD\",
    \"role\": \"interventionAddress\",
    \"@referredType\": \"GeographicAddress\"
  },
  \"relatedEntity\": [
    {
      \"id\": \"48dbfbf9201f0250f877303e8a020dcd\",
      \"role\": \"work order\",
      \"@referredType\": \"WorkOrder\"
    }
  ],
  \"timeZone\": \"US/Arizona\"
}" \
--user 'username':'password'

Resposta:

{
  "validFor": {
    "startDateTime": "2024-07-19 09:00:00",
    "endDateTime": "2024-07-19 11:00:00"
  },
  "category": "e4c1116b3b810300ce8a4d72f3efc40f",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "role": "customer",
      "@referredType": "Individual"
    }
  ],
  "relatedPlace": {
    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
    "name": "100 South Charles Street, Baltimore,MD",
    "role": "interventionAddress",
    "@referredType": "GeographicAddress"
  },
  "relatedEntity": [
    {
      "id": "48dbfbf9201f0250f877303e8a020dcd",
      "role": "work order",
      "@referredType": "WorkOrder"
    }
  ],
  "timeZone": "US/Arizona",
  "success": true,
  "id": "feacb7f9201f0250f877303e8a020d38",
  "href": "api/sn_tmf_api/appointment/appointment/feacb7f9201f0250f877303e8a020d38",
  "creationDate": "2024-07-10 22:45:01",
  "lastUpdate": "2024-07-10 22:45:01"
}

Compromisso em aberto - EXCLUA /api/sn_tmf_api/appointment/appointment/

Exclui um registro de compromisso com um determinado ID.

Formato de URL

URL padrão: /api/sn_tmf_api/appointment/appointment/

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
id	Sys_id do registro de compromisso a ser excluído. Tipo de dados: Cadeia de caracteres Tabela: Agendamento de compromisso [sn_apptmnt_booking_appointment_booking]

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte 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.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome

Descrição

mensagem

Mensagem de resposta confirmando a exclusão bem-sucedida. Sucesso: "O compromisso (<id>) foi cancelado com sucesso." Erros: "Falha no cancelamento de compromisso.": O ID não pode ser encontrado no sistema e retorna um código de status 404. "Falha no cancelamento de compromisso.": O compromisso já está em um estado Cancelado ou Concluído ou não pode ser excluído e retorna um código de status 404. "O compromisso (<id>) não pode ser cancelado, pois está além do Cancelar por hora.": O compromisso já está além do "cancelar por hora", que está configurado na configuração do serviço de agendamento de compromisso. Retorna um código de status 400. Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir exclui um compromisso com um ID específico.

curl "http://instance.servicenow.com/api/sn_tmf_api/appointment/appointment/68cc0a5a9314521060320dd548373" \ 
--request GET\ 
--user 'username':'password' 

Corpo da resposta:

"The appointment (68cc0a5a9314521060320dd548373cbd) is successfully cancelled."

Compromisso em aberto - OBTER /api/sn_tmf_api/appointment/appointment/

Recupera um registro de compromisso associado a um ID especificado.

Formato de URL

URL padrão: /api/sn_tmf_api/appointment/appointment/

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
id	Sys_id do compromisso a ser recuperado. Tipo de dados: Cadeia de caracteres Tabela: Agendamento de compromisso [sn_apptmnt_booking_appointment_booking]

Tabela 20. Parâmetros de consulta

Nome	Descrição
categoria	Filtre o compromisso por categoria sys_id. Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location] Padrão: Retorna todos os compromissos se a categoria sys_id não for fornecida.
RelatedEntity	Detalhes sobre a entidade relacionada associada à ordem de serviço. Tipo de dados: Objeto "relatedEntity": { "id": "String" }
relatedEntity.id	Obrigatório. Sys_id da entidade relacionada. Tipo de dados: Cadeia de caracteres Tabela: Ordem de serviço [wm_order] Padrão: Retorna tudo se o sys_id não for fornecido.
RelatedParty	Filtre o compromisso pelo sys_id da parte relacionada associada ao compromisso. Tipo de dados: Objeto "relatedParty": { "id": "String", "name": "String" } Padrão: Retorna todos os compromissos se relatedPartynão foi fornecido.
relatedParty.id	Sys_id da parte relacionada. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user]
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedPlace	Filtre o compromisso pelo local onde o serviço ou reparo está programado para acontecer. Tipo de dados: Objeto "relatedPlace": { "id": "String" } Padrão: Retorna todos os compromissos se relatedPlacenão foi fornecido.
relatedPlace.id	Sys_id do local relacionado. Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location]
ValidFor	Filtre o compromisso por um intervalo de datas para o qual o compromisso é válido. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" } Padrão: Retorna todos os compromissos se validFornão foi fornecido.
ValidFor.endDateTime	Data e hora de término do compromisso. Somente compromissos com a data e hora de término especificadas são retornados na resposta. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43. Tabela: Local [cmn_location]
ValidFor.startDateTime	Data e hora de início do compromisso. Somente compromissos com a data e hora de início especificadas são retornados na resposta. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43. Tabela: Local [cmn_location]

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 22. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Tabela 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 24. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta

Nome	Descrição
categoria	Sys_id do produtor de registro configurado para a configuração do serviço de reserva de compromisso. Tipo de dados: Cadeia de caracteres Armazenado em: Campo Item do catálogo da tabela Configuração do serviço de agendamentos [sn_apptmnt_booking_service_config].
creationDate	Data e hora em que o compromisso foi criado. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
href	Hiperlink para o registro do compromisso. Use este link em outra solicitação de API em aberto de compromisso para reagendar ou excluir o compromisso. Tipo de dados: Cadeia de caracteres
id	Sys_id do compromisso. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Configuração do serviço de agendamentos [sn_apptmnt_booking_service_config]
LastUpdate	Data e hora em que o compromisso foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
RelatedEntity	Detalhes sobre a entidade relacionada do compromisso. Tipo de dados: Matriz de objetos "relatedEntity": [ { "@referredType": "String", "id": "String", "role": "String" } ]
ReferredEntity. Em referredType	Tipo de item ou serviço. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Ordem de serviço [wm_order]
RelatedEntity.id	Sys_id da entidade relacionada. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Ordem de serviço [wm_order]
RelatedEntity.role	Descrição da função da entidade relacionada. Valor possível: Ordem de serviço Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Ordem de serviço [wm_order]
RelatedParty	Lista de contatos do compromisso. Cada contato é um objeto na matriz. Tipo de dados: Matriz de objetos "relatedParty": [ { "@referredType": "String", "id": "String", "name": " String", "role": "String" } ]
RelatedParty. Em referredType	Tipo de cliente. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
IdentidadeRelatedParty.id	Sys_id do contato do cliente associado à ordem de serviço. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
relatedParty.name	Nome do contato do cliente. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
RelatedParty.role	Função do contato do cliente. Valores possíveis: Cliente: O contato tem uma função de cliente. Técnico: O contato tem uma função de técnico. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
RelatedPlace	Detalhes do local do compromisso associado. Tipo de dados: Objeto "relatedPlace": { "@referredType": "String", "id": "String", "name": "String", "role": "String" }
RelatedPlace. Em referredType	Endereço geográfico do compromisso. Valor possível: GeographicLocation. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
RelatedPlace.id	Sys_id do local. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
relatedPlace.name	Nome do local relacionado ao contato. Por exemplo, 100 South Charles Street, Baltimore, MD. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
RelatedPlace.role	Função do local do compromisso como um endereço de intervenção. Valor possível: InterventionAddress Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
ValidFor	Intervalo de datas para o qual o compromisso é válido. Tipo de dados: Objeto "validFor": { "endDateTime": "String" "startDateTime": "String" }
ValidFor.endDateTime	Data e hora de término do compromisso. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
ValidFor.startDateTime	Data e hora de início do compromisso. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.

Solicitação de curl

O exemplo a seguir retorna detalhes do compromisso de acordo com o ID de registro do compromisso fornecido.

curl "http://instance.servicenow.com/api/sn_tmf_api/appointment/appointment/201071ad4f80d210f8992fec52ce0ba9" \ 
--request GET\ 
--user 'username':'password'

Corpo da resposta:

[
  {
    "id": "201071ad4f80d210f8992fec52ce0ba9",
    "href": "api/sn_tmf_api/appointment/appointment/201071ad4f80d210f8992fec52ce0ba9",
    "validFor": {
      "startDateTime": "2024-08-16 17:00:00",
      "endDateTime": "2024-08-16 19:00:00"
    },
    "category": "4a34a64d4f4c1210f8992fec52ce0b63",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": " null",
        "role": "customer",
        "@referredType": "Individual"
      }
    ],
    "relatedPlace": {
      "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
      "name": "100 South Charles Street, Baltimore,MD",
      "role": "interventionAddress",
      "@referredType": "Individual"
    },
    "relatedEntity": [
      {
        "id": "b440a5694f40d210f8992fec52ce0ba3",
        "role": "work order",
        "@referredType": "WorkOrder"
      }
    ],
    "creationDate": "2024-08-16 00:39:22",
    "lastUpdate": "2024-08-16 00:39:22"
  }
]

Compromisso em aberto - OBTENHA /api/sn_tmf_api/appointment/appointment

Recupera uma lista de registros de compromisso.

Formato de URL

URL padrão: /api/sn_tmf_api/appointment/appointment

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 26. Parâmetros de consulta

Nome	Descrição
categoria	Filtre o compromisso por categoria sys_id. Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location] Padrão: Retorna todos os compromissos se a categoria sys_id não for fornecida.
RelatedEntity	Detalhes sobre a entidade relacionada associada à ordem de serviço. Tipo de dados: Objeto "relatedEntity": { "id": "String" }
relatedEntity.id	Obrigatório. Sys_id da entidade relacionada. Tipo de dados: Cadeia de caracteres Tabela: Ordem de serviço [wm_order] Padrão: Retorna tudo se o sys_id não for fornecido.
RelatedParty	Filtre o compromisso pelo sys_id da parte relacionada associada ao compromisso. Tipo de dados: Objeto "relatedParty": { "id": "String", "name": "String" } Padrão: Retorna todos os compromissos se relatedPartynão foi fornecido.
relatedParty.id	Sys_id da parte relacionada. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user]
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedPlace	Filtre o compromisso pelo local onde o serviço ou reparo está programado para acontecer. Tipo de dados: Objeto "relatedPlace": { "id": "String" } Padrão: Retorna todos os compromissos se relatedPlacenão foi fornecido.
relatedPlace.id	Sys_id do local relacionado. Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location]
ValidFor	Filtre o compromisso por um intervalo de datas para o qual o compromisso é válido. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" } Padrão: Retorna todos os compromissos se validFornão foi fornecido.
ValidFor.endDateTime	Data e hora de término do compromisso. Somente compromissos com a data e hora de término especificadas são retornados na resposta. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43. Tabela: Local [cmn_location]
ValidFor.startDateTime	Data e hora de início do compromisso. Somente compromissos com a data e hora de início especificadas são retornados na resposta. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43. Tabela: Local [cmn_location]

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 28. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 30. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
404	Não encontrado. O item solicitado não foi encontrado.

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

Nome	Descrição
categoria	Sys_id do produtor de registro configurado para a configuração do serviço de reserva de compromisso. Tipo de dados: Cadeia de caracteres Armazenado em: Campo Item do catálogo da tabela Configuração do serviço de agendamentos [sn_apptmnt_booking_service_config].
creationDate	Data e hora em que o compromisso foi criado. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
href	Hiperlink para o registro do compromisso. Use este link em outra solicitação de API em aberto de compromisso para reagendar ou excluir o compromisso. Tipo de dados: Cadeia de caracteres
id	Sys_id do compromisso. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Configuração do serviço de agendamentos [sn_apptmnt_booking_service_config]
LastUpdate	Data e hora em que o compromisso foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
RelatedEntity	Detalhes sobre a entidade relacionada do compromisso. Tipo de dados: Matriz de objetos "relatedEntity": [ { "@referredType": "String", "id": "String", "role": "String" } ]
ReferredEntity. Em referredType	Tipo de item ou serviço. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Ordem de serviço [wm_order]
RelatedEntity.id	Sys_id da entidade relacionada. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Ordem de serviço [wm_order]
RelatedEntity.role	Descrição da função da entidade relacionada. Valor possível: Ordem de serviço Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Ordem de serviço [wm_order]
RelatedParty	Lista de contatos do compromisso. Cada contato é um objeto na matriz. Tipo de dados: Matriz de objetos "relatedParty": [ { "@referredType": "String", "id": "String", "name": " String", "role": "String" } ]
RelatedParty. Em referredType	Tipo de cliente. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
IdentidadeRelatedParty.id	Sys_id do contato do cliente associado à ordem de serviço. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
relatedParty.name	Nome do contato do cliente. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
RelatedParty.role	Função do contato do cliente. Valores possíveis: Cliente: O contato tem uma função de cliente. Técnico: O contato tem uma função de técnico. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
RelatedPlace	Detalhes do local do compromisso associado. Tipo de dados: Objeto "relatedPlace": { "@referredType": "String", "id": "String", "name": "String", "role": "String" }
RelatedPlace. Em referredType	Endereço geográfico do compromisso. Valor possível: GeographicLocation. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
RelatedPlace.id	Sys_id do local. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
relatedPlace.name	Nome do local relacionado ao contato. Por exemplo, 100 South Charles Street, Baltimore, MD. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
RelatedPlace.role	Função do local do compromisso como um endereço de intervenção. Valor possível: InterventionAddress Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Local [cmn_location]
ValidFor	Intervalo de datas para o qual o compromisso é válido. Tipo de dados: Objeto "validFor": { "endDateTime": "String" "startDateTime": "String" }
ValidFor.endDateTime	Data e hora de término do compromisso. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
ValidFor.startDateTime	Data e hora de início do compromisso. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.

Solicitação de curl

O exemplo a seguir mostra como retornar uma lista de compromissos usando o método OBTER compromisso.

curl "http://instance.servicenow.com/api/sn_tmf_api/appointment/appointment" \ 
--request GET\ 
--user 'username':'password' 

O corpo da resposta contém os detalhes de dois compromissos diferentes configurados na configuração do serviço de reserva de compromisso:

[
  {
    "id": "201071ad4f80d210f8992fec52ce0ba9",
    "href": "api/sn_tmf_api/appointment/appointment/201071ad4f80d210f8992fec52ce0ba9",
    "validFor": {
      "startDateTime": "2024-08-16 17:00:00",
      "endDateTime": "2024-08-16 19:00:00"
    },
    "category": "4a34a64d4f4c1210f8992fec52ce0b63",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": " null",
        "role": "customer",
        "@referredType": "Individual"
      }
    ],
    "relatedPlace": {
      "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
      "name": "100 South Charles Street, Baltimore,MD",
      "role": "interventionAddress",
      "@referredType": "Individual"
    },
    "relatedEntity": [
      {
        "id": "b440a5694f40d210f8992fec52ce0ba3",
        "role": "work order",
        "@referredType": "WorkOrder"
      }
    ],
    "creationDate": "2024-08-16 00:39:22",
    "lastUpdate": "2024-08-16 00:39:22"
  },
  {
    "id": "25c012c07f5c5610f8994fa63c866523",
    "href": "api/sn_tmf_api/appointment/appointment/25c012c07f5c5610f8994fa63c866523",
    "validFor": {
      "startDateTime": "2024-08-26 17:00:00",
      "endDateTime": "2024-08-26 19:00:00"
    },
    "category": "4a34a64d4f4c1210f8992fec52ce0b63",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": " null",
        "role": "customer",
        "@referredType": "Individual"
      }
    ],
    "relatedPlace": {
      "id": "f48b21850a0a0ba7004182b18099696d",
      "name": "11251 Rancho Carmel Drive, San Diego,CA",
      "role": "interventionAddress",
      "@referredType": "Individual"
    },
    "relatedEntity": [
      {
        "id": "c0b09a047f109610f8994fa63c8665b4",
        "role": "work order",
        "@referredType": "WorkOrder"
      }
    ],
    "creationDate": "2024-08-23 22:18:43",
    "lastUpdate": "2024-08-23 22:18:43"
  }
]

Compromisso em aberto - PATCH /api/sn_tmf_api/appointment/appointment/

Reprograme compromissos com um determinado ID para uma ordem de serviço.

Formato de URL

URL padrão: PATCH /api/sn_tmf_api/appointment/appointment/

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho

Nome	Descrição
id	Sys_id do compromisso a ser reprogramado. Tipo de dados: Cadeia de caracteres Tabela: Agendamento de compromisso [sn_apptmnt_booking_appointment_booking]

Tabela 32. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
nota	Se cancelar o compromisso, você poderá adicionar anotações de trabalho aqui. Atualiza as anotações de trabalho da ordem de serviço e a mensagem do compromisso. Tipo de dados: Matriz de objetos "note": [ { "author": "String", "date": "String", "text": "String" } ] Armazenado em: Tabela Agendamento de compromisso [sn_apptmnt_booking_appointment_booking]
note.author	Nome da pessoa que escreve a anotação. Tipo de dados: Cadeia de caracteres
note.date	Data e hora em que a anotação foi publicada. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2018-02-04T11:00:18.071Z.
note.text	Texto descritivo sobre a ordem de serviço anexada ao compromisso. Por exemplo, atualizações sobre o andamento da ordem de serviço. Tipo de dados: Cadeia de caracteres
status	Status do compromisso. Valores válidos: Cancelado: A reprogramação de compromisso foi cancelada. Concluído: O compromisso reagendado foi concluído. Confirmado: A reprogramação do compromisso foi aceita e reservada. Novo: A solicitação de reagendamento de compromisso foi criada recentemente. Pendente: A reprogramação de compromisso está pendente. Pronto: A reprogramação de compromisso é solicitada. Tipo de dados: Cadeia de caracteres
ValidFor	Filtre o compromisso por um intervalo de datas para o qual o compromisso é válido. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" } Padrão: Retorna todos os compromissos se validFornão foi fornecido.
ValidFor.endDateTime	Data e hora de término do compromisso. Somente compromissos com a data e hora de término especificadas são retornados na resposta. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43. Tabela: Local [cmn_location]
ValidFor.startDateTime	Data e hora de início do compromisso. Somente compromissos com a data e hora de início especificadas são retornados na resposta. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43. Tabela: Local [cmn_location]

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 34. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Tabela 35. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 36. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
creationDate	Data e hora em que o compromisso foi criado. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
href	Link de referência exclusivo do compromisso. Você pode usar este link em outra solicitação para obter um compromisso. Tipo de dados: Cadeia de caracteres
id	Sys_id do compromisso que foi reprogramado. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Agendamento de compromisso [sn_apptmnt_booking_appointment_booking]
LastUpdate	Data e hora em que o compromisso foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.
motivo	Atualização do compromisso. Valores possíveis: "Compromisso reprogramado.": O método DE PATCH foi usado para reprogramar o compromisso. "O compromisso (ID) foi cancelado com sucesso.": O método DE PATCH foi usado para cancelar o compromisso. Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes do cliente do compromisso associado. Tipo de dados: Matriz de objetos "relatedParty": [ { "@referredType": "String", "id": "String", "name": "String", "role": "String" } ]
relatedParty.id	Sys_id do contato do cliente. Tipo de dados: Cadeia de caracteres Armazenado em: Tabela Contato [customer_contact]
relatedParty.name	Nome do contato do cliente. Tipo de dados: Cadeia de caracteres
RelatedPlace. Em referredType	Tipo de cliente. Tipo de dados: Cadeia de caracteres Somente valor possível: Individual
RelatedParty.role	Função do contato. Tipo de dados: Cadeia de caracteres Somente valor possível: Contato
êxito	Sinalizador que indica se a solicitação foi bem-sucedida. Valores possíveis: Verdadeiro: O compromisso foi reprogramado com sucesso. Falso: Não foi possível reprogramar o compromisso. Tipo de dados: Booliano

Solicitação de curl

O exemplo a seguir demonstra como usar um método DE PATCH para reprogramar um compromisso com um determinado ID.

curl -X POST 'https://instance.service-now.com/api/sn_tmf_api/appointment/appointment/68cc0a5a9314521060320dd548373cbd ' \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-data {
  "validFor": { 
      "startDateTime": "2024-07-30 00:0:00", 
      "endDateTime": "2024-08-30 00:00:00" 
              }
  "note": {
      "date": "85388c25b71011104eed4643ae11a993",
      "author": "Sarah Johnson",
      "text": "customer"
    }
  "state": "active"
   }
  ]
}

O corpo da resposta mostra uma mensagem de sucesso de que o compromisso foi reprogramado.

{
  "relatedParty": [
    {
      "id": "85388c25b71011104eed4643ae11a993",
      "name": "Sarah Johnson",
      "role": "customer",
      "@referredType": "Individual"
    }
  ],
  "success": true,
  "reason": "Appointment rescheduled!",
  "id": "68cc0a5a9314521060320dd548373cbd",
  "href": "api/sn_tmf_api/appointment/appointment/68cc0a5a9314521060320dd548373cbd",
  "creationDate": "2024-08-30 20:56:54",
  "lastUpdate": "2024-08-30 20:56:54"
}