Jump to

• Request
• Response
• Examples

Create a detailed record for a duplicate party resolution

post

/crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/ResolutionDetail

Request

Path Parameters

• RequestId(required): integer(int64)
  The unique identifier of the resolution request.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EntityId: integer (int64)
  The unique identifier of the logical business entity associated with the record.
• EntityNumber: string
  The unique alternate identifier of the record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.
• EntityObject: string
  Maximum Length: 30

  The name of the logical business entity associated with the record.
• MasterId: integer
  The unique identifier of the master record.
• MasterNumber: string
  The unique alternate identifier of the master record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.

{
    "type":"object",
    "properties":{
        "EntityId":{
            "type":"integer",
            "description":"The unique identifier of the logical business entity associated with the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MasterNumber":{
            "type":"string",
            "description":"The unique alternate identifier of the master record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.",
            "nullable":true,
            "x-queryable":false
        },
        "EntityNumber":{
            "type":"string",
            "description":"The unique alternate identifier of the record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.",
            "nullable":true,
            "x-queryable":false
        },
        "MasterId":{
            "type":"integer",
            "description":"The unique identifier of the master record.",
            "nullable":true,
            "x-queryable":false
        },
        "EntityObject":{
            "maxLength":"30",
            "type":"string",
            "description":"The name of the logical business entity associated with the record.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : resolutionRequests-ResolutionDetail-item-response

Type: object

Show Source

• Action: string
  Read Only: true

  Maximum Length: 30

  The action performed on the record, for example MERGE or RETAIN.
• EntityId: integer (int64)
  The unique identifier of the logical business entity associated with the record.
• EntityNumber: string
  The unique alternate identifier of the record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.
• EntityObject: string
  Maximum Length: 30

  The name of the logical business entity associated with the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MasterFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates if the duplicate entity is master. The default value is false.
• MasterId: integer
  The unique identifier of the master record.
• MasterNumber: string
  The unique alternate identifier of the master record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.
• ParentId: integer (int64)
  Read Only: true

  The unique identifier of the parent record.
• ParentMasterId: integer (int64)
  Read Only: true

  The unique identifier of the master record associated with the parent record.
• ParentObject: string
  Read Only: true

  Maximum Length: 255

  The name of the parent object.

{
    "type":"object",
    "properties":{
        "ParentId":{
            "type":"integer",
            "description":"The unique identifier of the parent record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ParentObject":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the parent object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EntityId":{
            "type":"integer",
            "description":"The unique identifier of the logical business entity associated with the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Action":{
            "maxLength":"30",
            "type":"string",
            "description":"The action performed on the record, for example MERGE or RETAIN.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentMasterId":{
            "type":"integer",
            "description":"The unique identifier of the master record associated with the parent record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MasterNumber":{
            "type":"string",
            "description":"The unique alternate identifier of the master record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.",
            "nullable":true,
            "x-queryable":false
        },
        "EntityNumber":{
            "type":"string",
            "description":"The unique alternate identifier of the record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.",
            "nullable":true,
            "x-queryable":false
        },
        "MasterId":{
            "type":"integer",
            "description":"The unique identifier of the master record.",
            "nullable":true,
            "x-queryable":false
        },
        "EntityObject":{
            "maxLength":"30",
            "type":"string",
            "description":"The name of the logical business entity associated with the record.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MasterFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the duplicate entity is master.  The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

EntityObjectLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ZCH_WS_ENTITY_OBJ

The list of values indicating the entity objects supported.

The following properties are defined on the LOV link relation:

• Source Attribute: EntityObject; Target Attribute: LookupCode
• Display Attribute: LookupCode

Back to Top

Examples

The following example shows how to create a detailed record for a duplicate party resolution by submitting a POST request on the REST resource using cURL.

Note:

The Resolution Detail resource can be created as a part of the Create a Resolution Request payload. The Resolution Detail structure is required for single-party resolution requests, otherwise it is optional. The following example shows the creation of a single-party resolution request, with the resolution detail specifying that one of the party's addresses be merged into another address of the party.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resolutionRequests

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"ResolutionType": "MERGE",
"DuplicateParty": [
   {"PartyNumber":"4433085"}
  ],
 "ResolutionDetail": [
 {
   "EntityId":300000135216345,
   "EntityObject":"HZ_PARTY_SITES",
   "MasterId":300000135216355
    }    
  ]
}

Back to Top