API de ordem de serviço aberta

Versão de lançamento: Zurich

Atualizado 31 de jul. de 2025

73 min. de leitura

. Ordem de serviço aberta A API fornece endpoint que habilita um mecanismo padronizado para fazer ordens de serviço.

Esta API é um ServiceNow® Implementação da API aberta TMForum TMF641 Service Ordering Management.

Logotipo de conformidade da TMF

Para acessar esta API, o 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 .

Esta API é fornecida no sn_tmf_api namespace.

O usuário chamador deve ter a função sn_ind_tmt_orn.order_integrator.

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

API de ordem de serviço em aberto - GET /sn_tmf_api/order/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_orn_order]
Valor da característica do pedido [sn_ind_tmt_orn_order_characteristic_value]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]
Itens relacionados à linha de pedido [sn_ind_tmt_orn_order_line_related_items]

Formato de URL

/api/sn_tmf_api/order/serviceOrder

Parâmetros de solicitação compatíveis

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

Tabela 2. Parâmetros de consulta
Nome	Descrição
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 offsetparâmetro para paginar a recuperação de registro. Tipo de dados: Número Padrão: 20 Máximo: 100
deslocamento	Índice inicial no qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Tipo de dados: Número Padrão: 0
estado	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. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
Nenhum(a)

Cabeçalhos

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

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

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

Códigos de status

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

Tabela 6. Códigos de status
Código do status	Descrição
200	Solicitação processada com sucesso. 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 executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data em que o pedido deve ser concluído. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
id	Sys_id da ordem de serviço solicitada. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	Nome de usuário da pessoa que criou a anotação associada. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi criada. Tipo de dados: Cadeia de caracteres
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
orderDate	Carimbo de data e hora do pedido. FORMATO: AAAA-MM-DD HH:MM:SS Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ponr	Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores válidos: Verdadeiro: O ponto sem retorno do pedido foi atingido. O pedido não pode ser modificado ou cancelado enquanto a execução estiver em andamento. Falso: O ponto sem retorno do pedido não foi atingido. O pedido pode ser modificado ou cancelado. Tipo de dados: Booliano
RelatedParty	Lista de contatos do pedido. Tipo de dados: Matriz de objetos `"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, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
ServiceOrderItem	Lista de 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
ServiceOrderItem.action	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 do Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Para obter detalhes, consulte Action types for customer and service orders. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.externalProductInventory	Lista de IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ServiceOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres
serviceOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.orderRelationship	Lista de relacionamentos entre 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_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.orderRelationship.Relationship.Relationship Type	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent 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
ServiceOrderItem.Quantidade	Número de itens de linha solicitados. Tipo de dados: Número
serviceOrderItem.place	Mapa dos locais nos quais instalar o serviço. 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
serviceOrderItem.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.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 do item de linha do pedido foi atingido. O item de linha do pedido não pode ser modificado ou cancelado enquanto a execução estiver em andamento. Falso: O ponto sem retorno do 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_orn_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. Em referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
ServiceOrderItem.RelatedParty. No tipo	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service	Descrição dos detalhes da instância do serviço comprado 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 características de serviço com uma corrente valuediferente de previousValueretornados. 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. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Número inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceRelationship	Lista de inventários de produtos relacionados ao serviço. Tipo de dados: Matriz de objetos `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou sn_prd_invt_external_id da tabela Inventário de produto [sn_prd_invt_product_inventory].
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	Initial_version ou external_id da especificação do serviço. Initial_version é 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	Versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceOrderItem.service.serviceSpecification.internalVersion	Versão da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.name	Nome da especificação do 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 do serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.@type	Parte do padrão TMF Open API. 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
serviceOrderItem.service.state	Estado do produto vendido. Por exemplo, novo. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.state	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
ServiceOrderItem. No tipo	Parte do padrão TMF Open API. Este valor é sempre `ServiceOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de serviço. Para obter mais informações, consulteService order states. Tipo de dados: Cadeia de caracteres
.	Parte do padrão TMF Open API. 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 todas as ordens de serviço.

curl --location --request GET 'http://instance.service-now.com/api/sn_tmf_api/order/serviceOrder' \
--user 'username':'password'

Corpo da resposta.

[
    {
        "id": "bd30366ec3a83010abc8b5183c40dd92",
        "ponr": "true",
        "href": "/api/sn_tmf_api/order/serviceOrder/bd30366ec3a83010abc8b5183c40dd92",
        "completionDate": "2021-06-07T21:52:12.000Z",
        "expectedCompletionDate": "2018-01-14T20:07:40.000Z",
        "orderDate": "2021-06-08T05:34:59.000Z",
        "requestedCompletionDate": "2018-01-14T20:07:40.000Z",
        "requestedStartDate": "2018-01-14T20:07:40.000Z",
        "serviceOrderItem": [
            {
                "id": "100",
                "ponr": "true",
                "quantity": 1,
                "action": "add",
                "service": {
                    "@type": "Service",
                    "id": "4b5072aec3a83010abc8b5183c40dd42",
                    "state": "active",
                    "serviceType": "cfs",
                    "serviceCharacteristic": [
                        {
                            "name": "Firewall coverage",
                            "valueType": "Choice",
                            "value": "Premium(Up to 50 sites)\n\t\t",
                            "previousValue": ""
                        },
                        {
                            "name": "Firewall Security",
                            "valueType": "choice",
                            "value": "Premium",
                            "previousValue": ""
                        },
                        {
                            "name": "CPE Type",
                            "valueType": "choice",
                            "value": "Physical",
                            "previousValue": ""
                        },
                        {
                            "name": "Administration Support",
                            "valueType": "choice",
                            "value": "Basic( Customer Managed)\n\t\t",
                            "previousValue": ""
                        }
                    ],
                    "serviceSpecification": {
                        "id": "f99546ff07266010a7955b7e0ad300a8",
                        "name": "Managed Firewall Service",
                        "version": "",
                        "internalVersion": "1",
                        "internalId": "f99546ff07266010a7955b7e0ad300a8",
                        "@type": "ServiceSpecificationRef"
                    }
                },
                "place": {
                    "id": "920cf6ac73d423002728660c4cf6a799",
                    "@type": "Place"
                },
                "state": "completed",
                "version": "2",
                "@type": "ServiceOrderItem"
            }
        ],
        "relatedParty": [
            {
                "id": "ffc68911c35420105252716b7d40dd55",
                "name": "Funco Intl",
                "@type": "RelatedParty",
                "@referredType": "Customer"
            },
            {
                "id": "eaf68911c35420105252716b7d40ddde",
                "name": "Sally Thomas",
                "@type": "RelatedParty",
                "@referredType": "CustomerContact"
            }
        ],
        "state": "completed",
        "version": "2",
        "@type": "ServiceOrder"
    }
]

API de ordem de serviço em aberto - GET /sn_tmf_api/order/serviceOrder/

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_orn_order]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
Valor da característica do pedido [sn_ind_tmt_orn_order_characteristic_value]
Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]
Itens relacionados à linha de pedido [sn_ind_tmt_orn_order_line_related_items]

Formato de URL

/api/sn_tmf_api/order/serviceOrder/

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. Tipo de dados: Cadeia de caracteres Tabela: Pedido [sn_ind_tmt_orn_order]

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

Tabela 9. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
Nenhum(a)

Cabeçalhos

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

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 seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 12. Códigos de status
Código do status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação). A resposta retornará Bem-sucedida com uma mensagem de erro se o pedido selecionado tiver problemas de processamento. Uma resposta 200 OK acontece se o pedido estiver na tabela Fila de entrada [sn_tmt_core_inbound_queue] aguardando que o programador escolha 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 pedido 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 de 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 executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	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
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	Nome de usuário da pessoa que criou a anotação associada. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi criada. Tipo de dados: Cadeia de caracteres
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
orderDate	Carimbo de data e hora do pedido. FORMATO: AAAA-MM-DD HH:MM:SS Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ponr	Sinalizador que indica se o ponto sem retorno do pedido foi atingido. Valores válidos: Verdadeiro: O ponto sem retorno do pedido foi atingido. O pedido não pode ser modificado ou cancelado enquanto a execução estiver em andamento. Falso: O ponto sem retorno do pedido não foi atingido. O pedido pode ser modificado ou cancelado. Tipo de dados: Booliano
RelatedParty	Lista de contatos do pedido. Tipo de dados: Matriz de objetos `"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, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
ServiceOrderItem	Lista de 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" } ]`
ServiceOrderItem.action	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 do Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Para obter detalhes, consulte Action types for customer and service orders Tipo de dados: Cadeia de caracteres
ServiceOrderItem.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.externalProductInventory	Lista de IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ServiceOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres
serviceOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.orderRelationship	Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.orderRelationship.Relationship.Relationship Type	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent 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
ServiceOrderItem.Quantidade	Número de itens de linha solicitados. Tipo de dados: Número
serviceOrderItem.place	Mapa dos locais nos quais instalar o serviço. 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
serviceOrderItem.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.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 do item de linha do pedido foi atingido. O item de linha do pedido não pode ser modificado ou cancelado enquanto a execução estiver em andamento. Falso: O ponto sem retorno do 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_orn_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. Em referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
ServiceOrderItem.RelatedParty. No tipo	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service	Descrição dos detalhes da instância do serviço comprado 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 características de serviço com uma corrente valuediferente de previousValueretornados. 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. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Número inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceRelationship	Lista de inventários de produtos relacionados ao serviço. Tipo de dados: Matriz de objetos `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou sn_prd_invt_external_id da tabela Inventário de produto [sn_prd_invt_product_inventory].
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	Initial_version ou external_id da especificação do serviço. Initial_version é 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	Versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceOrderItem.service.serviceSpecification.internalVersion	Versão da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.name	Nome da especificação do 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 do serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.@type	Parte do padrão TMF Open API. 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
serviceOrderItem.service.state	Estado do produto vendido. Por exemplo, novo. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.state	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
ServiceOrderItem. No tipo	Parte do padrão TMF Open API. Este valor é sempre `ServiceOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de serviço. Para obter mais informações, consulteService order states. Tipo de dados: Cadeia de caracteres
.	Parte do padrão TMF Open API. 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_tmf_api/order/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"
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcfç",
   "orderDate": "2021-06-08T05:34:59.000Z",
}

API de ordem de serviço em aberto - PATCH /sn_tmf_api/order/serviceOrder/

Atualiza a ordem de serviço especificada.

Formato de URL

URL padrão: /api/sn_tmf_api/order/serviceOrder/

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho
Nome	Descrição
id	Sys_id da ordem do cliente a ser atualizada. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]

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

Tabela 15. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
committedDueDate	Data e hora em que a ação deve ser executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Se a ação para itens de linha do pedido for `suspender` ou `retomar` este parâmetro não pode ser atualizado. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela sn_ind_tmt_orn_order.
externalId	Número do pedido exclusivo para a ordem de serviço externa. Tipo de dados: Cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orn_order
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "text": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de comentários da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. A solicitação deve listar pelo menos um item que contém 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. Tipo de dados: Cadeia de caracteres Tabela: Tabela Conta [customer_account], tabela Contato [customer_contact] ou Consumidor [csm_consumer] Tabela atualizada: sn_ind_tmt_ORM_ORM_ORDER
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_end_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_start_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
ServiceOrderItem	Obrigatório. Lista de itens de linha na ordem de serviço e sua ação associada. Tipo de dados: Matriz de objetos `"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_orn_order_line_item
ServiceOrderItem.action	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 do Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Valores possíveis: adicionar mudança excluir nenhuma 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_orn_order_line_item/action
ServiceOrderItem.actionMotivo	Opcional. Descrição do motivo do item de linha. Tipo de dados: Cadeia de caracteres Tabela/campo atualizado: Item de linha do pedido [sn_ind_tmt_orn_order_line_item] table/action_reason.
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Se a ação do item for `suspender` ou `retomar` este parâmetro não pode ser atualizado. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela sn_ind_tmt_orn_order_line_item.
ServiceOrderItem.externalProductInventory	Lista de IDs externos a serem mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Nota: Anteriormente, ao criar um pedido DE PATCH com um ID de inventário de produto externo que já existia, a operação era anulada e retornava um erro. Com Xanadu Este parâmetro é simplesmente ignorado quando um ID de inventário de produto externo existente é fornecido e um erro não é gerado.
ServiceOrderItem.externalProductInventory.externalProductInventoryId	ID externo a ser mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_inventory_id da tabela Item de linha do pedido [sn_ind_tmt_ORM_order_line_item] e o campo sn_prd_invt_external_id da tabela sn_prd_invt_product_inventory.
serviceOrderItem.id	Obrigatório. Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orn_order_line_item/external_id
ServiceOrderItem.orderRelationship	Obrigatório. Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabela/campo atualizado: sn_ind_tmt_orn_order_line_item
serviceOrderItem.orderRelationship.id	Obrigatório. Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_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.Relationship.Relationship Type	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: HasChild HasParent 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
serviceOrderItem.place	Mapa dos locais nos quais instalar o serviço. 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_orn_order_line_item/location
serviceOrderItem.place.@type	Padrão de API aberta do TMF. Anotação para local do item de linha do pedido. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.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 de actiona propriedade é `adicionar` . Tipo de dados: Número Cadeia de caracteres vazia Tabela/campo atualizado: sn_ind_tmt_orn_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. Em referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
ServiceOrderItem.RelatedParty. No tipo	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service	Obrigatório. Descrição dos detalhes da instância do serviço comprado pelo cliente. Tipo de dados: Objeto `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }` Tabela/campo atualizado: sn_ind_tmt_orn_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 Inventário de produto [sn_ind_tmt_orn_product_inventory]. Este valor é usado somente para ordens 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 características de serviço com uma corrente valuediferente de previousValueretornados. Tipo de dados: Matriz `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nome do registro de característica a ser associado ao serviço. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para pedido de mudança. A solicitação é uma ordem de mudança se serviceOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.value	Valores de opção de característica associados ao serviço. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Número inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceSpecification	Obrigatório. Descrição da especificação de serviço associada ao serviço. Nota: Ordens de mudança ( serviceOrderItem.action. `mudança` ) são processados de forma diferente com base no valor de sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderpropriedade do sistema. Quando a propriedade é definida como verdadeira (padrão), se o serviço for uma versão diferente da indicada na ordem, o serviço será atualizado automaticamente para a versão na ordem alterando a especificação do serviço referenciado. Isso permite que o pedido seja processado com sucesso. Quando a propriedade é definida como falsa, se o serviço for uma versão diferente da indicada no pedido, o pedido falhará devido à incompatibilidade da versão. Tipo de dados: Objeto `"serviceSpecification:" { "id": "String", "name": "String", "@type": "String" }` Armazenado em: O campo service_specification da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
serviceOrderItem.service.serviceSpecification.id	Obrigatório. Initial_version ou external_id da especificação do serviço. Initial_version é 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 do 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 TMF Open API. Este valor é sempre `ServiceSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceOrderItem. No tipo	Parte do padrão TMF Open API. Este valor é sempre `ServiceOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
.	Parte do padrão TMF Open API. 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 seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 18. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
201	Bem-sucedido. Se houver problemas com as características ou as informações da 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 de pedido do cliente associado: `As seguintes características do item do pedido não existem: Revisar 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.` `Característica do item do pedido characteristic.name> com valor de característica: > characteristic.value> é inválido. Corrija os valores das características antes de aprovar o pedido.`
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: `Carga inválida: Corpo da solicitação ausente` A carga não foi passada no corpo da solicitação. `Carga inválida: ServiceOrderItem está ausente` Objeto de item de linha da ordem de serviço ou JSON ausente. `Carga inválida: O ID ServiceOrderItem está ausente` - O. ido parâmetro está ausente no item de linha da ordem de serviço da carga. `Carga inválida: A ação ServiceOrderItem está ausente` - O. actiono parâmetro está ausente no item de linha da ordem de serviço da carga. `Carga inválida: O serviceOrderItem serviceOffering está ausente` - O objeto de oferta de serviço ou JSON está ausente no item de linha da ordem de serviço na carga. `Carga inválida: O ID do ServiceOffering está ausente` - O. ido parâmetro está ausente no item de linha da ordem de serviço do objeto de oferta de serviço na carga. `Carga inválida: A oferta de serviço não existe` - A oferta de serviço no item de linha da ordem de serviço não é válida. `Carga inválida: O serviço ServiceOrderItem está ausente` - O objeto de serviço ou JSON no item de linha da ordem de serviço está ausente na carga. `Carga inválida: Service service Specification está ausente` - O objeto de especificação de serviço ou JSON no item de linha de ordem de serviço está ausente na carga. `Carga inválida: O ID ServiceSpecification está ausente` - O. ido parâmetro no item de linha da ordem de serviço do objeto de especificação de serviço está ausente na carga. `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 a quantidade em estoque. `Carga inválida: O ID do inventário de serviço está ausente` - Em uma ordem de mudança, o. service.idestá ausente na carga. `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 da parte relacionada está ausente na carga. `Carga inválida: A conta do cliente ou o consumidor está ausente` - O objeto do cliente ou consumidor da parte relacionada está ausente na carga. `Carga inválida: A conta do cliente não existe` - O cliente da parte relacionada especificada não existe na instância. `Carga inválida: O consumidor não existe` - O consumidor da parte relacionada especificada não existe na instância. `Carga inválida: Falha na criação do pedido` - Não foi possível criar o pedido solicitado. `Revisão em andamento para a moeda do pedido não compatível` - O. orderCurrencyo parâmetro não pode ser atualizado depois que o pedido é criado. `Este pedido ainda não foi criado na tabela de pedido de venda. Verifique na fila de entrada para obter mais detalhes.` - O ID do pedido fornecido não está na tabela de pedido 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 executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres
externalId	Número do pedido exclusivo para a ordem de serviço externa. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
id	Sys_id da ordem de serviço. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz `"note": [ { "text": "String" } ]`
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
orderDate	Carimbo de data e hora do pedido. FORMATO: AAAA-MM-DD HH:MM:SS Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
RelatedParty	Lista de contatos do pedido. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
IdentidadeRelatedParty.id	Sys_id ou external_id da conta, cliente ou contato do consumidor associado ao pedido. Localizado em Tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Contato do cliente Cliente Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
ServiceOrderItem	Lista de 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" } ]`
ServiceOrderItem.action	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 do Dicionário de ação da tabela sn_ind_tmt_orn_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.actionMotivo	Motivo para adicionar o item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo action_reason da tabela sn_ind_tmt_orn_order_line_item.
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.externalProductInventory	Lista de IDs externos a serem mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Nota: Anteriormente, ao criar um pedido DE PATCH com um ID de inventário de produto externo que já existia, a operação era anulada e retornava um erro. Com Xanadu Este parâmetro é simplesmente ignorado quando um ID de inventário de produto externo existente é fornecido e um erro não é gerado.
ServiceOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.orderRelationship	Lista de relacionamentos entre 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_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.orderRelationship.Relationship.Relationship Type	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent 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
serviceOrderItem.place	Mapa dos locais nos quais instalar o serviço. 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
serviceOrderItem.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.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.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. Em referredType	Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
ServiceOrderItem.RelatedParty. No tipo	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service	Descrição dos detalhes da instância do serviço comprado 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 Inventário de produto [sn_ind_tmt_orn_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 características de serviço com uma corrente valuediferente de previousValueretornados. Tipo de dados: Matriz `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nome do registro de característica a ser associado ao serviço. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para pedido de mudança. A solicitação é uma ordem de mudança se serviceOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.value	Valores de opção de característica associados ao serviço. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Número inteiro, Data/Hora Objeto Texto de Linha Única Sim/Nã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	Initial_version ou external_id da especificação do serviço. Initial_version é 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 do 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 TMF Open API. Este valor é sempre `ServiceSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceOrderItem. No tipo	Parte do padrão TMF Open API. Este valor é sempre `ServiceOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de serviço. Para obter mais informações, consulteService order states. 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_tmf_api/order/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": "Choice",
            "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.

{
  "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": "Choice",
            "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_tmf_api/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}

API de ordem de serviço em aberto - POST /sn_tmf_api/order/serviceOrder/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 de pedido não pode ser cancelado enquanto a execução estiver em andamento.

Formato de URL

URL padrão: /api/sn_tmf_api/order/serviceOrder/cancelserviceorder

Parâmetros de solicitação compatíveis

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

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

Tabela 21. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
CancelationMotivo	Motivo do cancelamento. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ServiceOrder	Dados sobre a ordem de serviço. Tipo de dados: Objeto `"serviceOrder": { "id": "String", "href": "String", "@referredType": "String" }`
serviceOrder.id	Obrigatório. Sys_id da ordem do cliente a ser cancelada. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]
ServiceOrder.href	URL da ordem do cliente a ser cancelada. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ServiceOrder. Em referredType	O valor deste parâmetro deve ser `ServiceOrder` . Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
CancellationDate solicitada	Data para cancelar o pedido. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
.	O valor deste parâmetro deve ser `CancelServiceOrder` . Tipo de dados: Cadeia de caracteres 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 seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 24. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. 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 pedido de venda` . 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 que o programador escolha o registro.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
CancelationMotivo	Motivo do cancelamento. Tipo de dados: Cadeia de caracteres
id	Sys_id do pedido cancelado. Tipo de dados: Cadeia de caracteres
ServiceOrder	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. Em referredType	O valor deste parâmetro é `ServiceOrder` . Tipo de dados: Cadeia de caracteres
CancellationDate solicitada	Data para cancelar o pedido. Tipo de dados: Cadeia de caracteres
estado	Estado do cancelamento. Se a solicitação de cancelamento foi processada com sucesso (código de status 201), o valor desse parâmetro será `concluído` . Tipo de dados: Cadeia de caracteres
.	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 de cliente.

curl -X POST "https://instance.servicenow.com/api/sn_tmf_api/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 de ordem de serviço em aberto – POST /sn_tmf_api/order/serviceOrder

Cria, atualiza ou exclui uma ordem 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_orn_order]
Valor da característica do pedido [sn_ind_tmt_orn_order_characteristic_value]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
Contato do item de linha do pedido [sn_ind_tmt_orn_order_line_item_contact]
Itens relacionados à linha de pedido [sn_ind_tmt_orn_order_line_related_items]

Formato de URL

/api/sn_tmf_api/order/serviceOrder

Parâmetros de solicitação compatíveis

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

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

Tabela 27. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
committedDueDate	Data e hora em que a ação deve ser executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela sn_ind_tmt_orn_order.
externalId	Número do pedido exclusivo para a ordem de serviço externa. Tipo de dados: Cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orn_order
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz de objetos `"note": [ { "text": "String" } ]` Armazenado em: sn_ind_tmt_ORM_ORM_ORDER
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo de comentários da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
orderDate	Carimbo de data e hora do pedido. FORMATO: AAAA-MM-DD HH:MM:SS Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
RelatedParty	Lista de contatos do pedido. Cada contato é um objeto na matriz. A solicitação deve listar pelo menos um item que contém 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. Tipo de dados: Cadeia de caracteres Tabela: Tabela Conta [customer_account], tabela Contato [customer_contact] ou Consumidor [csm_consumer] Tabela atualizada: sn_ind_tmt_ORM_ORM_ORDER
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Contato do cliente Cliente Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_end_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres Armazenado em: O campo expected_start_date da tabela sn_ind_tmt_orn_order. Cadeia de caracteres em branco
ServiceOrderItem	Obrigatório. Lista de itens de linha na ordem de serviço e sua ação associada. Tipo de dados: Matriz de objetos `"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_orn_order_line_item
ServiceOrderItem.action	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 do Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Valores possíveis: adicionar mudança excluir nenhuma 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_orn_order_line_item/action Padrão: Adicionar
ServiceOrderItem.actionMotivo	Opcional. Descrição do motivo do item de linha. Tipo de dados: Cadeia de caracteres Tabela/campo atualizado: Item de linha do pedido [sn_ind_tmt_orn_order_line_item] table/action_reason.
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres Armazenado em: O campo committed_due_date da tabela Item de linha do pedido [sn_ind_tmt_ORM_order_line_item].
ServiceOrderItem.externalProductInventory	IDs externos a serem mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ServiceOrderItem.externalProductInventory.externalProductInventoryId	ID externo a ser mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_inventory_id da tabela sn_ind_tmt_orn_order_line_item e o campo sn_prd_invt_external_id da tabela sn_prd_invt_product_inventory.
serviceOrderItem.id	Obrigatório. Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres Tabela/campo atualizado: sn_ind_tmt_orn_order_line_item/external_id
ServiceOrderItem.orderRelationship	Obrigatório. Lista de relacionamentos entre itens de linha do pedido. Tipo de dados: Matriz de objetos `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabela/campo atualizado: sn_ind_tmt_orn_order_line_item
serviceOrderItem.orderRelationship.id	Obrigatório. Identificador exclusivo do item de linha relacionado. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_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.Relationship.Relationship Type	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: HasChild HasParent 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
serviceOrderItem.place	Mapa dos locais nos quais instalar o serviço. 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_orn_order_line_item/location Cadeia de caracteres em branco
serviceOrderItem.place.@type	Padrão de API aberta do TMF. Anotação para local do item de linha do pedido. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.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 de actiona propriedade é `adicionar` . Tipo de dados: Número Cadeia de caracteres vazia Tabela/campo atualizado: sn_ind_tmt_orn_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. Em referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
ServiceOrderItem.RelatedParty. No tipo	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service	Obrigatório. Descrição dos detalhes da instância do serviço comprado pelo cliente. Tipo de dados: Objeto `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }` Tabela/campo atualizado: sn_ind_tmt_orn_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 Inventário de produto [sn_ind_tmt_orn_product_inventory]. Este valor é usado somente para ordens 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 características de serviço com uma corrente valuediferente de previousValueretornados. Tipo de dados: Matriz `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nome do registro de característica a ser associado ao serviço. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para pedido de mudança. A solicitação é uma ordem de mudança se serviceOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.value	Valores de opção de característica associados ao serviço. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Número inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceRelationship	Lista de inventários de produtos relacionados ao serviço. Tipo de dados: Matriz de objetos `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou sn_prd_invt_external_id da tabela Inventário de produto [sn_prd_invt_product_inventory].
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. Nota: Ordens de mudança ( serviceOrderItem.action. `mudança` ) são processados de forma diferente com base no valor de sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderpropriedade do sistema. Quando a propriedade é definida como verdadeira (padrão), se o serviço for uma versão diferente da indicada na ordem, o serviço será atualizado automaticamente para a versão na ordem alterando a especificação do serviço referenciado. Isso permite que o pedido seja processado com sucesso. Quando a propriedade é definida como falsa, se o serviço for uma versão diferente da indicada no pedido, o pedido falhará devido à incompatibilidade da versão. Tipo de dados: Objeto `"serviceSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Armazenado em: O campo service_specification da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
serviceOrderItem.service.serviceSpecification.id	Obrigatório. Initial_version ou external_id da especificação do serviço. Initial_version é 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 do serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.name	Obrigatório. Nome da especificação do 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 do serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ServiceSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceOrderItem. No tipo	Parte do padrão TMF Open API. Este valor é sempre `ServiceOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
.	Parte do padrão TMF Open API. 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 seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 30. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
201	Bem-sucedido. Se houver problemas com as características ou as informações da 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 de pedido do cliente associado: As seguintes características do item do pedido não existem: Revisar 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. Característica do item do pedido characteristic.name> com valor de característica: > characteristic.value> é inválido. Corrija os valores das características 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 modeparâmetro 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. Qualquer um dos seguintes motivos: Carga inválida: O consumidor não existe - o consumidor da parte relacionada especificada não existe na instância. Carga inválida: A conta do cliente não existe. - O cliente da parte relacionada fornecido na carga não está presente no sistema. Conta do cliente ou consumidor inválida ausente - O objeto do cliente ou consumidor relacionado está ausente na carga. Carga inválida: Falha na criação do pedido. - Não foi possível criar o pedido solicitado. Carga inválida: O inventário do produto não existe. - Em um pedido de mudança ou exclusão (ou seja, ação de 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. Carga inválida: Corpo da solicitação ausente. A carga não foi passada no corpo da solicitação. Carga inválida: A ação ServiceOrderItem está ausente. - O objeto de serviço ou JSON está ausente na carga. Carga inválida: O ID ServiceOrderItem está ausente. - O ID está ausente no item de linha da ordem de serviço. Carga inválida: ServiceOrderItem ausente. Objeto de item de linha da ordem de serviço ou JSON ausente. 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: 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 ID ServiceSpecification está ausente. - O. ido parâmetro no item de linha da ordem de serviço do objeto de especificação de serviço está ausente na carga. Carga inválida: ServiceSpecification está ausente. - O objeto de especificação de serviço ou JSON no item de linha de ordem de serviço está ausente na carga. 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.
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 executada no pedido. Este valor deve ser igual ou posterior a committedDueDatevalores para cada item de linha do pedido. Tipo de dados: Cadeia de caracteres
externalId	Número do pedido exclusivo para a ordem de serviço externa. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
id	Sys_id da ordem de serviço. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações adicionais feitas pelo cliente ao fazer o pedido. Tipo de dados: Matriz `"note": [ { "text": "String" } ]`
note.text	Observações/comentários adicionais feitos pelo cliente durante o pedido. Tipo de dados: Cadeia de caracteres
orderDate	Carimbo de data e hora do pedido. FORMATO: AAAA-MM-DD HH:MM:SS Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
orderId	Sys_id do pedido a ser criado. Na 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 o pedido for criado de forma assíncrona usando o. modeparâmetro de consulta. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos do pedido. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
IdentidadeRelatedParty.id	Sys_id ou external_id da conta, cliente ou contato do consumidor associado ao pedido. Localizado em Tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Contato do cliente Cliente Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data de entrega solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início do pedido solicitada pelo cliente. Tipo de dados: Cadeia de caracteres
ServiceOrderItem	Lista de 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" } ]`
ServiceOrderItem.action	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 do Dicionário de ação da tabela sn_ind_tmt_orn_order_line_item. Valores possíveis: adicionar mudança excluir nenhuma mudança resume suspender Para obter detalhes, consulte Action types for customer and service orders. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.actionMotivo	Descrição do motivo para adicionar o item de linha. Tipo de dados: Cadeia de caracteres Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
serviceOrderItem.committedDueDate	Data e hora em que a ação deve ser executada no item de linha do pedido. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.externalProductInventory	Lista de IDs externos mapeados para os inventários de produtos criados para o pedido. Tipo de dados: Matriz de objetos `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
ServiceOrderItem.externalProductInventory.externalProductInventoryId	ID externo mapeado para o inventário do produto. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.id	Identificador exclusivo do item de linha. Localizado no campo sn_ind_tmt_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.orderRelationship	Lista de relacionamentos entre 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_orn_external_id da tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.orderRelationship.Relationship.Relationship Type	Tipo de relacionamento entre os dois itens de linha. Essas informações são usadas para identificar a hierarquia de relacionamento. Valores possíveis: HasChild HasParent 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
serviceOrderItem.place	Mapa dos locais nos quais instalar o serviço. 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
serviceOrderItem.place.@type	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Lugar` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.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.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. Em referredType	Obrigatório. Tipo de cliente. Valor possível: OrderLineItemContact Tipo de dados: Cadeia de caracteres
ServiceOrderItem.RelatedParty. No tipo	Padrão de API aberta do TMF. Anotação para contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service	Descrição dos detalhes da instância do serviço comprado 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 Inventário de produto [sn_ind_tmt_orn_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 características de serviço com uma corrente valuediferente de previousValueretornados. Tipo de dados: Matriz `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nome do registro de característica a ser associado ao serviço. Localizado na tabela Característica [sn_prd_pm_characteric]. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.previousValue	Valores de opção de característica anterior se a atualização for para pedido de mudança. A solicitação é uma ordem de mudança se serviceOrderItem.actiono parâmetro é diferente de `adicionar` . Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.value	Valores de opção de característica associados ao serviço. Para obter informações adicionais sobre valores de opção de característica, consulte Create product characteristics and characteristic options. Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceCharacteristic.valueType	Tipo de valor de característica. Valores possíveis: Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Teste de linha única Caixa de seleção Escolha Data, Endereço E-mail Número inteiro, Data/Hora Objeto Texto de Linha Única Sim/Não Tipo de dados: Cadeia de caracteres
serviceOrderItem.service.serviceRelationship	Lista de inventários de produtos relacionados ao serviço. Tipo de dados: Matriz de objetos `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id do inventário do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou sn_prd_invt_external_id da tabela Inventário de produto [sn_prd_invt_product_inventory].
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	Initial_version ou external_id da especificação do serviço. Initial_version é 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	Versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceOrderItem.service.serviceSpecification.internalVersion	Versão da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.name	Nome da especificação do 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 do serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.@type	Parte do padrão TMF Open API. Este valor é sempre `ServiceSpecificationRef` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceOrderItem.state	Estado do item da ordem de serviço. Por exemplo, novo. Tipo de dados: Cadeia de caracteres
ServiceOrderItem. No tipo	Parte do padrão TMF Open API. Este valor é sempre `ServiceOrderItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de serviço. Para obter mais informações, consulteService order states. Tipo de dados: Cadeia de caracteres
.	Parte do padrão TMF Open API. 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. modeparâmetro de consulta 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_tmf_api/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"
}

Processando de forma síncrona (padrão)

O exemplo a seguir mostra como criar uma ordem de serviço definindo serviceOrderItem.actionpropriedade para adicionar .

curl "https://instance.service-now.com/api/sn_tmf_api/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",
                  "valueType": "Choice",
                  "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",
                  "valueType": "Choice",
                  "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",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

Solicitação de curl

O exemplo a seguir atualiza uma ordem de serviço definindo serviceOrderItem.actionpropriedade para mudança .

curl "https://instance.service-now.com/api/sn_tmf_api/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",
                  "valueType": "Choice",
                  "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",
                  "valueType": "Choice",
                  "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",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

Solicitação de curl

O exemplo a seguir exclui um item de linha de ordem de serviço definindo serviceOrderItem.actionpropriedade para excluir .

curl "https://instance.service-now.com/api/sn_tmf_api/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",
                  "valueType": "Choice",
                  "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",
                  "valueType": "Choice",
                  "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",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

API de ordem de serviço em aberto – POST /sn_tmf_api/order/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 gerará 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 .

Formato de URL

/api/sn_tmf_api/order/serviceOrder/outboundresponse

Parâmetros de solicitação compatíveis

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

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

Tabela 33. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
externalId	Obrigatório. Identificador da solicitação de saída do registro de pedidos de domínio enviado para execução. Tipo de dados: Cadeia de caracteres Tabela: No campo request_id da tabela Solicitação de saída [sn_tmt_core_outbound_request].
ServiceOrderItem	Obrigatório. Lista de pedidos de domínio cujo estado de execução externa 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. Tipo de dados: Cadeia de caracteres Ordem de domínio [sn_ind_tmt_orn_domain_order]
ServiceOrderItem.state	Obrigatório. Estado de execução externa do pedido de domínio. Valores válidos: erro cumprido pendente(s) 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(a)

Códigos de status

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

Tabela 36. Códigos de status
Código do status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: `Carga inválida: ExternalId está 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 passado em uma ou mais ordens de domínio. `ID externa inválida. Passe o ID externo correto` : Indica que o ID externo aprovado ( 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 aprovado ( ServiceOrderItem.id) não está presente no sistema. `O ID de pedido de domínio aprovado não está associado ao ID externo` : Indica que o ID externo ( externalId) não está associado a nenhuma ordem de domínio. O sistema atualiza somente pedidos de domínio que estão associados a um ID externo passado na carga. `Estado de execução inválido: Forneça o estado de execução correto` : Indica que o estado de execução aprovado ( ServiceOrderItem.statepara 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
externalId	Identificador da solicitação de saída do registro de pedidos de domínio enviado para execução. Tipo de dados: Cadeia de caracteres Tabela: No campo request_id da tabela Solicitação de saída [sn_tmt_core_outbound_request].
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
orderDate	Carimbo de data e hora do pedido. FORMATO: AAAA-MM-DD HH:MM:SS Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ServiceOrderItem	Lista de pedidos de domínio cujo estado de execução externa 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. Tipo de dados: Cadeia de caracteres Ordem de domínio [sn_ind_tmt_orn_domain_order]
ServiceOrderItem.state	Estado de execução externa do pedido de domínio. Valores possíveis: erro cumprido pendente(s) 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_tmf_api/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"
    }
  ]
}