Obtaining a GitCode Repository

Function

This API is used to obtain a GitCode repository.

Calling Method

For details, see Calling APIs.

URI

GET /v1/code/git-code/{endpoint_id}/repositories

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
endpoint_id	Yes	String	Definition Endpoint ID. Constraints N/A. Range Use a mix of digits and lowercase letters.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page	No	Integer	Definition The index of the page to start the query from. Constraints N/A. Range The value of page is at least 1.
page_size	No	Integer	Definition Number of items displayed on each page. Constraints The value is a positive integer. Range The value of page_size is no more than 100.
search	No	String	Definition Filter criteria. Constraints N/A. Range N/A. Default Value N/A.
limit	No	Integer	Details: Number of items displayed on each page. The value of limit is no more than 100. Constraints: N/A Value Range: Only numbers that are 100 or less can be used.
offset	No	Integer	Definition The index of the page to start the query from. Constraints N/A. Range Use only numbers that are 0 or greater.
ids	No	String	Definition Code repository ID. Constraints N/A. Range N/A.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	Array of GitCodeRepository objects	Result.
error	String	Returned error message.
status	String	Returned status information.

**Table 4** GitCodeRepository
Parameter	Type	Description
id	String	Definition Code repository ID. Constraints N/A. Range N/A.
uuid	String	Definition UUID. Constraints N/A. Range N/A.
name	String	Definition Code repository name. Constraints N/A. Range N/A.
http_url	String	Definition Http URL (httpUrl). Constraints N/A. Range The value consists of uppercase letters, lowercase letters, and other characters.
git_url	String	Definition Git URL (gitUrl). Constraints N/A. Range The value consists of uppercase letters, lowercase letters, and other characters.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

GET https://{endpoint}/v1/code/git-code/{endpoint_id}/repositories

Example Responses

Status code: 200

{
  "result" : [ {
    "id" : 4267732,
    "uuid" : null,
    "name" : "CodeArtsBuild",
    "http_url" : "https://gitcode.com/chopinwang/CodeArtsBuild",
    "git_url" : "https://gitcode.com/chopinwang/CodeArtsBuild.git"
  } ],
  "error" : null,
  "status" : "success"
}