Skip to content

Latest commit

 

History

History
88 lines (57 loc) · 1.93 KB

foundry-api-indexing.md

File metadata and controls

88 lines (57 loc) · 1.93 KB

Foundry API: Indexing (old)

POST dashboard/index

create ES index for a processed resource

Request

  • Form Param: apiKey, string
  • Form Param: batchSize, integer (optional default:100)
  • Form Param: filter, string (optional)
  • Form Param: idJsonPath, string (optional)
  • Form Param: idList, string (optional)
  • Form Param: mappingFile, string (optional)
  • Form Param: mode, string (optional [full|update] default:full)
  • Form Param: pkList, string (optional primary key list file)
  • Form Param: pwd, string (optional if ES server does not need authentication)
  • Form Param: sourceID, string
  • Form Param: status2Match, string
  • Form Param: urlStr, string
  • Form Param: user, string (optional if ES server does not need authentication)

Response

Content-Type: application/json

200 OK

Response Body: (A JSON object)

{
  "url": "http://localhost:9200/scr_013869_rin_test/data",
  "status": "RUNNING",
  "numIndexed": 0,
  "errMessage": "<error message if an error has occurred>"
}

If there is an error, numIndexed field will not be present in the JSON response body, instead an errMessage field will be present.

400 Bad Request

Response Body: (error message)

403 Forbidden

500 Internal Server Error

Response Body: (error message)

GET dashboard/index_status

Request

  • Query Param: apiKey, string
  • Query Param: urlStr, string

Response

Content-Type: application/json

200 OK

Response Body: (A JSON object)

{
  "url": "http://localhost:9200/scr_013869_rin_test/data",
  "status": "FINISHED",
  "numIndexed": 287
}

400 Bad Request

Response Body: (error message)

403 Forbidden

404 Not Found

Response Body: (error message)

500 Internal Server Error

Response Body: (error message)