Unify and manage your data

Search by Filter

Request:

GET {TenantURL}/lookups/{tenant_name}?filter=equals(type,%27State%27)&sort=code&order=asc
AUTHORIZATION: Bearer {access_token}
Table 1. Search Filters
PropertyDescription
typeLookup type name
codeLookup code
valueCanonical value
enabledEnabled/Disabled flat
updateDateLast lookup update date
updatedBy
versionCurrent version
startDateLookup code start date
endDateLookup code end date
Table 2. Sorting
PropertyDescription
typeLookup type name
codeLookup code
valueCanonical value
enabledEnabled/Disabled flat
updateDateLast lookup update date
updatedBy
versionCurrent version
startDateLookup code start date
endDateLookup code end date
Table 3. Ordering
Order
acsA to Z. 0 to 9
descZ to A, 0 to 0
Table 4. Filter Operators
OperatorDescription
equals (property, value)exact match condition, ignoring case
fullText (property, value)combines results into the overall result. Any entity whose title field contains at least one of the specified terms will match the query. The more terms that match, the more relevant the entity
startsWith (property, stricted value)prefix condition; returns entities that have condition property starting with condition value
contains (property, tokenized value)prefix condition; returns entities that have condition property starting with condition value
lt (property, value)less than condition
lte (property, value)less than or equals condition
gt (property, value)greater than condition
gte (property, value)greater than or equals condition
missing (property)returns entities with fields that have no values for 'property' or 'property' value is empty
exists (property)returns entities having some not empty value for 'property'

Update Lookup Code

Request:

PUT https://{{rdm-service}}/lookups/rdm_tenant_name/State/AR
Authorization: Bearer {{token}}
{
    "tenantId": "rdm_tenant_name",
    "enabled": true,
    "code": "AR",
    "type": "rdm/lookupTypes/State",
    "sourceMappings": [
      {
        "source": "Reltio",
        "values": [
          {
            "code": "AR",
            "value": "Arkansas",
            "enabled": true
          }
        ]
      },
      {
        "source": "FB",
        "values": [
          {
            "code": "AR",
            "value": "Arkansas",
            "enabled": true
          }
        ]
      }
    ],
    "localizations": [],
    "parents": [
        "rdm/lookupTypes/Country/US"
    ]
  }
Response:
{
  "tenantId": "rdm_tenant_name",
  "updatedBy": "anton.artemyev",
  "updateDate": 1488466088624,
  "version": 6,
  "type": "rdm/lookupTypes/State",
  "code": "AR",
  "enabled": true,
  "sourceMappings": [
    {
      "source": "Reltio",
      "values": [
        {
          "code": "AR",
          "value": "Arkansas",
          "enabled": true,
          "canonicalValue": true,
          "downStreamDefaultValue": true
        }
      ]
    },
    {
      "source": "FB",
      "values": [
        {
          "code": "AR",
          "value": "Arkansas",
          "enabled": true,
          "canonicalValue": false,
          "downStreamDefaultValue": true
        }
      ]
    }
  ],
  "localizations": [],
  "parents": [
    "rdm/lookupTypes/Country/US"
  ],
  "startDate": 0,
  "endDate": 0
}

Delete Lookup Code

Request

DELETE https://{{rdm-service}}/lookups/rdm_tenant_name/State/AR
Authorization: Bearer {{token}}

Response

{
    "status" : "success"
}