Creating a Submodule

This API is used to create a submodule.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

POST https://{hostURL}/v4/repositories/{repository_id}/repository/submodules

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Definition You can query the project list to obtain the repository ID by calling the API used to query user's all repositories. Constraints N/A. Value range: 1~2147483647

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
branch_name	Yes	String	Definition Branch name. Range 1 to 200 bytes Constraints Existing branch under the repository.
file_path	Yes	String	File path of the submodule under the repository.
subrepo_id	Yes	String	ID of the repository where the submodule locates
commit_message	Yes	String	Commit message.
subrepo_branch	Yes	String	Definition Submodule branch name. Range 1 to 200 bytes Constraints Existing branch under the target repository.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	String	Definition Successful creation commit ID.
status	String	Definition Creation return status.

Status code: 401

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

POST https://{endpoint}/v4/repositories/2112031271/repository/submodules

Status code: 200

{
  "result" : "e7a2c9c8a3672ee82b8eb5f771f468e1f6d50282",
  "status" : "success"
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status Code	Description
200	OK
401	Unauthorized

Parent topic: Repository

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.