Returns a compact representation of a specific schedule baseline
https://api.constructiononline.com/api/baselines/ID={ID}
This endpoint allows users to obtain a single baseline for a specific schedule in their ConstructionOnline company account. The baseline's ID is stored in the baseline property ID. If a baseline in the user's company account matches the provided ID, information about the baseline will be returned—specifically, the baseline's ID, name, creation date, and all schedule tasks/groups captured within the baseline.
Please note that this endpoint returns a compact representation of the tasks/groups within the schedule baseline; all details for returned schedule task/groups will not be included in the response. Only the following properties will return with each schedule task/group: NAME, ACTIVITY_ID, START_TIME, END_TIME, TYPE, TYPE_NAME. To return a detailed breakdown of each task and group within the baseline, please use this endpoint.
Requests
REQUIRED PARAMETERS
ID: integer
- Unique identifier for the schedule baseline
Sample URL request:
- https://api.constructiononline.com/api/baselines/ID=123456
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 https://api.constructiononline.com/api/baselines/ID={ID} -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 GetData(string endpoint) {
string username = "{username}";
string password = "{password}";
string apikey = "{apikey}";
HttpResponseMessage response = null;
HttpClientHandler handler = new HttpClientHandler() { AutomaticDecompression = System.Net.DecompressionMethods.GZip };
using (HttpClient client = new HttpClient(handler)) {
client.Timeout = new TimeSpan(0, 0, 30);
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");
response = client.GetAsync(endpoint).Result;
}
return response?.Content.ReadAsStringAsync().Result;
}
MessageBox.Show(GetData("api/baselines/ID={ID}"));
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
apikey = "{apikey}"
username = "{username}"
password = "{password}"
def makeRequest(endpoint):
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.get(url, headers=headers)
return json.dumps(json.loads(response.text), indent=2)
#Main Program
print(makeRequest("api/baselines/ID={ID}"))
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) {
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: 'GET',
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}");
Responses
200: Success
A successful request will return a 200 response with the requested baseline in the body, as seen below. Definitions for all returned properties can be found here.
{
"ID": "458111",
"DATE_CREATED": "2024-03-26T16:58:22.223",
"NAME": "Baseline 1",
"TASKS": [
{
"ID": 70247123,
"ACTIVITY_ID": 30455888,
"START_TIME": "2024-01-30T00:00:00",
"END_TIME": "2024-01-31T00:00:00",
"TYPE": 3,
"TYPE_NAME": "SUBTASK 1"
},
{
"ID": 70247223,
"ACTIVITY_ID": 30455889,
"START_TIME": "2024-02-01T00:00:00",
"END_TIME": "2024-02-12T00:00:00",
"TYPE": 3,
"TYPE_NAME": "SUBTASK 2"
}
]
}
404: Error
The server was not able to locate the resource specified in the request. The baseline 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 26, 2024