This method commits the pipeline.
HTTP Request
- Supported Method: POST
/api/v1/pipeline/commit/ - Parameter name: SQDataCommitRequest
- Input Field
Parameter Type Description entrypoint string incremental boolean internalPipelineName string The name of the pipeline. For example, test-pipeline. parameters sqdata.SQDParameter - name - string
- value - string
payload string payloadFormat string pipelineName string projectId string Value of the project. The minimum length is 1. For example, 123. runtimeServerHost string The name of the runtime server. For example, Localhost. runtimeServerPort integer This port number should match whatever listener port you selected when installing the Apply engine. For example, 2626. validate boolean
- Input Field
- Parameter content type - Both request body data and response data are formatted as JSON. Content type for responses will always be
application/json.
Code example
You can use cURL to execute the call. For example,
curl 'http://localhost:8026/api/v1/pipeline/commit/'
-H "Content-Type: application/json"
-X POST
-d '
{
"entrypoint": "test-pipeline.sqd",
"incremental": true,
"internalPipelineName": "test-pipeline",
"parameters": [
{
"name": "param1",
"value": "value1"
}
],
"payload": "UEsDBBQAAAAIAJFtT1b9sYcZgwAAAK0AAA",
"payloadFormat": "base64/zip",
"pipelineName": "test-pipeline",
"projectId": "123",
"runtimeServerHost": "localhost",
"runtimeServerPort": 2626,
"validate": true
}Postman works the same way. Use Postman to query the end point with the Json payload list below. For example,
{
"internalPipelineName": "test-pipeline",
"logLevel": "3",
"logOptions": [
"Debug",
"Warn"
],
"pipelineName": "test-pipeline",
"projectId": "123",
"runtimeServerHost": "localhost",
"runtimeServerPort": 2626
}
"url": http://localhost:8026/api/v1/pipeline/commit/Response Fields
| Response Element | Type | Description |
| createdAt | string | |
| id | string | |
| message | string | |
| result | string | |
| success | boolean | |
| version | string |