Open topic with navigation

Scripts

Description

Uploads a VuGen script to ALM.

URL

/LoadTest/rest/domains/{domainName}/projects/{projectName}/Scripts

Remarks

None

HTTP Method

POST: Uploads a VuGen script to ALM.

Request

Headers:

Content-Type: multipart/form-data

Cookies:

LWSSO_COOKIE_KEY={LwssoCookie};QCSession={QCSessionCookie};

Request Body:

Multipart data with two entities:

The elements of the XML are:

Element Description
Script The top-level element.
TestFolderPath The path of the folder within the ALM Test Plan the script will be uploaded to.
Overwrite Action if script with the same pathname already exists. One of:
  • true: Overwrite existing script. (default)
  • false: Automatically rename new script.
RuntimeOnly One of:
  • true: Upload only runtime files. (default)
  • false: Upload all files.
KeepCheckedOut Applies if project supports versioning. Otherwise, leave empty. One of:
  • true: Uploaded script will remain checked-out.
  • false: Uploaded script is checked in. (default).
ClosedRequest Example 
POST http://<PcServer>/LoadTest/rest/domains/alex-qc/projects/PCdemo/Scripts
Content-Type: application/xml
Cookie: LWSSO_COOKIE_KEY={LwssoCookie};QCSession={QCSessionCookie};

<Script xmlns="http://www.hp.com/PC/REST/API">
 <TestFolderPath>myTestFolder01\myWebScripts</TestFolderPath>
 <Overwrite>true</Overwrite>
 <RuntimeOnly>true</RuntimeOnly>
 <KeepCheckedOut/>
</Script>

Response

Headers:

Content-Type: application/xml or Content-Type: application/json

Location: { the link to the new Script entity}. Can be used for getting the upload response again or to download the script as a zip file.

Cookies:

None

HTML Return Code:

See the HTTP Return Codes

HTML Body:

The data on the new entity. See Script Status XML

See Also

Scripts/{ID}

Script Status XML

Send Documentation Feedback