---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

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

# Compromisso em aberto - POST /sn_tmf_api/appointment/appointment {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 min. de leitura

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

## Formato da URL

/api/sn_tmf_api/appointment/appointment

## Parâmetros de solicitação compatíveis

{#apptOpen-POST-appointment__table_lr2_mwt_dcc__entry__2}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 1. Parâmetros de caminho]

{#apptOpen-POST-appointment__table_lr2_mwt_dcc} {#apptOpen-POST-appointment__entry__6}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 2. Parâmetros de consulta]

{#apptOpen-POST-appointment__entry__10}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime}

| Nome | Descrição |
|-|-|
| categoria | Obrigatório. O sys_id do produtor de registro configurado para a configuração do serviço de agendamentos. O produtor de registro é definido no campo Item do catálogo no registro de configuração do serviço de agendamentos relacionado - tabela Configuração do serviço de agendamentos \[sn_apptmnt_booking_service_config\]. Tipo de dados: cadeia de caracteres |
| relatedEntity | Lista de ordens de serviço afetadas. Tipo de dados: matriz "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | Obrigatório. O sys_id do registro localizado na tabela Ordem de serviço \[wm_order\]. Tipo de dados: cadeia de caracteres |
| relatedEntity.@referredType | O tipo de item ou serviço. Por exemplo, `OrdemDeServiço`. Tipo de dados: cadeia de caracteres |
| relatedEntity.role | Descrição da função da entidade. Por exemplo, `ordem`de serviço . Tipo de dados: cadeia de caracteres |
| relatedParty | Lista de contatos do compromisso. Cada contato é um objeto na matriz. A solicitação deve listar pelo menos um item que contenha informações da conta do cliente. Tipo de dados: matriz "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] |
| relatedParty.id | Obrigatório. O sys_id ou external_id do contato do cliente associado à ordem de serviço. Localizado na tabela Contato \[customer_contact\]. Tipo de dados: cadeia de caracteres |
| relatedParty.name | Nome do cliente. Tipo de dados: cadeia de caracteres |
| relatedParty.@referredType | Tipo de cliente. Por exemplo, `Individual`. Tipo de dados: cadeia de caracteres |
| relatedParty.role | Obrigatório. Função predefinida do contato. Por exemplo, `cliente`. Tipo de dados: cadeia de caracteres |
| relatedPplace | Lista dos locais relacionados ao compromisso. "relatedPlace": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] Tipo de dados: matriz |
| relatedPlace.id | Obrigatório. O sys_id do local listado na tabela Locais \[cmn_location\]. Tipo de dados: cadeia de caracteres |
| relatedPlace.name | O nome do local listado na tabela Locais \[cmn_location\]. Por exemplo, `251 Reddy St, darwin, CA 93522`. Tipo de dados: cadeia de caracteres |
| relatedPlace.@referredType | Tipo de local. Por exemplo, `Cidade`. Tipo de dados: cadeia de caracteres |
| relatedPlace.role | 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 período de compromisso especificado. |
| validFor | Obrigatório. Intervalo de datas para o qual o compromisso é válido. Tipo de dados: objeto "validFor": { "startDateTime": "String", "endDateTime": "String" } |
| validFor.startDateTime | Data de início do intervalo de tempo. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres |
| validFor.endDateTime | Data de término do intervalo de tempo. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres |
[Tabela 3. Parâmetros do corpo da solicitação]

## 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apptOpen-POST-appointment__entry__50}{#apptOpen-POST-appointment__accept-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 4. Cabeçalhos da solicitação]

{#apptOpen-POST-appointment__entry__54}{#apptOpen-POST-appointment__content_type-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 5. Cabeçalhos de resposta]

## 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apptOpen-POST-appointment__entry__58}{#apptOpen-POST-appointment__entry-200-status-code}{#apptOpen-POST-appointment__entry-500-status-code}

| Código de 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. |
[Tabela 6. Códigos de status]

## Parâmetros do corpo da resposta

{#apptOpen-POST-appointment__entry__64}

| Nome | Descrição |
|-|-|
| categoria | O sys_id do produtor de registro configurado para a configuração do serviço de agendamentos. O produtor de registro é definido no campo Item do catálogo no registro de configuração do serviço de agendamentos relacionado - tabela Configuração do serviço de agendamentos \[sn_apptmnt_booking_service_config\]. Tipo de dados: cadeia de caracteres |
| creationDate | A data e a hora em que o registro de compromisso foi criado. Tipo de dados: cadeia de caracteres |
| ID | O sys_id do compromisso criado. Localizado na tabela Configuração do serviço de agendamentos \[sn_apptmnt_booking_service_config\]. Tipo de dados: cadeia de caracteres |
| href | Link relativo para o registro de compromisso. Tipo de dados: cadeia de caracteres |
| últimaAtualização | A data e a hora em que o registro de compromisso foi atualizado pela última vez. Tipo de dados: cadeia de caracteres |
| relatedEntity | Lista de ordens de serviço afetadas. Tipo de dados: matriz "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | O sys_id do registro localizado na tabela Ordem de serviço \[wm_order\]. Tipo de dados: cadeia de caracteres |
| relatedEntity.@referredType | O tipo de item ou serviço. Tipo de dados: cadeia de caracteres |
| relatedEntity.role | Descrição da função da entidade. Tipo de dados: cadeia de caracteres |
| relatedParty | Lista de contatos do compromisso. Cada contato é um objeto na matriz. A solicitação deve listar pelo menos um item que contenha informações da conta do cliente. Tipo de dados: matriz "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] |
| relatedParty.id | O sys_id ou external_id do contato do cliente associado à ordem de serviço. Localizado na tabela Contato \[customer_contact\]. Tipo de dados: cadeia de caracteres |
| relatedParty.name | Nome do cliente. Tipo de dados: cadeia de caracteres |
| relatedParty.@referredType | Tipo de cliente. Tipo de dados: cadeia de caracteres |
| relatedParty.role | Função predefinida do contato. Tipo de dados: cadeia de caracteres |
| relatedPplace | Lista dos locais relacionados ao compromisso. "relatedPlace": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] Tipo de dados: matriz |
| relatedPlace.id | O sys_id do local listado na tabela Locais \[cmn_location\]. Tipo de dados: cadeia de caracteres |
| relatedPlace.name | O nome do local listado na tabela Locais \[cmn_location\]. Tipo de dados: cadeia de caracteres |
| relatedPlace.@referredType | Tipo de local. Tipo de dados: cadeia de caracteres |
| relatedPlace.role | Descrição da função do local. Tipo de dados: cadeia de caracteres |
| fuso horário | Fuso horário a ser usado ao reservar o período de compromisso especificado. |
| validFor | Intervalo de datas para o qual o compromisso é válido. Tipo de dados: objeto "validFor": { "startDateTime": "String", "endDateTime": "String" } |
| validFor.startDateTime | Data de início do intervalo de tempo. Tipo de dados: cadeia de caracteres |
| validFor.endDateTime | Data de término do intervalo de tempo. Tipo de dados: cadeia de caracteres |
| ê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 |
[ ]

## Solicitação de cURL

O exemplo a seguir mostra como criar um novo agendamento...

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