Guia do desenvolvedor de API de ordem de serviço aberta

Use API de ordem de serviço aberta para criar, atualizar e recuperar informações de ordem de serviço.

Este guia do desenvolvedor fornece informações sobre como estender o. API de ordem de serviço aberta para fazer várias personalizações.

Estender a API de ordem de serviço em aberto

. API de ordem de serviço aberta pode ser estendido editando inclusões de script.

Essas inclusões de script só devem ser editadas com uma compreensão das consequências das mudanças.

• TMFServiceOrderAPIUtil : Contém funções para lidar com solicitações POST.
• TMFServiceOrderGetAPIUtil : Contém funções para lidar com solicitações GET.
• ServiceOrderExtensionOOB : Contém funções de ajuda que oferecem suporte a funções no TMFServiceOrderAPIUtil e. TMFServiceOrderGetAPIUtil .
• ServiceOrderProcessor : Um arquivo de inclusão de script vazio. Use este arquivo para definir todas as funções que você deseja substituir ServiceOrderExtensionOOB .

Estenda API de ordem de serviço aberta para fazer as personalizações a seguir.

Parâmetros obrigatórios

Para mudar quais parâmetros do corpo da solicitação são necessários ou não para criar uma ordem de serviço, substitua a função GetServiceOrderSchema() contido em ServiceOrderExtensionOOB inclusão de script.

A função GetServiceOrderSchema() lê o esquema do TMFOrderAPIConstantes inclusão de script. TMFOrderAPIConstantes está protegido e não pode ser editado, portanto, você não pode simplesmente atualizar o esquema. Em vez disso, um novo esquema deve ser lido de um arquivo diferente. Você pode substituir GetServiceOrderSchema() para ler um novo esquema. Para substituir GetServiceOrderSchema() escreva uma função com o mesmo nome em ServiceOrderProcessor inclusão de script. A nova função em ServiceOrderProcessor será chamado por TMFServiceOrderAPIUtil para substituir o padrão GetServiceOrderSchema() função em ServiceOrderExtensionOOB .

Neste exemplo, GetServiceOrderSchema() retorna um esquema personalizado que é definido em um novo arquivo de constante.

// ServiceOrderProcessor

var ServiceOrderProcessor = Class.create();
ServiceOrderProcessor.prototype = Object.extendsObject(ServiceOrderExtensionOOB, {
   // Define overriding functions here
   // Function name and parameters must be identical to the function it overrides

   getServiceOrderSchema: function() {
      //Define your own custom schema in a new constant file
      return JSON.parse(Constants.SCHEMA.CREATE_SERVICE_ORDER);
   },

   type: 'ServiceOrderProcessor'
});

Validação do corpo da solicitação

Para executar validação adicional no corpo da solicitação, substitua ServiceOrderExtensionOOB funções. ServiceOrderExtensionOOB contém as quatro funções auxiliares a seguir que retornam verdadeiro por padrão.

• ValidatePostRequest() - Chamado por ProcessPostOrder() em TMFServiceOrderAPIUtil .
• ValidateServiceObj() - Chamado por ProcessPostOrder() em TMFServiceOrderAPIUtil .
• ValidateRelatedPartyObj() - Chamado por ProcessPostOrder() em TMFServiceOrderAPIUtil .
• ValidateGetRequest() - Chamado por ProcessGetOrder() em TMFServiceOrderGetAPIUtil .

Se uma função auxiliar retornar falso , Interrompe a operação da API. Para aplicar validação personalizada, substitua ServiceOrderExtensionOOB funções de ajuda criando funções com nomes e parâmetros idênticos em ServiceOrderProcessor . Novos ServiceOrderProcessor as funções serão chamadas por TMFServiceOrderAPIUtil e. TMFServiceOrderGetAPIUtil para substituir o padrão ServiceOrderExtensionOOB funções auxiliares.

Neste exemplo, uma função em ServiceOrderProcessor substitui uma função padrão em ServiceOrderExtensionOOB para executar a validação no serviceOrderItematributo.

// ServiceOrderProcessor

var ServiceOrderProcessor = Class.create();
ServiceOrderProcessor.prototype = Object.extendsObject(ServiceOrderExtensionOOB, {
    // Define overriding functions here
    // Function name and parameters must be identical to the function it overrides

    validatePostRequest: function(orderObject, details) {
        // Returning false terminates the POST request
        // Make sure to push error message in details array in case of error
        if (gs.nil(orderObject.serviceOrderItem)) {
            details.push(new TMFCommonOrderAPIUtil().getErrorDetailsObj(TMFOrderAPIConstants.MESSAGES.MISSING_ORDER_ITEM, '/'));
            return false;
        }
        return true;
    },

    type: 'ServiceOrderProcessor'
});

Operações REST adicionais

Para criar operações adicionais além das operações GET e POST existentes, Criar recursos REST com script adicionais para API de ordem de serviço aberta . A lógica dos novos recursos REST com script deve ser consistente com as operações existentes. Defina funções para as novas operações em uma nova inclusão de script.

Mapeamento de campo

Ao criar registros, a API mapeia os parâmetros do corpo da solicitação para campos de registro. Ao recuperar registros, a API mapeia campos de registro para atributos de objeto de resposta.

ServiceOrderExtensionOOB Contém as seguintes funções para mapear um corpo de solicitação POST para um GlideRecord.

• TransformOrderGr()
• TransformOrdLineItemGr()
• TransformCustLineItmContact()
• TransformOrderItemChar()

ServiceOrderExtensionOOB Contém as seguintes funções para mapear um GlideRecord para um objeto de resposta para solicitações GET ou POST.

• TransformPostOrderResponse()
• TransformGetOrderResponse()
• TransformServiceObj()
• TransformRelatedPartyCustomerLineItem()
• TransformOrderItemRelationship()
• TransformGetOrdLineItmResponse()
• TransformServiceCharacteristics()
• TransformServiceSpecification()

Personalize mapeamentos de campo para adicionar e recuperar dados de campos adicionais ou para mudar os mapeamentos padrão de campos. Para personalizar os mapeamentos de campo, substitua ServiceOrderExtensionOOB mapeamento de funções criando funções com nomes e parâmetros idênticos em ServiceOrderProcessor . Novos ServiceOrderProcessor as funções serão usadas por TMFServiceOrderAPIUtil e. TMFServiceOrderGetAPIUtil para substituir o padrão ServiceOrderExtensionOOB funções de mapeamento.

Neste exemplo, duas funções em ServiceOrderProcessor substitua as funções padrão em ServiceOrderExtensionOOB para criar mapeamentos para external_ide. sys_idcampos.

// ServiceOrderProcessor

var ServiceOrderProcessor = Class.create();
ServiceOrderProcessor.prototype = Object.extendsObject(ServiceOrderExtensionOOB, {
    // Define overriding functions here
    // Function name and parameters must be identical to the function it overrides

    transformOrderGr: function(requestObject, orderGr) {
        orderGr.external_id = requestObject.externalId;
        return orderGr;
    },

    transformPostOrderResponse: function(orderObject, orderGr) {
        orderObject.id = orderGr.getValue('sys_id');
        return orderObject;
    },

    type: 'ServiceOrderProcessor'
});