Scripts

Description

Uploads or retrieves a VuGen or JMeter script to/from ALM.

URL

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

Remarks

None

HTTP Method

POST: Uploads a VuGen or JMeter script to ALM.

GET: Returns the script in the body of the response.

Request

Headers:

Content-Type: multipart/form-data

Cookies:

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

Request Body:

POST: Multipart data with two entities:

GET: No request body

The fields in the response 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 to indicate whether the script needs to be checked in/out after an upload. Use one of:

  • true: Uploaded script will remain checked-out.
  • false: Uploaded script is checked in. (default).

Note: If the project does not support version control, this element is meaningless and you can leave the default value ("false") or not use the KeepCheckedOut element at all. Do not send an empty element.

Response

Headers:

Content-Type: application/xml

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes

HTML Body:

GET: Returns the data on the entity in the response. See Script XML

See Also

Scripts/{ID}
Script XML