|
| 1 | +# GiteeEnterprise\CheckRunsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.gitee.com/enterprises* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**getEnterpriseIdProjectsProjectIdCheckRunsList**](CheckRunsApi.md#getEnterpriseIdProjectsProjectIdCheckRunsList) | **GET** /{enterprise_id}/projects/{project_id}/check_runs/list | 门禁列表 |
| 8 | +[**postEnterpriseIdProjectsProjectIdCheckRunsAnnotations**](CheckRunsApi.md#postEnterpriseIdProjectsProjectIdCheckRunsAnnotations) | **POST** /{enterprise_id}/projects/{project_id}/check_runs/annotations | 门禁详情翻页 |
| 9 | +[**postEnterpriseIdProjectsProjectIdCheckRunsFixCheckRun**](CheckRunsApi.md#postEnterpriseIdProjectsProjectIdCheckRunsFixCheckRun) | **POST** /{enterprise_id}/projects/{project_id}/check_runs/fix_check_run | 重新执行门禁或fix失败门禁 |
| 10 | +[**postEnterpriseIdProjectsProjectIdCheckRunsSearch**](CheckRunsApi.md#postEnterpriseIdProjectsProjectIdCheckRunsSearch) | **POST** /{enterprise_id}/projects/{project_id}/check_runs/search | 设置门禁检查项查询接口 |
| 11 | + |
| 12 | + |
| 13 | +# **getEnterpriseIdProjectsProjectIdCheckRunsList** |
| 14 | +> \GiteeEnterprise\Model\CheckRun getEnterpriseIdProjectsProjectIdCheckRunsList($enterpriseId, $projectId, $pullRequestId, $checkRunId, $headSha) |
| 15 | +
|
| 16 | +门禁列表 |
| 17 | + |
| 18 | +门禁列表 |
| 19 | + |
| 20 | +### Example |
| 21 | +```php |
| 22 | +<?php |
| 23 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 24 | + |
| 25 | +$apiInstance = new GiteeEnterprise\Api\CheckRunsApi( |
| 26 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 27 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 28 | + new GuzzleHttp\Client() |
| 29 | +); |
| 30 | +$enterpriseId = 56; // int | |
| 31 | +$projectId = 56; // int | |
| 32 | +$pullRequestId = 56; // int | pr id |
| 33 | +$checkRunId = 56; // int | 门禁ID |
| 34 | +$headSha = "headSha_example"; // string | 提交sha |
| 35 | + |
| 36 | +try { |
| 37 | + $result = $apiInstance->getEnterpriseIdProjectsProjectIdCheckRunsList($enterpriseId, $projectId, $pullRequestId, $checkRunId, $headSha); |
| 38 | + print_r($result); |
| 39 | +} catch (Exception $e) { |
| 40 | + echo 'Exception when calling CheckRunsApi->getEnterpriseIdProjectsProjectIdCheckRunsList: ', $e->getMessage(), PHP_EOL; |
| 41 | +} |
| 42 | +?> |
| 43 | +``` |
| 44 | + |
| 45 | +### Parameters |
| 46 | + |
| 47 | +Name | Type | Description | Notes |
| 48 | +------------- | ------------- | ------------- | ------------- |
| 49 | + **enterpriseId** | **int**| | |
| 50 | + **projectId** | **int**| | |
| 51 | + **pullRequestId** | **int**| pr id | [optional] |
| 52 | + **checkRunId** | **int**| 门禁ID | [optional] |
| 53 | + **headSha** | **string**| 提交sha | [optional] |
| 54 | + |
| 55 | +### Return type |
| 56 | + |
| 57 | +[**\GiteeEnterprise\Model\CheckRun**](../Model/CheckRun.md) |
| 58 | + |
| 59 | +### Authorization |
| 60 | + |
| 61 | +No authorization required |
| 62 | + |
| 63 | +### HTTP request headers |
| 64 | + |
| 65 | + - **Content-Type**: Not defined |
| 66 | + - **Accept**: application/json |
| 67 | + |
| 68 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 69 | + |
| 70 | +# **postEnterpriseIdProjectsProjectIdCheckRunsAnnotations** |
| 71 | +> \GiteeEnterprise\Model\Annotations postEnterpriseIdProjectsProjectIdCheckRunsAnnotations($enterpriseId, $projectId, $checkRunId, $headSha, $page) |
| 72 | +
|
| 73 | +门禁详情翻页 |
| 74 | + |
| 75 | +门禁详情翻页 |
| 76 | + |
| 77 | +### Example |
| 78 | +```php |
| 79 | +<?php |
| 80 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 81 | + |
| 82 | +$apiInstance = new GiteeEnterprise\Api\CheckRunsApi( |
| 83 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 84 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 85 | + new GuzzleHttp\Client() |
| 86 | +); |
| 87 | +$enterpriseId = 56; // int | |
| 88 | +$projectId = 56; // int | |
| 89 | +$checkRunId = 56; // int | 门禁ID |
| 90 | +$headSha = "headSha_example"; // string | 提交sha |
| 91 | +$page = 56; // int | 页数 |
| 92 | + |
| 93 | +try { |
| 94 | + $result = $apiInstance->postEnterpriseIdProjectsProjectIdCheckRunsAnnotations($enterpriseId, $projectId, $checkRunId, $headSha, $page); |
| 95 | + print_r($result); |
| 96 | +} catch (Exception $e) { |
| 97 | + echo 'Exception when calling CheckRunsApi->postEnterpriseIdProjectsProjectIdCheckRunsAnnotations: ', $e->getMessage(), PHP_EOL; |
| 98 | +} |
| 99 | +?> |
| 100 | +``` |
| 101 | + |
| 102 | +### Parameters |
| 103 | + |
| 104 | +Name | Type | Description | Notes |
| 105 | +------------- | ------------- | ------------- | ------------- |
| 106 | + **enterpriseId** | **int**| | |
| 107 | + **projectId** | **int**| | |
| 108 | + **checkRunId** | **int**| 门禁ID | [optional] |
| 109 | + **headSha** | **string**| 提交sha | [optional] |
| 110 | + **page** | **int**| 页数 | [optional] |
| 111 | + |
| 112 | +### Return type |
| 113 | + |
| 114 | +[**\GiteeEnterprise\Model\Annotations**](../Model/Annotations.md) |
| 115 | + |
| 116 | +### Authorization |
| 117 | + |
| 118 | +No authorization required |
| 119 | + |
| 120 | +### HTTP request headers |
| 121 | + |
| 122 | + - **Content-Type**: application/json |
| 123 | + - **Accept**: application/json |
| 124 | + |
| 125 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 126 | + |
| 127 | +# **postEnterpriseIdProjectsProjectIdCheckRunsFixCheckRun** |
| 128 | +> postEnterpriseIdProjectsProjectIdCheckRunsFixCheckRun($checkRunId, $enterpriseId, $projectId, $identifier) |
| 129 | +
|
| 130 | +重新执行门禁或fix失败门禁 |
| 131 | + |
| 132 | +重新执行门禁或fix失败门禁 |
| 133 | + |
| 134 | +### Example |
| 135 | +```php |
| 136 | +<?php |
| 137 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 138 | + |
| 139 | +$apiInstance = new GiteeEnterprise\Api\CheckRunsApi( |
| 140 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 141 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 142 | + new GuzzleHttp\Client() |
| 143 | +); |
| 144 | +$checkRunId = 56; // int | 门禁ID |
| 145 | +$enterpriseId = 56; // int | |
| 146 | +$projectId = 56; // int | |
| 147 | +$identifier = "identifier_example"; // string | 标识 |
| 148 | + |
| 149 | +try { |
| 150 | + $apiInstance->postEnterpriseIdProjectsProjectIdCheckRunsFixCheckRun($checkRunId, $enterpriseId, $projectId, $identifier); |
| 151 | +} catch (Exception $e) { |
| 152 | + echo 'Exception when calling CheckRunsApi->postEnterpriseIdProjectsProjectIdCheckRunsFixCheckRun: ', $e->getMessage(), PHP_EOL; |
| 153 | +} |
| 154 | +?> |
| 155 | +``` |
| 156 | + |
| 157 | +### Parameters |
| 158 | + |
| 159 | +Name | Type | Description | Notes |
| 160 | +------------- | ------------- | ------------- | ------------- |
| 161 | + **checkRunId** | **int**| 门禁ID | |
| 162 | + **enterpriseId** | **int**| | |
| 163 | + **projectId** | **int**| | |
| 164 | + **identifier** | **string**| 标识 | [optional] |
| 165 | + |
| 166 | +### Return type |
| 167 | + |
| 168 | +void (empty response body) |
| 169 | + |
| 170 | +### Authorization |
| 171 | + |
| 172 | +No authorization required |
| 173 | + |
| 174 | +### HTTP request headers |
| 175 | + |
| 176 | + - **Content-Type**: application/json |
| 177 | + - **Accept**: application/json |
| 178 | + |
| 179 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 180 | + |
| 181 | +# **postEnterpriseIdProjectsProjectIdCheckRunsSearch** |
| 182 | +> postEnterpriseIdProjectsProjectIdCheckRunsSearch($enterpriseId, $projectId, $q) |
| 183 | +
|
| 184 | +设置门禁检查项查询接口 |
| 185 | + |
| 186 | +设置门禁检查项查询接口 |
| 187 | + |
| 188 | +### Example |
| 189 | +```php |
| 190 | +<?php |
| 191 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 192 | + |
| 193 | +$apiInstance = new GiteeEnterprise\Api\CheckRunsApi( |
| 194 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 195 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 196 | + new GuzzleHttp\Client() |
| 197 | +); |
| 198 | +$enterpriseId = 56; // int | |
| 199 | +$projectId = 56; // int | |
| 200 | +$q = "q_example"; // string | 查询门禁名称 |
| 201 | + |
| 202 | +try { |
| 203 | + $apiInstance->postEnterpriseIdProjectsProjectIdCheckRunsSearch($enterpriseId, $projectId, $q); |
| 204 | +} catch (Exception $e) { |
| 205 | + echo 'Exception when calling CheckRunsApi->postEnterpriseIdProjectsProjectIdCheckRunsSearch: ', $e->getMessage(), PHP_EOL; |
| 206 | +} |
| 207 | +?> |
| 208 | +``` |
| 209 | + |
| 210 | +### Parameters |
| 211 | + |
| 212 | +Name | Type | Description | Notes |
| 213 | +------------- | ------------- | ------------- | ------------- |
| 214 | + **enterpriseId** | **int**| | |
| 215 | + **projectId** | **int**| | |
| 216 | + **q** | **string**| 查询门禁名称 | [optional] |
| 217 | + |
| 218 | +### Return type |
| 219 | + |
| 220 | +void (empty response body) |
| 221 | + |
| 222 | +### Authorization |
| 223 | + |
| 224 | +No authorization required |
| 225 | + |
| 226 | +### HTTP request headers |
| 227 | + |
| 228 | + - **Content-Type**: application/json |
| 229 | + - **Accept**: application/json |
| 230 | + |
| 231 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 232 | + |
0 commit comments