Web Central REST API
Version: 1.0.0
Access
[ Jump to Models ]
Table of Contents
Up
delete /v1/checklist/answer/bulk-delete
Bulk delete checklist answers for questions. (v1ChecklistAnswerBulkDeleteDelete)
Query parameters
checklistId (required)
Query Parameter — Checklist ID.
eventId (required)
Query Parameter — Event ID.
questions (required)
Query Parameter — IDs of questions.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated checklist questions.
ArrayOfRecordsWithObjectValues
Up
delete /v1/checklist/answer
Delete checklist answer. (v1ChecklistAnswerDelete)
Query parameters
id (required)
Query Parameter — Answer ID.
checklistId (required)
Query Parameter — Checklist ID.
questionId (required)
Query Parameter — Question ID.
eventId (required)
Query Parameter — Event ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated answers of the question.
ArrayOfRecordsWithObjectValues
Up
post /v1/checklist/answer
Save checklist answer. (v1ChecklistAnswerPost)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated answer.
RecordWithObjectValues
Up
post /v1/checklist/complete
Complete checklist. (v1ChecklistCompletePost)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — checklist.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated checklist questions.
ArrayOfRecordsWithObjectValues
Query all checklists of work request. (v1ChecklistGet)
Query parameters
wrId (required)
Query Parameter — Work request ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Checklists.
ArrayOfRecordsWithObjectValues
Up
get /v1/checklist/{id}/questions
Query checklist questions. (v1ChecklistIdQuestionsGet)
Path parameters
id (required)
Path Parameter — ID.
Query parameters
eventId (optional)
Query Parameter — event ID. default: 0
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Checklists.
ArrayOfRecordsWithObjectValues
Up
post /v1/checklist/question
Save all answers for question. (v1ChecklistQuestionPost)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Question.
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated question.
RecordWithObjectValues
Query records. (v1DataGet)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Filter clauses.
Query parameters
viewName (optional)
Query Parameter — View file name.
dataSource (required)
Query Parameter — Data source name.
pageStart (optional)
Query Parameter — 0-based index of the first record. default: 0
pageSize (optional)
Query Parameter — Number of records to retrieve. default: 0
filter (optional)
Query Parameter — URL filter.
dataSourceParameters (optional)
Query Parameter — Data source parameters.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Array of records.
ArrayOfRecordsWithObjectValues
Create, update, delete records using specified data source. (v1DataPost)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Array of records.
Query parameters
viewName (optional)
Query Parameter — View file name.
dataSource (required)
Query Parameter — Data source name.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Array of records.
ArrayOfRecordsWithObjectValues
Find document for specified inventory record, create temporary file and return it's URL. (v1DocumentGet)
Query parameters
tableName (required)
Query Parameter — Inventory table name.
fieldName (required)
Query Parameter — Inventory field name.
keys (required)
Query Parameter — Primary keys of inventory record.
Return type
Example data
Content-Type: application/json
{
"key" : ""
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Key-value pairs: url (URL of the file), fileName, thumbUrl, fileContent.
RecordWithStringValues
Upload document and attach it to specified inventory record. (v1DocumentPost)
Consumes
This API call consumes the following media types via the request header:
Query parameters
tableName (required)
Query Parameter — Inventory table name.
fieldName (required)
Query Parameter — Inventory field name.
keys (required)
Query Parameter — Primary keys of inventory record.
Form parameters
orderId (required)
Form Parameter —
userId (required)
Form Parameter —
fileName (required)
Form Parameter — format: binary
Responses
200
OK.
Query equipments. (v1EquipmentGet)
Query parameters
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
filter (optional)
Query Parameter — Filter values.
searchTerm (optional)
Query Parameter — Search term.
sort (optional)
Query Parameter — Sort fields.
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Equipments.
RecordWithObjectValues
Up
get /v1/equipment/{id}/workrequests
Query equipment work requests. (v1EquipmentIdWorkrequestsGet)
Path parameters
id (required)
Path Parameter — Equipment ID.
Query parameters
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
searchTerm (optional)
Query Parameter — Search term.
sort (optional)
Query Parameter — Sort fields.
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work requests.
RecordWithObjectValues
Up
get /v1/floorplan/exists
Check if floor plan SVG file for specified building and floor exists. (v1FloorplanExistsGet)
Query parameters
buildingId (required)
Query Parameter — Building ID.
floorId (required)
Query Parameter — Floor ID.
Return type
Boolean
Example data
Content-Type: application/json
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
true if floor plan exists, false otherwise.
Boolean
Get floor plan for specified building and floor. (v1FloorplanGet)
Query parameters
buildingId (required)
Query Parameter — Building ID.
floorId (required)
Query Parameter — Floor ID.
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
BASE64-encoded SVG file content.
String
Up
get /v1/onsite/localization
Query OnSite localized enum strings and locale attributes for current user locale. (v1OnsiteLocalizationGet)
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Localized strings and locale attributes.
RecordWithObjectValues
Up
delete /v1/onsite/notification/bulk-delete
Delete all my notifications. (v1OnsiteNotificationBulkDeleteDelete)
Return type
Boolean
Example data
Content-Type: application/json
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
true.
Boolean
Up
delete /v1/onsite/notification
Delete notification. (v1OnsiteNotificationDelete)
Query parameters
id (required)
Query Parameter — Notification ID.
Return type
Boolean
Example data
Content-Type: application/json
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
true.
Boolean
Up
get /v1/onsite/notification
Query notifications. (v1OnsiteNotificationGet)
Query parameters
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Notifications.
RecordWithObjectValues
Up
get /v1/onsite/offline/buidlings
Get buidlings modified since lastSyncTime. (v1OnsiteOfflineBuidlingsGet)
Query parameters
lastSyncTime (optional)
Query Parameter — Last sync time. default: 0 format: int64
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Buidlings.
ArrayOfRecordsWithObjectValues
Up
post /v1/onsite/offline/checkConflict
Check Sync conflict. (v1OnsiteOfflineCheckConflictPost)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Conflict result.
RecordWithObjectValues
Up
get /v1/onsite/offline/deleted_data
Get deleted data modified since lastSyncTime. (v1OnsiteOfflineDeletedDataGet)
Query parameters
lastSyncTime (optional)
Query Parameter — Last sync time. default: 0 format: int64
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Deleted data.
ArrayOfRecordsWithObjectValues
Up
get /v1/onsite/offline/equipments
Get equipments modified since lastSyncTime. (v1OnsiteOfflineEquipmentsGet)
Query parameters
lastSyncTime (optional)
Query Parameter — Last sync time. default: 0 format: int64
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Equipments.
ArrayOfRecordsWithObjectValues
Up
get /v1/onsite/offline/floors
Get floors modified since lastSyncTime. (v1OnsiteOfflineFloorsGet)
Query parameters
lastSyncTime (optional)
Query Parameter — Last sync time. default: 0 format: int64
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Floors.
ArrayOfRecordsWithObjectValues
Up
get /v1/onsite/offline/persons
Get persons modified since lastSyncTime. (v1OnsiteOfflinePersonsGet)
Query parameters
lastSyncTime (optional)
Query Parameter — Last sync time. default: 0 format: int64
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Persons.
ArrayOfRecordsWithObjectValues
Up
get /v1/onsite/offline/problem_types
Get problem types modified since lastSyncTime. (v1OnsiteOfflineProblemTypesGet)
Query parameters
lastSyncTime (optional)
Query Parameter — Last sync time. default: 0 format: int64
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Problem types.
ArrayOfRecordsWithObjectValues
Up
get /v1/onsite/offline/rooms
Get rooms modified since lastSyncTime. (v1OnsiteOfflineRoomsGet)
Query parameters
lastSyncTime (optional)
Query Parameter — Last sync time. default: 0 format: int64
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Rooms.
ArrayOfRecordsWithObjectValues
Up
get /v1/onsite/offline/sites
Get sites modified since lastSyncTime. (v1OnsiteOfflineSitesGet)
Query parameters
lastSyncTime (optional)
Query Parameter — Last sync time. default: 0 format: int64
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Sites.
ArrayOfRecordsWithObjectValues
Up
get /v1/onsite/offline/workrequests
Get work requests modified since lastSyncTime. (v1OnsiteOfflineWorkrequestsGet)
Query parameters
lastSyncTime (optional)
Query Parameter — Last sync time. default: 0 format: int64
pageStart (optional)
Query Parameter — Page start. default: 0
pageSize (optional)
Query Parameter — Page size. default: 10
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work requests.
ArrayOfRecordsWithObjectValues
Up
get /v1/onsite/usage-analytics/common-properties
Get event properties. (v1OnsiteUsageAnalyticsCommonPropertiesGet)
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Event properties.
RecordWithObjectValues
Up
get /v1/service-desk/requests
Retrieves a list of service requests based on optional filters, selected fields, and pagination parameters. Returns all matching records or a paginated subset. (v1ServiceDeskRequestsGet)
Consumes
This API call consumes the following media types via the request header:
Request Body (Optional)
Body Parameter — A JSON array of filter conditions. Each condition is a key-value pair where the key is the field name, and the value is the filter value. Example:
[{
"fieldName": "prob_type",
"filterValue": "%",
"filterOperation": "LIKE"
}]
Query Parameters
fields (optional)
Query Parameter — Specifies which fields to include in the response. If not provided, all fields are returned. Example: fields=activity_type,site_id
pageStart (optional)
Query Parameter — The zero-based index of the first record to return (used for pagination). Default: 0
pageSize (optional)
Query Parameter — The number of records to retrieve. If 0, all records are returned. Default: 0
Return type
Example data
Content-Type: application/json
1. Retrieve all service requests
[
{
"activity_log_id": 1,
"activity_type": "REGULATION - ADA COMPLIANCE REVIEW",
"bl_id": "STOWER",
"site_id": "NORTH",
"description": "Determine the work required to make the elevator landing on the 17th floor of the HQ building handicap accessible.",
"key": 1,
"status": "PLANNED"
},
{
"activity_log_id": 2,
"activity_type": "PROPERTY - MAINTENANCE",
"description": "Cleaning",
"key": 2,
"status": "COMPLETED"
}
]
2. Retrieve specific fields (activity_type, site_id)
[
{
"activity_log_id": 1,
"activity_type": "REGULATION - ADA COMPLIANCE REVIEW",
"site_id": "NORTH"
},
{
"activity_log_id": 2,
"activity_type": "PROPERTY - MAINTENANCE"
}
]
3. Paginated response with fields (activity_type, site_id, bl_id) and first 5 records
[
{
"activity_log_id": 1,
"activity_type": "REGULATION - ADA COMPLIANCE REVIEW",
"bl_id": "STOWER",
"site_id": "NORTH"
},
{
"activity_log_id": 3,
"activity_type": "CORRESPONDENCE - SEND"
},
{
"activity_log_id": 383,
"activity_type": "SERVICE DESK - HOTELING"
},
{
"activity_log_id": 4,
"activity_type": "PROPERTY - GENERAL",
"bl_id": "LX",
"site_id": "MARKET"
},
{
"activity_log_id": 6,
"activity_type": "PROJECT - CONTRACT BID REVIEW"
}
]
4. Filtered response where prob_type is not null
[
{
"activity_log_id": 328,
"rm_id": "106",
"bl_id": "HQ",
"description": "printer gets no power",
"eq_id": "2000000017",
"requestor": "ABERNATHY, ALISON",
"dv_id": "ELECTRONIC SYS.",
"prob_type": "ELECTRICAL",
"activity_type": "SERVICE DESK - MAINTENANCE",
"site_id": "MARKET",
"dp_id": "ENGINEERING",
"fl_id": "18",
"key": 328,
"status": "COMPLETED"
},
{
"activity_log_id": 329,
"rm_id": "207",
"bl_id": "XC",
"description": "replace fridge as soon as possible",
"eq_id": "1900",
"requestor": "ABERNATHY, ALISON",
"dv_id": "ELECTRONIC SYS.",
"prob_type": "OFFICE EQUIPMENT",
"activity_type": "SERVICE DESK - MAINTENANCE",
"site_id": "OLDCITY",
"dp_id": "ENGINEERING",
"fl_id": "04",
"key": 329,
"status": "APPROVED"
}
]
5. Filtered response where site_id = "MARKET"
[
{
"activity_log_id": 4,
"activity_type": "PROPERTY - GENERAL",
"bl_id": "LX",
"site_id": "MARKET",
"description": "Schedule fly over, topographical map.",
"key": 4,
"status": "COMPLETED"
},
{
"activity_log_id": 8,
"activity_type": "SPECIAL EVENTS - PREPARE FOR COMPANY PICNIC",
"bl_id": "HQ",
"site_id": "MARKET",
"description": "Summer company picnic site preparations.",
"key": 8,
"status": "PLANNED"
}
]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Found service requests.
ArrayOfRecordsWithObjectValues
404
Not Found.
Up
delete /v1/service-desk/requests/{id}
Delete service request. (v1ServiceDeskRequestsIdDelete)
This API allows the deletion of an existing service request.
Path parameters
id (required)
Path Parameter — ID of service request.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — JSON object containing the wr_id of the service request.
Example Request
DELETE /v1/service-desk/requests/329
Content-Type: application/json
{
"wr_id": 950000129
}
Responses
200 OK
Success. No response body.
400 Bad Request
If the request body is invalid or missing required fields.
404 Not Found
If no service request exists with the given ID.
Up
delete /v1/service-desk/requests/{id}/doc
Delete document attached to service request. (v1ServiceDeskRequestsIdDocDelete)
This API allows the deletion of a document attached to a service request.
Path parameters
id (required)
Path Parameter —The unique ID of the service request from which the document should be deleted.
Produces
This API call produces the following media types:
Example Request
DELETE /v1/service-desk/requests/63/doc?field=doc1
Responses
200 OK
Success. No response body.
Up
get /v1/service-desk/requests/{id}/doc
Downloads a document or image attached to the service request. (v1ServiceDeskRequestsIdDocGet)
This API allows downloading a document attached to a service request. The document is retrieved as a byte stream and returned in the response body.
Path parameters
id (required)
Path Parameter — The unique ID of the service request from which the document should be downloaded.
Query parameters
field (required)
Query Parameter — The document field name (e.g., doc1, doc2) that identifies the document to be downloaded.
Produces
This API call produces the following media types according to the request header; the media type will be conveyed by the response header.
Return type
byte[]
Example Usage
GET /v1/service-desk/requests/63/doc?field=doc1
Responses
200 OK
The binary data of the requested document.
Up
post /v1/service-desk/requests/{id}/doc
Upload document or image and attach it to the service request. (v1ServiceDeskRequestsIdDocPost)
This API allows users to upload a document for a specific service request by specifying the request ID and document field name. The file content is sent as a multipart/form-data request.
Path parameters
id (required)
Path Parameter — The unique ID of the service request to which the document is attached.
Query parameters
field (required)
Query Parameter — The document field name (e.g., doc1, doc2) that identifies the document to be uploaded.
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types via the response header:
Form parameters
file (required)
Form Parameter — Choose a file from your system.
Type: File
Example Usage
POST /v1/service-desk/requests/63/doc?field=doc1
Responses
200 OK
No response body.
Up
get /v1/service-desk/requests/{id}
Query work request. (v1ServiceDeskRequestsIdGet)
This API retrieves details of a service request by its ID. Optionally, specific fields can be queried to limit the response data. If the request is found, it returns a 200 OK status with the requested details. If no request is found, it returns a 404 NOT FOUND status.
Path parameters
id (required)
Path Parameter — The unique ID of the service request to be retrieved.
Query parameters
fields (optional)
Query Parameter — A list of specific field names to include in the response. If not provided, all available fields are returned.
Produces
This API call produces the following media types via the response header:
Return type
Example data
Content-Type: application/json
Request:
GET /v1/service-desk/requests/14386
{
"activity_log_id": 14386,
"dv_id": "FACILITIES",
"prob_type": "PREVENTIVE MAINT",
"rm_id": "340MEC",
"activity_type": "SERVICE DESK - MAINTENANCE",
"bl_id": "NB",
"site_id": "BEDFORD",
"eq_id": "AHU_1",
"dp_id": "MAINTENANCE",
"fl_id": "03",
"key": 14386,
"status": "IN PROGRESS"
}
Response (200 OK)
Request with specific fields:
GET /v1/service-desk/requests/14386?fields=activity_type,site_id
{
"activity_log_id": 14386,
"activity_type": "SERVICE DESK - MAINTENANCE",
"site_id": "BEDFORD"
}
Response (200 OK)
Up
patch /v1/service-desk/requests/{id}
Update service request. (v1ServiceDeskRequestsIdPatch)
This API updates an existing service request by its ID. The request body should contain the fields that need to be updated. It returns an HTTP 200 OK status upon successful update.
Path parameters
id (required)
Path Parameter — The unique ID of the service request to be updated.
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types:
Request body
Body Parameter — A JSON object containing the fields to be updated. Only the specified fields will be modified.
Example Request
Content-Type: application/json
{
"activity_log_id": 9,
"bl_id": "STOWER",
"site_id": "NORTH"
}
Example Usage
PATCH /v1/service-desk/requests/9
Request Body:
{
"activity_log_id": 9,
"bl_id": "STOWER",
"site_id": "NORTH"
}
Responses
200 OK
Up
post /v1/service-desk/requests
Creates a new service request. (v1ServiceDeskRequestsPost)
Creates a new service request based on the provided request body. Upon successful creation, it returns the request details along with the newly generated request ID in the response body.
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header:
Request body
Body Parameter — A JSON object containing the necessary details for creating a request.
Example Request
Content-Type: application/json
{
"activity_type": "REGULATION - ADA COMPLIANCE REVIEW",
"requestor": "AFM",
"prob_type": "HVAC",
"description": "Determine the work required to make the elevator landing on the 17th floor of the HQ building handicap accessible."
}
Example Usage
POST /v1/service-desk/requests
Request Body:
{
"activity_type": "REGULATION - ADA COMPLIANCE REVIEW",
"requestor": "AFM",
"prob_type": "HVAC",
"description": "Determine the work required to make the elevator landing on the 17th floor of the HQ building handicap accessible."
}
Responses
201
Created. The request was successfully created. The response body contains the ID of the created request.
{
"id": 14404
}
400
Bad Request. The request body is invalid or missing required fields.
Query OnSite configuration. (v1TenantConfigGet)
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OnSite configuration.
RecordWithObjectValues
Up
get /v1/usage-analytics/event-properties
Get event properties. (v1UsageAnalyticsEventPropertiesGet)
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Event properties.
Object
Up
get /v1/usage-analytics/javascript
Get JavaScript tracking code. (v1UsageAnalyticsJavascriptGet)
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
JavaScript code.
String
Update user. (v1UserConfigPatch)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
User.
RecordWithObjectValues
Up
get /v1/user/{id}/avatar
Query employee avatar URL link. (v1UserIdAvatarGet)
Path parameters
id (required)
Path Parameter — Employee ID.
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Employee avatar URL link.
String
Query for user. (v1UserIdGet)
Path parameters
id (required)
Path Parameter — User ID.
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
User.
RecordWithObjectValues
Up
put /v1/workflowrule/callWorkflowRuleMethod/{ruleName}
Run specified workflow rule event handler. (v1WorkflowruleCallWorkflowRuleMethodRuleNamePut)
Path parameters
ruleName (required)
Path Parameter — Name of the workflow rule, e.g. AbCommonResources-getJobStatus.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Parameters.
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Outputs.
RecordWithObjectValues
Up
put /v1/workflowrule/callWorkflowRule/{ruleName}
Run specified workflow rule event handler. (v1WorkflowruleCallWorkflowRuleRuleNamePut)
Path parameters
ruleName (required)
Path Parameter — name of the workflow rule, e.g. AbCommonResources-getJobStatus.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Outputs.
RecordWithObjectValues
Delete work log. (v1WorklogDelete)
Query parameters
wrId (required)
Query Parameter — Work request ID.
cfId (required)
Query Parameter — Craftsperson ID.
dateAssigned (required)
Query Parameter — Date assigned.
timeAssigned (required)
Query Parameter — Time assigned.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work logs.
ArrayOfRecordsWithObjectValues
Query for work logs of given work request. (v1WorklogGet)
Query parameters
wrId (required)
Query Parameter — Work request ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work logs.
ArrayOfRecordsWithObjectValues
Update work log. (v1WorklogPatch)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Work log.
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work log.
RecordWithObjectValues
Add new work log. (v1WorklogPut)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Work log.
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work log.
RecordWithObjectValues
Up
delete /v1/workrequest/comments
Delete comments from work request. Uses current user locale. (v1WorkrequestCommentsDelete)
Query parameters
id (required)
Query Parameter — ID.
wrId (required)
Query Parameter — Work request ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work request user activities.
ArrayOfRecordsWithObjectValues
Up
patch /v1/workrequest/comments
Update comments of work request. Uses current user locale. (v1WorkrequestCommentsPatch)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Comments.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work request user activities.
ArrayOfRecordsWithObjectValues
Up
post /v1/workrequest/comments
Add comments to work request. Uses current user locale. (v1WorkrequestCommentsPost)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Comments.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work request user activities.
ArrayOfRecordsWithObjectValues
Up
delete /v1/workrequest/document
Delete document from work request. Uses current user locale. (v1WorkrequestDocumentDelete)
Query parameters
wrId (required)
Query Parameter — Work request ID.
tableName (required)
Query Parameter — Table name.
fieldName (required)
Query Parameter — Field name.
pkeyValue (required)
Query Parameter — Primary key value.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work request user activities.
ArrayOfRecordsWithObjectValues
Up
post /v1/workrequest/document
Add document to work request. (v1WorkrequestDocumentPost)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Document.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work request documents.
ArrayOfRecordsWithObjectValues
Up
get /v1/workrequest/eq/{id}/references
Query equipment references. (v1WorkrequestEqIdReferencesGet)
Path parameters
id (required)
Path Parameter — Equipment ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Equipment references.
ArrayOfRecordsWithObjectValues
Query work requests. (v1WorkrequestGet)
Query parameters
pageStart (optional)
Query Parameter — 0-based index of the first record. default: 0
pageSize (optional)
Query Parameter — Number of records to retrieve. default: 10
filter (optional)
Query Parameter — filter values.
sort (optional)
Query Parameter — sort fields.
userId (optional)
Query Parameter — user ID. default: %
searchTerm (optional)
Query Parameter — search term.
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work requests.
RecordWithObjectValues
Up
get /v1/workrequest/{id}/activity
Query work request user activities. Uses current user locale. (v1WorkrequestIdActivityGet)
Path parameters
id (required)
Path Parameter — Work request ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work request user activities.
ArrayOfRecordsWithObjectValues
Up
get /v1/workrequest/{id}/craftsperson
Query work request assignments. (v1WorkrequestIdCraftspersonGet)
Path parameters
id (required)
Path Parameter — ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work request assignments.
ArrayOfRecordsWithObjectValues
Up
get /v1/workrequest/{id}/documents
Query work request documents. (v1WorkrequestIdDocumentsGet)
Path parameters
id (required)
Path Parameter — Work request ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work request documents.
ArrayOfRecordsWithObjectValues
Up
get /v1/workrequest/{id}
Query work request. (v1WorkrequestIdGet)
Path parameters
id (required)
Path Parameter — ID.
Query parameters
checkPermission (optional)
Query Parameter — true if permission should be checked. default: true
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated work request.
RecordWithObjectValues
Up
get /v1/workrequest/{id}/hasLoggedHours
Check if work request has logged hours. (v1WorkrequestIdHasLoggedHoursGet)
Path parameters
id (required)
Path Parameter — work request ID.
Return type
Boolean
Example data
Content-Type: application/json
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
true or false.
Boolean
Up
get /v1/workrequest/{id}/linkedRequests
Query linked work requests of given work request. (v1WorkrequestIdLinkedRequestsGet)
Path parameters
id (required)
Path Parameter — work request ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Linked work requests.
ArrayOfRecordsWithObjectValues
Up
get /v1/workrequest/{id}/part
Query work request parts. (v1WorkrequestIdPartGet)
Path parameters
id (required)
Path Parameter — Work request ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Parts.
ArrayOfRecordsWithObjectValues
Up
get /v1/workrequest/{id}/references
Query work request references. (v1WorkrequestIdReferencesGet)
Path parameters
id (required)
Path Parameter — work request ID.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Work request references.
ArrayOfRecordsWithObjectValues
Update work request. (v1WorkrequestPatch)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Work request.
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated work request.
RecordWithObjectValues
Up
get /v1/workrequest/persons
Query suggested persons. (v1WorkrequestPersonsGet)
Query parameters
pageStart (optional)
Query Parameter — 0-based index of the first record. default: 0
pageSize (optional)
Query Parameter — Number of records to retrieve. default: 15
filter (optional)
Query Parameter — filter values.
Return type
Example data
Content-Type: application/json
[ {
"key" : {
"code" : 0,
"text" : "text"
}
}, {
"key" : {
"code" : 0,
"text" : "text"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Persons.
ArrayOfRecordsWithObjectValues
Create work request. (v1WorkrequestPost)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Work request.
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created work request.
RecordWithObjectValues
Up
post /v1/workrequest/rm
Query room details. (v1WorkrequestRmPost)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"key" : {
"code" : 0,
"text" : "text"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Room details.
RecordWithObjectValues
404
Not found.
Up
get /v1/workrequest/sla
Get SLA for the given work request. (v1WorkrequestSlaGet)
Query parameters
values (required)
Query Parameter — work request.
Return type
Boolean
Example data
Content-Type: application/json
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
true or false.
Boolean
[ Jump to Methods ]
Table of Contents
ArrayOfRecordsWithObjectValuesArrayOfRecordsWithStringValuesRecordWithObjectValuesRecordWithStringValues