API de Gestão de ordem de serviço

Versão de lançamento: Zurich

Atualizado 31 de jul. de 2025

57 min. de leitura

. Gestão de ordem de serviço A API fornece endpoints para criar, atualizar e recuperar ordens de serviço.

Esta API está incluída na aplicação APIs de telecomunicações abertas, que está disponível no ServiceNow Store.

Esta API é fornecida no sn_tmf_api namespace.

O usuário chamador deve ter a função sn_tmf_api.work_order_integrator.

. Gestão de ordem de serviço A API é um ServiceNow Implementação da especificação REST da API Gestão de ordem de serviço do TM Forum. Esta implementação é baseada no TMF697 API de Gestão de ordens de serviço v5.0 .

Gestão de ordem de serviço - OBTER /sn_tmf_api/work_order_management_api/workorder/

Recupera uma ordem de serviço especificada da tabela Ordem de serviço [wm_order].

Formato de URL

URL com controle de versão: /api/sn_tmf_api//work_order_management_api/workorder/

URL padrão: /api/sn_tmf_api/work_order_management_api/workorder/

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
id	Sys_id ou externalIdentifierda ordem de serviço. Tabela: Ordem de serviço [wm_order] Campo: Sys_id ou correlation_id Tipo de dados: Cadeia de caracteres

Tabela 2. Parâmetros de consulta
Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Valores válidos: . categoria Data de conclusão descrição ExpectedCompletionDate href id Iniciadode prioridade SolidadData de conclusão solicitada StartDate solicitada shortDescription startDate estado WorkOrderNumber Padrão: Retorna todos os campos. Tipo de dados: Cadeia de caracteres

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

Tabela 5. 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 6. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
.	Este valor é sempre `Ordem de serviço` . Tipo de dados: Cadeia de caracteres
categoria	Categoria da ordem de serviço que pode ser usada por um sistema de gestão de pedidos, como `empresa` ou `residencial` . Tipo de dados: Cadeia de caracteres
Data de conclusão	Data e hora em que a ordem de serviço foi concluída. Tipo de dados: Cadeia de caracteres
descrição	Descrição da ordem de serviço. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data e hora de conclusão esperadas designadas pelo provedor. Tipo de dados: Cadeia de caracteres
ExternalIdentifier	Lista de referências externas, como fornecedor ou ID de correlação. Tipo de dados: Matriz `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier. No tipo	Este valor é sempre `Identificador Externo` . Tipo de dados: Cadeia de caracteres
externalIdentifier.id	Referência externa, como fornecedor ou ID de correlação. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro da ordem de serviço. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem de serviço. Tabela: Ordem de serviço [wm_order] Tipo de dados: Cadeia de caracteres
Iniciadode	ID de referência que indica onde a ordem de serviço foi iniciada. Por exemplo, uma tarefa sys_id da tabela Tarefa de ordem de serviço [wm_task]. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações sobre o pedido. Tipo de dados: Matriz `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
note.author	Autor da nota. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi adicionada à ordem de serviço. Tipo de dados: Cadeia de caracteres
note.text	O texto da anotação. Tipo de dados: Cadeia de caracteres
lugar	A localização geográfica associada à ordem de serviço. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
tipo de local	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
Lugar.Parte Relacionada	Lista de grupos de suporte para o local. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Lugar.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
place.relatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
place.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
Lugar.Parte.RelatedParteRelatedFunção	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
prioridade	Classificação de prioridade da ordem de serviço. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos associados à ordem de serviço. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty. Em	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. Tabela: Conta [customer_account], Empresa [core_company] ou Usuário [sys_user] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedParty.role	Função da parte relacionada. Valores possíveis: Conta Empresa Cliente Contato Tipo de dados: Cadeia de caracteres
RelatedProductOrder	Lista de pedidos de produto para a ordem de serviço. Tipo de dados: Matriz `"relatedProductOrder": [ { "@type": "String", "id": "String" } ]`
RelatedProductOrder. No tipo	Este valor é sempre `ProductOrderRef` . Tipo de dados: Cadeia de caracteres
relatedProductOrder.id	Sys_id do pedido do produto. Tabela: Pedido do produto [sn_ind_tmt_orn_product_order] Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data e hora de conclusão solicitadas. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início da execução do pedido designada pelo solicitante. Usado nos casos em que o solicitante não pode permitir que o provedor inicie a execução antes de uma data especificada. Tipo de dados: Cadeia de caracteres
shortDescription	Breve resumo da ordem de serviço. Tipo de dados: Cadeia de caracteres
startDate	Data e hora em que o pedido foi iniciado. Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de serviço. Valores possíveis: Rascunho Aguardando qualificação Qualificada Atribuída Trabalho em andamento Concluídas Tipo de dados: Cadeia de caracteres
WorkOrderItem	Lista de tarefas na ordem de serviço. Tipo de dados: Matriz `"workOrderItem": [ { "@type": "String", "description": "String", "id": "String", "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem. No tipo	Este valor é sempre `WorkOrderItem` . Tipo de dados: Cadeia de caracteres
workOrderItem.description	Descrição da tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.id	Sys_id da tarefa. Tabela: Tarefa de ordem de serviço [wm_task] Tipo de dados: Cadeia de caracteres
WorkOrderItem.ShortDescription	Descrição resumida da tarefa Tipo de dados: Cadeia de caracteres
WorkOrderItem.state	Estado da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work	Descrição do trabalho necessário para a tarefa. Tipo de dados: Objeto `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "relatedWork": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
WorkOrderItem.Trabalho. No tipo	Este valor é sempre `WorkRefOrValue` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.expectedCompletionDate	Data de conclusão esperada para a tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.work.id	Sys_id do tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place	Lista de localizações geográficas associadas à tarefa. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Este valor é sempre `RelatedPlaceRefOrValue Related` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place	Detalhes sobre o local. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.role	Função deste local no contexto da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Trabalho.ParteRelacionado	Lista de grupos de suporte para a tarefa. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
WorkOrderItem.Trabalho.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorOrderItem.Trabalho.ParteRelatedParteParteRelated.Função	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.RelatedWork	Lista de tarefas de ordem de serviço relacionadas. Tipo de dados: Matriz `"relatedWork": [ { "@type": "String", "id": "String" } ]`
WorkOrderItem.Work.RelatedWork. No tipo	Este valor é sempre `WorkRefOrValue` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedWork.id	Sys_id da tarefa relacionada. Tabela: Tarefa de ordem de serviço [wm_task] Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.scheduledStartDate	Data de início programada da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment	Detalhes da atribuição da tarefa. Tipo de dados: Matriz `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
WorkOrderItem.Work.workforceEmployeeAssignment. No tipo	Este valor é sempre `WorkforceEmployeeAssignment` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.id	Sys_id do grupo atribuído à tarefa. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee	Detalhes sobre o funcionário atribuído à tarefa. Tipo de dados: Objeto `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployeeEmployee. No tipo	Este valor é sempre `Individual` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Lista de números de telefone do funcionário. Tipo de dados: Matriz `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium. No tipo	Este valor é sempre `PhoneContactMedium` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Número de telefone do funcionário. Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id do funcionário. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nome do funcionário. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workPriority	Classificação de prioridade da tarefa. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.WorkType	O tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Campo: Nome Tipo de dados: Cadeia de caracteres
WorkOrderNumber	Identificador exclusivo da ordem de serviço, como WO0008004. Tabela: Ordem de serviço [wm_order] Campo: Número Tipo de dados: Cadeia de caracteres
WorkOrderRelationship	Lista de relacionamentos de tarefa com a ordem de serviço. Tipo de dados: Matriz `"workOrderRelationship": [ { "@type": "String", "id": "String", "relationshipType": "String" } ]`
WorkOrderRelationship. No tipo	Este valor é sempre `OrderRelacionamento` . Tipo de dados: Cadeia de caracteres
workOrderRelationship.id	Sys_id do relacionamento de tarefa. Tabela: Relacionamento de tarefa [task_rel_task] Tipo de dados: Cadeia de caracteres
WorkOrderRelationship.Relationship Type	Tipo de relacionamento de tarefa. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Recupera a ordem de serviço especificada.

curl "https://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workorder/27e756a1df113100dca6a5f59bf263da" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Corpo da resposta.

{
   "@type": "WorkOrder",
   "href": "api/sn_tmf_api/workordermanagement/workorder/6d22c6f0ff0de650f8dfffffffffff98",
   "workOrderNumber": "WO0008004",
   "id": "6d22c6f0ff0de650f8dfffffffffff98",
   "category": "test",
   "shortDescription": "Test-Test",
   "description": "Test",
   "startDate": "",
   "requestedCompletionDate": "2025-04-19 07:17:04",
   "requestedStartDate": "",
   "state": "Awaiting Qualification",
   "priority": "4 - Low",
   "initiatedFrom": "",
   "completionDate": "",
   "expectedCompletionDate": "",
   "place": {
      "@type": "GeographicSite",
      "id": "920cf6ac73d423002728660c4cf6a799",
      "relatedParty": [
         {
            "@type": "RelatedPartyRef",
            "id": "320ee92637232000158bbfc8bcbe5d40",
            "name": "East Qualifiers",
            "role": "QualificationGroup"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "5408091a3b100300e81d47b334efc452",
         "name": "Ashley Parker",
         "role": "Contact"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Account"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Consumer"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "820351a1c0a8018b67c73d51c074097c",
         "name": "Acer",
         "role": "Company"
      }
   ],
   "appointment": {},
   "relatedProductOrder": [
      {
         "@type": "ProductOrderRef",
         "id": "19f5456dff092a50f8dfffffffffff01"
      },
      {
         "@type": "ProductOrderRef",
         "id": "7116456dff092a50f8dfffffffffff6e"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifierRef",
         "id": "r6879"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "2fa566fdff456a50f8dfffffffffffc6",
         "shortDescription": "abc",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "2fa566fdff456a50f8dfffffffffffc6",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "25ab8dcd0a0a0bb300bd8a8899934d72"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "bb420af0ff0de650f8dfffffffffff4a",
         "shortDescription": "Test",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "bb420af0ff0de650f8dfffffffffff4a",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "920cf6ac73d423002728660c4cf6a799"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "c301e379ff096a50f8dfffffffffff43",
         "shortDescription": "hi",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "c301e379ff096a50f8dfffffffffff43",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "6808184aeb211100420124e05206fe12"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      }
   ],
   "workOrderRelationship": [
      {
         "@type": "OrderRelationship",
         "id": "02016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "0e016b46ffcd6a50f8dfffffffffff30",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "66da174eff8d6a50f8dfffffffffffda",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "aada174eff8d6a50f8dfffffffffffd9",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "bd20e706ffcd6a50f8dfffffffffffc6",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "c2016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      }
   ],
   "note": [
      {
         "@type": "Note",
         "author": "System Administrator",
         "date": "2025-04-23",
         "text": "This is a note."
      }
   ]
}

Gestão de ordem de serviço - OBTENHA /sn_tmf_api/work_order_management_api/workordermanagement

Recupera uma lista de todas as ordens de serviço da tabela Ordem de serviço [wm_order].

Formato de URL

URL com controle de versão: /api/sn_tmf_api//work_order_management_api/workordermanagement

URL padrão: /api/sn_tmf_api/work_order_management_api/workordermanagement

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 8. Parâmetros de consulta
Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Valores válidos: . categoria Data de conclusão descrição ExpectedCompletionDate href id Iniciadode prioridade SolidadData de conclusão solicitada StartDate solicitada shortDescription startDate estado WorkOrderNumber Padrão: Retorna todos os campos. Tipo de dados: Cadeia de caracteres
id	Sys_ids a serem usados para filtrar ordens de serviço. Somente ordens de serviço correspondentes aos sys_ids especificados são retornadas na resposta. Tabela: Ordem de serviço [wm_order] Tipo de dados: Cadeia de caracteres
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. Padrão: 20 Tipo de dados: Número
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. Padrão: 0 Tipo de dados: Número

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

Tabela 11. 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 12. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
206	Conteúdo parcial. A solicitação foi processada com sucesso e retornou um intervalo parcial de conteúdo especificado por uma chamada paginada.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
.	Este valor é sempre `Ordem de serviço` . Tipo de dados: Cadeia de caracteres
categoria	Categoria da ordem de serviço que pode ser usada por um sistema de gestão de pedidos, como `empresa` ou `residencial` . Tipo de dados: Cadeia de caracteres
Data de conclusão	Data e hora em que a ordem de serviço foi concluída. Tipo de dados: Cadeia de caracteres
descrição	Descrição da ordem de serviço. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data e hora de conclusão esperadas designadas pelo provedor. Tipo de dados: Cadeia de caracteres
ExternalIdentifier	Lista de referências externas, como fornecedor ou ID de correlação. Tipo de dados: Matriz `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier. No tipo	Este valor é sempre `Identificador Externo` . Tipo de dados: Cadeia de caracteres
externalIdentifier.id	Referência externa, como fornecedor ou ID de correlação. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro da ordem de serviço. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem de serviço. Tabela: Ordem de serviço [wm_order] Tipo de dados: Cadeia de caracteres
Iniciadode	ID de referência que indica onde a ordem de serviço foi iniciada. Por exemplo, uma tarefa sys_id da tabela Tarefa de ordem de serviço [wm_task]. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações sobre o pedido. Tipo de dados: Matriz `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
note.author	Autor da nota. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi adicionada à ordem de serviço. Tipo de dados: Cadeia de caracteres
note.text	O texto da anotação. Tipo de dados: Cadeia de caracteres
lugar	A localização geográfica associada à ordem de serviço. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
tipo de local	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
Lugar.Parte Relacionada	Lista de grupos de suporte para o local. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Lugar.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
place.relatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
place.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
Lugar.Parte.RelatedParteRelatedFunção	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
prioridade	Classificação de prioridade da ordem de serviço. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos associados à ordem de serviço. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty. Em	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. Tabela: Conta [customer_account], Empresa [core_company] ou Usuário [sys_user] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedParty.role	Função da parte relacionada. Valores possíveis: Conta Empresa Cliente Contato Tipo de dados: Cadeia de caracteres
RelatedProductOrder	Lista de pedidos de produto para a ordem de serviço. Tipo de dados: Matriz `"relatedProductOrder": [ { "@type": "String", "id": "String" } ]`
RelatedProductOrder. No tipo	Este valor é sempre `ProductOrderRef` . Tipo de dados: Cadeia de caracteres
relatedProductOrder.id	Sys_id do pedido do produto. Tabela: Pedido do produto [sn_ind_tmt_orn_product_order] Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data e hora de conclusão solicitadas. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início da execução do pedido designada pelo solicitante. Usado nos casos em que o solicitante não pode permitir que o provedor inicie a execução antes de uma data especificada. Tipo de dados: Cadeia de caracteres
shortDescription	Breve resumo da ordem de serviço. Tipo de dados: Cadeia de caracteres
startDate	Data e hora em que o pedido foi iniciado. Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de serviço. Valores possíveis: Rascunho Aguardando qualificação Qualificada Atribuída Trabalho em andamento Concluídas Tipo de dados: Cadeia de caracteres
WorkOrderItem	Lista de tarefas na ordem de serviço. Tipo de dados: Matriz `"workOrderItem": [ { "@type": "String", "description": "String", "id": "String", "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem. No tipo	Este valor é sempre `WorkOrderItem` . Tipo de dados: Cadeia de caracteres
workOrderItem.description	Descrição da tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.id	Sys_id da tarefa. Tabela: Tarefa de ordem de serviço [wm_task] Tipo de dados: Cadeia de caracteres
WorkOrderItem.ShortDescription	Descrição resumida da tarefa Tipo de dados: Cadeia de caracteres
WorkOrderItem.state	Estado da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work	Descrição do trabalho necessário para a tarefa. Tipo de dados: Objeto `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "relatedWork": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
WorkOrderItem .work. no tipo	Este valor é sempre `WorkRefOrValue` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.expectedCompletionDate	Data de conclusão esperada para a tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.work.id	Sys_id do tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place	Lista de localizações geográficas associadas à tarefa. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Este valor é sempre `RelatedPlaceRefOrValue Related` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place	Detalhes sobre o local. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.role	Função deste local no contexto da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Trabalho.ParteRelacionado	Lista de grupos de suporte para a tarefa. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
WorkOrderItem.Trabalho.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorOrderItem.Trabalho.ParteRelatedParteParteRelated.Função	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.RelatedWork	Lista de tarefas de ordem de serviço relacionadas. Tipo de dados: Matriz `"relatedWork": [ { "@type": "String", "id": "String" } ]`
WorkOrderItem.Work.RelatedWork. No tipo	Este valor é sempre `WorkRefOrValue` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedWork.id	Sys_id da tarefa relacionada. Tabela: Tarefa de ordem de serviço [wm_task] Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.scheduledStartDate	Data de início programada da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment	Detalhes da atribuição da tarefa. Tipo de dados: Matriz `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
WorkOrderItem.Work.workforceEmployeeAssignment. No tipo	Este valor é sempre `WorkforceEmployeeAssignment` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.id	Sys_id do grupo atribuído à tarefa. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee	Detalhes sobre o funcionário atribuído à tarefa. Tipo de dados: Objeto `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployeeEmployee. No tipo	Este valor é sempre `Individual` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Lista de números de telefone do funcionário. Tipo de dados: Matriz `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium. No tipo	Este valor é sempre `PhoneContactMedium` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Número de telefone do funcionário. Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id do funcionário. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nome do funcionário. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workPriority	Classificação de prioridade da tarefa. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.WorkType	O tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Campo: Nome Tipo de dados: Cadeia de caracteres
WorkOrderNumber	Identificador exclusivo da ordem de serviço, como WO0008004. Tabela: Ordem de serviço [wm_order] Campo: Número Tipo de dados: Cadeia de caracteres
WorkOrderRelationship	Lista de relacionamentos de tarefa com a ordem de serviço. Tipo de dados: Matriz `"workOrderRelationship": [ { "@type": "String", "id": "String", "relationshipType": "String" } ]`
WorkOrderRelationship. No tipo	Este valor é sempre `OrderRelacionamento` . Tipo de dados: Cadeia de caracteres
workOrderRelationship.id	Sys_id do relacionamento de tarefa. Tabela: Relacionamento de tarefa [task_rel_task] Tipo de dados: Cadeia de caracteres
WorkOrderRelationship.Relationship Type	Tipo de relacionamento de tarefa. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Recupera a primeira página de ordens de serviço.

curl "https://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workordermanagement" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Corpo da resposta.

[{
   "@type": "WorkOrder",
   "href": "api/sn_tmf_api/workordermanagement/workorder/6d22c6f0ff0de650f8dfffffffffff98",
   "workOrderNumber": "WO0008004",
   "id": "6d22c6f0ff0de650f8dfffffffffff98",
   "category": "test",
   "shortDescription": "Test-Test",
   "description": "Test",
   "startDate": "",
   "requestedCompletionDate": "2025-04-19 07:17:04",
   "requestedStartDate": "",
   "state": "Awaiting Qualification",
   "priority": "4 - Low",
   "initiatedFrom": "",
   "completionDate": "",
   "expectedCompletionDate": "",
   "place": {
      "@type": "GeographicSite",
      "id": "920cf6ac73d423002728660c4cf6a799",
      "relatedParty": [
         {
            "@type": "RelatedPartyRef",
            "id": "320ee92637232000158bbfc8bcbe5d40",
            "name": "East Qualifiers",
            "role": "QualificationGroup"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "5408091a3b100300e81d47b334efc452",
         "name": "Ashley Parker",
         "role": "Contact"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Account"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Consumer"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "820351a1c0a8018b67c73d51c074097c",
         "name": "Acer",
         "role": "Company"
      }
   ],
   "appointment": {},
   "relatedProductOrder": [
      {
         "@type": "ProductOrderRef",
         "id": "19f5456dff092a50f8dfffffffffff01"
      },
      {
         "@type": "ProductOrderRef",
         "id": "7116456dff092a50f8dfffffffffff6e"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifierRef",
         "id": "r6879"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "2fa566fdff456a50f8dfffffffffffc6",
         "shortDescription": "abc",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "2fa566fdff456a50f8dfffffffffffc6",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "25ab8dcd0a0a0bb300bd8a8899934d72"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "bb420af0ff0de650f8dfffffffffff4a",
         "shortDescription": "Test",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "bb420af0ff0de650f8dfffffffffff4a",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "920cf6ac73d423002728660c4cf6a799"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "c301e379ff096a50f8dfffffffffff43",
         "shortDescription": "hi",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "c301e379ff096a50f8dfffffffffff43",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "6808184aeb211100420124e05206fe12"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      }
   ],
   "workOrderRelationship": [
      {
         "@type": "OrderRelationship",
         "id": "02016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "0e016b46ffcd6a50f8dfffffffffff30",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "66da174eff8d6a50f8dfffffffffffda",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "aada174eff8d6a50f8dfffffffffffd9",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "bd20e706ffcd6a50f8dfffffffffffc6",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "c2016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      }
   ],
   "note": [
      {
         "@type": "Note",
         "author": "System Administrator",
         "date": "2025-04-23",
         "text": "This is a note."
      }
   ]
}]

Gestão de ordem de serviço - PATCH /sn_tmf_api/work_order_management_api/Workorder/

Atualiza uma ordem de serviço e tarefas associadas.

O registro da ordem de serviço é atualizado na tabela Ordem de serviço [wm_order]. Os registros de tarefa são atualizados na tabela Tarefa de ordem de serviço [wm_task].

Formato de URL

URL com controle de versão: /api/sn_tmf_api//work_order_management_api/Workorder/

URL padrão: /api/sn_tmf_api/work_order_management_api/Workorder/

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem de serviço. Tabela: Ordem de serviço [wm_order] Tipo de dados: Cadeia de caracteres

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

Tabela 15. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
.	Este valor é sempre `Ordem de serviço` . Tipo de dados: Cadeia de caracteres
Data de conclusão	Data e hora em que a ordem de serviço foi concluída. Tipo de dados: Cadeia de caracteres
descrição	Descrição da ordem de serviço. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data e hora de conclusão esperadas designadas pelo provedor. Tipo de dados: Cadeia de caracteres
ExternalIdentifier	Lista de referências externas, como fornecedor ou ID de correlação. Tipo de dados: Matriz `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier. No tipo	Este valor é sempre `Identificador Externo` . Tipo de dados: Cadeia de caracteres
externalIdentifier.id	Referência externa, como fornecedor ou ID de correlação. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro da ordem de serviço. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem de serviço. Tabela: Ordem de serviço [wm_order] Tipo de dados: Cadeia de caracteres
Iniciadode	ID de referência que indica onde a ordem de serviço foi iniciada. Por exemplo, uma tarefa sys_id da tabela Tarefa de ordem de serviço [wm_task]. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações sobre o pedido. Tipo de dados: Matriz `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
note.author	Autor da nota. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi adicionada à ordem de serviço. Tipo de dados: Cadeia de caracteres
note.text	O texto da anotação. Tipo de dados: Cadeia de caracteres
lugar	A localização geográfica associada à ordem de serviço. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
tipo de local	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
Lugar.Parte Relacionada	Lista de grupos de suporte para o local. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Lugar.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
place.relatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
place.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
Lugar.Parte.RelatedParteRelatedFunção	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
prioridade	Classificação de prioridade da ordem de serviço. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos associados à ordem de serviço. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty. Em	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. Tabela: Conta [customer_account], Empresa [core_company] ou Usuário [sys_user] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedParty.role	Função da parte relacionada. Valores possíveis: Conta Empresa Cliente Contato Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data e hora de conclusão solicitadas. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início da execução do pedido designada pelo solicitante. Usado nos casos em que o solicitante não pode permitir que o provedor inicie a execução antes de uma data especificada. Tipo de dados: Cadeia de caracteres
shortDescription	Breve resumo da ordem de serviço. Tipo de dados: Cadeia de caracteres
startDate	Data e hora em que o pedido foi iniciado. Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de serviço. Valores possíveis: Rascunho Aguardando qualificação Qualificada Atribuída Trabalho em andamento Concluídas Tipo de dados: Cadeia de caracteres
templateId	Sys_id do modelo a ser usado para a ordem de serviço. Tabela: Modelo de produto [cmdb_model] Tipo de dados: Cadeia de caracteres
WorkOrderItem	Lista de tarefas na ordem de serviço. Tipo de dados: Matriz `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem. No tipo	Este valor é sempre `WorkOrderItem` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.action	Ação a ser executada no produto da tarefa. Valores possíveis: adicionar excluir modificar NoChange Tipo de dados: Cadeia de caracteres
workOrderItem.completionDate	Data e hora em que a tarefa foi concluída. Tipo de dados: Cadeia de caracteres
workOrderItem.description	Descrição da tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.id	Sys_id da tarefa. Tabela: Tarefa de ordem de serviço [wm_task] Tipo de dados: Cadeia de caracteres
workOrderItem.note	Lista de anotações sobre a tarefa. Tipo de dados: Matriz `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
workOrderItem.note.author	Autor da nota. Tipo de dados: Cadeia de caracteres
workOrderItem.note.date	Data em que a anotação foi adicionada à tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.note.text	O texto da anotação. Tipo de dados: Cadeia de caracteres
WorkOrderItem.ShortDescription	Descrição resumida da tarefa Tipo de dados: Cadeia de caracteres
WorkOrderItem.state	Estado da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work	Descrição do trabalho necessário para a tarefa. Tipo de dados: Objeto `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
WorkOrderItem.Trabalho. No tipo	Este valor é sempre `WorkRefOrValue` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.expectedCompletionDate	Data de conclusão esperada para a tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.work.id	Sys_id do tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place	Lista de localizações geográficas associadas à tarefa. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Este valor é sempre `RelatedPlaceRefOrValue Related` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place	Detalhes sobre o local. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.role	Função deste local no contexto da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Trabalho.ParteRelacionado	Lista de grupos de suporte para a tarefa. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
WorkOrderItem.Trabalho.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorOrderItem.Trabalho.ParteRelatedParteParteRelated.Função	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.scheduledStartDate	Data de início programada da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment	Detalhes da atribuição da tarefa. Tipo de dados: Matriz `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
WorkOrderItem.Work.workforceEmployeeAssignment. No tipo	Este valor é sempre `WorkforceEmployeeAssignment` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.id	Sys_id do grupo atribuído à tarefa. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee	Detalhes sobre o funcionário atribuído à tarefa. Tipo de dados: Objeto `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployeeEmployee. No tipo	Este valor é sempre `Individual` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Lista de números de telefone do funcionário. Tipo de dados: Matriz `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium. No tipo	Este valor é sempre `PhoneContactMedium` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Número de telefone do funcionário. Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id do funcionário. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nome do funcionário. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workPriority	Classificação de prioridade da tarefa. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.WorkType	O tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Campo: Nome Tipo de dados: Cadeia de caracteres
WorkOrderNumber	Identificador exclusivo da ordem de serviço, como WO0008004. Tabela: Ordem de serviço [wm_order] Campo: Número 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.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
.	Este valor é sempre `Ordem de serviço` . Tipo de dados: Cadeia de caracteres
Data de conclusão	Data e hora em que a ordem de serviço foi concluída. Tipo de dados: Cadeia de caracteres
descrição	Descrição da ordem de serviço. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data e hora de conclusão esperadas designadas pelo provedor. Tipo de dados: Cadeia de caracteres
ExternalIdentifier	Lista de referências externas, como fornecedor ou ID de correlação. Tipo de dados: Matriz `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier. No tipo	Este valor é sempre `Identificador Externo` . Tipo de dados: Cadeia de caracteres
ExternalIdentifier.id	Referência externa, como fornecedor ou ID de correlação. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro da ordem de serviço. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem de serviço. Tabela: Ordem de serviço [wm_order] Tipo de dados: Cadeia de caracteres
Iniciadode	ID de referência que indica onde a ordem de serviço foi iniciada. Por exemplo, uma tarefa sys_id da tabela Tarefa de ordem de serviço [wm_task]. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações sobre o pedido. Tipo de dados: Matriz `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
note.author	Autor da nota. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi adicionada à ordem de serviço. Tipo de dados: Cadeia de caracteres
note.text	O texto da anotação. Tipo de dados: Cadeia de caracteres
lugar	A localização geográfica associada à ordem de serviço. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
tipo de local	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
Lugar.Parte Relacionada	Lista de grupos de suporte para o local. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Lugar.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
Place.RelatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
place.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
Lugar.Parte.RelatedParteRelatedFunção	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
prioridade	Classificação de prioridade da ordem de serviço. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos associados à ordem de serviço. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty. Em	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
IdentidadeRelatedParty.id	Sys_id da parte relacionada. Tabela: Conta [customer_account], Empresa [core_company] ou Usuário [sys_user] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedParty.role	Função da parte relacionada. Valores possíveis: Conta Empresa Cliente Contato Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data e hora de conclusão solicitadas. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início da execução do pedido designada pelo solicitante. Usado nos casos em que o solicitante não pode permitir que o provedor inicie a execução antes de uma data especificada. Tipo de dados: Cadeia de caracteres
shortDescription	Breve resumo da ordem de serviço. Tipo de dados: Cadeia de caracteres
startDate	Data e hora em que o pedido foi iniciado. Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de serviço. Valores possíveis: Rascunho Aguardando qualificação Qualificada Atribuída Trabalho em andamento Concluídas Tipo de dados: Cadeia de caracteres
templateId	Sys_id do modelo a ser usado para a ordem de serviço. Tabela: Modelo de produto [cmdb_model] Tipo de dados: Cadeia de caracteres
WorkOrderItem	Lista de tarefas na ordem de serviço. Tipo de dados: Matriz `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem. No tipo	Este valor é sempre `WorkOrderItem` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.action	Ação a ser executada no produto da tarefa. Valores possíveis: adicionar excluir modificar NoChange Tipo de dados: Cadeia de caracteres
workOrderItem.completionDate	Data e hora em que a tarefa foi concluída. Tipo de dados: Cadeia de caracteres
workOrderItem.description	Descrição da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.id	Sys_id da tarefa. Tabela: Tarefa de ordem de serviço [wm_task] Tipo de dados: Cadeia de caracteres
workOrderItem.note	Lista de anotações sobre a tarefa. Tipo de dados: Matriz `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
workOrderItem.note.author	Autor da nota. Tipo de dados: Cadeia de caracteres
workOrderItem.note.date	Data em que a anotação foi adicionada à tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.note.text	O texto da anotação. Tipo de dados: Cadeia de caracteres
WorkOrderItem.ShortDescription	Descrição resumida da tarefa Tipo de dados: Cadeia de caracteres
WorkOrderItem.state	Estado da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work	Descrição do trabalho necessário para a tarefa. Tipo de dados: Objeto `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
WorkOrderItem.Trabalho. No tipo	Este valor é sempre `WorkRefOrValue` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.expectedCompletionDate	Data de conclusão esperada para a tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.ID	Sys_id do tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place	Lista de localizações geográficas associadas à tarefa. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Este valor é sempre `RelatedPlaceRefOrValue Related` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place	Detalhes sobre o local. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.role	Função deste local no contexto da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Trabalho.ParteRelacionado	Lista de grupos de suporte para a tarefa. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
WorkOrderItem.Trabalho.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.RelatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorOrderItem.Trabalho.ParteRelatedParteParteRelated.Função	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.scheduledStartDate	Data de início programada da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment	Detalhes da atribuição da tarefa. Tipo de dados: Matriz `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
WorkOrderItem.Work.workforceEmployeeAssignment. No tipo	Este valor é sempre `WorkforceEmployeeAssignment` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.id	Sys_id do grupo atribuído à tarefa. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee	Detalhes sobre o funcionário atribuído à tarefa. Tipo de dados: Objeto `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployeeEmployee. No tipo	Este valor é sempre `Individual` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Lista de números de telefone do funcionário. Tipo de dados: Matriz `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium. No tipo	Este valor é sempre `PhoneContactMedium` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Número de telefone do funcionário. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id do funcionário. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nome do funcionário. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workPriority	Classificação de prioridade da tarefa. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.WorkType	O tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Campo: Nome Tipo de dados: Cadeia de caracteres
WorkOrderNumber	Identificador exclusivo da ordem de serviço, como WO0008004. Tabela: Ordem de serviço [wm_order] Campo: Número Tipo de dados: Cadeia de caracteres

Solicitação de curl

Atualiza a ordem de serviço especificada.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder/2d3f32f0df113100dca6a5f59bf263a9" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "@type": "WorkOrder",
   "description": "Fixed Fibre Broadband Installation",
   "shortDescription": "Fixed Fibre",
   "priority": "1 - Critical",
   "place": {
      "@type": "GeographicSite",
      "id": "f48b22530a0a0ba70001913a1c181eeb",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "781da52637232000158bbfc8bcbe5db8",
            "name": "Jane Smith",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "86a08090ffcd62105e0dffffffffff8b",
         "name": "Workforce Engineering Group",
         "role": "Consumer"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "3df59e8cff5d26105e0dffffffffff0e",
         "action": "add",
         "description": "FTTH Installation",
         "shortDescription": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "state": "Accepted",
         "work": {
            "@type": "WorkRefOrValue",
            "scheduledStartDate": "2024-04-22T14:23:06.528Z",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "description": "Cabinet Configuration",
            "name": "FTTH Installation",
            "workPriority": "high",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "b04b813bffc126105e0dffffffffff0d"
                  }
               }
            ],
            "note": {
               "@type": "Note",
               "text": "Demand Point Type: SDU"
            }
         }
      }
   ],
   "note": {
      "@type": "Note",
      "text": "This is important"
   }
}" \
--user 'username':'password'

Corpo da resposta.

{
   "@type": "WorkOrder",
   "description": "Fixed Fibre Broadband Installation",
   "shortDescription": "Fixed Fibre",
   "priority": "1 - Critical",
   "place": {
      "@type": "GeographicSite",
      "id": "f48b22530a0a0ba70001913a1c181eeb",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "781da52637232000158bbfc8bcbe5db8",
            "name": "Jane Smith",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "86a08090ffcd62105e0dffffffffff8b",
         "name": "Workforce Engineering Group",
         "role": "Consumer"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "3df59e8cff5d26105e0dffffffffff0e",
         "action": "add",
         "description": "FTTH Installation",
         "shortDescription": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "state": "Accepted",
         "work": {
            "@type": "WorkRefOrValue",
            "scheduledStartDate": "2024-04-22T14:23:06.528Z",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "description": "Cabinet Configuration",
            "name": "FTTH Installation",
            "workPriority": "high",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "b04b813bffc126105e0dffffffffff0d"
                  }
               }
            ],
            "note": {
               "@type": "Note",
               "text": "Demand Point Type: SDU"
            }
         }
      }
   ],
   "note": {
      "@type": "Note",
      "text": "This is important"
   },
   "id": "2d3f32f0df113100dca6a5f59bf263a9",
   "href": "/api/sn_tmf_api/work_order_management_api/workOrder/2d3f32f0df113100dca6a5f59bf263a9"
}

Gestão de ordem de serviço - POST /sn_tmf_api/work_order_management_api/cancelWorkOrder

Cancela uma ordem de serviço especificada e todas as tarefas associadas.

Formato de URL

URL com controle de versão: /api/sn_tmf_api//work_order_management_api/cancelWorkOrder

URL padrão: /api/sn_tmf_api/work_order_management_api/cancelWorkOrder

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

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

Tabela 21. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
.	Este valor é sempre `CancelarOrderWorkOrder` . Tipo de dados: Cadeia de caracteres
CancelationMotivo	Motivo para cancelar a ordem de serviço. Tipo de dados: Cadeia de caracteres
workOrder	Detalhes sobre a ordem de serviço. Tipo de dados: Objeto `"workOrder": { "@type": "String", "id": "String" }`
Tipo de ordem de serviço	Este valor é sempre `OrderOrderServiço` . Tipo de dados: Cadeia de caracteres
workOrder.id	Obrigatório. Sys_id da ordem de serviço a ser cancelada. Tabela: Ordem de serviço [wm_order] Tipo de dados: Cadeia de caracteres

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. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
.	Este valor é sempre `CancelarOrderWorkOrder` . Tipo de dados: Cadeia de caracteres
CancelationMotivo	Motivo para cancelar a ordem de serviço. Tipo de dados: Cadeia de caracteres
estado	Estado da solicitação de cancelamento. Se a ordem de serviço foi cancelada com sucesso, este valor será `Cancelado` . Tipo de dados: Cadeia de caracteres
workOrder	Detalhes sobre a ordem de serviço. Tipo de dados: Objeto `"workOrder": { "@type": "String", "id": "String" }`
Tipo de ordem de serviço	Este valor é sempre `OrderOrderServiço` . Tipo de dados: Cadeia de caracteres
ID.Ordem de serviço	Sys_id da ordem de serviço cancelada. Tabela: Ordem de serviço [wm_order] Tipo de dados: Cadeia de caracteres

Solicitação de curl

Cancela a ordem de serviço especificada.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/cancelWorkOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "@type": "CancelWorkOrder",
   "cancellationReason": "Workforce unavailability",
   "workOrder": {
      "@type": "WorkOrderRef",
      "id": "f8ec1c38-4e4d-4378-a693-f95680e51e25"
   }
}" \
--user 'username':'password'

Corpo da resposta.

{
  "@type": "CancelWorkOrder",
  "cancellationReason": "Workforce unavailability",
  "state": "Cancelled",
  "workOrder": {
    "@type": "WorkOrderRef",
    "id": "f8ec1c38-4e4d-4378-a693-f95680e51e25"
  }
}

Gestão de ordem de serviço - POST /sn_tmf_api/work_order_management_api/Workorder

Cria uma ordem de serviço e tarefas associadas.

Um registro para a ordem de serviço é criado na tabela Ordem de serviço [wm_order]. Um registro para cada tarefa é criado na tabela Tarefa de ordem de serviço [wm_task].

Formato de URL

URL com controle de versão: /api/sn_tmf_api//work_order_management_api/Workorder

URL padrão: /api/sn_tmf_api/work_order_management_api/Workorder

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

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

Tabela 27. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
.	Este valor é sempre `Ordem de serviço` . Tipo de dados: Cadeia de caracteres
categoria	Categoria da ordem de serviço que pode ser usada por um sistema de gestão de pedidos, como `empresa` ou `residencial` . Tipo de dados: Cadeia de caracteres
Data de conclusão	Data e hora em que a ordem de serviço foi concluída. Tipo de dados: Cadeia de caracteres
descrição	Descrição da ordem de serviço. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data e hora de conclusão esperadas designadas pelo provedor. Tipo de dados: Cadeia de caracteres
ExternalIdentifier	Lista de referências externas, como fornecedor ou ID de correlação. Tipo de dados: Matriz `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier. No tipo	Este valor é sempre `Identificador Externo` . Tipo de dados: Cadeia de caracteres
externalIdentifier.id	Referência externa, como fornecedor ou ID de correlação. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro da ordem de serviço. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem de serviço. Tabela: Ordem de serviço [wm_order] Tipo de dados: Cadeia de caracteres
Iniciadode	ID de referência que indica onde a ordem de serviço foi iniciada. Por exemplo, uma tarefa sys_id da tabela Tarefa de ordem de serviço [wm_task]. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações sobre o pedido. Tipo de dados: Matriz `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
note.author	Autor da nota. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi adicionada à ordem de serviço. Tipo de dados: Cadeia de caracteres
note.text	O texto da anotação. Tipo de dados: Cadeia de caracteres
lugar	A localização geográfica associada à ordem de serviço. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
tipo de local	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
Lugar.Parte Relacionada	Lista de grupos de suporte para o local. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Lugar.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
place.relatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
place.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
Lugar.Parte.RelatedParteRelatedFunção	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
prioridade	Classificação de prioridade da ordem de serviço. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos associados à ordem de serviço. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty. Em	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. Tabela: Conta [customer_account], Empresa [core_company] ou Usuário [sys_user] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedParty.role	Função da parte relacionada. Valores possíveis: Conta Empresa Cliente Contato Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data e hora de conclusão solicitadas. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início da execução do pedido designada pelo solicitante. Usado nos casos em que o solicitante não pode permitir que o provedor inicie a execução antes de uma data especificada. Tipo de dados: Cadeia de caracteres
shortDescription	Breve resumo da ordem de serviço. Tipo de dados: Cadeia de caracteres
startDate	Data e hora em que o pedido foi iniciado. Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de serviço. Valores possíveis: Rascunho Aguardando qualificação Qualificada Atribuída Trabalho em andamento Concluídas Tipo de dados: Cadeia de caracteres
templateId	Sys_id do modelo a ser usado para a ordem de serviço. Tabela: Modelo de produto [cmdb_model] Tipo de dados: Cadeia de caracteres
WorkOrderItem	Lista de tarefas na ordem de serviço. Tipo de dados: Matriz `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem. No tipo	Este valor é sempre `WorkOrderItem` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.action	Ação a ser executada no produto da tarefa. Valores possíveis: adicionar excluir modificar NoChange Tipo de dados: Cadeia de caracteres
workOrderItem.completionDate	Data e hora em que a tarefa foi concluída. Tipo de dados: Cadeia de caracteres
workOrderItem.description	Descrição da tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.id	Sys_id da tarefa. Tabela: Tarefa de ordem de serviço [wm_task] Tipo de dados: Cadeia de caracteres
workOrderItem.note	Lista de anotações sobre a tarefa. Tipo de dados: Matriz `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
workOrderItem.note.author	Autor da nota. Tipo de dados: Cadeia de caracteres
workOrderItem.note.date	Data em que a anotação foi adicionada à tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.note.text	O texto da anotação. Tipo de dados: Cadeia de caracteres
WorkOrderItem.ShortDescription	Descrição resumida da tarefa Tipo de dados: Cadeia de caracteres
WorkOrderItem.state	Estado da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work	Descrição do trabalho necessário para a tarefa. Tipo de dados: Objeto `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
WorkOrderItem.Trabalho. No tipo	Este valor é sempre `WorkRefOrValue` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.expectedCompletionDate	Data de conclusão esperada para a tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.work.id	Sys_id do tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place	Lista de localizações geográficas associadas à tarefa. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Este valor é sempre `RelatedPlaceRefOrValue Related` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place	Detalhes sobre o local. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.role	Função deste local no contexto da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Trabalho.ParteRelacionado	Lista de grupos de suporte para a tarefa. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
WorkOrderItem.Trabalho.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorOrderItem.Trabalho.ParteRelatedParteParteRelated.Função	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.scheduledStartDate	Data de início programada da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment	Detalhes da atribuição da tarefa. Tipo de dados: Matriz `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
WorkOrderItem.Work.workforceEmployeeAssignment. No tipo	Este valor é sempre `WorkforceEmployeeAssignment` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.id	Sys_id do grupo atribuído à tarefa. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee	Detalhes sobre o funcionário atribuído à tarefa. Tipo de dados: Objeto `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployeeEmployee. No tipo	Este valor é sempre `Individual` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Lista de números de telefone do funcionário. Tipo de dados: Matriz `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium. No tipo	Este valor é sempre `PhoneContactMedium` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Número de telefone do funcionário. Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id do funcionário. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nome do funcionário. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workPriority	Classificação de prioridade da tarefa. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.WorkType	O tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Campo: Nome Tipo de dados: Cadeia de caracteres
WorkOrderNumber	Identificador exclusivo da ordem de serviço, como WO0008004. Tabela: Ordem de serviço [wm_order] Campo: Número 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.
Tipo de conteúdo	Formato de dados do corpo da solicitação. 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
201	Criado. A ordem de serviço foi criada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
.	Este valor é sempre `Ordem de serviço` . Tipo de dados: Cadeia de caracteres
categoria	Categoria da ordem de serviço que pode ser usada por um sistema de gestão de pedidos, como `empresa` ou `residencial` . Tipo de dados: Cadeia de caracteres
Data de conclusão	Data e hora em que a ordem de serviço foi concluída. Tipo de dados: Cadeia de caracteres
descrição	Descrição da ordem de serviço. Tipo de dados: Cadeia de caracteres
ExpectedCompletionDate	Data e hora de conclusão esperadas designadas pelo provedor. Tipo de dados: Cadeia de caracteres
ExternalIdentifier	Lista de referências externas, como fornecedor ou ID de correlação. Tipo de dados: Matriz `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
ExternalIdentifier. No tipo	Este valor é sempre `Identificador Externo` . Tipo de dados: Cadeia de caracteres
externalIdentifier.id	Referência externa, como fornecedor ou ID de correlação. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro da ordem de serviço. Tipo de dados: Cadeia de caracteres
id	Sys_id da ordem de serviço. Tabela: Ordem de serviço [wm_order] Tipo de dados: Cadeia de caracteres
Iniciadode	ID de referência que indica onde a ordem de serviço foi iniciada. Por exemplo, uma tarefa sys_id da tabela Tarefa de ordem de serviço [wm_task]. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações sobre o pedido. Tipo de dados: Matriz `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
tipo. em	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
note.author	Autor da nota. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi adicionada à ordem de serviço. Tipo de dados: Cadeia de caracteres
note.text	O texto da anotação. Tipo de dados: Cadeia de caracteres
lugar	A localização geográfica associada à ordem de serviço. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
tipo de local	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
Lugar.Parte Relacionada	Lista de grupos de suporte para o local. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
Lugar.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
place.relatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
place.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
Lugar.Parte.RelatedParteRelatedFunção	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
prioridade	Classificação de prioridade da ordem de serviço. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos associados à ordem de serviço. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
RelatedParty. Em	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. Tabela: Conta [customer_account], Empresa [core_company] ou Usuário [sys_user] Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedParty.role	Função da parte relacionada. Valores possíveis: Conta Empresa Cliente Contato Tipo de dados: Cadeia de caracteres
SolidadData de conclusão solicitada	Data e hora de conclusão solicitadas. Tipo de dados: Cadeia de caracteres
StartDate solicitada	Data de início da execução do pedido designada pelo solicitante. Usado nos casos em que o solicitante não pode permitir que o provedor inicie a execução antes de uma data especificada. Tipo de dados: Cadeia de caracteres
shortDescription	Breve resumo da ordem de serviço. Tipo de dados: Cadeia de caracteres
startDate	Data e hora em que o pedido foi iniciado. Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de serviço. Valores possíveis: Rascunho Aguardando qualificação Qualificada Atribuída Trabalho em andamento Concluídas Tipo de dados: Cadeia de caracteres
templateId	Sys_id do modelo a ser usado para a ordem de serviço. Tabela: Modelo de produto [cmdb_model] Tipo de dados: Cadeia de caracteres
WorkOrderItem	Lista de tarefas na ordem de serviço. Tipo de dados: Matriz `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
WorkOrderItem. No tipo	Este valor é sempre `WorkOrderItem` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.action	Ação a ser executada no produto da tarefa. Valores possíveis: adicionar excluir modificar NoChange Tipo de dados: Cadeia de caracteres
workOrderItem.completionDate	Data e hora em que a tarefa foi concluída. Tipo de dados: Cadeia de caracteres
workOrderItem.description	Descrição da tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.id	Sys_id da tarefa. Tabela: Tarefa de ordem de serviço [wm_task] Tipo de dados: Cadeia de caracteres
workOrderItem.note	Lista de anotações sobre a tarefa. Tipo de dados: Matriz `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Este valor é sempre `Observação` . Tipo de dados: Cadeia de caracteres
workOrderItem.note.author	Autor da nota. Tipo de dados: Cadeia de caracteres
workOrderItem.note.date	Data em que a anotação foi adicionada à tarefa. Tipo de dados: Cadeia de caracteres
workOrderItem.note.text	O texto da anotação. Tipo de dados: Cadeia de caracteres
WorkOrderItem.ShortDescription	Descrição resumida da tarefa Tipo de dados: Cadeia de caracteres
WorkOrderItem.state	Estado da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work	Descrição do trabalho necessário para a tarefa. Tipo de dados: Objeto `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
WorkOrderItem.Trabalho. No tipo	Este valor é sempre `WorkRefOrValue` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.expectedCompletionDate	Data de conclusão esperada para a tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.ID	Sys_id do tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place	Lista de localizações geográficas associadas à tarefa. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Este valor é sempre `RelatedPlaceRefOrValue Related` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place	Detalhes sobre o local. Tipo de dados: Objeto `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Este valor é sempre `GeographicSite` . Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.place.id	Sys_id do local. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
workOrderItem.work.place.role	Função deste local no contexto da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Trabalho.ParteRelacionado	Lista de grupos de suporte para a tarefa. Tipo de dados: Matriz `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
WorkOrderItem.Trabalho.RelatedParty. No tipo	Este valor é sempre `ReferênciaPartyRelacionada` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.RelatedParty.id	Sys_id do grupo de suporte. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
workOrderItem.work.relatedParty.name	Nome do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorOrderItem.Trabalho.ParteRelatedParteParteRelated.Função	Função do grupo de suporte. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.scheduledStartDate	Data de início programada da tarefa. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment	Detalhes da atribuição da tarefa. Tipo de dados: Matriz `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
WorkOrderItem.Work.workforceEmployeeAssignment. No tipo	Este valor é sempre `WorkforceEmployeeAssignment` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.id	Sys_id do grupo atribuído à tarefa. Tabela: Grupo [sys_user_group] Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee	Detalhes sobre o funcionário atribuído à tarefa. Tipo de dados: Objeto `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployeeEmployee. No tipo	Este valor é sempre `Individual` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Lista de números de telefone do funcionário. Tipo de dados: Matriz `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium. No tipo	Este valor é sempre `PhoneContactMedium` . Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Número de telefone do funcionário. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id do funcionário. Tabela: Usuário [sys_user] Tipo de dados: Cadeia de caracteres
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nome do funcionário. Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.workPriority	Classificação de prioridade da tarefa. Valores possíveis: 1 - Crítico(a) 2 - Alta 3 - Moderado(a) 4 - Baixa 5 - Planejamento Tipo de dados: Cadeia de caracteres
WorkOrderItem.Work.WorkType	O tipo de trabalho da tarefa. Tabela: Tipo de trabalho [wm_work_type] Campo: Nome Tipo de dados: Cadeia de caracteres
WorkOrderNumber	Identificador exclusivo da ordem de serviço, como WO0008004. Tabela: Ordem de serviço [wm_order] Campo: Número Tipo de dados: Cadeia de caracteres

Solicitação de curl

Cria uma ordem de serviço e uma tarefa usando um modelo.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "id": "323",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "templateId": "191ba0e0df113100dca6a5f59bf26336",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   }
}" \
--user 'username':'password'

Corpo da resposta.

{
   "id": "ca6d72d1ffa96210b79dffffffffffa1",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "templateId": "191ba0e0df113100dca6a5f59bf26336",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   },
   "href": "api/sn_tmf_api/work_order_management_api/workOrder/ca6d72d1ffa96210b79dffffffffffa1"
}

Solicitação de curl

Cria uma ordem de serviço e uma tarefa sem usar um modelo.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "id": "323",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   }
}" \
--user 'username':'password'

Corpo da resposta.

{
   "id": "24fc3259ffa96210b79dffffffffff56",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   },
   "href": "api/sn_tmf_api/work_order_management_api/workOrder/24fc3259ffa96210b79dffffffffff56"
}