API de abertura de ordem de serviço

Versão de lançamento: Washingtondc

Atualizado 1 de fev. de 2024

70 min. de leitura

A API de abertura de ordem de serviço fornece um mecanismo padronizado para colocar ordens de serviço.

Esta API é uma implementação ServiceNow® da especificação da API Open API TMForum TMF641 Service Ordering Management.

Para acessar esta API, o plug-in Order Management for Telecommunications (sn_ind_tmt_orm) deve ser ativado. Para obter mais informações, consulte Install Order Management . Para obter informações sobre Gestão de pedidos tabelas, entidades e relacionamentos, consulte Order Management data model.

Esta API é fornecida no namespace sn_ind_tmt_orm.

O usuário que faz a chamada deve ter a função sn_ind_tmt_orm.order_integrator.

Esta API pode ser estendida para fazer personalizações em torno dos parâmetros obrigatórios, solicitar validação do corpo, operações REST adicionais e mapeamentos de campo. Para obter mais informações, consulte o Guia do desenvolvedor de API aberta de ordem de serviço.

API de abertura de ordem de serviço – GET /sn_ind_tmt_orm/serviceorder

Recupera todas as ordens de serviço.

Esta API recupera informações de ordem de serviço das seguintes tabelas relacionadas:

Pedido [sn_ind_tmt_orm_order]
Valor da característica do pedido [sn_ind_tmt_orm_order_characteristic_value]
Item da linha do pedido [sn_ind_tmt_orm_order_line_item]
Contato do item de linha do pedido [sn_ind_tmt_orm_order_line_item_contact]
Itens relacionados à linha do pedido [sn_ind_tmt_orm_order_line_related_items]

Formato de URL

/api/sn_ind_tmt_orm/serviceorder

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho
Nome	Descrição
Nenhum

Tabela 2. Parâmetros de consulta
Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: cadeia de caracteres Padrão: todos os campos retornados.
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro. Padrão: 20 Máximo: 100 Tipo de dados: número
deslocamento	Índice inicial no qual iniciar a recuperação de registros. Use este valor para paginar a recuperação do registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Padrão: 0 Tipo de dados: número
state	Filtrar pedidos por estado. Somente pedidos com um estado correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres Padrão: todos os estados retornados.

Tabela 3. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
Nenhum

Cabeçalhos

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

Tabela 4. Cabeçalhos da solicitação
Cabeçalho	Descrição
Nenhum

Tabela 5. Cabeçalhos de resposta
Cabeçalho	Descrição
Intervalo de conteúdo	Especifica o intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se `deslocamento=2` e `limite=3`, o valor do cabeçalho Content-Range será `itens 3-5`.
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Link	Contém os links a seguir para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Contagem total	Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

Códigos de status

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

Tabela 6. Códigos de status
Código de status	Descrição
200	Solicitação processada com êxito. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado na resposta (com paginação).
400	Solicitação incorreta. Possíveis motivos: Parâmetro de caminho inválido URI inválido
404	Registro não encontrado. Nenhum registro correspondente aos parâmetros de consulta foi encontrado na tabela.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
committedDueDate	Data e hora em que a ação deve ser realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate para cada item de linha do pedido. Tipo de dados: cadeia de caracteres
Expectativa de conclusão	Data em que o pedido deve ser concluído. Tipo de dados: cadeia de caracteres
id	Sys_id da ordem de serviço solicitada. Tipo de dados: cadeia de caracteres
anotação	Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
nota.autor	Nome de usuário da pessoa que criou a anotação associada. Tipo de dados: cadeia de caracteres
nota.data	Data em que a anotação foi criada. Tipo de dados: cadeia de caracteres
nota.texto	Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres
ponr	Sinalizador que indica se o ponto sem retorno da ordem foi atingido. Valores válidos: verdadeiro: o ponto sem retorno para o pedido foi atingido. O pedido não pode ser modificado ou cancelado enquanto a execução estiver em andamento. false: o ponto de não retorno do pedido não foi atingido. A ordem pode ser modificada ou cancelada. Tipo de dados: booliano
relatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Tipo de dados: matriz `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.name	Nome da conta, do cliente ou do consumidor. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Consumidor Cliente CustomerContact Tipo de dados: cadeia de caracteres
parte relacionada. @tipo	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
requestCompletionDate	Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres
requestStartDate	Data de início do pedido solicitada pelo cliente. Tipo de dados: cadeia de caracteres
serviceOrderItem	Matriz de objetos que descreve os itens de linha na ordem de serviço e sua ação associada. `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ]` Tipo de dados: matriz
itemDeOrdemDeServiço.ação	Ação a ser executada no item da ordem de serviço. As ações possíveis são definidas na guia Lista de seleção no campo Entrada de dicionário de ação da tabela sn_ind_tmt_orm_order_line_item. Para obter detalhes, consulte Action types for customer and service orders. Tipo de dados: cadeia de caracteres
serviceOrderItem.actionReason	O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres
serviceOrderItem.externalProductInventory	Matriz de objetos que contém IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: matriz `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário de produtos. Tipo de dados: cadeia de caracteres
serviceOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceOrderItem.orderRelationship	Matriz de objetos que descreve os relacionamentos entre os itens de linha do pedido. Tipo de dados: matriz `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceOrderItem.orderRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: Tem secundário Tem primário Requer `HasChild` e `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.quantidade	Número de itens de linha solicitados. Tipo de dados: número
itemDeOrdemDeServiço.place	Mapa dos locais nos quais o serviço será instalado. Tipo de dados: objeto `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.place.@tipo	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Posição`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.ponr	Sinalizador que indica se o ponto sem retorno do item de linha do pedido foi atingido. Valores válidos: verdadeiro: o ponto sem retorno para o item de linha do pedido foi atingido. O item de linha do pedido não pode ser modificado ou cancelado enquanto a execução está em andamento. falso: o ponto sem retorno para o item de linha do pedido não foi atingido. O item de linha do pedido pode ser modificado ou cancelado. Tipo de dados: booliano
serviceOrderItem.relatedParty	Lista de contatos para itens de linha. Tipo de dados: matriz `"relatedParty:" [ { "email": "String", "firstName": "String" "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
serviceOrderItem.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.firstName	Nome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.id	Sys_id do contato do item de linha associado ao item de linha do pedido. Localizado na tabela Contato do item de linha do pedido [sn_ind_tmt_orm_order_line_item_contact]. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.lastName	Sobrenome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@type	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
serviçoItemOrdem.serviço	Descrição dos detalhes da instância do serviço adquirido pelo cliente. Tipo de dados: objeto `"service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" }`
serviceOrderItem.service.serviceCharacteristic	Lista que descreve as características do serviço associado. Somente as características de serviço com um value atual diferente de previousValue são retornadas. Tipo de dados: matriz de objetos `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.value	Valores de opção de característica associados ao serviço. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.valueType	Tipo de valor da característica. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceRelationship	Lista de inventários de produtos relacionados ao serviço. Tipo de dados: matriz `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário de produtos. Localizado no campo sys_id ou sn_prd_invt_external_id da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceRelationship.relationshipType	Tipo de relacionamento entre o serviço e o inventário de produtos. Valor possível: requer Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification	Descrição da especificação de serviço associada ao serviço. Tipo de dados: objeto `"serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Inicial_versão ou external_id da especificação de serviço. O inicial_versão é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.internalId	Inicial_versão da especificação de serviço. O inicial_versão é o sys_id da primeira versão da especificação. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.internalVersion	Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.name	Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.version	External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.@type	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceSpecificationRef`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceType	Tipo de serviço. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.serviço.estado	Estado do produto vendido. Por exemplo, novo. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.estado	Estado do item da ordem de serviço. Por exemplo, novo. Tipo de dados: cadeia de caracteres
serviceOrderItem.version	Versão do item de linha da ordem de serviço. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrderItem`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
state	Estado da ordem de serviço. Tipo de dados: cadeia de caracteres
@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrder`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo recupera todos os pedidos de serviço.

curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder' \
--user 'username':'password'

Corpo da resposta.

[
   {
      "id": "4f2af65ac3a030106e2473ce3640ddcf",
      "ponr": "false",
      "expectedCompletionDate": "2018-01-15T09:37:40.000Z",
      "requestedCompletionDate": "2018-01-15T09:37:40.000Z",
      "requestedStartDate": "2018-01-15T09:37:40.000Z",
      "note": [
         {
            "author": "System Administrator",
            "date": "2021-06-07T14:53:04.000Z",
            "text": "This is a TMF service order illustration no 2"
         },
         {
            "author": "System Administrator",
            "date": "2021-06-07T14:53:03.000Z",
            "text": "This is a TMF service order illustration"
         }
      ],
      "serviceOrderItem": [
         {
            "id": "100",
            "ponr": "false",
            "action": "add",
            "actionReason": "adding service package OLI",
            "quantity": 1,
            "service": {
               "@type": "Service",
               "state": "",
               "serviceType": "cfs",
               "serviceCharacteristic": [
                  {
                     "name": "Firewall coverage",
                     "valueType": "choice",
                     "value": "Premium (Up to 50 sites)",
                     "previousValue": ""
                  },
                  {
                     "name": "Firewall Security",
                     "valueType": "choice",
                     "value": "Standard",
                     "previousValue": ""
                  },
                  {
                     "name": "Administration Support",
                     "valueType": "choice",
                     "value": "Basic (Customer Managed)",
                     "previousValue": ""
                  }
               ],
               "serviceRelationship": [
                  {
                     "id": "326d13f45b5620102dff5e92dc81c785",
                     "relationshipType": "Requires"
                  }
               ],
               "serviceSpecification": {
                  "id": "f99546ff07266010a7955b7e0ad300a8",
                  "name": "Managed Firewall Service",
                  "version": "v2",
                  "internalVersion": "2",
                  "internalId": " f99546ff07266010a7955b7e0ad300a8",
                  "@type": "ServiceSpecificationRef"
               }
            },
            "place": {
               "id": "920cf6ac73d423002728660c4cf6a799",
               "@type": "Place"
            },
            "relatedParty": [
               {
                  "id": "972af65ac3a030106e2473ce3640ddda",
                  "firstName": "Mike",
                  "lastName": "Hudson",
                  "email": "mike@example.com",
                  "phone": "1234567890",
                  "@type": "RelatedParty",
                  "@referredType": "OrderLineItemContact"
               }
            ],
            "state": "new",
            "version": "1",
            "@type": "ServiceOrderItem"
         }
      ],
      "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
      "state": "new",
      "version": "1",
      "@type": "ServiceOrder"
   }
]

API aberta de ordem de serviço – GET /sn_ind_tmt_orm/serviceorder/{id}

Recupera uma ordem de serviço especificada.

Esta API recupera informações de ordem de serviço das seguintes tabelas relacionadas:

Pedido [sn_ind_tmt_orm_order]
Item da linha do pedido [sn_ind_tmt_orm_order_line_item]
Valor da característica do pedido [sn_ind_tmt_orm_order_characteristic_value]
Contato do item de linha do pedido [sn_ind_tmt_orm_order_line_item_contact]
Itens relacionados à linha do pedido [sn_ind_tmt_orm_order_line_related_items]

Formato de URL

/api/sn_ind_tmt_orm/serviceorder/{id}

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho
Nome	Descrição
id	Sys_id da ordem de serviço a ser recuperada. Localizado na tabela Order [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres

Tabela 8. Parâmetros de consulta
Nome	Descrição
Nenhum

Tabela 9. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
Nenhum

Cabeçalhos

Tabela 10. Cabeçalhos da solicitação
Cabeçalho	Descrição
Nenhum

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

Códigos de status

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

Tabela 12. Códigos de status
Código de status	Descrição
200	Solicitação processada com êxito. Recurso completo retornado na resposta (sem paginação). A resposta retornará bem-sucedido com uma mensagem de erro se o pedido selecionado tiver problemas de processamento. Uma resposta 200 OK acontece se a ordem estiver na tabela Fila de entrada [sn_tmt_core_inbound_queue] aguardando o programador selecionar o registro a ser processado. O campo de mensagem de erro inclui detalhes do registro. Por exemplo: `{ "code": 102, "reason": "Request in queue", "message": "Request in queue", "details": [ { "message": "This Order is still in the inbound queue table waiting to be processed.", "datapath": "" } ] }` Uma resposta 200 OK acontece se uma criação de ordem falhar e o registro na tabela Fila de entrada [sn_tmt_core_inbound_queue] estiver em um estado de erro. O campo de mensagem de erro inclui detalhes em para o registro da tabela da fila de entrada. Por exemplo: `{ "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] }`
400	Solicitação incorreta. Possíveis motivos: Parâmetro de consulta ausente URI inválido
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
committedDueDate	Data e hora em que a ação deve ser realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate para cada item de linha do pedido. Tipo de dados: cadeia de caracteres
Expectativa de conclusão	Data em que o pedido deve ser concluído. Tipo de dados: cadeia de caracteres
id	Sys_id da ordem de serviço solicitada. Tipo de dados: cadeia de caracteres
anotação	Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
nota.autor	Nome de usuário da pessoa que criou a anotação associada. Tipo de dados: cadeia de caracteres
nota.data	Data em que a anotação foi criada. Tipo de dados: cadeia de caracteres
nota.texto	Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres
ponr	Sinalizador que indica se o ponto sem retorno da ordem foi atingido. Valores válidos: verdadeiro: o ponto sem retorno para o pedido foi atingido. O pedido não pode ser modificado ou cancelado enquanto a execução estiver em andamento. false: o ponto de não retorno do pedido não foi atingido. A ordem pode ser modificada ou cancelada. Tipo de dados: booliano
relatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Tipo de dados: matriz `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.name	Nome da conta, do cliente ou do consumidor. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Consumidor Cliente CustomerContact Tipo de dados: cadeia de caracteres
parte relacionada. @tipo	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
requestCompletionDate	Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres
requestStartDate	Data de início do pedido solicitada pelo cliente. Tipo de dados: cadeia de caracteres
serviceOrderItem	Matriz de objetos que descreve os itens de linha na ordem de serviço e sua ação associada. Tipo de dados: matriz `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ]`
itemDeOrdemDeServiço.ação	Ação a ser executada no item da ordem de serviço. As ações possíveis são definidas na guia Lista de seleção no campo Entrada de dicionário de ação da tabela sn_ind_tmt_orm_order_line_item. Para obter detalhes, consulte Action types for customer and service orders Tipo de dados: cadeia de caracteres
serviceOrderItem.actionReason	O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres
serviceOrderItem.externalProductInventory	Matriz de objetos que contém IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: matriz `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário de produtos. Tipo de dados: cadeia de caracteres
serviceOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceOrderItem.orderRelationship	Matriz de objetos que descreve os relacionamentos entre os itens de linha do pedido. Tipo de dados: matriz `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceOrderItem.orderRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: Tem secundário Tem primário Requer `HasChild` e `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.quantidade	Número de itens de linha solicitados. Tipo de dados: número
itemDeOrdemDeServiço.place	Mapa dos locais nos quais o serviço será instalado. Tipo de dados: objeto `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.place.@tipo	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Posição`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.ponr	Sinalizador que indica se o ponto sem retorno do item de linha do pedido foi atingido. Valores válidos: verdadeiro: o ponto sem retorno para o item de linha do pedido foi atingido. O item de linha do pedido não pode ser modificado ou cancelado enquanto a execução está em andamento. falso: o ponto sem retorno para o item de linha do pedido não foi atingido. O item de linha do pedido pode ser modificado ou cancelado. Tipo de dados: booliano
serviceOrderItem.relatedParty	Lista de contatos para itens de linha. Tipo de dados: matriz `"relatedParty:" { "email": "String", "firstName": "String" "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.firstName	Nome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.id	Sys_id do contato do item de linha associado ao item de linha do pedido. Localizado na tabela Contato do item de linha do pedido [sn_ind_tmt_orm_order_line_item_contact]. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.lastName	Sobrenome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@type	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
serviçoItemOrdem.serviço	Descrição dos detalhes da instância do serviço adquirido pelo cliente. `"service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" }` Tipo de dados: objeto
serviceOrderItem.service.serviceCharacteristic	Lista que descreve as características do serviço associado. Somente as características de serviço com um value atual diferente de previousValue são retornadas. Tipo de dados: matriz `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.value	Valores de opção de característica associados ao serviço. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.valueType	Tipo de valor da característica. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceRelationship	Lista de inventários de produtos relacionados ao serviço. Tipo de dados: matriz `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário de produtos. Localizado no campo sys_id ou sn_prd_invt_external_id da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceRelationship.relationshipType	Tipo de relacionamento entre o serviço e o inventário de produtos. Valor possível: requer Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification	Descrição da especificação de serviço associada ao serviço. Tipo de dados: objeto `"serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Inicial_versão ou external_id da especificação de serviço. O inicial_versão é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.internalId	Inicial_versão da especificação de serviço. O inicial_versão é o sys_id da primeira versão da especificação. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.internalVersion	Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.name	Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.version	External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.@type	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceSpecificationRef`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceType	Tipo de serviço. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.serviço.estado	Estado do produto vendido. Por exemplo, novo. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.estado	Estado do item da ordem de serviço. Por exemplo, novo. Tipo de dados: cadeia de caracteres
serviceOrderItem.version	Versão do item de linha da ordem de serviço. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrderItem`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
state	Estado da ordem de serviço. Tipo de dados: cadeia de caracteres
@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrder`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo a seguir recupera uma ordem de serviço especificada.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder/4f2af65ac3a030106e2473ce3640ddcf" \
--request GET \
--user 'username':'password'

Corpo da resposta.

{
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "ponr": "false",
   "expectedCompletionDate": "2018-01-15T09:37:40.000Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.000Z",
   "requestedStartDate": "2018-01-15T09:37:40.000Z",
   "note": [
      {
         "author": "System Administrator",
         "date": "2021-06-07T14:53:04.000Z",
         "text": "This is a TMF service order illustration no 2"
      },
      {
         "author": "System Administrator",
         "date": "2021-06-07T14:53:03.000Z",
         "text": "This is a TMF service order illustration"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "ponr": "false",
         "action": "add",
         "actionReason": "adding service package OLI",
         "quantity": 1,
         "service": {
            "@type": "Service",
            "state": "",
            "serviceType": "cfs",
            "serviceCharacteristic": [
               {
                  "name": "Firewall coverage",
                  "valueType": "choice",
                  "value": "Premium (Up to 50 sites)",
                  "previousValue": ""
               },
               {
                  "name": "Firewall Security",
                  "valueType": "choice",
                  "value": "Standard",
                  "previousValue": ""
               },
               {
                  "name": "Administration Support",
                  "valueType": "choice",
                  "value": "Basic (Customer Managed)",
                  "previousValue": ""
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "version": "v2",
               "internalVersion": "2",
               "internalId": "f99546ff07266010a7955b7e0ad300a8",
               "@type": "ServiceSpecificationRef"
            }
         },
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "relatedParty": [
            {
               "id": "972af65ac3a030106e2473ce3640ddda",
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "state": "new",
         "version": "1",
         "@type": "ServiceOrderItem"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "state": "new",
   "version": "1",
   "@type": "ServiceOrder"
}

API de abertura de ordem de serviço - PATCH /sn_ind_tmt_orm/order/serviceorder/{id}

Atualiza a ordem de serviço especificada.

Formato de URL

URL padrão: /api/sn_ind_tmt_orm/order/serviceOrder/{id}

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho
Nome	Descrição
id	Sys_id do pedido do cliente a ser atualizado. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres

Tabela 14. Parâmetros de consulta
Nome	Descrição
Nenhum

Tabela 15. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
committedDueDate	Data e hora em que a ação deve ser realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate para cada item de linha do pedido. Se a ação dos itens de linha do pedido for `suspender` ou `retomar`, este parâmetro não poderá ser atualizado. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/committed_due_date
IDexterno	Número de ordem exclusivo para a ordem de serviço externa. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order
anotação	Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz `"note:" [ { "text": "String" } ]` Tabela/campo atualizado: sn_ind_tmt_orm_order
nota.texto	Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/comments Padrão: cadeia de caracteres em branco
orderDate	Data da solicitação de pedido do cliente. Tipo de dados: cadeia de caracteres
relatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. A solicitação deve listar pelo menos um item que contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Obrigatório. Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], tabela Contato [customer_contact] ou tabela Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres Tabela atualizada: sn_ind_tmt_orm_order
relatedParty.name	Nome de umaconta, cliente ou consumidor. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Consumidor Cliente CustomerContact Tipo de dados: cadeia de caracteres
parte relacionada. @tipo	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
requestCompletionDate	Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_end_date Padrão: cadeia de caracteres em branco
requestStartDate	Data de início do pedido solicitada pelo cliente. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_start_date Padrão: cadeia de caracteres em branco
serviceOrderItem	Obrigatório. Matriz de objetos que descreve os itens de linha na ordem de serviço e sua ação associada. Tipo de dados: matriz `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]` Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item
itemDeOrdemDeServiço.ação	Obrigatório. Ação a ser executada no item da ordem de serviço. As ações possíveis são definidas na guia Lista de seleção no campo Entrada de dicionário de ação da tabela sn_ind_tmt_orm_order_line_item. Valores possíveis: adicionar mudança excluir sem mudança resume suspender Para obter detalhes, consulte Action types for customer and service orders. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action
serviceOrderItem.actionReason	Opcional. Descrição do motivo do item de linha. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]/action_reason.
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser realizada no item de linha do pedido. Se a ação do item for `suspender` ou `retomar`, este parâmetro não poderá ser atualizado. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/committed_due_date
serviceOrderItem.externalProductInventory	Matriz de objetos que contém IDs externos a serem mapeados para os inventários de produtos criados para o pedido. Tipo de dados: matriz `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externo a ser mapeado para o inventário de produtos. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_inventory_id e sn_prd_invt_product_inventory/sn_prd_invt_external_id
serviceOrderItem.id	Obrigatório. Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_id
serviceOrderItem.orderRelationship	Obrigatório. Matriz de objetos que descreve os relacionamentos entre os itens de linha do pedido. Tipo de dados: matriz `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item
serviceOrderItem.orderRelationship.id	Obrigatório. Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/parent_line_item ou sn_ind_tmt_orm_order_line_related_items/related_order_line_item
serviceOrderItem.orderRelationship.relationshipType	Obrigatório. Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: Tem secundário Tem primário Requer `HasChild` e `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.place	Mapa dos locais nos quais o serviço será instalado. Tipo de dados: objeto `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Obrigatório. Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/location
itemDeOrdemDeServiço.place.@tipo	Parte do padrão da API aberta do TMF. Anotação para o local do item de linha do pedido. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.quantidade	Define o número de itens de linha a serem solicitados. Esta propriedade só é aplicável ao adicionar uma ordem de serviço; ou seja, o valor da propriedade action é `add`. Tipo de dados: número Padrão: cadeia de caracteres vazia Tabela/campo atualizado: sn_ind_tmt_orm_order/quantity
serviceOrderItem.relatedParty	Lista de contatos para itens de linha. Tipo de dados: matriz `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.firstName	Nome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.lastName	Sobrenome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@type	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
serviçoItemOrdem.serviço	Obrigatório. Descrição dos detalhes da instância do serviço adquirido pelo cliente. Tipo de dados: objeto `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }` Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item
serviceOrderItem.service.id	Identificador exclusivo do serviço vendido. Este valor pode ser o sys_id ou o ID externo na tabela Product Inventory [sn_ind_tmt_orm_product_inventory]. Este valor é usado somente para pedidos de mudança/desconexão. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic	Lista que descreve as características do serviço associado. Somente as características de serviço com um value atual diferente de previousValue são retornadas. Tipo de dados: matriz `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nome do registro da característica a ser associado ao serviço. Localizado na tabela Característica [sn_prd_pm_characteristic]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.previousValue	Valores da opção da característica anterior se a atualização for para a ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro serviceOrderItem.action for diferente de `add`. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.value	Valores de opção de característica associados ao serviço. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification	Obrigatório. Descrição da especificação de serviço associada ao serviço. Tipo de dados: objeto `"serviceSpecification:" { "id": "String", "name": "String", "@type": "String" }` Atualiza o campo service_specification na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item].
serviceOrderItem.service.serviceSpecification.id	Obrigatório. Inicial_versão ou external_id da especificação de serviço. O inicial_versão é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.name	Obrigatório. Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.@type	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceSpecificationRef`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrderItem`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrder`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres

Cabeçalhos

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.
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
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Códigos de status

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

Tabela 18. Códigos de status
Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
201	Bem-sucedido. Se houver algum problema com as características ou informações de opção de características, o endpoint armazenará os seguintes comentários nos campos de anotações de trabalho do registro de item de linha do pedido do cliente associado: `As seguintes características do item do pedido não existem: revise a especificação <specification.name> e corrija a característica e a opção de característica no item de linha do pedido antes de aprovar o pedido.` `A característica do item do pedido: <characteristic.name> com o valor da característica: <characteristic.value>é inválida. Corrija os valores da característica antes de aprovar o pedido.`
400	Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: Carga`inválida: corpo da solicitação ausente` - a carga não foi aprovada no corpo da solicitação. `Carga inválida: serviceOrderItem ausente` : objeto de item de linha da ordem de serviço ou JSON ausente. `Carga inválida: id de serviceOrderItem ausente` - O parâmetro id está ausente no item de linha da ordem de serviço da carga. `Carga inválida: a ação serviceOrderItem está ausente` - O parâmetro action está ausente no item de linha da ordem de serviço da carga. `Carga inválida: serviceOrderItem serviceOffering está ausente` - O objeto de oferta de serviço ou JSON está ausente do item de linha da ordem de serviço na carga. `Carga inválida: id de oferta de serviço ausente` - O parâmetro id está ausente no item de linha da ordem de serviço do objeto de oferta de serviço na carga útil. `Carga inválida: a oferta de serviço não existe` : a oferta de serviço no item de linha do pedido de serviço não é válida. `Carga inválida: serviço serviceOrderItem ausente` : o objeto de serviço ou JSON no item de linha da ordem de serviço está ausente na carga útil. `Carga inválida: serviço serviceSpecification ausente` : o objeto de especificação de serviço ou JSON no item de linha da ordem de serviço está ausente na carga útil. `Carga inválida: id de especificação de serviço ausente` : o parâmetro id no item de linha da ordem de serviço do objeto de especificação de serviço está ausente na carga útil. `Carga inválida: a especificação de serviço não existe` : a especificação de serviço no item de linha da ordem de serviço não é válida. `Carga inválida: o inventário de serviço não existe` - Em um pedido de mudança (ação = mudança), a quantidade de um item é maior do que o que está em estoque. `Carga inválida: ID de inventário de serviço ausente` - Em um pedido de mudança, o service.id está ausente na carga útil. `Carga inválida: o serviço vendido está inativo` — Em uma ordem de mudança, um serviço especificado na carga está inativo. `Carga inválida: relatedParty está ausente` - O objeto de parte relacionada está ausente na carga. `Carga inválida: a conta do cliente ou o consumidor está ausente` - o cliente da parte relacionada ou o objeto do consumidor está ausente na carga útil. `Carga inválida: a conta do cliente não existe` — O cliente especificado da parte relacionada não existe na instância. `Carga inválida: o consumidor não existe` : o consumidor de parte relacionada especificado não existe na instância. `Carga inválida: Falha na criação do pedido` - Não é possível criar o pedido solicitado. `A revisão em andamento para a moeda do pedido não é compatível` - o parâmetro orderCurrency não pode ser atualizado depois que o pedido é criado. `Este pedido ainda não foi criado na tabela de pedidos do cliente. Verifique a fila de entrada para obter mais detalhes.` – o ID do pedido fornecido não está na tabela de pedidos do cliente. `A solicitação de patch não pode ser feita porque o tipo de execução do pedido não é "entregar".` – A solicitação de patch foi feita em um pedido que tem um tipo de execução diferente de entrega.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
committedDueDate	Data e hora em que a ação deve ser realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate para cada item de linha do pedido. Tipo de dados: cadeia de caracteres
IDexterno	Número de ordem exclusivo para a ordem de serviço externa. Tipo de dados: cadeia de caracteres
id	Sys_id da ordem de serviço. Tipo de dados: cadeia de caracteres
anotação	Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz `"note": [ { "text": "String" } ]`
nota.texto	Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres
relatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Tipo de dados: matriz `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta ou contato do cliente associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.name	Nome da conta, do cliente ou do consumidor. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Cliente CustomerContact Tipo de dados: cadeia de caracteres
parte relacionada. @tipo	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
requestCompletionDate	Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres
requestStartDate	Data de início do pedido solicitada pelo cliente. Tipo de dados: cadeia de caracteres
serviceOrderItem	Matriz de objetos que descreve os itens de linha na ordem de serviço e sua ação associada. Tipo de dados: matriz `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]`
itemDeOrdemDeServiço.ação	Ação a ser executada no item da ordem de serviço. As ações possíveis são definidas na guia Lista de seleção no campo Entrada de dicionário de ação da tabela sn_ind_tmt_orm_order_line_item. Valores possíveis: adicionar mudança excluir Para obter detalhes, consulte Action types for customer and service orders. Tipo de dados: cadeia de caracteres
serviceOrderItem.actionReason	O motivo para adicionar o item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action_reason
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres
serviceOrderItem.externalProductInventory	Matriz de objetos que contém IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: matriz `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário de produtos. Tipo de dados: cadeia de caracteres
serviceOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceOrderItem.orderRelationship	Matriz de objetos que descreve os relacionamentos entre os itens de linha do pedido. Tipo de dados: matriz `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceOrderItem.orderRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: Tem secundário Tem primário Requer `HasChild` e `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.place	Mapa dos locais nos quais o serviço será instalado. Tipo de dados: objeto `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.place.@tipo	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Posição`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.quantidade	Número de itens de linha solicitados. Tipo de dados: número
serviceOrderItem.relatedParty	Lista de contatos para itens de linha. Tipo de dados: matriz `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.e-mail	Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.firstName	Nome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.lastName	Sobrenome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@type	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
serviçoItemOrdem.serviço	Descrição dos detalhes da instância do serviço adquirido pelo cliente. Tipo de dados: objeto `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }`
serviceOrderItem.service.id	Identificador exclusivo do serviço vendido. Este valor pode ser o sys_id ou o ID externo na tabela Product Inventory [sn_ind_tmt_orm_product_inventory]. Este valor só é retornado para pedidos de mudança/desconexão. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic	Lista que descreve as características do serviço associado. Somente as características de serviço com um value atual diferente de previousValue são retornadas. Tipo de dados: matriz `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nome do registro da característica a ser associado ao serviço. Localizado na tabela Característica [sn_prd_pm_characteristic]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.previousValue	Valores da opção da característica anterior se a atualização for para a ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro serviceOrderItem.action for diferente de `add`. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.value	Valores de opção de característica associados ao serviço. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification	Descrição da especificação de serviço associada ao serviço. Tipo de dados: objeto `"serviceSpecification:" { "id": "String", "name": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Inicial_versão ou external_id da especificação de serviço. O inicial_versão é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.name	Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.@type	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceSpecificationRef`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrderItem`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
state	Estado da ordem de serviço. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo mostra como atualizar uma ordem de serviço.

curl -X PATCH 'https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder/a831e56e77602110c8b3a4d54b5a9954' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      "actionReason":"adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic( Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "relatedParty":     "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}'
Sarsij Kumar02:14
Change the response as well to the following
Sarsij Kumar02:14
{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      "actionReason": "adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic( Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service",
          "sys_id": "f99546ff07266010a7955b7e0ad300a8",
          "version": "",
          "status": "published",
          "internalId": "f99546ff07266010a7955b7e0ad300a8"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "orderType": "add",
  "state": "revision_received",
  "href": "/api/sn_ind_tmt_orm/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}

Corpo da resposta.

{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      v"actionReason": "adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic(Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service",
          "sys_id": "f99546ff07266010a7955b7e0ad300a8",
          "version": "",
          "status": "published",
          "internalId": "f99546ff07266010a7955b7e0ad300a8"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "relatedParty": [    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "orderType": "add",
  "state": "revision_received",
  "href": "/api/sn_ind_tmt_orm/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}

API aberta de ordem de serviço - POST /sn_ind_tmt_orm/cancelserviceorder

Cancela a ordem de serviço especificada.

Nota:

Este endpoint não pode ser usado em pedidos para os quais o ponto sem retorno foi atingido. Um item de linha do pedido não pode ser cancelado enquanto a execução estiver em andamento.

Formato de URL

URL padrão: /api/sn_ind_tmt_orm/cancelserviceorder

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho
Nome	Descrição
Nenhum

Tabela 20. Parâmetros de consulta
Nome	Descrição
Nenhum

Tabela 21. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
CancelamentoMotivo	Motivo do cancelamento. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
pedido de serviço	Contém dados sobre a ordem de serviço. Tipo de dados: objeto `"serviceOrder": { "id": "String", "href": "String", "@referredType": "String" }`
serviceOrder.id	Obrigatório. Sys_id do pedido do cliente a ser cancelado. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
serviceOrder.href	URL do pedido do cliente a ser cancelado. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
serviceOrder.@referredType	O valor deste parâmetro deve ser `ServiceOrder`. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
requestCancellationDate	Data para cancelar o pedido. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco
@tipo	O valor deste parâmetro deve ser `CancelServiceOrder`. Tipo de dados: cadeia de caracteres Padrão: cadeia de caracteres em branco

Cabeçalhos

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.
Tipo de conteúdo	Formato de dados do corpo da solicitação. 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 resposta. Oferece suporte somente a application/json.

Códigos de status

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

Tabela 24. Códigos de status
Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: Carga vazia. Carga inválida. Campo obrigatório ausente:<field name> . ID de pedido inválido. ID de pedido inválido: `este pedido ainda não foi criado na tabela de pedidos do cliente`. A solicitação de cancelamento foi feita para um pedido que ainda não foi criado. A ordem está na tabela Fila de entrada [sn_tmt_core_inbound_queue] aguardando o programador selecionar o registro.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
CancelamentoMotivo	Motivo do cancelamento. Tipo de dados: cadeia de caracteres
id	Sys_id do pedido cancelado. Tipo de dados: cadeia de caracteres
pedido de serviço	Contém dados sobre a ordem de serviço. Tipo de dados: objeto `"serviceOrder": { "id": "String", "@referredType": "String" }`
serviceOrder.id	Sys_id do pedido cancelado. Tipo de dados: cadeia de caracteres
serviceOrder.@referredType	O valor deste parâmetro é `ServiceOrder`. Tipo de dados: cadeia de caracteres
requestCancellationDate	Data para cancelar o pedido. Tipo de dados: cadeia de caracteres
state	Estado do cancelamento. Se a solicitação de cancelamento tiver sido processada com sucesso (código de status 201), o valor desse parâmetro será `concluído`. Tipo de dados: cadeia de caracteres
@tipo	O valor deste parâmetro é `CancelServiceOrder`. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo de código a seguir cancela um pedido do cliente.

curl -X POST "https://instance.servicenow.com/api/sn_ind_tmt_orm/cancelserviceorder" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "cancellationReason": "Duplicate order",
  "requestedCancellationDate": "2023-01-24T11:56:21.931Z",
  "serviceOrder": {
    "id": "5f4f5e5377a311101fa5a4d54b5a99fd",
    "@referredType": "ServiceOrder"
  },
  "@type": "CancelServiceOrder"
}

{
  "id": "5f4f5e5377a311101fa5a4d54b5a99fd",
  "cancellationReason": "Duplicate order",
  "requestedCancellationDate": "2023-01-24T11:56:21.931Z",
  "@type": "CancelServiceOrder",
  "serviceOrder": {
    "id": "5f4f5e5377a311101fa5a4d54b5a99fd",
    "@referredType": "ServiceOrder"
  },
  "state": "done"
}

API aberta de ordem de serviço – POST /sn_ind_tmt_orm/serviceorder

Cria, atualiza ou exclui um pedido de serviço ou item de linha.

Quando uma ação de adição é recebida e aceita, um novo registro é criado nas seguintes tabelas:

Pedido [sn_ind_tmt_orm_order]
Valor da característica do pedido [sn_ind_tmt_orm_order_characteristic_value]
Item da linha do pedido [sn_ind_tmt_orm_order_line_item]
Contato do item de linha do pedido [sn_ind_tmt_orm_order_line_item_contact]
Itens relacionados à linha do pedido [sn_ind_tmt_orm_order_line_related_items]

Formato de URL

/api/sn_ind_tmt_orm/serviceorder

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho
Nome	Descrição
Nenhum

Tabela 26. Parâmetros de consulta
Nome	Descrição
Modo	Habilita o processamento de pedido assíncrono. Ou seja, o pedido é adicionado à tabela Fila de entrada [sn_tmt_core_inbound_queue] a ser criada. Se não for incluído, o pedido será processado de forma síncrona. Valor possível: assíncrono Tipo de dados: cadeia de caracteres

Tabela 27. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
committedDueDate	Data e hora em que a ação deve ser realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate para cada item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/committed_due_date
IDexterno	Número de ordem exclusivo para a ordem de serviço externa. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order
anotação	Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz `"note:" [ { "text": "String" } ]` Tabela/campo atualizado: sn_ind_tmt_orm_order
nota.texto	Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/comments Padrão: cadeia de caracteres em branco
orderDate	Data da solicitação de pedido do cliente. Tipo de dados: cadeia de caracteres
relatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. A solicitação deve listar pelo menos um item que contenha informações da conta do cliente ou da conta do consumidor. Tipo de dados: matriz `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Obrigatório. Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Localizado na tabela Conta [customer_account], tabela Contato [customer_contact] ou tabela Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres Tabela atualizada: sn_ind_tmt_orm_order
relatedParty.name	Nome da conta, do cliente ou do consumidor. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Cliente CustomerContact Consumidor Tipo de dados: cadeia de caracteres
parte relacionada. @tipo	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
requestCompletionDate	Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_end_date Padrão: cadeia de caracteres em branco
requestStartDate	Data de início do pedido solicitada pelo cliente. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order/expected_start_date Padrão: cadeia de caracteres em branco
serviceOrderItem	Obrigatório. Matriz de objetos que descreve os itens de linha na ordem de serviço e sua ação associada. Tipo de dados: matriz `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]` Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item
itemDeOrdemDeServiço.ação	Obrigatório. Ação a ser executada no item da ordem de serviço. As ações possíveis são definidas na guia Lista de seleção no campo Entrada de dicionário de ação da tabela sn_ind_tmt_orm_order_line_item. Valores possíveis: adicionar mudança excluir sem mudança resume suspender Para obter detalhes, consulte Action types for customer and service orders. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/action Padrão: adicionar
ItemDeOrdemDeServiço.MotivoDeação	Opcional. Descrição do motivo do item de linha. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]/action_reason.
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/committed_due_date
serviceOrderItem.externalProductInventory	Matriz de objetos que contém IDs externos a serem mapeados para os inventários de produtos criados para o pedido. Tipo de dados: matriz `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externo a ser mapeado para o inventário de produtos. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_inventory_id e sn_prd_invt_product_inventory/sn_prd_invt_external_id
serviceOrderItem.id	Obrigatório. Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/external_id
serviceOrderItem.orderRelationship	Obrigatório. Matriz de objetos que descreve os relacionamentos entre os itens de linha do pedido. Tipo de dados: matriz `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item
serviceOrderItem.orderRelationship.id	Obrigatório. Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/parent_line_item ou sn_ind_tmt_orm_order_line_related_items/related_order_line_item
serviceOrderItem.orderRelationship.relationshipType	Obrigatório. Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: Tem secundário Tem primário Requer `HasChild` e `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.place	Mapa dos locais nos quais o serviço será instalado. Tipo de dados: objeto `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Obrigatório. Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item/location Padrão: cadeia de caracteres em branco
itemDeOrdemDeServiço.place.@tipo	Parte do padrão da API aberta do TMF. Anotação para o local do item de linha do pedido. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.quantidade	Define o número de itens de linha a serem solicitados. Esta propriedade só é aplicável ao adicionar uma ordem de serviço; ou seja, o valor da propriedade action é `add`. Tipo de dados: número Padrão: cadeia de caracteres vazia Tabela/campo atualizado: sn_ind_tmt_orm_order/quantity
serviceOrderItem.relatedParty	Lista de contatos para itens de linha. Tipo de dados: matriz `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.firstName	Nome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.lastName	Sobrenome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@type	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
serviçoItemOrdem.serviço	Obrigatório. Descrição dos detalhes da instância do serviço adquirido pelo cliente. Tipo de dados: objeto `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }` Tabela/campo atualizado: sn_ind_tmt_orm_order_line_item
serviceOrderItem.service.id	Identificador exclusivo do serviço vendido. Este valor pode ser o sys_id ou o ID externo na tabela Product Inventory [sn_ind_tmt_orm_product_inventory]. Este valor é usado somente para pedidos de mudança/desconexão. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic	Lista que descreve as características do serviço associado. Somente as características de serviço com um value atual diferente de previousValue são retornadas. Tipo de dados: matriz `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nome do registro da característica a ser associado ao serviço. Localizado na tabela Característica [sn_prd_pm_characteristic]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.previousValue	Valores da opção da característica anterior se a atualização for para a ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro serviceOrderItem.action for diferente de `add`. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.value	Valores de opção de característica associados ao serviço. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceRelationship	Lista de inventários de produtos relacionados ao serviço. Tipo de dados: matriz `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário de produtos. Localizado no campo sys_id ou sn_prd_invt_external_id da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceRelationship.relationshipType	Tipo de relacionamento entre o serviço e o inventário de produtos. Valor possível: requer Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification	Obrigatório. Descrição da especificação de serviço associada ao serviço. Tipo de dados: objeto `"serviceSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Atualiza o campo service_specification na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item].
serviceOrderItem.service.serviceSpecification.id	Obrigatório. Inicial_versão ou external_id da especificação de serviço. O inicial_versão é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.internalVersion	Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.name	Obrigatório. Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.version	External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.@type	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceSpecificationRef`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrderItem`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrder`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres

Cabeçalhos

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

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

Códigos de status

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

Tabela 30. Códigos de status
Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
201	Bem-sucedido. Se houver algum problema com as características ou informações de opção de características, o endpoint armazenará os seguintes comentários nos campos de anotações de trabalho do registro de item de linha do pedido do cliente associado: As seguintes características do item do pedido não existem: revise a especificação <specification.name> e corrija a característica e a opção de característica no item de linha do pedido antes de aprovar o pedido. A característica do item do pedido: <characteristic.name> com o valor da característica: <characteristic.value> é inválida. Corrija os valores da característica antes de aprovar o pedido.
202	Aceito. Solicitação bem-sucedida de um pedido no modo assíncrono. Ou seja, a solicitação foi feita com o parâmetro mode definido como `assíncrono` e o registro está programado para ser processado na tabela Fila de entrada [sn_tmt_core_inbound_queue].
400	Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: Carga inválida: corpo da solicitação ausente. - A carga não foi aprovada no corpo da solicitação. Carga inválida: serviceOrderItem ausente. - O objeto de item de linha da ordem de serviço ou JSON está ausente. Carga inválida: o ID de serviceOrderItem está ausente. – O ID está ausente no item de linha da ordem de serviço. Carga inválida: a ação serviceOrderItem está ausente. – O objeto de serviço ou JSON está ausente na carga útil. Carga inválida: o serviço serviceOrderItem está ausente. – A propriedade de serviço está ausente no item de linha da ordem de serviço. Carga inválida: serviceSpecification ausente. - O objeto de especificação de serviço ou JSON no item de linha da ordem de serviço está ausente na carga útil. Carga inválida: serviceSpecification ID ausente. - O parâmetro id no item de linha da ordem de serviço do objeto de especificação de serviço está ausente na carga útil. Carga inválida: a especificação de serviço não existe. - A especificação de serviço no item de linha da ordem de serviço não é válida. Carga inválida: o inventário do produto não existe. - Em um pedido de mudança ou exclusão (ou seja, ação = mudança ou exclusão), o serviço vendido enviado não está presente no sistema. Carga inválida: o ID do inventário do produto está ausente. – Em um pedido de mudança ou exclusão, o ID do produto vendido está ausente na carga útil. Carga inválida: a conta do cliente ou o consumidor está ausente - o cliente da parte relacionada ou o objeto do consumidor está ausente na carga útil. Carga inválida: o produto vendido está inativo. – Em um pedido de mudança ou exclusão, o produto vendido enviado na carga não está no estado ativo. Carga inválida: o consumidor não existe: o consumidor de parte relacionada especificado não existe na instância. Carga inválida: a conta do cliente não existe. – O cliente da parte relacionada fornecido na carga útil não está presente no sistema. Carga inválida: falha na criação do pedido. - Não é possível criar o pedido solicitado.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
committedDueDate	Data e hora em que a ação deve ser realizada no pedido. Este valor deve ser igual ou posterior aos valores committedDueDate para cada item de linha do pedido. Tipo de dados: cadeia de caracteres
IDexterno	Número de ordem exclusivo para a ordem de serviço externa. Tipo de dados: cadeia de caracteres
id	Sys_id da ordem de serviço. Tipo de dados: cadeia de caracteres
anotação	Matriz de objetos que descreve anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: matriz `"note": [ { "text": "String" } ]`
nota.texto	Anotações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: cadeia de caracteres
orderId	Sys_id do pedido a ser criado. Após a solicitação bem-sucedida, o pedido é adicionado à tabela Fila de entrada [sn_tmt_core_inbound_queue] em uma programação a ser processada. Nota: Este valor será o único resultado se a ordem for criada de forma assíncrona usando o parâmetro de consulta mode. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Tipo de dados: cadeia de caracteres
relatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. Tipo de dados: matriz `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id da conta ou contato do cliente associado ao pedido. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.name	Nome da conta, do cliente ou do consumidor. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Cliente CustomerContact Consumidor Tipo de dados: cadeia de caracteres
parte relacionada. @tipo	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
requestCompletionDate	Data de entrega solicitada pelo cliente. Tipo de dados: cadeia de caracteres
requestStartDate	Data de início do pedido solicitada pelo cliente. Tipo de dados: cadeia de caracteres
serviceOrderItem	Matriz de objetos que descreve os itens de linha na ordem de serviço e sua ação associada. Tipo de dados: matriz `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]`
itemDeOrdemDeServiço.ação	Ação a ser executada no item da ordem de serviço. As ações possíveis são definidas na guia Lista de seleção no campo Entrada de dicionário de ação da tabela sn_ind_tmt_orm_order_line_item. Valores possíveis: adicionar mudança excluir sem mudança resume suspender Para obter detalhes, consulte Action types for customer and service orders. Tipo de dados: cadeia de caracteres
ItemDeOrdemDeServiço.MotivoDeação	Descrição do motivo para adicionar o item de linha. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser realizada no item de linha do pedido. Tipo de dados: cadeia de caracteres
serviceOrderItem.externalProductInventory	Matriz de objetos que contém IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: matriz `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário de produtos. Tipo de dados: cadeia de caracteres
serviceOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceOrderItem.orderRelationship	Matriz de objetos que descreve os relacionamentos entre os itens de linha do pedido. Tipo de dados: matriz `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orm_external_id da tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceOrderItem.orderRelationship.relationshipType	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: Tem secundário Tem primário Requer `HasChild` e `HasParent` são usados para relacionamentos primário/secundário. `Requer` é usado para relacionamentos horizontais (um item de linha requer outro item de linha). Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.place	Mapa dos locais nos quais o serviço será instalado. Tipo de dados: objeto `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id do registro de local associado na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.place.@tipo	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Posição`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.quantidade	Número de itens de linha solicitados. Tipo de dados: número
serviceOrderItem.relatedParty	Lista de contatos para itens de linha. Tipo de dados: matriz `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.e-mail	Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.firstName	Nome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.lastName	Sobrenome do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.phone	Número de telefone comercial do contato. Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: cadeia de caracteres
serviceOrderItem.relatedParty.@type	Parte do padrão da API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
serviçoItemOrdem.serviço	Descrição dos detalhes da instância do serviço adquirido pelo cliente. Tipo de dados: objeto `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }`
serviceOrderItem.service.id	Identificador exclusivo do serviço vendido. Este valor pode ser o sys_id ou o ID externo na tabela Product Inventory [sn_ind_tmt_orm_product_inventory]. Este valor só é retornado para pedidos de mudança/desconexão. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic	Lista que descreve as características do serviço associado. Somente as características de serviço com um value atual diferente de previousValue são retornadas. Tipo de dados: matriz `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nome do registro da característica a ser associado ao serviço. Localizado na tabela Característica [sn_prd_pm_characteristic]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.previousValue	Valores da opção da característica anterior se a atualização for para a ordem de mudança. A solicitação será uma ordem de mudança se o parâmetro serviceOrderItem.action for diferente de `add`. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.value	Valores de opção de característica associados ao serviço. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceRelationship	Lista de inventários de produtos relacionados ao serviço. Tipo de dados: matriz `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário de produtos. Localizado no campo sys_id ou sn_prd_invt_external_id da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceRelationship.relationshipType	Tipo de relacionamento entre o serviço e o inventário de produtos. Valor possível: requer Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification	Descrição da especificação de serviço associada ao serviço. Tipo de dados: objeto `"serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Inicial_versão ou external_id da especificação de serviço. O inicial_versão é o sys_id da primeira versão da especificação. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.internalId	Inicial_versão da especificação de serviço. O inicial_versão é o sys_id da primeira versão da especificação. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.internalVersion	Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.name	Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.version	External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification]. Tipo de dados: cadeia de caracteres
serviceOrderItem.service.serviceSpecification.@type	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceSpecificationRef`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.estado	Estado do item da ordem de serviço. Por exemplo, novo. Tipo de dados: cadeia de caracteres
itemDeOrdemDeServiço.@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrderItem`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
state	Estado da ordem de serviço. Tipo de dados: cadeia de caracteres
@tipo	Parte do padrão da API aberta do TMF. Este valor é sempre `ServiceOrder`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres

Processando de forma assíncrona

Este exemplo mostra como usar o parâmetro de consulta mode para criar um pedido de forma assíncrona. O pedido é adicionado à tabela Fila de entrada [sn_tmt_core_inbound_queue] em uma programação a ser criada.

curl -X POST 'https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder?mode=async' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      "actionReason":"adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic( Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}'

Corpo da resposta.

{
  "orderId": "304e877ac3ab5110856d73ce3640dde5"
}

Processamento síncrono (padrão)

O exemplo a seguir mostra como criar uma ordem de serviço definindo a propriedade serviceOrderItem.action como add.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "add",
         "actionReason":"adding service package OLI",
         "quantity": 1,
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Standard"
               },
               {
                  "name": "Firewall coverage",
                  "value": "Premium (Up to 50 sites)"
               },
               {
                  "name": "Administration Support",
                  "value": "Basic (Customer Managed)"
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "@type": "Managed Firewall Service"
            }
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

Corpo da resposta:

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "add",
         "actionReason":"adding service package OLI",
         "quantity": 1,
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Standard"
               },
               {
                  "name": "Firewall coverage",
                  "value": "Premium (Up to 50 sites)"
               },
               {
                  "name": "Administration Support",
                  "value": "Basic (Customer Managed)"
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "@type": "Managed Firewall Service",
               "internalVersion": "2",
               "version": "v2",
               "internalId": "f99546ff07266010a7955b7e0ad300a8"
            }
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "state": "new"
}

Solicitação de cURL

O exemplo a seguir atualiza uma ordem de serviço definindo a propriedade serviceOrderItem.action como change.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "change",
         "actionReason":"change service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

Corpo da resposta.

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "change",
         "actionReason":"change service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "state": "new"
}

Solicitação de cURL

O exemplo a seguir exclui um item de linha de ordem de serviço definindo a propriedade serviceOrderItem.action como excluir.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "delete",
         "actionReason":"delete service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

Corpo da resposta.

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "delete",
         "actionReason":"delete service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "state": "new"
}

API aberta de ordem de serviço – POST /sn_ind_tmt_orm/serviceorder/outboundresponse

Atualiza o estado de execução dos registros de pedido de domínio especificados na tabela Solicitação de saída [sn_tmt_core_outbound_request].

Para usar este método, a tabela Solicitação de saída deve conter o registro de pedido de domínio especificado. Além disso, a validação do método gera um erro se os registros ou estados especificados no corpo da solicitação não estiverem localizados no registro de saída existente.

Nota:

Você não pode criar novos registros nesta tabela usando este endpoint.

Para obter informações adicionais sobre pedidos de domínio, consulte Order Management data model.

Formato de URL

/api/sn_ind_tmt_orm/serviceorder/outboundresponse

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho
Nome	Descrição
Nenhum

Tabela 32. Parâmetros de consulta
Nome	Descrição
Nenhum

Tabela 33. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
IDexterno	Obrigatório. Identificador de solicitação de saída do registro de pedidos de domínio enviado para execução. Localizado no campo request_id na tabela Solicitação de saída [sn_tmt_core_outbound_request]. Tipo de dados: cadeia de caracteres
ItemDeOrdemDeServiço	Obrigatório. Lista de pedidos de domínio cujo estado de execução externo precisa ser atualizado. Tipo de dados: matriz de objetos `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceOrderItem.id	Obrigatório. Sys_id de um registro de pedido de domínio para o qual atualizar o estado de execução externo. Localizado na tabela Pedido de domínio [sn_ind_tmt_orm_domain_order]. Tipo de dados: cadeia de caracteres
ItemDeOrdemDeServiço.estado	Obrigatório. Estado de execução externo do pedido de domínio. Valores válidos: Erro atendido pendente Tipo de dados: cadeia de caracteres

Cabeçalhos

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.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Tabela 35. Cabeçalhos de resposta
Cabeçalho	Descrição
Nenhum

Códigos de status

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

Tabela 36. Códigos de status
Código de status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: `Carga inválida: externalId ausente`: indica que o ID externo (externalId) não foi aprovado. `Carga inválida: o estado serviceOrderItem está ausente:` indica que o estado de execução externo (ServiceOrderItem.state) não foi aprovado em um ou mais pedidos de domínio. `ID externo inválido. Passe o ID externo correto`: indica que o ID externo passado (externalId) não está presente no sistema. `ID de pedido de domínio inválido. Passe o ID de pedido de domínio correto`: indica que o ID de pedido de domínio passado (ServiceOrderItem.id) não está presente no sistema. `O ID de pedido de domínio passado não está associado ao ID externo`: indica que o ID externo (externalId) não está associado a nenhum pedido de domínio. O sistema atualiza somente os pedidos de domínio que estão associados a um ID externo passado na carga útil. `Estado de execução inválido: Forneça o estado de execução correto`: indica que o estado de execução aprovado (ServiceOrderItem.state) para um ou mais pedidos de domínio não é válido.
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
IDexterno	Identificador de solicitação de saída do registro de pedidos de domínio enviado para execução. Localizado no campo request_id na tabela Solicitação de saída [sn_tmt_core_outbound_request]. Tipo de dados: cadeia de caracteres
ItemDeOrdemDeServiço	Lista de pedidos de domínio cujo estado de execução externo precisa ser atualizado. Tipo de dados: matriz de objetos `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceOrderItem.id	Sys_id de um registro de pedido de domínio para o qual atualizar o estado de execução externo. Localizado na tabela Pedido de domínio [sn_ind_tmt_orm_domain_order]. Tipo de dados: cadeia de caracteres
ItemDeOrdemDeServiço.estado	Estado de execução externo do pedido de domínio. Valores possíveis: Erro atendido pendente Tipo de dados: cadeia de caracteres

Solicitação de cURL

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

curl "http://instance.servicenow.com/api/sn_ind_tmt_orm/serviceorder/outboundresponse" \ 
--request POST \
--header "Accept:application/json" \
--data "{ 
  "externalId": "607017d243322110461f99612bb8f25c",
  "serviceOrderItem": [
    {
      "id": "19913c3577b301108e191e599a5a9988",
      "state": "error"
    }
  ]
}"
--user 'username':'password'

Resposta:

{
  "externalId": "607017d243322110461f99612bb8f25c",
  "serviceOrderItem": [
    {
      "id": "19913c3577b301108e191e599a5a9988",
      "state": "error"
    }
  ]
}