Get Matches Defined by User
Returns URIs of all entities marked as 'matches defined by user' for an entity in a
request. Also returns 'updatedBy
' and 'updateTime
'
values.
Request
GET {TenantURL}/{entityURI1}/_setAMatch
Parameter | Required | Details | |
---|---|---|---|
Headers |
Authorization
|
Yes | Information about authentication access token in format "Bearer
<accessToken> " (see details in Authentication API). |
Query |
returnObjects
|
No | Specifies if response should contain created entities. Default value
is true . |
Response
Returns array of JSON nodes with URIs of 'matches', names of users who marked the entities as 'matches defined by user' and update dates.
Example 1
Request
GET {TenantURL}/entities/00005KL/_setAMatch?returnObjects=falseHeaders:Authorization:
Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,Content-Type: application/json
Response
GET {
TenantURL
}
/entities/
00005 KL / _notMatches ? returnObjects = falseHeaders :
Authorization: Bearer 204938 ca-2 cf7-44 b0-b11a-1 b4c59984512[{
"URI": "entities/0000Dqr",
"updatedTime": 1440399634351,
"updatedBy": "User"
}, {
"URI": "entities/00009ab",
"updatedTime": 1440399532513,
"updatedBy": "User"
}, {
"URI": "entities/0000I77",
"updatedTime": 1440399641181,
"updatedBy": "User"
}]
Example 2
Request
GET {TenantURL}/entities/00005KL/_setAMatch
Headers:Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,Content-Type:
application/json
Response
[{
"object": {
"URI": "entities/0000Dqr",
...
},
"URI": "entities/0000Dqr",
"updatedTime": 1440399634351,
"updatedBy": "User"
}, {
"object": {
"URI": "entities/00009ab",
...
},
"URI": "entities/00009ab",
"updatedTime": 1440399532513,
"updatedBy": "User"
}, {
"object": {
"URI": "entities/0000I77",
...
},
"URI": "entities/0000I77",
"updatedTime": 1440399641181,
"updatedBy": "User"
}]