check-out

Description

Checks out an entity.

URL

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

Remarks

POST the comment and version number with an XML compliant with the check-out-parameters Schema.

The version is optional. If not specified, the latest version is checked out.

The comment is 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 a comment nor a version 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: Retrieves a document that represents the checked-out entity.

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

Returns

One of the HTTP Return Codes.

An XML/JSON string containing the data on the checked out version of the entity.

Examples

POST Entity Check-out Example