check-in

Description

Checks in a new version of the entity.

URL

/qcbin/rest/domains/{domain}/projects/{project}/{entity collection}/{Entity ID}/versions/check-in

Remarks

To add a comment, Post an XML string compliant with the check-in-parameters Schema.

Both the comment and OverrideLastVersion are optional.

A comment can be entered either on check in or check out. If a comment is entered on check-in, it overrides any comment entered on check-out.

If neither OverrideLastVersion nor a comment is specified, the input XML is not required. If no XML is sent, do not specify a content-type header.

For the work flow, see Update an Entity.

For details of which resources support versioning, see Version Control and Locking Resources

HTTP Methods

GET: N/A

PUT: N/A

DELETE: N/A

POST: Checks in an edited entity.

Media Type	GET	PUT	DELETE	POST
application/xml	-	-	-
application/json	-	-	-

Returns

One of the HTTP Return Codes.

No response body returned.

Examples

XML example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--
POST: POST /qcbin/rest/domains/DEFAULT/projects/versionPro/tests/1/versions/check-in 
Accept: application/xml
Content-Type: application/xml
<CheckInParameters>
    <Comment>check in from rest</Comment>
    <OverrideLastVersion>false</OverrideLastVersion>
</CheckInParameters>
 -->

JSON example

POST /qcbin/rest/domains/DOMAIN_NAME/projects/PROJECT_NAME/tests/1/versions/check-in
Content-Type: application/json
{
"CheckInParameters": {
"Comment": "check in from rest",
"OverrideLastVersion": "false"
}
}