This documentation supports the 9.0 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

/mergeEntry/{formName}

The details of the Merge operation are tabulated below: 

Merge

DescriptionMerges an existing entry into the indicated form.
URL qualifier

/mergeEntry/{formName}

formName - The form for which an entry is to be created.

MethodPOST
Headers
HeaderValue
Authorizationtoken
Content-Typeapplication/json
(optional) X-AR-Client-TypeClient Type ID
(optional) X-AR-RPC-QueueRPC queue to which the client calls are routed
Request bodyAn entry object in JSON format, merge options and qualification
ReturnsNo body content, but returns HTTP status code 201 with the Location header set to the URL of the new instance resource.
Merge Type

A value that indicates the action to take if the operation includes an Entry ID field and Entry ID that already exists in the target form. This parameter is ignored if you do not specify the Entry ID field or the ID specified does not conflict with existing entry IDs.

Merge TypeDescription
DUP_ERRORGenerates an error.
DUP_NEW_IDCreates a new entry with a new entry ID.
DUP_OVERWRITEDeletes the existing entry and creates a new one.
DUP_MERGEUpdate the fields specified in fieldList in the existing entry.
GEN_NEW_IDAlways generates a new entry ID for the record, even if there is no conflicting entry ID.

Example

Merge entry without attachment field

{
// normal entry values section
    "values" : {
        ...
    },
    // merge options
    "mergeOptions" : {
        "ignorePatterns" : false,
        "ignoreRequired" : false,
        "workflowEnabled" : false,
        "associationsEnabled" : false,
        "mergeType" : "DUP_ERROR",
        "multimatchOption" : 0
    },
    // a String representation of the qualification
    "qualification" : "'8'LIKE \"%match criteria%\"
}

Merge with attachments

DescriptionMerges an existing entry into the indicated form.
URL qualifier

/mergeEntry/{formName}

formName - The form for which an entry is to be created.

MethodPOST
Headers
HeaderValue
Authorizationtoken
Content-Typemultipart/form-data
(optional) X-AR-Client-TypeClient Type ID
(optional) X-AR-RPC-QueueRPC queue to which the client calls are routed
Request bodyAn entry object in JSON format, merge options and qualification
ReturnsNo body content, but returns HTTP status code 201 with the Location header set to the URL of the new instance resource.
All possible error codes

If the request is not successful, the following error code is returned

500 - Internal Server Error

Example

Merge entry with attachment field

{
    // normal entry values section
    "values" : {
        ...
            AttachmentFieldName : “attachedFileName”,
        ...
    },
    // merge options
    "mergeOptions" : {
        "ignorePatterns" : false,
        "ignoreRequired" : false,
        "workflowEnabled" : false,
        "associationsEnabled" : false,
        "mergeType" : "DUP_ERROR",
        "multimatchOption" : 0
    },
    // a String representation of the qualification
    "qualification" : "'8'LIKE \"%match criteria%\"
}

Related topics

Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Lonnie Murray

    It'd be helpful if you also included the values for the "multimatchoption"

    Apr 15, 2019 11:36
    1. Anagha Deshpande

      Hello Lonnie,

      Thanks for the feedback. We will work on it and will update the topic soon.

      Regards,

      Anagha

      Apr 15, 2019 10:00
      1. Anagha Deshpande

        Hello Lonnie,

        Please see below the details for the multimatchoption option:

        • 0 No entry is merged with the sent entry.
        • 1 Only the first matching entry is merged. The remaining entries are not merged.

        Hope this helps.

        Regards,

        Anagha

        Apr 18, 2019 01:38