Read the Repository Information for an Xcode Cloud Workflow
Get information about the Git repository of a specific Xcode Cloud workflow.
URL
GET https://api.appstoreconnect.apple.com/v1/ciWorkflows/{id}/repositoryPath Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The opaque resource ID that uniquely identifies the Workflows resource. |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[scmRepositories] Optional | [string] | Additional fields to include for the Repositories resource returned by the response. |
fields[scmGitReferences] Optional | [string] | |
fields[scmProviders] Optional | [string] | |
include Optional | [string] |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | ScmRepositoryResponse | The request completed successfully. |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | An error occurred with your request. |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | Request not authorized. |
| 404 | Not Found Content-Type: application/json | ErrorResponse | Resource not found. |
| 429 | Content-Type: application/json | ErrorResponse |
Discussion
The example request below retrieves information about an Xcode Cloud workflow’s repository. Use the data provided in the response to read additional information; for example, pull request information.