Create a Lookup Table
LookupTables
Use Lookup tables to create links between associated values in your source and target data, such as a State code in the source and its State abbreviation in the target. For example, your Contact data source may have an address field called State which is populated with picklist values of 1, 2 , 3, up to 50. The Contact data target has an equivalent field, but stores values of State abbreviations, such as "NH", "ME", and "VT", to represent the equivalent settings in that field. You can create a lookup table that maps the value of 1 in the source system to the value "NH" in the equivalent field in the target system. See Lookup Tables in the TIBCO Scribe® Help.
Endpoints — Use the links in the Endpoints section below to access the TIBCO Scribe® Swagger page and try out the API against your Organization.
Fields For LookupTables Endpoints — Review the field definition table below the list of Endpoints for detailed field level information.
Considerations
In some cases there are special considerations or use cases for specific endpoints that you should know about before you use the endpoint.
GET /v1/orgs/{orgId}/lookuptables
- Lookup Table Values can be included as an option.
POST /v1/orgs/{orgId}/lookuptables
- ID, CreationDate, ModificationBy, and LastModificationDate are supplied by the API. Lookup Table name must be unique for the Organization.
- In some cases, a large Lookup table cannot be loaded with a single LookupTables POST call. If this call times out and returns a 504 error, add the Lookup table values one at a time using the LookupTables values POST call instead.
PUT /v1/orgs/{orgId}/lookuptables/{tableId}
- Removes all Lookup Table Values and applies the Values specified.
GET /v1/orgs/{orgId}/lookuptables/{tableId}/export/{exportId}
- Use the export ID returned by the GET /v1/orgs/{orgId}/lookuptables/{tableId}/export endpoint to retrieve an exported Lookup Table.
POST /v1/orgs/{orgId}/lookuptables/{tableId}/import
- Lookup Table must exist before you import a CSV file containing values. Use POST /v1/orgs/{orgId}/lookuptables to create the Lookup Table first.
POST /v1/orgs/{orgId}/lookuptables/{tableId}/values
- ID, CreationDate, ModificationBy, and LastModificationDate are supplied by the API.
GET /v1/orgs/{orgId}/lookuptables/{tableIdOrName}/values/value1/{value2}
- In a case where there are duplicates, the first value alphabetically is returned.
GET /v1/orgs/{orgId}/lookuptables/{tableIdOrName}/values/value2/{value1}
- In a case where there are duplicates, the first value alphabetically is returned.
Endpoints
Return a list of Lookup Tables
Delete a Lookup Table
Return information about a Lookup Table
Modify a Lookup Table
Export a Lookup Table
Return exported Lookup Table
Import a CSV file into a Lookup Table
Return a list of Lookup Table Values for a Lookup Table
Create a Lookup Table Value
Delete a Lookup Table Value
Return information about a Lookup Table Value
Modify a Lookup Table Value
Return Lookup Table Value1 based on Lookup Table Value2
Return Lookup Table Value2 based on Lookup Table Value1
Fields For LookupTables Endpoints
The list of fields defined in this table is comprehensive across all LookupTables endpoints. See Endpoints for a list of LookupTables endpoints with links to the associated Swagger page.
|
Name |
Description |
Endpoints |
|---|---|---|
|
Parameters |
||
|
commaSeparatedValues body string |
Lookup Table values in a comma separated format. Required Example with header row: ID,State 1,NH 2,VT Duplicates are allowed, however, the first item found alphabetically is returned. |
|
|
exportId path integer |
ID returned by the GET /v1/orgs/{orgId}/lookuptables/{tableId}/export method when a Lookup Table export is requested. Use this ID to retrieve the exported Lookup Table file using the GET /v1/orgs/{orgId}/lookuptables/{tableId}/export/{exportId} method. Required |
|
|
hasHeaderRow query boolean |
When importing a CSV file containing a Lookup Table, indicates whether the first row of comma separated values contains column headings. Default value is true.
|
|
|
includeLookupTableValues query boolean |
Controls whether or not to return associated Lookup Table Values. Default is false.
|
|
|
limit query integer |
Maximum number of Lookup Tables to return. Default value is 100. See Reading Resources for more information on offset and limit parameters. |
|
|
model body model |
Model for the Lookup Table record or the Lookup Table Value record being added or modified. Note: When modifying a Lookup Table, all Lookup Table Values are removed and only Values included in the model are stored. Required |
|
|
offset query integer |
Number of Lookup Tables to skip before returning results. Default value is 0. See Reading Resources for more information on offset and limit parameters. |
|
|
orgId path integer |
Unique ID for each Organization. Required |
All |
|
tableId path string |
GUID/UUID of the Lookup Table. Required |
|
|
tableIdOrName path string |
GUID/UUID or Name of the Lookup Table. Required |
|
|
value1 path string |
Value contained in the value1 field for the selected Lookup Table. Required |
|
|
value2 path string |
Value contained in the value2 field for the selected Lookup Table. An empty value, such as "" is valid. Required |
|
|
valueId path string |
GUID/UUID of the Lookup Table Value. Required |
|
|
Response |
||
|
creationDate response string |
Date and time in UTC time that the Lookup Table or Lookup Table Value was created. |
|
|
description response string |
User-specified description of the Lookup Table. |
|
|
exportId response string |
ID returned by the GET /v1/orgs/{orgId}/lookuptables/{tableId}/export method when a Lookup Table export is requested. Use this ID to retrieve the exported Lookup Table file using the GET /v1/orgs/{orgId}/lookuptables/{tableId}/export/{exportId} method |
|
|
id response string |
GUID/UUID of the Lookup Table or Lookup Table Value. |
|
|
lastModificationDate response string |
Date and time in UTC time that the Lookup Table or Lookup Table Value was last modified. |
|
|
modificationBy response string |
User name of the logged in user who modified the record via the API. A value of Cloud indicates that the modification was made via the TIBCO Scribe® User Interface. |
|
|
name response string |
Name of the Lookup Table. Must be unique for the Organization. |
|
|
lookupTableValues response array |
Array containing pairs of values in the Lookup Table. |
|
|
value1 response string |
First Lookup Table Value of the value pair, paired with value2. |
|
|
value2 response string |
Second Lookup Table Value of the value pair, paired with value1. |
|
See