Web Central REST API

Version: 1.0.0

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body map (optional)
Body Parameter — Answer.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body map (optional)
Body Parameter — checklist.

Return type

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Updated checklist questions. ArrayOfRecordsWithObjectValues
Up 
get /v1/checklist
Query all checklists of work request. (v1ChecklistGet)

Query parameters

wrId (required)
Query Parameter — Work request ID.

Return type

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body map (optional)
Body Parameter — Question.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Updated question. RecordWithObjectValues
Up 
get /v1/data
Query records. (v1DataGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (optional)
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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Array of records. ArrayOfRecordsWithObjectValues
Up 
post /v1/data
Create, update, delete records using specified data source. (v1DataPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (required)
Body Parameter — Array of records.

Query parameters

viewName (optional)
Query Parameter — View file name.
dataSource (required)
Query Parameter — Data source name.

Return type

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Array of records. ArrayOfRecordsWithObjectValues
Up 
get /v1/document
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

RecordWithStringValues

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Key-value pairs: url (URL of the file), fileName, thumbUrl, fileContent. RecordWithStringValues
Up 
post /v1/document
Upload document and attach it to specified inventory record. (v1DocumentPost)

Consumes

This API call consumes the following media types via the Content-Type 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.
Up 
get /v1/equipment
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

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

true if floor plan exists, false otherwise. Boolean
Up 
get /v1/floorplan
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 Accept request header; the media type will be conveyed by the Content-Type 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

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type 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

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body map (optional)
Body Parameter — change.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Work requests. ArrayOfRecordsWithObjectValues
Up 
get /v1/onsite/usage-analytics/common-properties
Get event properties. (v1OnsiteUsageAnalyticsCommonPropertiesGet)

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Event properties. RecordWithObjectValues
Up 
get /v1/service-desk/requests
Query for service requests. (v1ServiceDeskRequestsGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (optional)
Body Parameter — Filter clauses.

Query parameters

fields (optional)
Query Parameter — Field names to query and return.
pageStart (optional)
Query Parameter — 0-based index of the first record. default: 0
pageSize (optional)
Query Parameter — Number of records to retrieve, or 0 for all records. default: 0

Return type

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Found work requests. ArrayOfRecordsWithObjectValues

404

Not Found.
Up 
delete /v1/service-desk/requests/{id}
Delete service request. (v1ServiceDeskRequestsIdDelete)

Path parameters

id (required)
Path Parameter — ID of service request.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (required)
Body Parameter — Request.

Responses

200

Work request.
Up 
delete /v1/service-desk/requests/{id}/doc
Delete document attached to service request. (v1ServiceDeskRequestsIdDocDelete)

Path parameters

id (required)
Path Parameter — ID of service request.

Query parameters

field (required)
Query Parameter — The document field name, e.g. doc1.

Responses

200

OK.
Up 
get /v1/service-desk/requests/{id}/doc
Downloads a document or image attached to the service request. (v1ServiceDeskRequestsIdDocGet)

Path parameters

id (required)
Path Parameter — ID of service request.

Query parameters

field (required)
Query Parameter — The document field name, e.g. doc1.

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Document or image. byte[]
Up 
post /v1/service-desk/requests/{id}/doc
Upload document or image and attach it to the service request. (v1ServiceDeskRequestsIdDocPost)

Path parameters

id (required)
Path Parameter — ID of service request.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

field (required)
Query Parameter — The document field name, e.g. doc1.

Form parameters

fileName (required)
Form Parameter — format: binary

Responses

200

OK.
Up 
get /v1/service-desk/requests/{id}
Query work request. (v1ServiceDeskRequestsIdGet)

Path parameters

id (required)
Path Parameter — Service request ID.

Query parameters

fields (optional)
Query Parameter — list of field names to query and return.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Found work request. RecordWithObjectValues

404

Not Found.
Up 
patch /v1/service-desk/requests/{id}
Update service request. (v1ServiceDeskRequestsIdPatch)

Path parameters

id (required)
Path Parameter — ID of service request.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (required)
Body Parameter — Request.

Responses

200

OK.
Up 
put /v1/service-desk/requests
Creates work request. (v1ServiceDeskRequestsPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (required)
Body Parameter — request.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Work request. RecordWithObjectValues
Up 
get /v1/tenant_config
Query OnSite configuration. (v1TenantConfigGet)

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JavaScript code. String
Up 
patch /v1/user/config
Update user. (v1UserConfigPatch)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (required)
Body Parameter — config.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Employee avatar URL link. String
Up 
get /v1/user/{id}
Query for user. (v1UserIdGet)

Path parameters

id (required)
Path Parameter — User ID.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body object (optional)
Body Parameter — Parameters.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body map (optional)
Body Parameter — Inputs.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Outputs. RecordWithObjectValues
Up 
delete /v1/worklog
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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Work logs. ArrayOfRecordsWithObjectValues
Up 
get /v1/worklog
Query for work logs of given work request. (v1WorklogGet)

Query parameters

wrId (required)
Query Parameter — Work request ID.

Return type

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Work logs. ArrayOfRecordsWithObjectValues
Up 
patch /v1/worklog
Update work log. (v1WorklogPatch)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (required)
Body Parameter — Work log.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Work log. RecordWithObjectValues
Up 
put /v1/worklog
Add new work log. (v1WorklogPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (required)
Body Parameter — Work log.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body map (required)
Body Parameter — Comments.

Return type

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body map (required)
Body Parameter — Comments.

Return type

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body map (required)
Body Parameter — Document.

Return type

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Equipment references. ArrayOfRecordsWithObjectValues
Up 
get /v1/workrequest
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

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Work request references. ArrayOfRecordsWithObjectValues
Up 
patch /v1/workrequest
Update work request. (v1WorkrequestPatch)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (optional)
Body Parameter — Work request.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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

ArrayOfRecordsWithObjectValues

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Persons. ArrayOfRecordsWithObjectValues
Up 
post /v1/workrequest
Create work request. (v1WorkrequestPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body map (optional)
Body Parameter — Work request.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body map (required)
Body Parameter — Keys.

Return type

RecordWithObjectValues

Example data

Content-Type: application/json
{
  "key" : {
    "code" : 0,
    "text" : "text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

true or false. Boolean

Models

[ Jump to Methods ]

Table of Contents

  1. ArrayOfRecordsWithObjectValues
  2. ArrayOfRecordsWithStringValues
  3. RecordWithObjectValues
  4. RecordWithStringValues

ArrayOfRecordsWithObjectValues Up

ArrayOfRecordsWithStringValues Up

RecordWithObjectValues Up

RecordWithStringValues Up