Description: Gets a single pipeline source for the supplied numeric id. In the query, if sync is set as true and if branch is set to a multibranch, the latest commit will also be synchronized.
Security: Requires a valid user
Usage: GET api/v1/pipelineSources/:id
Produces: application/json
URL parameters:
Parameter | Data Type | Description |
|---|---|---|
| Integer | The numeric id of thepipeline sourcebeing requested |
Query Parameters:
Parameter | Data Type | Description |
|---|---|---|
| Boolean | ‘True’ to force the pipelineSource to sync. |
| integer | The branch to sync. Only valid for multibranch sources, and only if sync is true. |
Request Parameters: Ignored
Sample Response:
Returns the pipelineSource entity with the supplied numeric id.
{
"id": 1,
"projectId": 1,
"templateId": 1,
"integrationId": 1,
"repositoryFullName": "ankul-shippable/sample_java",
"branch": "master",
"fileFilter": "pipelines.config",
"isSyncing": false,
"lastSyncStatusCode": 4002,
"lastSyncStartedAt": "2019-04-15T05:39:29.627Z",
"lastSyncEndedAt": "2019-04-15T05:39:43.478Z",
"lastSyncLogs": "Successfully synced pipeline source\n\nSUMMARY:\n\nCreated 1 resources\nCreated 1 pipelines\nCreated 1 steps\n\nDETAILS:\n\npipelines.config: successfully created resource: sample_node\npipelines.config: successfully created pipeline: pipeline_1\npipelines.config: successfully created step: step_A\nSuccessfully created connection between step: step_A and sample_node",
"resourceId": 1,
"createdBy": "Service User",
"updatedBy": "Service User",
"createdAt": "2019-04-15T05:39:21.866Z",
"updatedAt": "2019-04-15T05:39:43.485Z"
}Response Codes:
200: Success
404: If no pipelineSource is found for the supplied id