Update a schedule baseline

Edit an existing schedule baseline in your ConstructionOnline company account

 https://api.constructiononline.com/api/baselines?id={id}&action=UPDATE

This endpoint allows users to edit an existing schedule baseline for a project schedule in ConstructionOnline. To update a baseline, users must enter the ID of the baseline in the URL of the request. Please note that only the name of the baseline can be edited. Users cannot edit the contents of the baseline, such as individual schedule tasks/groups, nor can they edit the creation/capture date of the baseline. The name property should be entered in the payload/body of the request. 

• Requests
• Responses

Requests

REQUIRED PARAMETERS

id: integer

• Unique identifier for the schedule baseline

Sample request URL:

• https://api.constructiononline.com/api/baselines?id=1234567&action=UPDATE

PAYLOAD EXAMPLE

Properties should be entered as JSON key-value pairs, as seen below:

{ "NAME": "Baseline March 3" }

Example requests in cURL, C#, Python, and JavaScript can be found below:

cURL

# replace {email} with the email address for your ConstructionOnline account
# {password} with your ConstructionOnline password
# {apikey} with your provided API key
# {id} with the baseline's ID


curl -X PUT https://api.constructiononline.com/api/baselines?id={id}&action=UPDATE -u {email}:{password} -H 'APIKey:{apikey}'

C#

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with your provided API key 
           {id} with the baseline's ID  */

public string MakeRequest(string endpoint, string payload) {
                string username = {username};
                string password = {password};
                string apiKey = {apikey};
                string response = "";
                var handler = new HttpClientHandler() { AutomaticDecompression = System.Net.DecompressionMethods.GZip };
                using (HttpClient client = new HttpClient(handler)) {
                    client.BaseAddress = new Uri("http://api.constructiononline.com");
                    client.DefaultRequestHeaders.Accept.Clear();
                    client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
                    client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", System.Convert.ToBase64String(System.Text.Encoding.GetEncoding("ISO-8859-1").GetBytes(username + ":" + password)));
                    client.DefaultRequestHeaders.Add("APIKey", apiKey);
                    client.DefaultRequestHeaders.Add("Accept-Encoding", "gzip");
                    HttpContent content = new StringContent(payload, System.Text.Encoding.UTF32, "application/json");
                    response = client.PutAsync(endpoint, content).Result.ToString();
                }
                return response;
            }
     MakeRequest("api/baselines?id={id}&action=UPDATE");

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{id} with the baseline's ID

import base64, requests, json

   #Global Variables
    apikey = {apikey}
    username = {username}
    password = {password}

    #Functions
     def makeRequest(endpoint, payload):
           url = "https://api.constructiononline.com/" + endpoint
            userPass = username + ":" + password    
            headers = {
                    "APIKey": apikey,
                    "Accept-Encoding": "gzip, deflate, br",
                    "Authorization": "Basic " + base64.b64encode(userPass.encode()).decode(),
                }
                response = requests.request("PUT", url, headers=headers, data=payload)
                return json.dumps(json.loads(response.text), indent=2)   
    #Main Program 
    print(makeRequest("api/baselines?id={id}&action=UPDATE"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with your provided API key 
           {id} with the baseline's ID */

 username = '{username}';
 password = '{password}';
 apikey = '{apikey}';
   
function makeRequest(endpoint, payload) {
           auth = btoa('${username}:${password}');
           var myHeaders = new Headers();
           myHeaders.append("APIKey", apikey);
           myHeaders.append("Accept-Encoding", "gzip, deflate, br");
           myHeaders.append("Authorization", "Basic ${auth}");
              var requestOptions = {
                    method: 'PUT',
                    body: '',
                    headers: myHeaders,
                    redirect: 'follow'
                };
                fetch("https://api.constructiononline.com/" + endpoint, requestOptions)
                    .then(response => response.text())
                    .then(result => console.log(result))
                    .catch(error => console.log('error', error));
                return response;
            }; 

makeRequest("api/baselines?id={id}&action=UPDATE");

Responses

 200: Success

A successful request will return a 200 response with a record of the edited baseline in the body.

A sample response and property definitions can be found here. 

 404: Error

The server was not able to locate the resource specified in the request. The ID may have been entered incorrectly or a schedule baseline with the entered ID does not exist.

 429: Error

The user has surpassed the request rate limit for the hour, day, week, or month.

  500: Error

There was an internal server error and the server was unable to complete the request.

 

Last updated: Mar 29, 2024