Lookup Table Integration

The following Lookup Table Integration APIs are available:

• POST pub/lookupTable

• GET pub/lookup Table

• DELETE pub/lookupTable/{lookupTableId}

• POST pub/lookupTable/{lookupTableId}/import

• GET pub/lookupTable/{lookupTableId}/task/{taskId}

• GET pub/lookupTable/{lookupTableId}/data

• PUT pub/lookupTable/{lookupTableId}/data

• PUT pub/lookupTable/{lookupTableId}/data/delete

POST pub/lookupTable

LookupTable - Post

The LookupTable endpoint allows you to create the definition of a lookupTable.

Resource

POST /pub/lookupTable

Authorization

Basic access authentication

Post Parameters

Example

{
  "name": "csurl_scores",
  "description": "",
  "organizationName": "Super",
  "columnList": [
    {
      "key": true,
      "name": "url",
      "type": "STRING"
    },
    {
      "key": false,
      "name": "wfCategoryID",
      "type": "LONG"
    },
    {
      "key": false,
      "name": "score",
      "type": "DOUBLE"
    }
  ]
}

Response

Status-Code: 200 OK

{
  "id": 1250451,
  "name": "csurl_scores",
  "description": "",
  "organizationName": "Super",
  "columnList": [
    {
      "key": true,
      "name": "url",
      "type": "STRING"
    },
    {
      "key": false,
      "name": "wfCategoryID",
      "type": "LONG"
    },
    {
      "key": false,
      "name": "score",
      "type": "DOUBLE"
    }
  ]
}

HTTP Error Codes

GET pub/lookup Table

LookupTable - Get

The LookupTable endpoint lets you retrieve the list of lookupTable definitions.

Resource

GET /pub/lookupTable

Authorization

Basic access authentication

Query Parameters

Example Request

Replace <credentials> in the example below with the Base64 encoding of username and password joined by a single colon :

curl -H 'Authorization: Basic <credentials>' \
     -H 'content-type: application/json' \
     'https://<IP>/phoenix/rest/pub/lookupTable'

Response

Status-Code: 200 OK

{
  "data": [
    {
      "columnList": [
        {
          "key": true,
          "name": "url",
          "type": "STRING"
        },
        {
          "key": false,
          "name": "wfCategoryID",
          "type": "LONG"
        },
        {
          "key": false,
          "name": "score",
          "type": "DOUBLE"
        }
      ],
      "organizationName": "Super",
      "description": "",
      "id": 1250451,
      "lastUpdated": 1632432976253,
      "lastUpdatedResult": "importDataViaFile : 24181 rows are imported successful.",
      "name": "csurl_scores"
    }
  ],
  "total": 1,
  "start": 0,
  "size": 25
}

Request Parameters

HTTP Error Codes

DELETE pub/lookupTable/{lookupTableId}

LookupTable - Delete

The LookupTable endpoint allows you to delete the lookupTable definition.

Resource

DELETE /pub/lookupTable/{lookupTableId}

Authorization

Basic access authentication

Path Parameters

Query Parameters

None

Example Request

curl -H 'Authorization: Basic <credentials>' \
     -H 'content-type: application/json' \
     -X DELETE \
     'https://<IP>/phoenix/rest/pub/lookupTable/<lookupTableId>'

Response

Status-Code: 204 No Content

POST pub/lookupTable/{lookupTableId}/import

LookupTable import data - Post

The LookupTable endpoint allows importing the data of lookupTable.

Resource

POST /pub/lookupTable/{lookupTableId}/import

Authorization

Basic access authentication

Post Parameters

Content-Type: multipart/form-data

{
   "<LookupTable_Column_Name_1>":<Position_1>,
"<LookupTable_Column_Name_2>":<Position_2>,
……
}

{
   "url":1,
   "wfCategoryID":2
}

Example Request

curl -H 'Authorization: Basic <credentials>' \
     -X POST \
     'https://<IP>/phoenix/rest/pub/lookupTable/<lookupTableId>/import'
     -F 'file=@"/<FileDir>/<FileName>.csv"' \
     -F 'mapping="{\"url\":1,\"wfCategoryID\":2}"' \
     -F 'fileSeparator=","' \
     -F 'fileQuoteChar="\""' \
     -F 'skipHeader="true"'

Response

Content-Type: application/json

Status-Code: 200 OK

{
  "taskId": 1250
}

HTTP Error Codes

GET pub/lookupTable/{lookupTableId}/task/{taskId}

LookupTable check importing task status - Get

The LookupTable endpoint allows checking the status of import data.

Resource

GET /pub/lookupTable/{lookupTableId}/task/{taskId}

Authorization

Basic access authentication

Path Parameters

Example Request

Replace <credentials> in the example below with the Base64 encoding of username and password joined by a single colon :

curl -H 'Authorization: Basic <credentials>' \
     -H 'content-type: application/json' \
     'https://<IP>/phoenix/rest/pub/lookupTable/<lookupTableId>/task/<taskId>'

Response

Status-Code: 200 OK

{
  "id": 1250
  "status": "Done",
  "progress": 100,
  "actionResult": "557 rows are imported successful."
}

HTTP Error Codes

GET pub/lookupTable/{lookupTableId}/data

Query LookupTable Data - Get

The LookupTable endpoint allows retrieving items of lookupTable.

Resource

GET /pub/lookupTable/{lookupTableId}/data

Authorization

Basic access authentication

Query Parameters

Example Request

Replace <credentials> in the example below with the Base64 encoding of username and password joined by a single colon :

curl -H 'Authorization: Basic <credentials>' \
     -H 'content-type: application/json' \  'https://<IP>/phoenix/rest/pub/lookupTable/<lookupTableId>/data?size=25&start=0&searchText=example&sortBy=score%20acs>'

Response

Status-Code: 200 OK

{
  "data": [
    {
      "url": "http://example.com",
      "wfCategoryID": 26,
      "score": 0.20050119
    },
    {
       "url": "http://www.sample.com/wp-login.php",
       "wfCategoryID": 26,
       "score": 0.25293878
    },
    {
       "url": "http://www.instance.com/case1",
       "wfCategoryID": 26,
       "score": 0.25635383
    },
    {
       "url": "http://www.instance.com/case2",
       "wfCategoryID": 26,
       "score": 0.25635383
    }
  ],
  "total": 4,
  "start": 0,
  "size": 25
}

HTTP Error Codes

PUT pub/lookupTable/{lookupTableId}/data

Update LookupTable Data - PUT

The LookupTable endpoint allows updating the item of lookupTable.

Resource

PUT /pub/lookupTable/{lookupTableId}/data

Authorization

Basic access authentication

Path Parameters

Query Parameters

key={"url":"http://example.com"}

Example Request

Replace <credentials> in the example below with the Base64 encoding of username and password joined by a single colon :

curl -g -H 'Content-Type: application/json' \
     -H 'Authorization: Basic <credentials>' \
     -X PUT \
'https://<IP>/phoenix/rest/pub/lookupTable/<lookupTableId>/data?key={%22url%22:%20%22http://example.com%22}' \
     --data-raw \
     '{
        "url": "www.test.com",
        "wfCategoryID": 30,
        "score": 0.50119
      }'

PUT Body

{
  "url": "http://test.com"
  "wfCategoryID": 30,
  "score": 0.50119
}

Response

Status-Code: 200 OK

HTTP Error Codes

PUT pub/lookupTable/{lookupTableId}/data/delete

Delete LookupTable Data- PUT

The LookupTable endpoint allows deleting the lookupTable item.

Resource

PUT /pub/lookupTable/{lookupTableId}/data/delete

Authorization

Basic access authentication

Path Parameters

Post Parameters

{"url":"http://example.com"}

Example Request

curl -g -H 'Content-Type: application/json' \
     -H 'Authorization: Basic <credentials>' \
     -X PUT \
'https://<IP>/phoenix/rest/pub/lookupTable/<lookupTableId>/data/delete' \
     --data-raw \
'[
    {
            "url": "http://www.sample.com/wp-login.php"
        },
    {
            "url": "http://www.instance.com/case1"
        },
    {
            "url": "http://www.sample.com/case2"
        }
     ]'

Response

Status-Code: 204 No Content

HTTP Error Codes