必須または不要の要求本文パラメーターを変更するには、TMFTroubleTicketAPIConstants スクリプトインクルードを更新します。デフォルトでは、チケット (POST) を作成するための要求本文には、パラメーター description、 severity、および ticketType が必要です。デフォルトでは、チケット (PATCH) を更新するための要求本文には必須パラメーターがありません。

• TMFTroubleTicketAPIConstants.TROUBLE_TICKET_CREATION_SCHEMA:チケットを作成するために必要な要求本文パラメーターを設定します。
• TMFTroubleTicketAPIConstants.TROUBLE_TICKET_UPDATE_SCHEMA:チケットを更新するために必要な要求本文パラメーターを設定します。

この例では、チケットを作成するために description、 severity、 status、および ticketType パラメーターが必要です。

// TMFTroubleTicketAPIConstants
TMFTroubleTicketAPIConstants.TROUBLE_TICKET_CREATION_SCHEMA = {
    "title": "CreateTroubleTicket",
    "type": "object",
    "properties": {
        "description": {
            "type": "string"
        },
        "severity": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "ticketType": {
            "type": "string"
        }
    },
    "required": [
        "description",
        "severity",
        "status",
        "ticketType"
    ]
};

要求本文で追加の検証を実行するには、TroubleTicketProcessorOOB 関数を上書きします。TroubleTicketProcessorOOB には、既定で true を返す次の 6 つのヘルパー関数が含まれています。これらの関数は TMFTroubleTicketAPIUtil で呼び出されます。

• verifyGetRequestForCase():processGetRequestForCase() によって呼び出されます。
• verifyPatchRequestForCase() - processPatchRequestForCase() によって呼び出されます。
• verifyPostRequestForCase() - processPostRequestForCase() によって呼び出されます。
• verifyGetRequestForIncident():processGetRequestForIncident() によって呼び出されます。
• verifyPatchRequestForIncident():processPatchRequestForIncident() によって呼び出されます。
• verifyPostRequestForIncident():processPostRequestForIncident() によって呼び出されます。

ヘルパー関数が false を返すと、API 操作が停止されます。カスタム検証を適用するには、TroubleTicketProcessor で同じ名前とパラメーターを持つ関数を作成して、TroubleTicketProcessorOOB ヘルパー関数を上書きします。これらの新しい TroubleTicketProcessor 関数は、デフォルトの TroubleTicketProcessorOOB ヘルパー関数を置き換えるために TMFTroubleTicketAPIUtil によって呼び出されます。

この例では、TroubleTicketProcessor の関数が TroubleTicketProcessorOOB のデフォルト関数を上書きして、name 属性の検証を実行します。

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

    verifyPostRequestForCase: function(caseObject, apiResponseProcessor){
        // Returning false terminates the POST request
        // Make sure to assign error message and reason
        if (caseObject.name != "Hello world") {
            apiResponseProcessor.setMessage(TMFTroubleTicketAPIConstants.MESSAGES.CASE_CREATION_FAILURE);
            apiResponseProcessor.setReason("No reason needed");
            return false;
        }
    },

    type: 'TroubleTicketProcessor'
});

TroubleTicketProcessorOOB には、PATCH または POST 要求本文をケースまたはインシデントの GlideRecord にマップするための次の関数が含まれています。

• mapPatchRequestToCase()
• mapPostRequestToCase()
• mapPatchRequestToIncident()
• mapPostRequestToIncident()

TroubleTicketProcessorOOB には、ケースまたはインシデントの GlideRecord を GET、PATCH、または POST 要求の JSON 応答オブジェクトにマップするための次の関数が含まれています。

• createGetResponseForCase()
• createPatchResponseForCase()
• createPostResponseForCase()
• createGetResponseForIncident()
• createPatchResponseForIncident()
• createPostResponseForIncident()

この例では、TroubleTicketProcessor の 2 つの関数が TroubleTicketProcessorOOB のデフォルト関数を上書きして、[説明] フィールドのマッピングを変更し、[契約] フィールドのマッピングを追加します。

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

    mapPostRequestToCase: function(caseGr, caseObject){
        // Override default mapping for the Description field
        caseGr.description = "All cases will be created with this description";
        // Add new mapping to the Contract field
        caseGr.contract = caseObject.contract;
     },

    createPostResponseForCase: function(caseGr, caseObject){
        // Override default mapping for the description attribute
        caseObject.description = "This will always be the retrieved description";
        // Add new contract attribute to the response object
        caseObject.contract = caseGr.contract;    
    },

    type: 'TroubleTicketProcessor'
});

TroubleTicketProcessorOOB には、次の選択肢フィールドマッピング関数が含まれています。

• transformCaseSeverity()
• transformCaseChannel()
• transformCaseStatus()
• transformIncidentSeverityToUrgency()
• transformIncidentSeverityToImpact()
• transformIncidentChannel()
• transformIncidentStatus()

TroubleTicketProcessor で同じ名前とパラメーターを持つ関数を作成して、TroubleTicketProcessorOOB 選択フィールドマッピング関数を上書きします。これらの新しい TroubleTicketProcessor 関数は、デフォルトの TroubleTicketProcessorOOB 選択フィールド マッピング関数を置き換えるために TMFTroubleTicketAPIUtil によって使用されます。

この例では、TroubleTicketProcessor の関数が TroubleTicketProcessorOOB のデフォルト関数を上書きして、[ ステータス] フィールドの選択肢マッピングを変更します。

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

    transformCaseStatus: function(status){
        if (status == "Draft")
            return 1;
        else return 10;
    },

    type: 'TroubleTicketProcessor'
});