Description: Gets all project integrations.
Security: Requires a valid user
Usage: GET api/v1/projectIntegrations
Produces: application/json
Query Parameters:
Parameter | Type | Description | Required/Optional |
---|---|---|---|
| String | A filter on the list based on the `id` property of the projectIntegration. Expects a comma separated string of projectIntegrationIds. | Optional |
| Integer | A limit on the number of projectIntegrations returned. | Optional |
| Integer | A cursor for use in pagination. `skip` defines the number of projectIntegrations skipped. | Optional |
| String | A filter on the list based on the `projectId` property of the projectIntegration. Expects a comma separated string of projectIds. | Optional |
| String | A filter on the list based on the `name` property of the projectIntegration. Expects a comma separated string of names. | Optional |
| String | A filter on the list based on the `masterIntegrationType` property of the projectIntegrations. Expects a comma separated string of masterIntegrationTypes. | Optional |
| String | A filter on the list based on the `masterIntegrationId` property of the projectIntegration. Expects a comma separated string of masterIntegrationIds. | Optional |
| String | A filter on the list based on the `name` property of the masterIntegration to which the projectIntegration belongs to. Expects a comma separated string of masterIntegrationNames. | Optional |
| String | A filter on the list based on the `environments` to which the projectIntegration belongs. Expects a comma separated list of environments and will return projectIntegrations with at least one. | Optional |
| Boolean | A filter on the list based on the `isInternal` property of the projectIntegration. | Optional |
| String | The projectIntegration properties to sort the results by. Expects a comma separated list of sorters. | Optional |
| Integer | A sort order based on the `sortBy` defined. If `1`, sorts the list in ascending order. If `-1`, sorts the list in descending order. | Optional |
Sample Response:
[ { "propertyBag": {}, "permissions": { "allowAllPipelineSources": true }, "id": 2, "name": "i_artifactory", "projectId": 1, "masterIntegrationId": 98, "masterIntegrationType": "generic", "masterIntegrationName": "artifactory", "providerId": null, "isInternal": false, "createdByUserName": "admin", "updatedByUserName": "admin", "createdBy": 3, "updatedBy": 3, "createdAt": "2019-11-11T10:24:46.112Z", "updatedAt": "2019-11-11T10:24:46.112Z", "formJSONValues": [ { "label": "apikey", "value": "AKCp5dK4oM4kP9VJL98E5Hsqbc" }, { "label": "url", "value": "http://192.168.50.4:8081" }, { "label": "user", "value": "admin" } ] } ]
Response Codes:
200: Success
400: Invalid parameters
404: If no project integration is found for the supplied id