Internal site. Jolli authentication required to view.
Skip to Content
API ReferenceInput ConnectorsGET /v0/pipelines/{pipeline_name}/tables/{table_name}/connectors/{connector_name}/completion_token

Get Completion Token

GET/v0/pipelines/{pipeline_name}/tables/{table_name}/connectors/{connector_name}/completion_tokenInput Connectors

Try it

GET/v0/pipelines/{pipeline_name}/tables/{table_name}/connectors/{connector_name}/completion_token
Authentication
Parameters

Generate a completion token for an input connector.

Returns a token that can be passed to the /completion_status endpoint to check whether the pipeline has finished processing all inputs received from the connector before the token was generated.

Authentication

  • JSON web token (JWT) or API keyBearer token

Parameters

Path parameters

NameTypeRequiredDescription
pipeline_namestringYesUnique pipeline name
table_namestringYesSQL table name. Unquoted SQL names have to be capitalized. Quoted SQL names have to exactly match the case from the SQL program.
connector_namestringYesUnique input connector name

Response

200Completion token that can be passed to the '/completion_status' endpoint.application/json
  • object
    Response to a completion token creation request.
    • tokenstringrequired
      Completion token. An opaque string associated with the current position in the input stream generated by an input connector. Pass this string to the `/completion_status` endpoint to check whether all inputs associated with the token have been fully processed by the pipeline.
404Specified pipeline, table, or connector does not existapplication/json
  • object
    Information returned by REST API endpoints on error.
    • detailsobjectrequired
      Detailed error metadata. The contents of this field is determined by `error_code`.
    • error_codestringrequired
      Error code is a string that specifies this error type.
    • messagestringrequired
      Human-readable error message.
500application/json
  • object
    Information returned by REST API endpoints on error.
    • detailsobjectrequired
      Detailed error metadata. The contents of this field is determined by `error_code`.
    • error_codestringrequired
      Error code is a string that specifies this error type.
    • messagestringrequired
      Human-readable error message.
503application/json
  • object
    Information returned by REST API endpoints on error.
    • detailsobjectrequired
      Detailed error metadata. The contents of this field is determined by `error_code`.
    • error_codestringrequired
      Error code is a string that specifies this error type.
    • messagestringrequired
      Human-readable error message.
Request
curl -X GET 'https://api.example.com/v0/pipelines/{pipeline_name}/tables/{table_name}/connectors/{connector_name}/completion_token' \ -H 'Authorization: Bearer YOUR_TOKEN'
Response
{ "message": "Unknown pipeline name 'non-existent-pipeline'", "error_code": "UnknownPipelineName", "details": { "pipeline_name": "non-existent-pipeline" } }