Update launch

Updates data of a test session launch

Parameters

Function UpdateLaunch(Val URL, Val Token, Val Project, Val LaunchID, Val LaunchStructure) Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	ReportPortal server URL
Token	--token	String	✔	Access token
Project	--proj	String	✔	Project ID
LaunchID	--id	Number	✔	Launch ID
LaunchStructure	--params	Structure Of KeyAndValue	✔	Launch parameters. See GetLaunchStructure

Returns

Map Of KeyAndValue - serialized JSON response from ReportPortal

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Numeric launch ID can be obtained by UUID using the GetLaunch function

1C:Enterprise/OneScript code example

    URL      = "tests.openintegrations.dev";
    Token    = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX25hbWUiOiJzdXBlcmFkbWluIiwic2NvcGVzIjpbInVpIl0sImV4cCI6MTc2MjAwMDI3NiwiaWF0IjoxNzYxOTEzODc2LCJqdGkiOiI0NTI3YTc5OS0wN2...";
    LaunchID = "";
    Project  = "Test";

    LaunchStructure = New Structure;
    LaunchStructure.Insert("description", "New description");

    Result = OPI_ReportPortal.UpdateLaunch(URL, Token, Project, LaunchID, LaunchStructure);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint rportal UpdateLaunch \
      --url "tests.openintegrations.dev" \
      --token "***" \
      --proj "Test" \
      --id 237 \
      --params "{'description':'New description'}"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint rportal UpdateLaunch ^
      --url "tests.openintegrations.dev" ^
      --token "***" ^
      --proj "Test" ^
      --id 237 ^
      --params "{'description':'New description'}"

Result

{
 "message": "Launch with ID = '237' successfully updated."
}