PM Schedule and Inspection Schedule

Overview

This page represents the essential documentation cornerstone for the Prism PM Schedule and Inspection Schedule API. The Prism API is a RESTful API that give programmatic access to Prism functionality. All calls to the API require credentials for a Prism User though, in cases, this may be a psuedo-user representing an API integration service (e.g. one customer users an email api-integration-services@xxx.com as a registered user to perform backend-to-backend requests).

Swagger Documentation

The reference documentation, generated from the system, exists in two formats:

Swagger
Redoc (please note, this is slower to load but has some additional searching)

These represent the core Prism API or, sometimes, Prism API 1.0.

Preventive Maintenance & Inspection Schedules API

Creating Preventive Maintenance Schedule

Preventive Schedule can be created with custom Procedure or using Procedure from Procedure library.
By Default schedule is created with draft status.

Creating PM Schedule Using Procedure Library

Use the following URL as a template for this request:
- POST https://api.connect.buildingengines.com/pm_programs
The payload is an array of JSON objects including the following fields:
- name: Name of the Schedule
- pmo_id: Management organization responsible for this schedule. This allows specification of an alternative management organization if one exists in the account. The default is the account primary management organization.
- procedure_id : Primary UUID of the Procedure

Example Payload:

{ 
"name":"PM Schedule Name",
"pmo_id":"04ce4a2e-0bca-4cc6-9dc3-1e5af67444ff",
"procedure_id":"fb10b36f-68d6-4410-b647-6f56662d6803"
}

Example Response:

{
"id": "145572ef-c008-41f6-bf51-93cc414bb94c",
"identifier": "PS-000010",
"name": "PM Schedule Name",
"status": "draft",
"task_schedules": [],
"all_buildings": false,
"buildings": [],
"procedure_id": "fb10b36f-68d6-4410-b647-6f56662d6803",
"procedure": {
"id": "fb10b36f-68d6-4410-b647-6f56662d6803",
"name": "Test without serdy",
"category": {
"id": "346537c2-b850-4149-96bb-c06f54c937d1",
"name": "Building Equipment",
"icon_type": "building"
},
"preferred_steps": "text",
"steps_form": null,
"estimated_labor": null,
"is_private": false,
"status": "active",
"identifier": "PR-000004"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-06-27T08:41:08.522931Z",
"updated_at": "2024-06-27T08:41:08.522961Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Tanuja",
"last_name": "Jain",
"phone": "+1XXXXXXXXXXX"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Tanuja",
"last_name": "Jain",
"phone": "+1XXXXXXXXXXX"
},
"allowed_statuses": [
"inactive"
],
"pmo_id": "04ce4a2e-0bca-4cc6-9dc3-1e5af67444ff",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": null,
"due_in": null,
"default_start": null,
"recurring_frequency": null,
"due_by": null,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": null,
"comments": [],
"counts": {
"total_building_count": 0,
"all_buildings_included": false,
"target_object_count": 0,
"all_target_objects": false
},
"allow_one_click_done": false,
"start_date": null,
"next_run": null,
"asset_types": null,
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": true,
"enable_notification": true,
"task_distribution": "equipment"
}

Creating PM Schedule Using Custom Procedure

Custom Procedure can have simple steps or Individual steps.
- Simple Steps
- Individual Steps
  - Individual steps can have Sections.
Use the following URL as a template for this request:
- POST https://api.connect.buildingengines.com/pm_programs

The payload is an array of JSON objects including the following fields:

name: Name of the Schedule
pmo_id: Management organization responsible for this schedule. This allows specification of an alternative management organization if one exists in the account. The default is the account primary management organization.
preferred_steps: This allows the specification of the steps type (Simple Step/ Individual step). This can have 2 values “text” for simple step and “form” for Individual Step.
notes: Optional column
parts: Optional column
estimated_labor: Optional column
serdy_form: Json form containing steps of the Procedure.

Example Payload:

{
"name": "Custom Procedure Simple steps",
"pmo_id": "04ce4a2e-0bca-4cc6-9dc3-1e5af67444ff",
"preferred_steps": "text",
"notes": "Schedule Notes",
"parts": "Schedule Parts",
"estimated_labor": null,
"serdy_form": {
"form": {
"type": "form",
"children": [
{
"type": "section",
"label": "Steps",
"children": [
{
"type": "field",
"fieldType": "done",
"label": "Step1 "
},
{
"type": "field",
"fieldType": "done",
"label": "Step 2"
}
]
}
]
}
}
}

Example Response:

{
"id": "82cf1ad0-2cca-432a-9b65-08966b8a1e00",
"identifier": "PS-000012",
"name": "Custom Procedure Simple steps",
"status": "draft",
"task_schedules": [],
"all_buildings": false,
"buildings": [],
"procedure_id": "76b0fec5-547a-43b7-8675-0a640a37d844",
"procedure": {
"id": "76b0fec5-547a-43b7-8675-0a640a37d844",
"name": "Custom Procedure Simple steps",
"category": null,
"preferred_steps": "text",
"steps_form": {
"id": "2eea52a3-e5ac-4bc8-b33b-aeef8785e409",
"created_at": "2024-06-27T08:47:39.089940Z",
"updated_at": "2024-06-27T08:47:39.089953Z",
"form": {
"type": "form",
"children": [
{
"type": "section",
"label": "Steps",
"children": [
{
"type": "field",
"fieldType": "done",
"label": "Step1 ",
"id": "b9587e2e-b413-40c4-bafc-9d9ac2636f80",
"summary": null
},
{
"type": "field",
"fieldType": "done",
"label": "Step 2",
"id": "44444268-1076-4d65-84bc-54e6ca4472f1",
"summary": null
}
],
"id": "b833ef58-f238-4e9d-bc91-f821c835fece",
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 2
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
}
}
],
"id": "725eb681-631b-4170-be83-4c5465b21913",
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 2
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
},
"hasWeightedScores": false
},
"type": "general",
"href": "https://api.connect.buildingengines.com/serdy_forms/2eea52a3-e5ac-4bc8-b33b-aeef8785e409",
"field_count": 2,
"field_value_count": 0,
"progress": 0,
"attachments_href": "https://api.connect.buildingengines.com/serdy_forms/2eea52a3-e5ac-4bc8-b33b-aeef8785e409/attachments",
"work_orders_href": "https://api.connect.buildingengines.com/serdy_forms/2eea52a3-e5ac-4bc8-b33b-aeef8785e409/work_orders",
"answers_href": "https://api.connect.buildingengines.com/serdy_forms/2eea52a3-e5ac-4bc8-b33b-aeef8785e409/answers",
"summary_href": "https://api.connect.buildingengines.com/serdy_forms/2eea52a3-e5ac-4bc8-b33b-aeef8785e409/summary"
},
"estimated_labor": null,
"is_private": true,
"status": "active",
"identifier": "PR-000011"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-06-27T08:47:39.137344Z",
"updated_at": "2024-06-27T08:47:39.137374Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Tanuja",
"last_name": "Jain",
"phone": "+1XXXXXXXXXXX"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Tanuja",
"last_name": "Jain",
"phone": "+1XXXXXXXXXXX"
},
"allowed_statuses": [
"inactive"
],
"pmo_id": "04ce4a2e-0bca-4cc6-9dc3-1e5af67444ff",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": null,
"due_in": null,
"default_start": null,
"recurring_frequency": null,
"due_by": null,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": null,
"comments": [],
"counts": {
"total_building_count": 0,
"all_buildings_included": false,
"target_object_count": 0,
"all_target_objects": false
},
"allow_one_click_done": false,
"start_date": null,
"next_run": null,
"asset_types": null,
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": true,
"enable_notification": true,
"task_distribution": "equipment"
}

Creating Inspection Schedule

Inspection Schedule can be of 4 types:
- Property Schedule
- Space Schedule
- Equipment Schedule
- Move In & Move Out Schedule
Use the following URL as a template for this request:
- POST https://api.connect.buildingengines.com/inspection_programs
The payload is an array of JSON objects including the following fields:
- name: Name of the Schedule
- pmo_id: Management organization responsible for this schedule. This allows specification of an alternative management organization if one exists in the account. The default is the account primary management organization.
- estimated_labor: Optional Column determining the labor duration in hours.
- include_authors_notes: Boolean Field determining whether authors notes are available.
- min_score_target_percent: Optional Column. Minimum required % of the positive Percentage.
- sub_type: Can have the following values based on Inspection Schedule type:
  - property
  - space
  - equipment
  - move_in_out
- task_distribution:
  - Optional Column for property type of Inspection Schedule.
  - Space schedule can have 2 values based on how Inspection task should be created.
    - space: To create individual task per space.
    - property: To create task per property. Single task for multiple space of a property will be created.
  - Equipment schedule can have 2 values based on how Inspection task should be created.
    - equipment: To create individual task per equipment.
    - property: To create task per property. Single task for multiple space of a property will be created
- serdy_form: A Json object containing the sections & questions for the task.

Example Payload:

{
"name": "Space Inspection Schedule",
"min_score_target_percent": 20,
"pmo_id": "04ce4a2e-0bca-4cc6-9dc3-1e5af67444ff",
"include_authors_notes": true,
"sub_type": "space",
"serdy_form": {
"form": {
"type": "form",
"children": [
{
"type": "section",
"children": [
{
"type": "field",
"fieldType": "goodfairpoor",
"label": "Question 1",
"meta": {
"required": null,
"allowNA": null,
"performanceScoresMap": {}
},
"followUpQuestion": {}
}
],
"label": "Section 1"
}
]
}
},
"task_distribution": "space"
}

Example Response:

{
"id": "cfcb8eb9-5d8e-450a-8c90-6bf8fdb88d5c",
"identifier": "IT-000002",
"name": "Space Inspection Schedule",
"status": "draft",
"task_schedules": [],
"all_buildings": false,
"buildings": [],
"procedure_id": "ad2efaa8-d1d8-4361-b022-cfb2dc4fced3",
"procedure": {
"id": "ad2efaa8-d1d8-4361-b022-cfb2dc4fced3",
"name": "Space Inspection Schedule",
"category": null,
"preferred_steps": "text",
"steps_form": {
"id": "b14627d4-174c-4862-9243-0972ddcc545b",
"created_at": "2024-07-01T15:46:34.558841Z",
"updated_at": "2024-07-01T15:46:34.558872Z",
"form": {
"type": "form",
"children": [
{
"type": "section",
"children": [
{
"type": "field",
"fieldType": "goodfairpoor",
"label": "Question 1",
"meta": {
"required": null,
"allowNA": null,
"performanceScoresMap": {}
},
"followUpQuestion": {},
"id": "74b1c4b7-3043-4bcd-8330-14668a110ef4",
"summary": null
}
],
"label": "Section 1",
"id": "13a51e52-7166-40d2-ba9b-fa99e8e448df",
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
}
}
],
"id": "bd95536c-e115-40f5-b80b-fbb6354f240c",
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
},
"hasWeightedScores": false
},
"type": "general",
"href": "https://api.connect.buildingengines.com/serdy_forms/b14627d4-174c-4862-9243-0972ddcc545b",
"field_count": 1,
"field_value_count": 0,
"progress": 0,
"attachments_href": "https://api.connect.buildingengines.com/serdy_forms/b14627d4-174c-4862-9243-0972ddcc545b/attachments",
"work_orders_href": "https://api.connect.buildingengines.com/serdy_forms/b14627d4-174c-4862-9243-0972ddcc545b/work_orders",
"answers_href": "https://api.connect.buildingengines.com/serdy_forms/b14627d4-174c-4862-9243-0972ddcc545b/answers",
"summary_href": "https://api.connect.buildingengines.com/serdy_forms/b14627d4-174c-4862-9243-0972ddcc545b/summary"
},
"estimated_labor": null,
"is_private": true,
"status": "active",
"identifier": "PR-000013"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-07-01T15:46:34.595961Z",
"updated_at": "2024-07-01T15:46:34.596010Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Tanuja",
"last_name": "Jain",
"phone": "+17792874331"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Tanuja",
"last_name": "Jain",
"phone": "+17792874331"
},
"allowed_statuses": [
"inactive"
],
"pmo_id": "04ce4a2e-0bca-4cc6-9dc3-1e5af67444ff",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": null,
"due_in": null,
"default_start": null,
"recurring_frequency": null,
"due_by": null,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": {
"all_target_objects": false,
"vacant_space_only": true,
"objects": []
},
"comments": [],
"counts": {
"total_building_count": 0,
"all_buildings_included": false,
"target_object_count": 0,
"all_target_objects": false
},
"allow_one_click_done": false,
"start_date": null,
"next_run": null,
"asset_types": null,
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": true,
"enable_notification": false,
"task_distribution": "space",
"sub_type": "space",
"min_score_target_percent": "20.00",
"include_authors_notes": true
}

Updating PM/Inspection Schedule Property

There are 2 ways of adding properties to schedule.
- There are 2 ways of adding properties to schedule.
- All properties/ Specific Property.

Adding All Properties To Schedule

All properties of the schedule pmo. This will automatically add new property whenever created to the schedule.
Use the following URL as a template for this request for Inspection schedule:

PATCH https://api.connect.buildingengines.com/pm_programs/{program_uuid}

Use the following URL as a template for this request for PM schedule:

PATCH https://api.connect.buildingengines.com/inspection_programs/{program_uuid}

The payload is an array of JSON objects including the following fields:
- all_buildings: true. Specifies that all the buildings of the schedule pmo is included.
- assignee_id: User Assignee id that will be associated with the auto generated Task.
- organization_assignee_id: Organization Assignee id that will be associated with the auto generated Task.
- team_assignee_id: Team Assignee id Assignee id that will be associated with the auto generated Task.
- Schedule can have either one of the following for default assignees:
  - team assignee
  - organization assignee
  - user assignee
  - Both organization & user assignee

Example Payload:

{
"all_buildings": true,
"assignee_id": null,
"organization_assignee_id": null,
"team_assignee_id": null
}

Example Response:

{
"id": "145572ef-c008-41f6-bf51-93cc414bb94c",
"identifier": "PS-000010",
"name": "PM Schedule Name",
"status": "draft",
"task_schedules": [],
"all_buildings": true,
"buildings": [
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"name": "Building 3",
"street_address": "Lal Darwaja Station Rd",
"street_address_2": "",
"city": "Surat",
"state": "GJ",
"zip_code": "395003",
"country": "IN",
"google_verification_override": false,
"timezone": "America/New_York",
"latitude": "21.206860",
"longitude": "72.840102",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "INR",
"formatted_address": "Lal Darwaja Station Rd, Suryapur Gate, Varachha, Surat, Gujarat 395003, India",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"next_occurence_skipped": null,
"next_run": null
},
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"name": "Tanuja",
"street_address": "4800 Airport Plaza Dr",
"street_address_2": "",
"city": "Long Beach",
"state": "CA",
"zip_code": "90815",
"country": "US",
"google_verification_override": false,
"timezone": "America/Los_Angeles",
"latitude": "33.810622",
"longitude": "-118.137960",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "USD",
"formatted_address": "4800 Airport Plaza Dr, Long Beach, CA 90815, USA",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"next_occurence_skipped": null,
"next_run": null
} 
],
"procedure_id": "05efbd9f-0f21-43cc-b3ee-8aa2f0ae1624",
"procedure": {
"id": "05efbd9f-0f21-43cc-b3ee-8aa2f0ae1624",
"name": "xsdsa",
"category": {
"id": "a31c1e44-d454-43ea-bdc2-290b8aa202cd",
"name": "Building Equipment",
"icon_type": "building"
},
"preferred_steps": "text",
"steps_form": {
"id": "95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f",
"created_at": "2023-09-18T16:35:44.175458Z",
"updated_at": "2023-09-18T16:35:44.208028Z",
"form": {
"id": "bf351e78-b993-4f7f-b9c0-e086f84a3014",
"type": "form",
"children": [
{
"id": "49a7d1e3-48a5-424e-aa9b-1f6772f333bb",
"type": "section",
"label": "Steps",
"children": [
{
"id": "4b3017d6-9226-406b-a823-4cbca7e0a0ef",
"type": "field",
"label": "wqd",
"fieldType": "done",
"summary": null
}
],
"actualWeightedScore": 0,
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
}
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
},
"hasWeightedScores": false
},
"type": "general",
"href": "https://api.connect.buildingengines.com/serdy_forms/95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f",
"field_count": 1,
"field_value_count": 0,
"progress": 0,
"attachments_href": "https://api.connect.buildingengines.com/serdy_forms/95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f/attachments",
"work_orders_href": "https://api.connect.buildingengines.com/serdy_forms/95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f/work_orders",
"answers_href": "https://api.connect.buildingengines.com/serdy_forms/95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f/answers",
"summary_href": "https://api.connect.buildingengines.com/serdy_forms/95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f/summary"
},
"estimated_labor": null,
"is_private": false,
"status": "active",
"identifier": "PR-000169"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-06-28T08:01:49.777735Z",
"updated_at": "2024-06-28T08:02:04.650959Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"allowed_statuses": [
"inactive"
],
"pmo_id": "8a33e1fc-f4f6-475e-a97d-5e70115eb380",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": null,
"due_in": null,
"default_start": null,
"recurring_frequency": null,
"due_by": null,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": null,
"counts": {
"total_building_count": 2,
"all_buildings_included": true,
"target_object_count": 0,
"all_target_objects": false
},
"allow_one_click_done": false,
"start_date": null,
"next_run": null,
"asset_types": null,
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": true,
"enable_notification": true,
"task_distribution": "equipment"
}

Response will have all the buildings included in the Json with the key “buildings”

Updating Specific Properties

Use the following URL as a template for this request for PM schedule:

PATCH https://api.connect.buildingengines.com/pm_programs/{program_uuid}

Use the following URL as a template for this request for Inspection schedule:

PATCH https://api.connect.buildingengines.com/inspection_programs/{program_uuid}

The payload is an array of JSON objects including the following fields:
- all_buildings: false. Specifies that all the buildings of the schedule pmo is not included.
- assignee_id: User Assignee id that will be associated with the auto generated Task.
- organization_assignee_id: Organization Assignee id that will be associated with the auto generated Task.
- team_assignee_id: Team Assignee id Assignee id that will be associated with the auto generated Task.
- include_buildings: Array of objects containing:
  - building_id: specifies the building uuid
  - assignee_id: User Asignee at the property level.
  - organization_assignee_id: Organization Assignee at the property level
  - team_assignee_id: Team Assignee at the property level
- Each building level assignee can have either one of the following:
  - team assignee
  - organization assignee
  - user assignee
  - Both organization & user assignee

Sample Payload:

{
"all_buildings": false,
"include_buildings": [
{
"building_id": "59fbf4ea-ca8b-4e3e-b02e-bc694b5ee23f",
"assignee_id": null,
"organization_assignee_id": null,
"team_assignee_id": null
},
{
"building_id": "7478cf9b-c78f-44f0-9326-431e9b97dc2a",
"assignee_id": "a82de24a-aab0-449e-abc7-7ca471a61d34",
"team_assignee_id": null
}
],
"assignee_id": null,
"organization_assignee_id": null,
"team_assignee_id": null
}

Sample Response:

{
"id": "145572ef-c008-41f6-bf51-93cc414bb94c",
"identifier": "PS-000010",
"name": "PM Schedule Name",
"status": "draft",
"task_schedules": [],
"all_buildings": false,
"buildings": [
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "59fbf4ea-ca8b-4e3e-b02e-bc694b5ee23f",
"name": "Building 3",
"street_address": "Lal Darwaja Station Rd",
"street_address_2": "",
"city": "Surat",
"state": "GJ",
"zip_code": "395003",
"country": "IN",
"google_verification_override": false,
"timezone": "America/New_York",
"latitude": "21.206860",
"longitude": "72.840102",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "INR",
"formatted_address": "Lal Darwaja Station Rd, Suryapur Gate, Varachha, Surat, Gujarat 395003, India",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"next_occurence_skipped": null,
"next_run": null
},
{
"is_active": true,
"is_default": true,
"assignee_id": "a82de24a-aab0-449e-abc7-7ca471a61d34",
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "7478cf9b-c78f-44f0-9326-431e9b97dc2a",
"name": "Building",
"street_address": "4800 Airport Plaza Dr",
"street_address_2": "",
"city": "Long Beach",
"state": "CA",
"zip_code": "90815",
"country": "US",
"google_verification_override": false,
"timezone": "America/Los_Angeles",
"latitude": "33.810622",
"longitude": "-118.137960",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "USD",
"formatted_address": "4800 Airport Plaza Dr, Long Beach, CA 90815, USA",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"next_occurence_skipped": null,
"next_run": null
} 
],
"procedure_id": "05efbd9f-0f21-43cc-b3ee-8aa2f0ae1624",
"procedure": {
"id": "05efbd9f-0f21-43cc-b3ee-8aa2f0ae1624",
"name": "xsdsa",
"category": {
"id": "a31c1e44-d454-43ea-bdc2-290b8aa202cd",
"name": "Building Equipment",
"icon_type": "building"
},
"preferred_steps": "text",
"steps_form": {
"id": "95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f",
"created_at": "2023-09-18T16:35:44.175458Z",
"updated_at": "2023-09-18T16:35:44.208028Z",
"form": {
"id": "bf351e78-b993-4f7f-b9c0-e086f84a3014",
"type": "form",
"children": [
{
"id": "49a7d1e3-48a5-424e-aa9b-1f6772f333bb",
"type": "section",
"label": "Steps",
"children": [
{
"id": "4b3017d6-9226-406b-a823-4cbca7e0a0ef",
"type": "field",
"label": "wqd",
"fieldType": "done",
"summary": null
}
],
"actualWeightedScore": 0,
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
}
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
},
"hasWeightedScores": false
},
"type": "general",
"href": "https://api.connect.buildingengines.com/serdy_forms/95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f",
"field_count": 1,
"field_value_count": 0,
"progress": 0,
"attachments_href": "https://api.connect.buildingengines.com/serdy_forms/95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f/attachments",
"work_orders_href": "https://api.connect.buildingengines.com/serdy_forms/95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f/work_orders",
"answers_href": "https://api.connect.buildingengines.com/serdy_forms/95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f/answers",
"summary_href": "https://api.connect.buildingengines.com/serdy_forms/95cf2bc9-83fa-42b0-b36f-d7f3ed07bb3f/summary"
},
"estimated_labor": null,
"is_private": false,
"status": "active",
"identifier": "PR-000169"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-06-28T08:01:49.777735Z",
"updated_at": "2024-06-28T08:02:04.650959Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"allowed_statuses": [
"inactive"
],
"pmo_id": "8a33e1fc-f4f6-475e-a97d-5e70115eb380",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": null,
"due_in": null,
"default_start": null,
"recurring_frequency": null,
"due_by": null,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": null,
"counts": {
"total_building_count": 2,
"all_buildings_included": true,
"target_object_count": 0,
"all_target_objects": false
},
"allow_one_click_done": false,
"start_date": null,
"next_run": null,
"asset_types": null,
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": true,
"enable_notification": true,
"task_distribution": "equipment"
}

Updating PM/Inspection Schedule Equipment

Configuring Schedule by Asset Type

When a schedule is configured by asset type, task are generated for all the equipment of the asset type for those building that are part of the schedule.
Use the following URL as a template for this request for PM schedule:

PATCH https://api.connect.buildingengines.com/pm_programs/{program_uuid}

Use the following URL as a template for this request for Inspection schedule:

PATCH https://api.connect.buildingengines.com/inspection_programs/{program_uuid}

The payload is an array of JSON objects including the following fields:
- equipment_data: It is a JSON containing the following fields:
  - all_asset_objects: The value of all_asset_objects should be True.
  - equipment_type_id : UUID of the asset type.

Sample Payload:

{
"equipment_type_id": "19354696-4c2c-4e46-9a49-cc791384840f",
"all_asset_objects": true
}

Sample Response:

{
"id": "d2c1ad83-bb2c-406e-9ae0-66421c2a4c5b",
"identifier": "IT-000119",
"name": "Equipment Schedule",
"status": "draft",
"task_schedules": [],
"all_buildings": false,
"buildings": [
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"name": "Building 3",
"street_address": "Lal Darwaja Station Rd",
"street_address_2": "",
"city": "Surat",
"state": "GJ",
"zip_code": "395003",
"country": "IN",
"google_verification_override": false,
"timezone": "America/New_York",
"latitude": "21.206860",
"longitude": "72.840102",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "INR",
"formatted_address": "Lal Darwaja Station Rd, Suryapur Gate, Varachha, Surat, Gujarat 395003, India",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"next_occurence_skipped": null,
"next_run": null
},
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"name": "Tanuja",
"street_address": "4800 Airport Plaza Dr",
"street_address_2": "",
"city": "Long Beach",
"state": "CA",
"zip_code": "90815",
"country": "US",
"google_verification_override": false,
"timezone": "America/Los_Angeles",
"latitude": "33.810622",
"longitude": "-118.137960",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "USD",
"formatted_address": "4800 Airport Plaza Dr, Long Beach, CA 90815, USA",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"next_occurence_skipped": null,
"next_run": null
},
],
"procedure_id": "4e9350a6-3443-4f59-bc61-8d8c7a6602b4",
"procedure": {
"id": "4e9350a6-3443-4f59-bc61-8d8c7a6602b4",
"name": "Eq Schedule",
"category": null,
"preferred_steps": "text",
"steps_form": {
"id": "e58baaae-0a3e-4fa8-ac3a-e573282fad29",
"created_at": "2024-07-02T05:16:37.587409Z",
"updated_at": "2024-07-02T05:16:37.587426Z",
"form": {
"id": "2cc20701-2ce6-425d-b728-d086c835e5ea",
"type": "form",
"children": [
{
"id": "d660a73a-b53b-41db-8b5f-3ed9a0e5d4fc",
"type": "section",
"label": "S1",
"children": [
{
"id": "02c1db80-520a-4dd1-976e-57b44a83caaa",
"meta": {
"allowNA": null,
"required": null,
"performanceScoresMap": {}
},
"type": "field",
"label": "Q1",
"fieldType": "goodfairpoor",
"followUpQuestion": {},
"summary": null
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
}
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
},
"hasWeightedScores": false
},
"type": "general",
"href": "https://api.connect.buildingengines.com/serdy_forms/e58baaae-0a3e-4fa8-ac3a-e573282fad29",
"field_count": 1,
"field_value_count": 0,
"progress": 0,
"attachments_href": "https://api.connect.buildingengines.com/serdy_forms/e58baaae-0a3e-4fa8-ac3a-e573282fad29/attachments",
"work_orders_href": "https://api.connect.buildingengines.com/serdy_forms/e58baaae-0a3e-4fa8-ac3a-e573282fad29/work_orders",
"answers_href": "https://api.connect.buildingengines.com/serdy_forms/e58baaae-0a3e-4fa8-ac3a-e573282fad29/answers",
"summary_href": "https://api.connect.buildingengines.com/serdy_forms/e58baaae-0a3e-4fa8-ac3a-e573282fad29/summary"
},
"estimated_labor": null,
"is_private": true,
"status": "active",
"identifier": "PR-000207"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-07-02T05:16:37.636250Z",
"updated_at": "2024-07-02T05:19:26.144906Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"allowed_statuses": [
"inactive"
],
"pmo_id": "8a33e1fc-f4f6-475e-a97d-5e70115eb380",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": null,
"due_in": null,
"default_start": null,
"recurring_frequency": null,
"due_by": null,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": {
"all_asset_objects": true,
"asset_target_id": "19354696-4c2c-4e46-9a49-cc791384840f",
"objects": []
},
"comments": [
{
"id": "318b2495-35fe-47cb-aa80-4131ce7247e3",
"text": "All Target Objects changed from False to True.",
"is_private": false,
"comment_type": "system",
"created_at": "2024-07-02T05:19:26.152587Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"identifier": "",
"external_key": null,
"is_online": true,
"image_url": null,
"last_login": "2024-07-02T05:15:52.883788Z",
"first_name": "Test",
"last_name": "Tanuja"
},
"default_comment_response_id": null,
"is_prism_admin": false,
"system_comment_type": "sct_change",
"parent": null,
"resolved": false,
"linkable_objects": [],
"notified_users": null,
"flagged_reasons": [],
"edit_details": null,
"metadata": {},
"decorated_comment": null
}
],
"counts": {
"total_building_count": 11,
"all_buildings_included": false,
"target_object_count": 11,
"all_target_objects": true
},
"allow_one_click_done": false,
"start_date": null,
"next_run": null,
"asset_types": [
"Test Asset Type"
],
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": true,
"enable_notification": false,
"task_distribution": "equipment",
"sub_type": "equipment",
"min_score_target_percent": null,
"include_authors_notes": false
}

Response will have the following fields:
- asset_types: An array of asset types name that are part of the schedule.
- content_object: An object having the following:
  - all_asset_objects with the value True to signify that the schedule is configured by asset type.
  - asset_target_id: UUID of the asset type.
  - objects: An empty array.

Configuring Schedule by Specific Equipment

Specific equipments for the buildings that are part of the schedule can be included.
Use the following URL as a template for this request for PM schedule:

PATCH https://api.connect.buildingengines.com/pm_programs/{program_uuid}

Use the following URL as a template for this request for Inspection schedule:

PATCH https://api.connect.buildingengines.com/inspection_programs/{program_uuid}

The payload is an array of JSON objects including the following fields:
- equipment_data: It is a JSON containing the following fields:
  - all_asset_objects: The value of all_asset_objects should be false.
  - equipments: An array of objects having:
    - equipment_id: UUID of the equipment that needs to be included.

Sample Payload:

{
"equipment_data": {
"all_asset_objects": false,
"equipments": [
{
"equipment_id": "3c12aacc-4892-4264-986c-48cebf2c829e"
},
{
"equipment_id": "69a20ebd-9ae9-4e38-a588-b508e2a731b2"
}
]
}
}

Sample Response:

{
"id": "d2c1ad83-bb2c-406e-9ae0-66421c2a4c5b",
"identifier": "IT-000119",
"name": "Eq Schedule",
"status": "draft",
"task_schedules": [],
"all_buildings": false,
"buildings": [
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"name": "Building 3",
"street_address": "Lal Darwaja Station Rd",
"street_address_2": "",
"city": "Surat",
"state": "GJ",
"zip_code": "395003",
"country": "IN",
"google_verification_override": false,
"timezone": "America/New_York",
"latitude": "21.206860",
"longitude": "72.840102",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "INR",
"formatted_address": "Lal Darwaja Station Rd, Suryapur Gate, Varachha, Surat, Gujarat 395003, India",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"next_occurence_skipped": null,
"next_run": null
},
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"name": "Tanuja",
"street_address": "4800 Airport Plaza Dr",
"street_address_2": "",
"city": "Long Beach",
"state": "CA",
"zip_code": "90815",
"country": "US",
"google_verification_override": false,
"timezone": "America/Los_Angeles",
"latitude": "33.810622",
"longitude": "-118.137960",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "USD",
"formatted_address": "4800 Airport Plaza Dr, Long Beach, CA 90815, USA",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"next_occurence_skipped": null,
"next_run": null
},

],
"procedure_id": "4e9350a6-3443-4f59-bc61-8d8c7a6602b4",
"procedure": {
"id": "4e9350a6-3443-4f59-bc61-8d8c7a6602b4",
"name": "Eq Schedule",
"category": null,
"preferred_steps": "text",
"steps_form": {
"id": "e58baaae-0a3e-4fa8-ac3a-e573282fad29",
"created_at": "2024-07-02T05:16:37.587409Z",
"updated_at": "2024-07-02T05:16:37.587426Z",
"form": {
"id": "2cc20701-2ce6-425d-b728-d086c835e5ea",
"type": "form",
"children": [
{
"id": "d660a73a-b53b-41db-8b5f-3ed9a0e5d4fc",
"type": "section",
"label": "S1",
"children": [
{
"id": "02c1db80-520a-4dd1-976e-57b44a83caaa",
"meta": {
"allowNA": null,
"required": null,
"performanceScoresMap": {}
},
"type": "field",
"label": "Q1",
"fieldType": "goodfairpoor",
"followUpQuestion": {},
"summary": null
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
}
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
},
"hasWeightedScores": false
},
"type": "general",
"href": "https://api.connect.buildingengines.com/serdy_forms/e58baaae-0a3e-4fa8-ac3a-e573282fad29",
"field_count": 1,
"field_value_count": 0,
"progress": 0,
"attachments_href": "https://api.connect.buildingengines.com/serdy_forms/e58baaae-0a3e-4fa8-ac3a-e573282fad29/attachments",
"work_orders_href": "https://api.connect.buildingengines.com/serdy_forms/e58baaae-0a3e-4fa8-ac3a-e573282fad29/work_orders",
"answers_href": "https://api.connect.buildingengines.com/serdy_forms/e58baaae-0a3e-4fa8-ac3a-e573282fad29/answers",
"summary_href": "https://api.connect.buildingengines.com/serdy_forms/e58baaae-0a3e-4fa8-ac3a-e573282fad29/summary"
},
"estimated_labor": null,
"is_private": true,
"status": "active",
"identifier": "PR-000207"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-07-02T05:16:37.636250Z",
"updated_at": "2024-07-02T05:46:14.669833Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"allowed_statuses": [
"inactive"
],
"pmo_id": "8a33e1fc-f4f6-475e-a97d-5e70115eb380",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": null,
"due_in": null,
"default_start": null,
"recurring_frequency": null,
"due_by": null,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": {
"all_asset_objects": false,
"asset_target_id": "19354696-4c2c-4e46-9a49-cc791384840f",
"objects": [
{
"assignee": null,
"assignee_id": null,
"team_assignee": null,
"team_assignee_id": null,
"organization_assignee": null,
"organization_assignee_id": null,
"next_run": null,
"start_date": null,
"due_by": null,
"next_occurence_skipped": false,
"equipment_id": "3c12aacc-4892-4264-986c-48cebf2c829e"
},
{
"assignee": null,
"assignee_id": null,
"team_assignee": null,
"team_assignee_id": null,
"organization_assignee": null,
"organization_assignee_id": null,
"next_run": null,
"start_date": null,
"due_by": null,
"next_occurence_skipped": false,
"equipment_id": "69a20ebd-9ae9-4e38-a588-b508e2a731b2"
}
]
},
"comments": [
{
"id": "39f5d959-65de-4c1f-8df2-d26a967240fe",
"text": "All Target Objects changed from True to False.",
"is_private": false,
"comment_type": "system",
"created_at": "2024-07-02T05:46:14.676593Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"identifier": "",
"external_key": null,
"is_online": true,
"image_url": null,
"last_login": "2024-07-02T05:15:52.883788Z",
"first_name": "Test",
"last_name": "Tanuja"
},
"default_comment_response_id": null,
"is_prism_admin": false,
"system_comment_type": "sct_change",
"parent": null,
"resolved": false,
"linkable_objects": [],
"notified_users": null,
"flagged_reasons": [],
"edit_details": null,
"metadata": {},
"decorated_comment": null
},
{
"id": "318b2495-35fe-47cb-aa80-4131ce7247e3",
"text": "All Target Objects changed from False to True.",
"is_private": false,
"comment_type": "system",
"created_at": "2024-07-02T05:19:26.152587Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"identifier": "",
"external_key": null,
"is_online": true,
"image_url": null,
"last_login": "2024-07-02T05:15:52.883788Z",
"first_name": "Test",
"last_name": "Tanuja"
},
"default_comment_response_id": null,
"is_prism_admin": false,
"system_comment_type": "sct_change",
"parent": null,
"resolved": false,
"linkable_objects": [],
"notified_users": null,
"flagged_reasons": [],
"edit_details": null,
"metadata": {},
"decorated_comment": null
}
],
"counts": {
"total_building_count": 2,
"all_buildings_included": false,
"target_object_count": 2,
"all_target_objects": false
},
"allow_one_click_done": false,
"start_date": null,
"next_run": null,
"asset_types": [
"Test Asset Type",
"Test Asset Type2"
],
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": true,
"enable_notification": false,
"task_distribution": "equipment",
"sub_type": "equipment",
"min_score_target_percent": null,
"include_authors_notes": false
}

Response will have the following fields:
- asset_types: An array of asset types name that are part of the schedule.
- content_object: An object having the following:
  - all_asset_objects with the value False to signify that the schedule is configured by equipment.
  - asset_target_id: UUID of any one equipment’s asset type.
  - objects: An array of the objects having following:
    - assignee: User Assignee object at the equipment level (Only applicable for PM Schedule).
    - assignee_id: UUID of the User assignee
    - team_assignee: Team Assignee object at the equipment level (Only applicable for PM Schedule).
    - team_assignee_id: UUID of the Team assignee
    - organization_assignee: Organization Assignee object at the equipment level (Only applicable for PM Schedule).
    - organization_assignee_id: UUID of the Organization assignee
    - next_run: Date & time on which next task will be generated for the equipment
    - start_date: DateTime from where task generation starts for the equipment.
    - due_by: Due by at equipment level.
    - next_occurence_skipped: Was next occurence skipped during previous Fire Now (Only applicable for Inspection Schedule)
    - equipment_id: UUID of the equipment

Updating Inspection Schedule Space

Spaces can be added with vacant space only enabled/disabled.
When vacant space only is enabled task will be created only for vacant suite that are part of the schedule.

Configuring by All Spaces

Use the following URL as a template for this request:

PATCH https://api.connect.buildingengines.com/inspection_programs/{program_uuid}

The payload is an array of JSON objects including the following fields:
- space data: It is a JSON containing the following fields:
  - all_target_objects: Value True to signify that the schedule is configured by all spaces
  - spaces: Optional. Empty Array
  - vacant_space_only: Boolean Field to signify whether task needs to be created only for vacant spaces.

Sample Payload:

{
"space_data": {
"all_target_objects": true,
"spaces": [],
"vacant_space_only": true
}
}

Sample Response:

{
"id": "978cd515-6320-4a89-b064-76b984a8d2b9",
"identifier": "IT-000120",
"name": "hgftgdg",
"status": "draft",
"task_schedules": [],
"all_buildings": false,
"buildings": [
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"name": "Building 3",
"street_address": "Lal Darwaja Station Rd",
"street_address_2": "",
"city": "Surat",
"state": "GJ",
"zip_code": "395003",
"country": "IN",
"google_verification_override": false,
"timezone": "America/New_York",
"latitude": "21.206860",
"longitude": "72.840102",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "INR",
"formatted_address": "Lal Darwaja Station Rd, Suryapur Gate, Varachha, Surat, Gujarat 395003, India",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"next_occurence_skipped": null,
"next_run": null
},
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"name": "Tanuja",
"street_address": "4800 Airport Plaza Dr",
"street_address_2": "",
"city": "Long Beach",
"state": "CA",
"zip_code": "90815",
"country": "US",
"google_verification_override": false,
"timezone": "America/Los_Angeles",
"latitude": "33.810622",
"longitude": "-118.137960",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "USD",
"formatted_address": "4800 Airport Plaza Dr, Long Beach, CA 90815, USA",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"next_occurence_skipped": null,
"next_run": null
},

],
"procedure_id": "0da31e89-a262-4709-b41a-4134c2dec247",
"procedure": {
"id": "0da31e89-a262-4709-b41a-4134c2dec247",
"name": "hgftgdg",
"category": null,
"preferred_steps": "text",
"steps_form": {
"id": "43ce913c-fa53-44cc-a2d1-dc34d0f0b151",
"created_at": "2024-07-02T07:28:59.519634Z",
"updated_at": "2024-07-02T07:28:59.519651Z",
"form": {
"id": "75c8f326-fcf4-4218-958b-cad9cc701dcc",
"type": "form",
"children": [
{
"id": "de6959a9-7dd3-4820-acf3-7ed2ba1c58f7",
"type": "section",
"label": "lkhkj",
"children": [
{
"id": "0e4a3d4f-4910-4598-ba3d-2cc45df91017",
"meta": {
"allowNA": null,
"required": null,
"performanceScoresMap": {}
},
"type": "field",
"label": ";l",
"fieldType": "goodfairpoor",
"followUpQuestion": {},
"summary": null
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
}
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
},
"hasWeightedScores": false
},
"type": "general",
"href": "https://api.connect.buildingengines.com/serdy_forms/43ce913c-fa53-44cc-a2d1-dc34d0f0b151",
"field_count": 1,
"field_value_count": 0,
"progress": 0,
"attachments_href": "https://api.connect.buildingengines.com/serdy_forms/43ce913c-fa53-44cc-a2d1-dc34d0f0b151/attachments",
"work_orders_href": "https://api.connect.buildingengines.com/serdy_forms/43ce913c-fa53-44cc-a2d1-dc34d0f0b151/work_orders",
"answers_href": "https://api.connect.buildingengines.com/serdy_forms/43ce913c-fa53-44cc-a2d1-dc34d0f0b151/answers",
"summary_href": "https://api.connect.buildingengines.com/serdy_forms/43ce913c-fa53-44cc-a2d1-dc34d0f0b151/summary"
},
"estimated_labor": null,
"is_private": true,
"status": "active",
"identifier": "PR-000209"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-07-02T07:28:59.561414Z",
"updated_at": "2024-07-02T11:01:03.358713Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"allowed_statuses": [
"inactive"
],
"pmo_id": "8a33e1fc-f4f6-475e-a97d-5e70115eb380",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": null,
"due_in": null,
"default_start": null,
"recurring_frequency": null,
"due_by": null,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": {
"all_target_objects": true,
"vacant_space_only": true,
"objects": []
},
"comments": [
{
"id": "5aa11cdc-4ddc-4c4d-99d7-ef649ee5e34a",
"text": "All Target Objects changed from False to True.",
"is_private": false,
"comment_type": "system",
"created_at": "2024-07-02T11:01:03.376086Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"identifier": "",
"external_key": null,
"is_online": true,
"image_url": null,
"last_login": "2024-07-02T05:15:52.883788Z",
"first_name": "Test",
"last_name": "Tanuja"
},
"default_comment_response_id": null,
"is_prism_admin": false,
"system_comment_type": "sct_change",
"parent": null,
"resolved": false,
"linkable_objects": [],
"notified_users": null,
"flagged_reasons": [],
"edit_details": null,
"metadata": {},
"decorated_comment": null
}
],
"counts": {
"total_building_count": 2,
"all_buildings_included": false,
"target_object_count": 0,
"all_target_objects": true
},
"allow_one_click_done": false,
"start_date": null,
"next_run": null,
"asset_types": null,
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": true,
"enable_notification": false,
"task_distribution": "space",
"sub_type": "space",
"min_score_target_percent": null,
"include_authors_notes": false
}

Configuring By Specific Spaces

Use the following URL as a template for this request:

PATCH https://api.connect.buildingengines.com/inspection_programs/{program_uuid}

The payload is an array of JSON objects including the following fields:
- space_data: It is a JSON containing the following fields:
  - all_target_objects: Value True to signify that the schedule is configured by all spaces
  - spaces: Optional. Empty Array
  - vacant_space_only: Boolean Field to signify whether task needs to be created only for vacant spaces.

Sample Payload:

{
"space_data": {
"all_target_objects": false,
"spaces": [
{
"space_id": "c24f1758-3446-4c15-9392-1780c37d1615"
},
{
"space_id": "d671d3dc-6896-41f8-b6c1-c19332290c5c"
}
],
"vacant_space_only": false
}
}

Sample Response:

{
"id": "978cd515-6320-4a89-b064-76b984a8d2b9",
"identifier": "IT-000120",
"name": "hgftgdg",
"status": "draft",
"task_schedules": [],
"all_buildings": false,
"buildings": [
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"name": "Building 3",
"street_address": "Lal Darwaja Station Rd",
"street_address_2": "",
"city": "Surat",
"state": "GJ",
"zip_code": "395003",
"country": "IN",
"google_verification_override": false,
"timezone": "America/New_York",
"latitude": "21.206860",
"longitude": "72.840102",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "INR",
"formatted_address": "Lal Darwaja Station Rd, Suryapur Gate, Varachha, Surat, Gujarat 395003, India",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"next_occurence_skipped": null,
"next_run": null
},
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"name": "Tanuja",
"street_address": "4800 Airport Plaza Dr",
"street_address_2": "",
"city": "Long Beach",
"state": "CA",
"zip_code": "90815",
"country": "US",
"google_verification_override": false,
"timezone": "America/Los_Angeles",
"latitude": "33.810622",
"longitude": "-118.137960",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "USD",
"formatted_address": "4800 Airport Plaza Dr, Long Beach, CA 90815, USA",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "0434df70-1acc-4775-8183-dc4c1fcb6618",
"next_occurence_skipped": null,
"next_run": null
},
],
"procedure_id": "0da31e89-a262-4709-b41a-4134c2dec247",
"procedure": {
"id": "0da31e89-a262-4709-b41a-4134c2dec247",
"name": "hgftgdg",
"category": null,
"preferred_steps": "text",
"steps_form": {
"id": "43ce913c-fa53-44cc-a2d1-dc34d0f0b151",
"created_at": "2024-07-02T07:28:59.519634Z",
"updated_at": "2024-07-02T07:28:59.519651Z",
"form": {
"id": "75c8f326-fcf4-4218-958b-cad9cc701dcc",
"type": "form",
"children": [
{
"id": "de6959a9-7dd3-4820-acf3-7ed2ba1c58f7",
"type": "section",
"label": "lkhkj",
"children": [
{
"id": "0e4a3d4f-4910-4598-ba3d-2cc45df91017",
"meta": {
"allowNA": null,
"required": null,
"performanceScoresMap": {}
},
"type": "field",
"label": ";l",
"fieldType": "goodfairpoor",
"followUpQuestion": {},
"summary": null
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
}
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 1
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
},
"hasWeightedScores": false
},
"type": "general",
"href": "https://api.connect.buildingengines.com/serdy_forms/43ce913c-fa53-44cc-a2d1-dc34d0f0b151",
"field_count": 1,
"field_value_count": 0,
"progress": 0,
"attachments_href": "https://api.connect.buildingengines.com/serdy_forms/43ce913c-fa53-44cc-a2d1-dc34d0f0b151/attachments",
"work_orders_href": "https://api.connect.buildingengines.com/serdy_forms/43ce913c-fa53-44cc-a2d1-dc34d0f0b151/work_orders",
"answers_href": "https://api.connect.buildingengines.com/serdy_forms/43ce913c-fa53-44cc-a2d1-dc34d0f0b151/answers",
"summary_href": "https://api.connect.buildingengines.com/serdy_forms/43ce913c-fa53-44cc-a2d1-dc34d0f0b151/summary"
},
"estimated_labor": null,
"is_private": true,
"status": "active",
"identifier": "PR-000209"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-07-02T07:28:59.561414Z",
"updated_at": "2024-07-02T13:13:04.803032Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"allowed_statuses": [
"inactive"
],
"pmo_id": "8a33e1fc-f4f6-475e-a97d-5e70115eb380",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": null,
"due_in": null,
"default_start": null,
"recurring_frequency": null,
"due_by": null,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": {
"all_target_objects": false,
"vacant_space_only": false,
"objects": [
{
"assignee": null,
"assignee_id": null,
"team_assignee": null,
"team_assignee_id": null,
"organization_assignee": null,
"organization_assignee_id": null,
"next_run": null,
"start_date": null,
"due_by": null,
"next_occurence_skipped": false,
"space_id": "c24f1758-3446-4c15-9392-1780c37d1615"
},
{
"assignee": null,
"assignee_id": null,
"team_assignee": null,
"team_assignee_id": null,
"organization_assignee": null,
"organization_assignee_id": null,
"next_run": null,
"start_date": null,
"due_by": null,
"next_occurence_skipped": false,
"space_id": "d671d3dc-6896-41f8-b6c1-c19332290c5c"
}
]
},
"comments": [
{
"id": "5aa11cdc-4ddc-4c4d-99d7-ef649ee5e34a",
"text": "All Target Objects changed from False to True.",
"is_private": false,
"comment_type": "system",
"created_at": "2024-07-02T11:01:03.376086Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"identifier": "",
"external_key": null,
"is_online": true,
"image_url": null,
"last_login": "2024-07-02T05:15:52.883788Z",
"first_name": "Test",
"last_name": "Tanuja"
},
"default_comment_response_id": null,
"is_prism_admin": false,
"system_comment_type": "sct_change",
"parent": null,
"resolved": false,
"linkable_objects": [],
"notified_users": null,
"flagged_reasons": [],
"edit_details": null,
"metadata": {},
"decorated_comment": null
}
],
"counts": {
"total_building_count": 2,
"all_buildings_included": false,
"target_object_count": 2,
"all_target_objects": false
},
"allow_one_click_done": false,
"start_date": null,
"next_run": null,
"asset_types": null,
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": false,
"enable_notification": false,
"task_distribution": "space",
"sub_type": "space",
"min_score_target_percent": null,
"include_authors_notes": false
}

Response has content_object which is similar to the response of equipment updation.

Adding Scheduling Related Information to PM/Inspection Schedule

Use the following URL as a template for this request for PM schedule:

PATCH https://api.connect.buildingengines.com/pm_programs/{program_uuid}

Use the following URL as a template for this request for Inspection schedule:

PATCH https://api.connect.buildingengines.com/inspection_programs/{program_uuid}

The payload is an array of JSON objects including the following fields:
- recurrence_metadata: recurrence rule which is created using rrule library
- recurring_frequency: schedule frequency. It can have the following possible values:
  - once: Task will created once and after that schedule will be completed.
  - hourly: By default task will be created every hour
  - monthly: Task will be created every month
  - minutely: Task will be created every 15 minutes
  - daily: Task will be created daily
  - weekdays: Task will be created only on week days.
  - weekly: Task will be created only on weekly
  - quarterly: Task will be created every quarted
  - semi-annual: Task will be created in 6 months
  - annual: Task will be created yearly
  - on-demand: Task will not be automatically created. User will have to use the fire now option to create task
  - custom: Any of the above mentioned frequency can be customised using custom frequency.
- default_start: Timestamp when the schedule should start firing task
- skip_weekends: Boolean column to signify whether task firing needs to be skipped on weekend.
- due_by: Can have the following possible values:
  - end_of_day: Task created will have due date of the end of the day.
  - end_of_work_week
  - end_of_week
  - end_of_month
  - end_of_quarter
  - end_of_year
  - x_days: To set due by in no of days set due_by to x_days and due_in to number of days
- due_in: To set due by in no of days set due_by to x_days and due_in to number of days.
- auto_stagger: Boolean column. Set it to true to set no of occurences of task per day to to spread the work out over time. Only Applicable for PM schedule.
- auto_stagger_occurences: No of occurences per day of task when auto_stagger is true.
- rolling_maintenance: If true, the next task will not be created until the current task is completed. Only Applicable for PM schedule.
- skip_holidays: If true, task will not be created on holidays.
- ends: Can have the following possible value:
  - on_date
  - never
  - after_occurrences
- on_date: When the value of ends is “on_date” this will have the timestamp of schedule end date
- after_occurrences: When the value of ends is “after_occurrences” this will no of occurence after which task should not be generated.
- enable_notification: Set to true to trigger notifications from the task created.
- task_creation_time: Time at which task needs to generated from schedule.
- program_group: An object containing name of the group based on which task should be overridden.
  - Eg: program_group: {"name": "override group”}

Sample Payload:

{
"recurrence_metadata": "DTSTART:20240702T000000Z\nRRULE:FREQ=MONTHLY;BYHOUR=06;BYMINUTE=00",
"recurring_frequency": "monthly",
"default_due": null,
"default_start": "2024-07-02T12:00:00.000Z",
"skip_weekends": false,
"due_by": "end_of_month",
"auto_stagger": false,
"rolling_maintenance": false,
"skip_holidays": false,
"auto_stagger_occurrences": 0,
"due_in": null,
"ends": "never",
"on_date": false,
"enable_notification": true,
"task_creation_time": "0600",
"program_group": null
}

Sample Response:

{
"id": "b51df0a1-8318-4053-9b4a-5ffc50e2ba69",
"identifier": "PS-000081",
"name": "Sample Schedule",
"status": "draft",
"task_schedules": [
{
"id": "5273f241-6fb0-48c4-bcf0-fff29e05a362",
"recurrence_rule": "DTSTART;TZID=America/New_York:20240702T000000\nRRULE:FREQ=MONTHLY;BYHOUR=06;BYMINUTE=00",
"frequency": "monthly",
"due_by": "end_of_month",
"due_in": null,
"next_run": null,
"total_run_count": 0,
"last_run_at": null,
"skip_weekends": false,
"skip_holidays": false,
"rolling_maintenance": false,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"metadata": null
},
{
"id": "b321c299-ab5d-4048-b883-95066e33a1f0",
"recurrence_rule": "DTSTART;TZID=Asia/Kolkata:20240702T000000\nRRULE:FREQ=MONTHLY;BYHOUR=06;BYMINUTE=00",
"frequency": "monthly",
"due_by": "end_of_month",
"due_in": null,
"next_run": null,
"total_run_count": 0,
"last_run_at": null,
"skip_weekends": false,
"skip_holidays": false,
"rolling_maintenance": false,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"metadata": null
},

],
"all_buildings": false,
"buildings": [
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"name": "Building 3",
"street_address": "Lal Darwaja Station Rd",
"street_address_2": "",
"city": "Surat",
"state": "GJ",
"zip_code": "395003",
"country": "IN",
"google_verification_override": false,
"timezone": "America/New_York",
"latitude": "21.206860",
"longitude": "72.840102",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "INR",
"formatted_address": "Lal Darwaja Station Rd, Suryapur Gate, Varachha, Surat, Gujarat 395003, India",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "d55d9c7c-b269-4bfd-bdb3-cc6b0b2f715e",
"next_occurence_skipped": null,
"next_run": null
},
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "28aa2933-2e11-4ba2-b563-5653156637c7",
"name": "Mohammed Ali Rd",
"street_address": "Mohammed Ali Rd",
"street_address_2": "",
"city": "Mumbai",
"state": "MH",
"zip_code": "400003",
"country": "IN",
"google_verification_override": false,
"timezone": "Asia/Kolkata",
"latitude": "18.955552",
"longitude": "72.832938",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "INR",
"formatted_address": "Mohammed Ali Rd, Mumbai, Maharashtra 400003, India",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "28aa2933-2e11-4ba2-b563-5653156637c7",
"next_occurence_skipped": null,
"next_run": null
},

],
"procedure_id": "66bf8792-1d38-4374-be89-748fc3b0ad5c",
"procedure": {
"id": "66bf8792-1d38-4374-be89-748fc3b0ad5c",
"name": "Individual Stped",
"category": null,
"preferred_steps": "form",
"steps_form": {
"id": "9e6d53bb-8804-4b62-aa26-dd06727ee742",
"created_at": "2024-07-02T06:56:45.287797Z",
"updated_at": "2024-07-02T06:56:45.287814Z",
"form": {
"id": "b82a33d4-93d0-4610-8715-393966945708",
"type": "form",
"children": [
{
"id": "b1f63a56-a780-4c85-b647-3267336d6c6e",
"type": "section",
"label": "S1",
"children": [
{
"id": "e3dc8bd4-bd59-4837-8910-4a356fa9b2e0",
"meta": {
"allowNA": null,
"required": null,
"performanceScoresMap": {}
},
"type": "field",
"label": "Q1",
"fieldType": "done",
"followUpQuestion": {},
"summary": null
},
{
"id": "63fd0428-1f08-4656-8f70-d75125ab8009",
"meta": {
"allowNA": null,
"required": null,
"performanceScoresMap": {}
},
"type": "field",
"label": "Q2",
"fieldType": "done",
"followUpQuestion": {},
"summary": null
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 2
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
}
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 2
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
},
"hasWeightedScores": false
},
"type": "general",
"href": "https://api.connect.buildingengines.com/serdy_forms/9e6d53bb-8804-4b62-aa26-dd06727ee742",
"field_count": 2,
"field_value_count": 0,
"progress": 0,
"attachments_href": "https://api.connect.buildingengines.com/serdy_forms/9e6d53bb-8804-4b62-aa26-dd06727ee742/attachments",
"work_orders_href": "https://api.connect.buildingengines.com/serdy_forms/9e6d53bb-8804-4b62-aa26-dd06727ee742/work_orders",
"answers_href": "https://api.connect.buildingengines.com/serdy_forms/9e6d53bb-8804-4b62-aa26-dd06727ee742/answers",
"summary_href": "https://api.connect.buildingengines.com/serdy_forms/9e6d53bb-8804-4b62-aa26-dd06727ee742/summary"
},
"estimated_labor": null,
"is_private": true,
"status": "active",
"identifier": "PR-000208"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-07-02T06:56:45.387486Z",
"updated_at": "2024-07-03T04:18:26.430265Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"allowed_statuses": [
"paused",
"inactive"
],
"pmo_id": "8a33e1fc-f4f6-475e-a97d-5e70115eb380",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": "DTSTART:20240702T000000Z\nRRULE:FREQ=MONTHLY;BYHOUR=06;BYMINUTE=00",
"due_in": null,
"default_start": "2024-07-02T12:00:00Z",
"recurring_frequency": "monthly",
"due_by": "end_of_month",
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": {
"all_asset_objects": false,
"asset_target_id": "19354696-4c2c-4e46-9a49-cc791384840f",
"objects": [
{
"assignee": null,
"assignee_id": null,
"team_assignee": null,
"team_assignee_id": null,
"organization_assignee": null,
"organization_assignee_id": null,
"next_run": "2024-08-02T00:30:00Z",
"start_date": null,
"due_by": null,
"next_occurence_skipped": false,
"equipment_id": "3c12aacc-4892-4264-986c-48cebf2c829e"
},
{
"assignee": null,
"assignee_id": null,
"team_assignee": null,
"team_assignee_id": null,
"organization_assignee": null,
"organization_assignee_id": null,
"next_run": "2024-08-02T00:30:00Z",
"start_date": null,
"due_by": null,
"next_occurence_skipped": false,
"equipment_id": "06cc6327-6a33-4b49-9d3d-7a0a5c13b449"
},

]
},
"comments": [],
"counts": {
"total_building_count": 2,
"all_buildings_included": false,
"target_object_count": 2,
"all_target_objects": false
},
"allow_one_click_done": false,
"start_date": "2024-07-02T12:00:00Z",
"next_run": null,
"asset_types": [
"Test Asset Type",
"Test Asset Type2",
],
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": true,
"enable_notification": true,
"task_distribution": "equipment"
}

The response has an array of objects task_schedules.

For each building in a schedule one TaskSchedule is created.

Updating Status of PM/Inspection Schedule

Use the following URL as a template for this request for PM schedule:

PATCH https://api.connect.buildingengines.com/pm_programs/{program_uuid}

Use the following URL as a template for this request for Inspection schedule:

PATCH https://api.connect.buildingengines.com/inspection_programs/{program_uuid}

The payload is an array of JSON objects including the following fields:
- status: It can have the following possible values:
  - inactive
  - draft
  - active
  - completed
  - paused

Sample Payload:

{
"status": "active"
}

Sample Response:

{
"id": "a1f7e0a8-db1e-41f9-b3ba-e23d7aa06cfd",
"identifier": "PS-000079",
"name": "Test Custom Fields",
"status": "active",
"task_schedules": [
{
"id": "4f92e36a-7dad-4e5e-a75d-19b3caa525ec",
"recurrence_rule": "DTSTART;TZID=America/New_York:20240517T000000\nRRULE:FREQ=MONTHLY;BYHOUR=06;BYMINUTE=00",
"frequency": "monthly",
"due_by": "end_of_month",
"due_in": null,
"next_run": "2024-07-17T10:00:00Z",
"total_run_count": 2,
"last_run_at": "2024-06-17T10:04:12.854233Z",
"skip_weekends": false,
"skip_holidays": false,
"rolling_maintenance": false,
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"metadata": null
}
],
"all_buildings": false,
"buildings": [
{
"is_active": true,
"is_default": true,
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"building": {
"id": "6f003117-138f-4244-af98-3118a4907ba7",
"name": "Building 2",
"street_address": "Lal Darwaja Station Rd",
"street_address_2": "",
"city": "Surat",
"state": "GJ",
"zip_code": "395003",
"country": "IN",
"google_verification_override": false,
"timezone": "America/New_York",
"latitude": "21.206860",
"longitude": "72.840102",
"external_key": null,
"account_id": "8db86cbf-3349-4f70-8280-4476e673b53f",
"building_identifier": null,
"currency": "INR",
"formatted_address": "Lal Darwaja Station Rd, Suryapur Gate, Varachha, Surat, Gujarat 395003, India",
"image_filename": null,
"image_url": null,
"status": "active"
},
"building_id": "6f003117-138f-4244-af98-3118a4907ba7",
"next_occurence_skipped": null,
"next_run": null
}
],
"procedure_id": "5410b639-04e5-4f9d-bcd7-20ef68b9c4a6",
"procedure": {
"id": "5410b639-04e5-4f9d-bcd7-20ef68b9c4a6",
"name": "Test Custom Fields",
"category": null,
"preferred_steps": "text",
"steps_form": {
"id": "d9266c4d-3351-42dd-bdb5-9f95804ae4b6",
"created_at": "2024-05-06T05:53:07.428256Z",
"updated_at": "2024-05-06T05:53:07.428273Z",
"form": {
"id": "ca817572-f98e-4a0e-b491-8ee3471403c2",
"type": "form",
"children": [
{
"id": "527cbda2-20fe-46e0-be80-f4c0de4aa5ff",
"type": "section",
"label": "Steps",
"children": [
{
"id": "65cb6040-0598-4665-b8cc-b59ba39f340c",
"type": "field",
"label": "1",
"fieldType": "done",
"summary": null
},
{
"id": "de6181ef-4d5b-485e-8b22-287650ee4683",
"type": "field",
"label": "1",
"fieldType": "done",
"summary": null
},
{
"id": "062c415e-d652-4738-8cdf-8f3c344c44e8",
"type": "field",
"label": "1",
"fieldType": "done",
"summary": null
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 3
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
}
}
],
"summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 3
},
"work_order_summary": {
"good": 0,
"fair": 0,
"poor": 0,
"unknown": 0,
"n/a": 0,
"total": 0
},
"hasWeightedScores": false
},
"type": "general",
"href": "https://api.connect.buildingengines.com/serdy_forms/d9266c4d-3351-42dd-bdb5-9f95804ae4b6",
"field_count": 3,
"field_value_count": 0,
"progress": 0,
"attachments_href": "https://api.connect.buildingengines.com/serdy_forms/d9266c4d-3351-42dd-bdb5-9f95804ae4b6/attachments",
"work_orders_href": "https://api.connect.buildingengines.com/serdy_forms/d9266c4d-3351-42dd-bdb5-9f95804ae4b6/work_orders",
"answers_href": "https://api.connect.buildingengines.com/serdy_forms/d9266c4d-3351-42dd-bdb5-9f95804ae4b6/answers",
"summary_href": "https://api.connect.buildingengines.com/serdy_forms/d9266c4d-3351-42dd-bdb5-9f95804ae4b6/summary"
},
"estimated_labor": null,
"is_private": true,
"status": "active",
"identifier": "PR-000202"
},
"assignee_id": null,
"assignee": null,
"organization_assignee_id": null,
"organization_assignee": null,
"team_assignee_id": null,
"team_assignee": null,
"created_at": "2024-05-06T05:53:07.599691Z",
"updated_at": "2024-07-04T06:56:39.257929Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"updated_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"phone_type": "mobile",
"identifier": "",
"is_online": true,
"image_url": null,
"first_name": "Test",
"last_name": "Tanuja",
"phone": "+14243255333"
},
"allowed_statuses": [
"paused",
"inactive"
],
"pmo_id": "8a33e1fc-f4f6-475e-a97d-5e70115eb380",
"default_due": null,
"skip_weekends": false,
"skip_holidays": false,
"recurrence_metadata": "DTSTART:20240517T000000Z\nRRULE:FREQ=MONTHLY;BYHOUR=06;BYMINUTE=00",
"due_in": null,
"default_start": "2024-05-17T12:00:00Z",
"recurring_frequency": "monthly",
"due_by": "end_of_month",
"auto_stagger": false,
"auto_stagger_occurrences": 0,
"content_object": {
"all_asset_objects": false,
"asset_target_id": "19354696-4c2c-4e46-9a49-cc791384840f",
"objects": [
{
"assignee": null,
"assignee_id": null,
"team_assignee": null,
"team_assignee_id": null,
"organization_assignee": null,
"organization_assignee_id": null,
"next_run": "2024-07-17T10:00:00Z",
"start_date": null,
"due_by": null,
"next_occurence_skipped": false,
"equipment_id": "dee4c835-de7d-4821-a75f-d5f0dd4b7d5d"
},
{
"assignee": null,
"assignee_id": null,
"team_assignee": null,
"team_assignee_id": null,
"organization_assignee": null,
"organization_assignee_id": null,
"next_run": "2024-07-17T10:00:00Z",
"start_date": null,
"due_by": null,
"next_occurence_skipped": false,
"equipment_id": "6ad7b650-b829-4e26-b148-b5cafbdfa487"
},
{
"assignee": null,
"assignee_id": null,
"team_assignee": null,
"team_assignee_id": null,
"organization_assignee": null,
"organization_assignee_id": null,
"next_run": "2024-07-17T10:00:00Z",
"start_date": null,
"due_by": null,
"next_occurence_skipped": false,
"equipment_id": "69a20ebd-9ae9-4e38-a588-b508e2a731b2"
},
{
"assignee": null,
"assignee_id": null,
"team_assignee": null,
"team_assignee_id": null,
"organization_assignee": null,
"organization_assignee_id": null,
"next_run": "2024-07-17T10:00:00Z",
"start_date": null,
"due_by": null,
"next_occurence_skipped": false,
"equipment_id": "3d2021ea-e63b-441e-8b43-968ad939c7bf"
}
]
},
"comments": [
{
"id": "00c90ca4-4bd6-4695-934d-7d8960d6b1f9",
"text": "Status changed from Draft to Active.",
"is_private": false,
"comment_type": "system",
"created_at": "2024-07-04T06:56:39.265549Z",
"created_by": {
"id": "xxxx-xxxx-xxxx-xxxx-xxxx",
"name": "John Smith",
"email": "jsmith@email.com",
"identifier": "",
"external_key": null,
"is_online": true,
"image_url": null,
"last_login": "2024-07-03T13:28:36.453276Z",
"first_name": "Test",
"last_name": "Tanuja"
},
"default_comment_response_id": null,
"is_prism_admin": false,
"system_comment_type": "sct_change",
"parent": null,
"resolved": false,
"linkable_objects": [],
"notified_users": null,
"flagged_reasons": [],
"edit_details": null,
"metadata": {},
"decorated_comment": null
},
],
"counts": {
"total_building_count": 1,
"all_buildings_included": false,
"target_object_count": 4,
"all_target_objects": false
},
"allow_one_click_done": false,
"start_date": "2024-05-17T12:00:00Z",
"next_run": "2024-07-17T10:00:00Z",
"asset_types": [
"Test Asset Type",
"Test Asset Type2"
],
"rolling_maintenance": false,
"program_group": null,
"program_group_id": null,
"vacant_space_only": true,
"enable_notification": true,
"task_distribution": "equipment"
}

After schedule is set to active status, next_run gets updated to the next date when task will be created for each task_schedule.

Cloning PM/Inspection Schedule

Use the following URL as a template for this request for PM schedule:

POST https://api.connect.buildingengines.com/pm_programs/{program_uuid}/clone

Use the following URL as a template for this request for Inspection schedule:

POST https://api.connect.buildingengines.com/inspection_programs/{program_uuid}/clone

Fire Now API

Task is created from schedule based on the scheduling info of the schedule.
To create task manually, fire now API can be used
When a schedule has on-demand frequency, task can be created only using fire now API

Fire Now API for PM Schedule

Use the following URL as a template for this request for PM schedule:

POST https://api.connect.buildingengines.com/pm_programs/{program_uuid}/firenow

This will created task for equipments that user have access to in the schedule.

Fire Now API for Inspection Schedule

This operations are performed as a background task.
API response will contain background task id which can be used to track the status of the operations

Fire Now for Inspection Property Schedule

All Property

To create task for all the property of the schedule.
Use the following URL as a template for this request:

POST https://api.connect.buildingengines.com/inspection_programs/{program_uuid}/firenow

The payload is an array of JSON objects including the following fields:
- all_buildings: with value true
- due_by: due by of the tasks that will be created
- due_in: due in when due_by is x_days
- skip_next_run: to skip next scheduled automatic task firing set it to true

Sample Payload:

{
"all_buildings": true,
"due_in": null,
"due_by": "end_of_month",
"skip_next_run": false
}

Sample Response:

{
"background_task": {
"id": "0133f69a-b98c-4512-9d55-330ea7d83bcb",
"task_id": "864c8566-5e85-4023-abda-a410817496c2",
"name": "bulk_generate_inspection_firenow_task",
"progress": null,
"processed_items": null,
"total_items": null,
"status": "in_progress",
"sub_status": null,
"created_at": "2024-07-08T07:37:19.577121Z",
"updated_at": "2024-07-08T07:37:19.577137Z",
"output_file": null,
"error_list": []
}
}

The sample response contains background task id which can be used to track the status of the fire now task

Specific Property

To create task for specific property of the schedule.
Use the following URL as a template for this request:

POST https://api.connect.buildingengines.com/inspection_programs/{program_uuid}/firenow

The payload is an array of JSON objects including the following fields:
- all_buildings: with value false
- due_by: due by of the tasks that will be created
- due_in: due in when due_by is x_days
- building_ids: an array of building ids for which task needs to be generated.
- skip_next_run: to skip next scheduled automatic task firing set it to true

Sample Payload:

{
"all_buildings": false,
"building_ids": [
"59fbf4ea-ca8b-4e3e-b02e-bc694b5ee23f",
"7478cf9b-c78f-44f0-9326-431e9b97dc2a"
],
"due_in": null,
"due_by": "end_of_month",
"skip_next_run": true
}

Fire Now for Inspection Equipment Schedule

Fire Task Based on Asset Type

Use the following URL as a template for this request:

POST https://api.connect.buildingengines.com/inspection_programs/{program_uuid}/firenow

The payload is an array of JSON objects including the following fields:
- all_buildings: Set True if needed to create task for the buildings otherwise False
- building_ids: An array of building ids when task needs to be created for specific buildings
- due_by: due by of the tasks that will be created
- due_in: due in when due_by is x_days
- equipment_data:
  - An object containing following values:
    - all_target_objects: To determine that the task needs to be fired based on asset type, this should be True.
    - equipment_ids: An empty array.
    - equipment_type_id: UUID of the asset type.
  - skip_next_run: to skip next scheduled automatic task firing set it to true

Sample Payload:

{
"all_buildings": false,
"building_ids": [
"28aa2933-2e11-4ba2-b563-5653156637c7",
"0434df70-1acc-4775-8183-dc4c1fcb6618"
],
"due_in": null,
"due_by": "end_of_month",
"equipment_data": {
"all_target_objects": true,
"equipment_ids": [],
"equipment_type_id": "19354696-4c2c-4e46-9a49-cc791384840f"
},
"skip_next_run": false
}

The sample response contains background task id which can be used to track the status of the fire now task

Fire Task Based on Specific Equipment

Use the following URL as a template for this request:

POST https://api.connect.buildingengines.com/inspection_programs/{program_uuid}/firenow

The payload is an array of JSON objects including the following fields:
- all_buildings: Set True if needed to create task for the buildings otherwise False
- building_ids: An array of building ids when task needs to be created for specific buildings
- due_by: due by of the tasks that will be created
- due_in: due in when due_by is x_days
- skip_next_run
- equipment_data:
  - An object containing following values:
    - all_target_objects: To determine that the task needs to be fired based on equipment, this should be False.
    - equipment_ids: An array of equipment ids.
    - equipment_type_id: None.
- skip_next_run: to skip next scheduled automatic task firing set it to true.

Sample Payload:

{
"all_buildings": true,
"building_ids": [],
"due_in": null,
"skip_next_run": false,
"due_by": "end_of_month",
"equipment_data": {
"all_target_objects": false,
"equipment_ids": [
"3c12aacc-4892-4264-986c-48cebf2c829e",
"69a20ebd-9ae9-4e38-a588-b508e2a731b2"
],
"equipment_type_id": null
},
"skip_next_run": false
}

The sample response contains background task id which can be used to track the status of the fire now task

Fire Now for Inspection Space Schedule

Use the following URL as a template for this request:

POST https://api.connect.buildingengines.com/inspection_programs/{program_uuid}/firenow

The payload is an array of JSON objects including the following fields:
- all_buildings: Set True if needed to create task for the buildings otherwise False
- building_ids: An array of building ids when task needs to be created for specific buildings
- due_by: due by of the tasks that will be created
- due_in: due in when due_by is x_days
- space_data: An object containing following values:
  - all_target_objects: true if task needed to be generated for all the spaces that are part of schedule otherwise false.
  - space_ids: An array of space ids for which task needs to be generated when all_target_objects is true.

Sample Payload:

{
"all_buildings": false,
"building_ids": [
"7478cf9b-c78f-44f0-9326-431e9b97dc2a",
],
"due_in": null,
"due_by": "end_of_month",
"space_data": {
"all_target_objects": false,
"space_ids": [
"6f36c9bd-f5df-4362-932c-a0a0491eb6ba",
"d671d3dc-6896-41f8-b6c1-c19332290c5c"
]
}
}

Fire Now for Inspection Move In Move Out Schedule

Use the following URL as a template for this request:

POST https://api.connect.buildingengines.com/inspection_programs/{program_uuid}/firenow

The payload is an array of JSON objects including the following fields:
- space_data: An object containing following values:
  - space_ids: An array of space ids for which task needs to be generated
  - sub_type: Can have two values based on Inspection Task type:
    - move_in
    - move_out

Sample Payload:

{
"sub_type": "move_in",
"space_data": {
"space_ids": [
"c24f1758-3446-4c15-9392-1780c37d1615"
]
}
}

PM Schedule Bulk Operation to Update Equipments

This operations are performed as a background task.
API response will contain background task id which can be used to track the status of the operations.

Override Schedule

Can be used to set specific start date & due by for some equipments.
Use the following URL as a template for this request:

POST https://api.connect.buildingengines.com/pm_programs/{program_uuid}/buildings_equipment/bulk_actions

The payload is an array of JSON objects including the following fields:
- included_ids: Comma separate equipment ids.
- action: The value of action should be “schedule”
- data: An object containing following:
  - start_date: start date for the equipments.
  - due_by: due by for the equipments.

Sample Payload:

{
"included_ids": "dee4c835-de7d-4821-a75f-d5f0dd4b7d5d,6ad7b650-b829-4e26-b148-b5cafbdfa487",
"action": "schedule",
"data": {
"start_date": "2024-07-10 00:00:00",
"due_by": "end_of_year"
}
}

Revert to Default Schedule

Used to revert override equipment level schedule.
Use the following URL as a template for this request:

POST https://api.connect.buildingengines.com/pm_programs/{program_uuid}/buildings_equipment/bulk_actions

The payload is an array of JSON objects including the following fields:
- included_ids: Comma separate equipment ids.
- action: The value of action should be “revert_schedule”

Sample Payload:

{
"included_ids": "dee4c835-de7d-4821-a75f-d5f0dd4b7d5d,6ad7b650-b829-4e26-b148-b5cafbdfa487",
"action": "revert_schedule"
}

Override Assignee

Set assignee at equipment level.
Use the following URL as a template for this request:

POST https://api.connect.buildingengines.com/pm_programs/{program_uuid}/buildings_equipment/bulk_actions

The payload is an array of JSON objects including the following fields:
- included_ids: Comma separate equipment ids.
- action: The value of action should be “assign”
- data: An object containing following:
  - assignee_id: UUID of the User assignee
  - team_assignee_id: UUID of the Team assignee
  - organization_assignee_id: UUID of the Organization assignee

Sample Payload:

{
"included_ids": "dee4c835-de7d-4821-a75f-d5f0dd4b7d5d,6ad7b650-b829-4e26-b148-b5cafbdfa487",
"action": "assign",
"data": {
"assignee_id": "a82de24a-aab0-449e-abc7-7ca471a61d34",
"organization_assignee_id": "8a33e1fc-f4f6-475e-a97d-5e70115eb380",
"team_assignee_id": null
}
}

Revert Assignee

Remove assignee from equipment level to use property/default level assignee.
Use the following URL as a template for this request:

POST https://api.connect.buildingengines.com/pm_programs/{program_uuid}/buildings_equipment/bulk_actions

The payload is an array of JSON objects including the following fields:
- included_ids: Comma separate equipment ids.
- action: The value of action should be “revert_assignee”

Overview

Swagger Documentation

Preventive Maintenance & Inspection Schedules API

Creating Preventive Maintenance Schedule

Creating PM Schedule Using Procedure Library

Creating PM Schedule Using Custom Procedure

Creating Inspection Schedule

Updating PM/Inspection Schedule Property

Updating Specific Properties

Updating PM/Inspection Schedule Equipment

Configuring Schedule by Asset Type

Configuring Schedule by Specific Equipment

Updating Inspection Schedule Space

Configuring by All Spaces

Configuring By Specific Spaces

Adding Scheduling Related Information to PM/Inspection Schedule

Updating Status of PM/Inspection Schedule

Cloning PM/Inspection Schedule

Fire Now API

Fire Now API for PM Schedule

Fire Now API for Inspection Schedule

Fire Now for Inspection Property Schedule

All Property

Fire Now for Inspection Equipment Schedule

Fire Task Based on Asset Type

Fire Task Based on Specific Equipment

Fire Now for Inspection Space Schedule

Fire Now for Inspection Move In Move Out Schedule

PM Schedule Bulk Operation to Update Equipments

Override Schedule

Revert to Default Schedule

Override Assignee

Revert Assignee

Categories

Toggle navigation menu

<%= category.name %>

Overview

Swagger Documentation

Preventive Maintenance & Inspection Schedules API

Creating Preventive Maintenance Schedule

Creating PM Schedule Using Procedure Library

Creating PM Schedule Using Custom Procedure

Creating Inspection Schedule

Updating PM/Inspection Schedule Property

Updating Specific Properties

Updating PM/Inspection Schedule Equipment

Configuring Schedule by Asset Type

Configuring Schedule by Specific Equipment

Updating Inspection Schedule Space

Configuring by All Spaces

Configuring By Specific Spaces

Adding Scheduling Related Information to PM/Inspection Schedule

Updating Status of PM/Inspection Schedule

Cloning PM/Inspection Schedule

Fire Now API

Fire Now API for PM Schedule

Fire Now API for Inspection Schedule

Fire Now for Inspection Property Schedule

All Property

Fire Now for Inspection Equipment Schedule

Fire Task Based on Asset Type

Fire Task Based on Specific Equipment

Fire Now for Inspection Space Schedule

Fire Now for Inspection Move In Move Out Schedule

PM Schedule Bulk Operation to Update Equipments

Override Schedule

Revert to Default Schedule

Override Assignee

Revert Assignee

Related articles

Categories

Toggle navigation menu

<%= category.name %>

Categories

Categories