1. Overview
The activities app impl service contains a collection of RESTful service calls to retrive information relevent to comments in manufacturing execution.
Description of endpoints can be found in the section headers for each collection of relevent resources.
1.2. Tags
-
activity-controller : Activity Controller
-
activity-creator-controller : Activity Creator Controller
-
activity-editor-controller : Activity Editor Controller
-
activity-history-controller : Activity History Controller
-
activity-viewer-controller : Activity Viewer Controller
-
esignature-controller : Esignature Controller
-
historian-variable-array-data-controller : Historian Variable Array Data Controller
-
monitoring-controller : Monitoring Controller
-
production-event-controller : Production Event Controller
-
test-history-records-controller : Test History Records Controller
-
user-defined-event-controller : User Defined Event Controller
-
user-info-controller : User Info Controller
-
user-settings-controller : User Settings Controller
-
variable-editor-controller : Variable Editor Controller
-
variable-header-controller : Variable Header Controller
-
variable-history-controller : Variable History Controller
2. Resources
2.1. Activity-controller
Activity Controller
2.1.1. Fetches List of records based on the list of activity Ids passed
GET /api/activities
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
activityIds |
List of activity ids whose records needs to be fetched |
< integer (int64) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ActivityInfo > array |
500 |
Internal Server Error |
2.2. Activity-creator-controller
Activity Creator Controller
2.2.1. Create product change event
POST /activity-creator/productChangeEvent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
productChangeRequest |
ProductChangeRequestInfo object to create product change event |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.2.2. Fetches product change state event details
GET /activity-creator/productChangeEvent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitId |
Unit id to fetch the product change event |
integer (int64) |
2.2.3. Fetches product change event for units
GET /activity-creator/productChangeEvent/{eventType}/machines/displays
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventType |
Comma separated eventTypes to filter activities, can be UDE, Production, TimeBased Event and Product Change |
enum (1, 2, 23, 25) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.2.4. Fetches product changed events product codes
GET /activity-creator/productChangeEvent/{productGroupId}/productCodes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
productGroupId |
Product group id to fetch prodcut change event code |
integer (int64) |
2.2.5. Create production event
POST /activity-creator/production
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
createProductionRecordInfo |
ProductionRecordInfo Object to create Production Event |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden , Unit is not configured |
No Content |
500 |
Internal Server Error |
2.2.6. Fetches production record state details
GET /activity-creator/production
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
sheetId |
Sheet id to get production record details |
integer (int64) |
Query |
unitId |
Unit id to get production record details |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.2.7. Create time based event
POST /activity-creator/sheetColumn
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
createSheetColumnRecord |
SheetColumnRecordInfo Object to create Timed Based Event |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden , Unot is not configured |
No Content |
422 |
Unprocessable Entity |
No Content |
500 |
Internal Server Error |
No Content |
2.2.8. Fetches time based event state details
GET /activity-creator/sheetColumn
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
sheetId |
Sheet id to get Time Based record details |
integer (int64) |
Query |
unitId |
Unit id to get Time Based record details |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
2.2.9. Create user defined event
POST /activity-creator/userDefined
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
addUserDefinedRecordInfo |
UserDefinedRecordInfo Object to create user defined event |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden , Unot is not configured |
No Content |
500 |
Internal Server Error |
No Content |
2.2.10. Fetches user defined record state details
GET /activity-creator/userDefined
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
sheetId |
Sheet id to get user defined record details |
integer (int64) |
Query |
unitId |
Unit id to get user defined record details |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.2.11. Fetches sheet displays based on event type enum
GET /activity-creator/{eventType}/displays
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventType |
Comma separated eventTypes to filter activities, can be UDE, Production, TimeBased Event and Product Change |
enum (1, 2, 23, 25) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, No machine is available |
No Content |
500 |
Internal Server Error |
No Content |
2.3. Activity-editor-controller
Activity Editor Controller
2.3.1. Fetches activity comments
GET /activity-editor/comment
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
assetId |
Asset id of an activity to get comment details |
integer (int64) |
Query |
commentId |
Comment id of an activity to get comment details |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
|
503 |
Service Unavailable , Resource access is not allowed |
No Content |
2.3.2. Add activity comments
POST /activity-editor/{activityId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of an activity to which the activity comments will be added |
integer (int64) |
Body |
statusInfo |
ActivityStatusRequest object to add activity comments |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request , Invalid data is supplied |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.3.3. Fetches activity comments
GET /activity-editor/{activityId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of an activity to get comments details |
integer (int64) |
Query |
commentType |
Type of comments for an activity can be General, Overdue, Skip and Activity Detail Comment |
< enum (GENERAL, OVERDUE, SKIP, ACTIVITY_DETAIL) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
|
503 |
Service Unavailable |
No Content |
2.3.4. Update activity comments
PUT /activity-editor/{activityId}/comments/{commentThreadId}/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of an activity to update comments |
integer (int64) |
Path |
commentId |
Comment id of an activity to update comment details |
integer (int64) |
Path |
commentThreadId |
Chained commentThreadId to update activity comments |
integer (int64) |
Query |
unitId |
Unit id of an activity to update comment |
integer (int64) |
Body |
activityInfo |
ActivityStatusRequest object to update activity comments |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
|
503 |
Service Unavailable , Resource access is not allowed |
No Content |
2.3.5. Delete activity comments
DELETE /activity-editor/{activityId}/comments/{commentThreadId}/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
activity id of an activity to delete a comments |
integer (int64) |
Path |
commentId |
Comment id of an activity to delete comment details |
integer (int64) |
Path |
commentThreadId |
Chained comment thread id to delete activity comments |
integer (int64) |
Query |
commentType |
Type of comment can be General, Overdue and Skip |
string |
Query |
unitId |
Unit id of an activity to delete comments data |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Service Unavailable , Resource access is not allowed |
No Content |
2.4. Activity-history-controller
Activity History Controller
2.4.1. Fetches the activity records
GET /activity-history
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
activityId |
Activity id to get the page that contains this activity. Page parameter is ignored if activity id is provided |
integer (int64) |
|
Query |
batchNumber |
Filtering activities by batch number |
string |
|
Query |
completeType |
Filter list of complete type of activities can be 0 - Manual Complete,1 - Auto Complete on status 100%,2 - Auto Complete previous activities,3- System Complete activities after duration |
enum (0, 1, 2, 3) |
|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
equipments |
Comma separated list of unit ids |
string |
|
Query |
eventNumber |
Filtering activities by event number |
string |
|
Query |
eventTypes |
Comma separated eventTypes to filter activities, can be UDE, Production, TimeBased Event and Product Change |
enum (1, 2, 23, 25) |
|
Query |
excludeActionLinks |
Optional flag telling the api whether to include hatheos links for actions Perform, Skip, in progress, Complete, Release and get comments in the response, defaults to true |
boolean |
|
Query |
isOverdue |
If true returns only overdue activities. |
integer (int32) |
|
Query |
page |
Results per page you want to retrieve (0..500) |
integer (int32) |
|
Query |
processOrderName |
Filtering activities by process order name |
string |
|
Query |
processOrders |
Comma separated list of process order ids |
string |
|
Query |
productCode |
Filtering activities by product code |
string |
|
Query |
products |
Comma separated list of product ids |
string |
|
Query |
size |
Number of records per page. |
integer (int32) |
|
Query |
sortColumn |
Optional sort column of activities, can be Activity, TimeDue, DueIn, PercentComplete, UserName, Duration, EndTime |
string |
|
Query |
sortOrder |
Ascending or descending order of data |
string |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
status |
Comma saperated list of activity status, can be 1-Not Started, 2-In Progress, 3-Complete, 4-Skipped, 5-Released |
string |
|
Query |
timeSelection |
Time selection values |
integer (int64) |
|
Query |
timeZone |
Time zone of startTime and endTime |
string |
|
Query |
variables |
Filtering activities by variable name. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content, Unit is not configured |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.4.2. Fetches the activity details by activity id
GET /activity-history/activity/{activityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
activity id of activity to get the activity record |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Service Unavailable , Resource access is not allowed |
2.4.3. Update activity record
PUT /activity-history/activity/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Id of activity id to update the activity record |
integer (int64) |
Body |
statusInfo |
ActivityStatusRequest object to update an activity record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden , User is not allowed to update the activity record |
|
500 |
Internal Server Error |
|
503 |
Service Unavailable |
2.4.4. This end point is used to clear the information of activities. This would be deprecated to the future
DELETE /activity-history/cache
2.4.5. Fetches activites view options like time selections, view by groups and create activities details
GET /activity-history/context-loader
|
Caution
|
operation.deprecated |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.4.6. Activities equipment options
GET /activity-history/equipments
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content , Unit is not configured |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.4.7. Activities filter options
GET /activity-history/filter-options
|
Caution
|
operation.deprecated |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content , Unit is not configured |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.4.8. Fetches the time selection intervals
GET /activity-history/time-selection
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
equipmentId |
Comma separated list of equipment Ids. |
< string > array(multi) |
Query |
equipmentType |
Equipment type values are 1 for Units, 2 for Lines, 3 for Departments. |
integer (int32) |
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.4.9. Fetches the time Selection options available for activities app
GET /activity-history/timeSelectionOptions
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< IdNameValue > array |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.5. Activity-viewer-controller
Activity Viewer Controller
2.5.1. Fetches the activity records
GET /activity-viewer
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
activityId |
Activity id to get the page that contains this activity. Page parameter is ignored if activity id is provided |
integer (int64) |
|
Query |
batchNumber |
Filtering activities by batch number |
string |
|
Query |
completeType |
Filter list of complete type of activities can be 0 - Manual Complete,1 - Auto Complete on status 100%,2 - Auto Complete previous activities,3- System Complete activities after duration |
enum (0, 1, 2, 3) |
|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
equipments |
Comma separated list of unit ids |
string |
|
Query |
eventNumber |
Filtering activities by event number |
string |
|
Query |
eventTypes |
Comma separated eventTypes to filter activities, can be UDE, Production, TimeBased Event and Product Change |
enum (1, 2, 23, 25) |
|
Query |
excludeActionLinks |
Optional flag telling the api whether to include hatheos links for actions Perform, Skip, in progress, Complete, Release and get comments in the response, defaults to true |
boolean |
|
Query |
isOverdue |
If true returns only overdue activities. |
integer (int32) |
|
Query |
page |
Results per page you want to retrieve (0..500) |
integer (int32) |
|
Query |
processOrderName |
Filtering activities by process order name |
string |
|
Query |
processOrders |
Comma separated list of process order ids |
string |
|
Query |
productCode |
Filtering activities by product code |
string |
|
Query |
products |
Comma separated list of product ids |
string |
|
Query |
size |
Number of records per page. |
integer (int32) |
|
Query |
sortColumn |
Optional sort column of activities, can be Activity, TimeDue, DueIn, PercentComplete, UserName, Duration, EndTime |
string |
|
Query |
sortOrder |
Ascending or descending order of data |
string |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
status |
Comma saperated list of activity status, can be 1-Not Started, 2-In Progress, 3-Complete, 4-Skipped, 5-Released |
string |
|
Query |
timeSelection |
Time selection values |
integer (int64) |
|
Query |
timeZone |
Time zone of startTime and endTime |
string |
|
Query |
variables |
Filtering activities by variable name. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content, Unit is not configured |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.5.2. Fetches List of activityIds by testRecordId
GET /activity-viewer/activities
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
testRecordId |
Test record id to get the list of activity ids |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.5.3. Fetches the activity records
GET /activity-viewer/activities/{viewBy}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
viewBy |
viewBy |
enum (Product, ProcessOrder, Equipment, Event, Activity) |
|
Query |
activityId |
Activity id to get the page that contains this activity. Page parameter is ignored if activityId is provided |
integer (int64) |
|
Query |
batchNumber |
Filtering activities by batch number |
string |
|
Query |
completeType |
Filter list of complete type of activities can be 0 - Manual Complete,1 - Auto Complete on status 100%,2 - Auto Complete previous activities,3- System Complete activities after duration |
enum (0, 1, 2, 3) |
|
Query |
displayType |
Filtering activities by display type can be 0-Standard or 1-Custom |
integer (int32) |
|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
equipments |
Comma separated list of unit ids |
string |
|
Query |
eventNumber |
Filtering activities by event number |
string |
|
Query |
eventTypes |
Comma separated eventTypes to filter activities, can be UDE, Production, TimeBased Event and Product Change |
enum (1, 2, 23, 25) |
|
Query |
isOverdue |
If true returns only overdue activities. |
integer (int32) |
|
Query |
processOrderName |
Filtering activities by process order name |
string |
|
Query |
processOrders |
Comma separated list of process order ids |
string |
|
Query |
productCode |
Filtering activities by product code |
string |
|
Query |
products |
Comma separated list of product ids |
string |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
status |
Comma saperated list of activity status, can be 1-Not Started, 2-In Progress, 3-Complete, 4-Skipped, 5-Released |
enum (1, 2, 3, 4, 5) |
|
Query |
timeSelection |
Time selection values |
integer (int64) |
|
Query |
timeZone |
Time zone of startTime and endTime |
string |
|
Query |
variables |
Filtering activities by variable name. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.5.4. Fetches the activity details by activity id
GET /activity-viewer/activity/{activityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
activity id of activity to get the activity record |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Service Unavailable , Resource access is not allowed |
2.5.5. Update activity record
PUT /activity-viewer/activity/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Id of activity id to update the activity record |
integer (int64) |
Body |
statusInfo |
ActivityStatusRequest object to update an activity record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden , User is not allowed to update the activity record |
|
500 |
Internal Server Error |
|
503 |
Service Unavailable |
2.5.6. This end point is used to clear the information of activities. This would be deprecated to the future
DELETE /activity-viewer/cache
2.5.7. Fetches activites view options like time selections, view by groups and create activities details
GET /activity-viewer/context-loader
|
Caution
|
operation.deprecated |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.5.8. Activities equipment options
GET /activity-viewer/equipments
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content , Unit is not configured |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.5.9. Activities filter options
GET /activity-viewer/filter-options
|
Caution
|
operation.deprecated |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content , Unit is not configured |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.5.10. Fetches the time selection intervals
GET /activity-viewer/time-selection
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
equipmentId |
Comma separated list of equipment Ids. |
< string > array(multi) |
Query |
equipmentType |
Equipment type values are 1 for Units, 2 for Lines, 3 for Departments. |
integer (int32) |
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.5.11. Fetches the time Selection options available for activities app
GET /activity-viewer/timeSelectionOptions
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< IdNameValue > array |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.6. Esignature-controller
Esignature Controller
2.7. Historian-variable-array-data-controller
Historian Variable Array Data Controller
2.7.1. Get information about the data values for an array data type variable’s historian tag
GET /historianVariableArrayData
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
arrayId |
ArrayId whose data points need to be pulled in |
integer (int64) |
Query |
historianInputTag |
Input tag column value for a historian variable |
string |
2.8. Monitoring-controller
Monitoring Controller
2.8.1. Fetches status for proficy message bridge
GET /monitoring-viewer/messageBridgeStatus
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content, no service exists |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.8.2. Fetches status for proficy message bridge
GET /monitoring-viewer/messagingStatus
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content, no service exists |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.9. Production-event-controller
Production Event Controller
2.9.1. Fetches a production record
GET /productionEvent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of an event to get a production record |
integer (int64) |
Query |
sheetId |
Sheet id to get the event header of production event |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.9.2. Update a production record by event id
PUT /productionEvent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of an event to update a production record |
integer (int64) |
Body |
updatedProductionRecordInfo |
ProductionRecordInfo object to update the production record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
412 |
Precondition Failed |
No Content |
500 |
Internal Server Error |
No Content |
2.9.3. Fetches a production record status by event id
GET /productionEvent/productionEventStatusOptions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of an event to get a production record status |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found, Resource is not found. |
No Content |
500 |
Internal Server Error |
No Content |
2.9.4. Creates production event comments
POST /productionEvent/{eventId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to create a production event comments |
integer (int64) |
Query |
sheetId |
sheetId |
integer (int64) |
Body |
productionEventUpdates |
ProductionEventUpdates object to create a prodcution event comment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.9.5. Fetches a production record status by event id
GET /productionEvent/{eventId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to get a production record status |
integer (int64) |
Query |
sheetId |
Sheet id to get a production event comment |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Service Unavailable |
No Content |
2.9.6. Update a production event comment
PUT /productionEvent/{eventId}/comments/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
Comment id of the comment to update |
integer (int64) |
Path |
eventId |
Event id of an event to update a production event comments |
integer (int64) |
Query |
commentThreadId |
Comment thread id of the comment to update |
integer (int64) |
Query |
sheetId |
Sheet id to update a production event comments |
integer (int64) |
Body |
productionEventUpdates |
ProductionEventUpdates Object to update a comment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Service Unavailable |
No Content |
2.9.7. Delete production record state details
DELETE /productionEvent/{eventId}/comments/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
Comment thread id of the comment to delete |
integer (int64) |
Path |
eventId |
Event id of an event to delete a production event comments |
integer (int64) |
Query |
commentThreadId |
Comment thread id of the comment to delete |
integer (int64) |
Query |
sheetId |
Sheet id to update a production event comments |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Service Unavailable |
No Content |
2.10. Test-history-records-controller
Test History Records Controller
2.10.1. Fetches the esignature test value records history
GET /testHistory
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
Page number to fetch. Defaults to 0 |
integer (int32) |
|
Query |
size |
Number of records per page. Defaults to 20 |
integer (int32) |
|
Query |
testId |
Test Id whose history values is to be fetched |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< TestHistoryRecord > array |
401 |
Unauthorized |
No Content |
500 |
Internal Server error, See logs for details |
No Content |
2.11. User-defined-event-controller
User Defined Event Controller
2.11.1. Fetches user defined record details
GET /userDefinedEvent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of an event to get user defined record details |
integer (int64) |
Query |
sheetId |
Sheet id to get user defined record details |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.11.2. Update user defined record details
PUT /userDefinedEvent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of an event to update user defined record details |
integer (int64) |
Body |
updatedUserDefinedRecordInfo |
UserDefinedRecordInfo object to update user defined record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.11.3. Fetches user defined status options
GET /userDefinedEvent/userDefinedEventStatusOptions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of an event to get user defined record status options |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
2.11.4. Create user defined event comments
POST /userDefinedEvent/{eventId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id to get Userdefined record comment details |
integer (int64) |
Query |
sheetId |
Sheet id to fetch user defined comments details |
integer (int64) |
Body |
userDefinedEventUpdates |
UserDefinedUpdates object to create user defined event comment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.11.5. Fetches userdefined record comments details
GET /userDefinedEvent/{eventId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to get user defined event comments |
integer (int64) |
Query |
sheetId |
Sheet id to fetch user defined comments details |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Service Unavailable |
No Content |
2.11.6. Delete user defined event comments based on comment id
DELETE /userDefinedEvent/{eventId}/comments/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
Comment id to delete user defined event comment details |
integer (int64) |
Path |
eventId |
Event id of an event to delete user defined record comment details |
integer (int64) |
Query |
commentThreadId |
comment thread id to delete user defined event comment details |
integer (int64) |
Query |
sheetId |
Sheet id to update user defined event comment details |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Service Unavailable |
No Content |
2.11.7. Update existing user defined record comments based on comment thread id and comment id
PUT /userDefinedEvent/{eventId}/comments/{commentThreadId}/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
Comment id to update user defined event comment details |
integer (int64) |
Path |
commentThreadId |
comment thread id to update user defined event comment details |
integer (int64) |
Path |
eventId |
Event id of an event to update user defined record comment details |
integer (int64) |
Query |
sheetId |
Sheet id to update user defined event comment details |
integer (int64) |
Body |
userDefinedEventUpdates |
UserDefinedUpdates Object to update user defined event comment details |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Service Unavailable |
No Content |
2.12. User-info-controller
User Info Controller
2.13. User-settings-controller
User Settings Controller
2.13.1. Create User settings for the logged in user
POST /v2/settings
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
204 |
No Content, Error retrieving created user settings |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
App ID not found in privilege set |
|
409 |
Conflict, User Setting already exists. Use a PUT to update |
|
500 |
Internal Server Error |
2.13.2. Get User settings for the logged in User
GET /v2/settings
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
appId |
appId |
integer (int32) |
Query |
viewName |
viewName |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, no user setting found for the user |
|
500 |
Internal Server Error |
2.13.3. Update User settings for the logged in user
PUT /v2/settings
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not Found, There is no saved User settings for the logged in user |
|
500 |
Internal Server Error |
2.13.4. Delete User settings for the logged in user
DELETE /v2/settings
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
appId |
appId |
integer (int32) |
Query |
viewName |
viewName |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
Success |
object |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not Found, User Setting not found |
|
500 |
Internal Server Error |
2.13.5. Get Privilege Sets
GET /v2/settings/apps
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< PrivilegeSet > array |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, no user setting found for the user |
|
500 |
Internal Server Error |
2.14. Variable-editor-controller
Variable Editor Controller
2.14.1. Fetches activity variables details
GET /variable-editor
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
activityId |
Activity id of an activity to get edit state of an activity |
integer (int64) |
|
Query |
enableVariableScrolling |
Enable variable scrolling for scrolling activities variables |
boolean |
|
Query |
page |
Page Number (0..500) |
integer (int32) |
|
Query |
size |
Number of records per page. |
integer (int32) |
|
Query |
variableFilter |
variableFilter used to encoding. The default value is UTF-8 |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.14.2. Update activity variable from edit state
PUT /variable-editor
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
activityId |
Activity id of an activity to update activity variable |
integer (int64) |
Query |
variableId |
Variable id of an activity to update activity variable |
integer (int64) |
Body |
activityVariableUpdates |
ActivityVariableUpdates object to update acitivity variables |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
2.14.3. Fetches production event information for an activity
GET /variable-editor/productionEvent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of events to get production event for an activity |
integer (int64) |
Query |
sheetId |
Sheet id to get production event for an activity |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.14.4. Update production record
PUT /variable-editor/productionEvent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of events to get produciton event status for an activity |
integer (int64) |
Body |
updatedProductionRecordInfo |
ProductionRecordInfo object to update production event for an activity |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.14.5. Fetches production event status options for an event
GET /variable-editor/productionEventStatusOptions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of events to get produciton event status for an activity |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
2.14.6. Fetches user defined event information for an activity
GET /variable-editor/userDefinedEvent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of events to get user defined event for an activity |
integer (int64) |
Query |
sheetId |
Sheet id get user defined event for an activity |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.14.7. Update user defined event information for an activity
PUT /variable-editor/userDefinedEvent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of events to update user defined event for an activity |
integer (int64) |
Body |
updatedUserDefinedRecordInfo |
UserDefinedRecordInfo object to update user defined event for an activity |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.14.8. Fetches user defined event status options for an event
GET /variable-editor/userDefinedEventStatusOptions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventId |
Event id of events to get user defined status for an activity |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.14.9. Add variable comments
POST /variable-editor/{variableId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
variableId |
Variable id of an activity to add variable comments |
integer (int64) |
Query |
activityId |
Activity id of an activity to add variable comments |
integer (int64) |
Body |
activityVariableUpdates |
ActivityVariableUpdates object to add variable comments |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.14.10. Fetches variable comments
GET /variable-editor/{variableId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
variableId |
Variable id of an activity to get variables comments |
integer (int64) |
Query |
activityId |
Activity id of an activity to get variables comments |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Service Unavailable, Resource access is not allowed |
No Content |
2.14.11. Update variable comments record
PUT /variable-editor/{variableId}/comments/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
Comment id of an activity to update variable comments |
integer (int64) |
Path |
variableId |
Variable id of an activity to update variable comments |
integer (int64) |
Query |
activityId |
Activity id of an activity to update variable comments |
integer (int64) |
Query |
commentThreadId |
Comment Thread Id of an activity to update variable comments |
integer (int64) |
Body |
commentInfo |
CommentInfo objcet to update a variable comments |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
|
503 |
Service Unavailable, Resource access is not allowed |
No Content |
2.14.12. Delete varible comments
DELETE /variable-editor/{variableId}/comments/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
Comment id of an activity to delete a variable comments |
integer (int64) |
Path |
variableId |
Varible id of an activity to delete a variable comments |
integer (int64) |
Query |
activityId |
Activity id of an activity to delete a variable comments |
integer (int64) |
Query |
commentThreadId |
Comment thread id of an activity to delete a variable comments |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
|
503 |
Service Unavailable, Resource access is not allowed |
No Content |
2.15. Variable-header-controller
Variable Header Controller
2.15.1. Fetches activity header details
GET /variable-header
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
activityId |
Activity id of an activity to get activity header |
integer (int64) |
2.16. Variable-history-controller
Variable History Controller
2.16.1. Fetches the history of Activity along with the test data on each activity
GET /variable-history
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
activityId |
activityId |
integer (int64) |
|
Query |
directionBackward |
Optional Input parameter for direction to determine if returned activities come before or after activityId |
boolean |
|
Query |
isInclusive |
Optional Input parameter for is inclusive to determine whether to include the activity details of the activityId passed as the first parameter |
boolean |
|
Query |
sameProduct |
Fetch the details of activities with same product as the activityId given in first parameter |
boolean |
|
Query |
sheetId |
Sheet id to get variable history of an activity |
integer (int64) |
|
Query |
size |
Number of records to fetch |
integer (int32) |
|
Query |
startActivityId |
Start activity id to get the starting point for the variable history |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
3. Definitions
3.1. ActivityCustomForm
| Name | Schema |
|---|---|
customActivityUser |
|
externalURL |
string |
openURL |
3.2. ActivityEditorState
| Name | Schema |
|---|---|
activityInfo |
|
eventInfo |
|
variableInfo |
|
variablePages |
3.3. ActivityHeaderInfo
| Name | Schema |
|---|---|
activityDescription |
string |
activityTypeId |
integer (int64) |
endTime |
string (date-time) |
isAppliedProduct |
boolean |
isDisplayUnits |
boolean |
isLocked |
boolean |
keyId |
string (date-time) |
keyId1 |
integer (int64) |
lockEventData |
boolean |
lockUnavailableCells |
boolean |
processOrder |
string |
product |
string |
sheetId |
integer (int64) |
startTime |
string (date-time) |
unitId |
integer (int64) |
user |
3.4. ActivityInfo
| Name | Schema |
|---|---|
activityId |
integer (int64) |
activityName |
string |
activityType |
|
asset |
|
commentHistory |
< Resource«CommentInfo» > array |
commentsThreadId |
integer (int64) |
completedTime |
string (date-time) |
completedType |
|
customFormData |
|
displayTypeId |
integer (int64) |
dueIn |
integer (int64) |
duration |
integer (int64) |
durationIn |
string |
estimatedStartTime |
string (date-time) |
eventNumber |
string |
hasAvailableCells |
boolean |
hasVariableAliasing |
boolean |
isLikelyOverdueActivity |
boolean |
isOverdueActivity |
boolean |
keyId |
integer (int64) |
keyTime |
string (date-time) |
line |
|
locked |
boolean |
mytime |
string (date-time) |
overdueComment |
string |
overdueCommentRequired |
boolean |
overdueCommentsThreadId |
integer (int64) |
overrideLockPermission |
boolean |
percentageComplete |
number (float) |
processOrder |
|
product |
|
sheetId |
integer (int64) |
sheetName |
string |
sheetVariableTitle |
string |
skipComment |
string |
skipCommentRequired |
boolean |
skipCommentsThreadId |
integer (int64) |
startTime |
string (date-time) |
status |
enum (NotValidStatus, NotStarted, InProgress, Skipped, Released, Completed) |
statusId |
integer (int64) |
targetDuration |
number (double) |
timeDue |
string (date-time) |
user |
3.5. ActivityRecord
| Name | Description | Schema |
|---|---|---|
activityId |
Unique identifier of an activity |
integer (int64) |
activityType |
The info of an activity type |
|
asset |
The Asset (Unit) that identifies this location |
|
autoComplete |
Defines an activity is auto complete |
boolean |
commentsThreadId |
Thread Id of the comment to fetch the comments associated to it |
integer (int64) |
completedType |
Whether the activity was completed by user or system |
|
department |
The Department this location belongs to |
|
description |
The description of an activity |
string |
displayTypeId |
Unique identifier for this display type |
integer (int64) |
dueIn |
The duration an activity is due in |
integer (int64) |
duration |
The duartion an activity is completed in |
integer (int64) |
endTime |
The end time of an activity |
string (date-time) |
entryOn |
The time when an activity happen |
string (date-time) |
estimatedStartTime |
estimatedStartTime for activity |
string (date-time) |
eventNumber |
Creates a key an event can be-time Based event and product change event of an activity |
string |
executionStartTime |
The time when an activity actually started executing |
string (date-time) |
extendedInfo |
The mode of the custom form can be payload, embedded and the external opening of an activity to the another browser |
string |
externalLink |
An activity opens to an external link in another browser that is a custom activity |
string |
generalComment |
General comment associated with an activity |
string |
hasAvailableCells |
Checks for the cells availability |
boolean |
hasVariableAliasing |
Whether the activity variable hasVariableAliasing |
boolean |
keyId |
Event id of an activity |
integer (int64) |
keyTime |
Creates a time stamp for an event can be-time Based event and product change event of an activity |
string (date-time) |
line |
The Line this location belongs to |
|
locked |
An activity is locked |
boolean |
overdueComment |
The overdue comment of an activity |
string |
overdueCommentRequired |
The overdue comment is required |
boolean |
overdueCommentsThreadId |
Overdue comment thread this record is part of |
integer (int64) |
overrideLockPermission |
Permission to override the lock if an activity is locked by the user |
boolean |
percentComplete |
The percentage by which an activity is completed |
number (double) |
priority |
integer (int64) |
|
processOrder |
An activity process order related to |
|
product |
The product activity is performed on |
|
sheet |
The info of the sheet associalted with an activity |
|
skipComment |
The skip comment of an activity |
string |
skipCommentRequired |
The skip comment is required |
boolean |
skipCommentsThreadId |
Skip comment thread this record is part of |
integer (int64) |
startTime |
The start time of an activity |
string (date-time) |
status |
The info of the status of an activity |
|
tag |
string |
|
targetDuration |
The target duration when an activity actually complete |
number (double) |
testsToComplete |
Unique identifier of this comment record |
integer (int64) |
timeDue |
The time by which an activity is due |
string (date-time) |
title |
The title of an activity |
string |
user |
The user performing on an activity can be a syatem user |
3.6. ActivityStatusRequest
| Name | Schema |
|---|---|
commentText |
string |
commentType |
string |
status |
integer (int64) |
3.7. ActivityUsers
| Name | Description | Schema |
|---|---|---|
id |
Unique indentifier for the user id |
integer (int64) |
name |
The user name who is performing on an activity |
string |
systemUser |
Defines if user is a system user |
boolean |
3.8. ActivityVariableHistoryInfo
| Name | Schema |
|---|---|
precision |
integer (int64) |
testId |
integer (int64) |
testTime |
string (date-time) |
typeId |
integer (int64) |
value |
object |
variableId |
integer (int64) |
3.9. ActivityVariableInfo
| Name | Description | Schema |
|---|---|---|
arrayId |
integer (int64) |
|
available |
boolean |
|
average |
object |
|
canceled |
boolean |
|
commentThreadId |
integer (int64) |
|
description |
string |
|
eSignatureId |
integer (int64) |
|
eSignatureLevel |
integer (int64) |
|
engineeringUnits |
string |
|
entryBy |
Entry by |
string |
entryById |
Entry by id |
integer (int64) |
entryOn |
Entry on |
string (date-time) |
externalLink |
string |
|
history |
< ActivityVariableHistoryInfo > array |
|
inputTag |
string |
|
isEditable |
boolean |
|
isMandatory |
boolean |
|
isUserDefined |
boolean |
|
lowerControlLimit |
object |
|
lowerEntryLimit |
object |
|
lowerQuartile |
object |
|
lowerRejectLimit |
object |
|
lowerUserLimit |
object |
|
lowerWarningLimit |
object |
|
maximum |
object |
|
median |
object |
|
minimum |
object |
|
order |
integer (int64) |
|
parentVariableId |
Parent Variable Id of a Variable |
string |
precision |
integer (int64) |
|
source |
string |
|
sourceId |
integer (int64) |
|
spcCalculationType |
Name of SPC calcuation type for variable |
string |
spcCalculationTypeId |
Id of SPC calcuation type for variable |
integer (int64) |
spcGroupVariableType |
Name of SPC Group variable type |
string |
spcGroupVariableTypeId |
Id of SPC Group variable type for variable |
integer (int64) |
target |
object |
|
targetControl |
object |
|
targetFreq |
integer (int32) |
|
testId |
integer (int64) |
|
type |
string |
|
typeEnum |
< IdNameValue > array |
|
typeId |
integer (int64) |
|
upperControlLimit |
object |
|
upperEntryLimit |
object |
|
upperQuartile |
object |
|
upperRejectLimit |
object |
|
upperUserLimit |
object |
|
upperWarningLimit |
object |
|
value |
object |
|
variableId |
integer (int64) |
|
variableName |
string |
|
variableState |
enum (Reject, Warning, Target, User, Control) |
3.10. ActivityVariableUpdates
| Name | Schema |
|---|---|
activityId |
integer (int64) |
canceled |
boolean |
commentText |
string |
commentThreadId |
integer (int64) |
esignatureId |
integer (int64) |
testId |
integer (int64) |
value |
string |
variableId |
integer (int64) |
3.11. ActivityViewerStateResource
| Name | Schema |
|---|---|
activityEndTime |
string (date-time) |
activityOverviews |
|
activityStartTime |
string (date-time) |
currentPage |
integer (int32) |
links |
< Link > array |
numActivitiesRemaining |
integer (int32) |
overdueCount |
integer (int32) |
3.12. BaseAssetInfo
| Name | Description | Schema |
|---|---|---|
assetId |
The asset Id |
integer (int64) |
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
3.14. CollectionResource«IdNameValue»
| Name | Schema |
|---|---|
collection |
|
content |
< IdNameValue > array |
links |
< Link > array |
3.15. CollectionResource«ReasonHeaderInfo»
| Name | Schema |
|---|---|
collection |
|
content |
< ReasonHeaderInfo > array |
links |
< Link > array |
3.16. CollectionResource«ReasonTreeNodeDto»
| Name | Schema |
|---|---|
collection |
|
content |
< ReasonTreeNodeDto > array |
links |
< Link > array |
3.17. CommentInfo
| Name | Schema |
|---|---|
addlInfo |
string |
addlInfo2 |
string |
commentId |
integer (int64) |
commentText |
string |
commentTime |
string (date-time) |
commentType |
string |
threadId |
integer (int64) |
user |
3.18. DimensionInfo
| Name | Schema |
|---|---|
dimensionId |
string |
finalValue |
number (double) |
initialValue |
number (double) |
name |
string |
unitOfMeasure |
string |
3.20. EventHeaderInfo
| Name | Schema |
|---|---|
eventStartsInfo |
integer (int64) |
productInfo |
|
unit |
|
user |
3.22. HistorianTagDataPoint
| Name | Schema |
|---|---|
dataPoint |
number (double) |
deviationPoint |
number (double) |
tagName |
string |
3.23. HistorianTagDataPointResponse
| Name | Schema |
|---|---|
content |
< HistorianTagDataPoint > array |
links |
< Link > array |
3.25. IdNameValue
| Name | Description | Schema |
|---|---|---|
id |
Unique identifier of this id of every pair/used across several services to represent a generic Id |
integer (int64) |
name |
Unique identifier of this name of every pair/used across several services to represent a generic name |
string |
3.27. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.28. PagedResources«Resource«ActivityInfo»»
| Name | Schema |
|---|---|
content |
< Resource«ActivityInfo» > array |
links |
< Link > array |
page |
3.29. PagedResources«Resource«VariablePage»»
| Name | Schema |
|---|---|
content |
< Resource«VariablePage» > array |
links |
< Link > array |
page |
3.30. PrivilegeSet
| Name | Schema |
|---|---|
category |
string |
description |
string |
displayName |
string |
icon |
string |
id |
integer (int32) |
scope |
string |
3.31. Product
| Name | Description | Schema |
|---|---|---|
code |
Product code for activity Product |
string |
id |
Product Id for activity Product |
integer (int64) |
isAppliedProduct |
flag to differentiate between AppliedProduct is current Product |
boolean |
name |
Product name for activity Product |
string |
3.32. ProductChangeCreatorInfo
| Name | Schema |
|---|---|
allProducts |
< ProductInfo > array |
header |
|
productChangeHistory |
< ProductChangeHistoryInfo > array |
productGroup |
< Resource«ProductGroup» > array |
startTime |
string (date-time) |
3.34. ProductChangeHistoryInfo
| Name | Schema |
|---|---|
endTime |
string (date-time) |
id |
integer (int64) |
productCode |
string |
productDescription |
string |
productId |
integer (int64) |
startTime |
string (date-time) |
3.35. ProductChangeRequestInfo
| Name | Schema |
|---|---|
eventId |
integer (int64) |
productId |
integer (int64) |
timeStamp |
string (date-time) |
unitId |
integer (int64) |
3.37. ProductInfo
| Name | Schema |
|---|---|
code |
string |
description |
string |
productFamilyId |
integer (int64) |
productId |
integer (int64) |
3.38. ProductionEventUpdates
| Name | Schema |
|---|---|
commentText |
string |
commentThreadId |
integer (int64) |
eventId |
integer (int64) |
testId |
integer (int64) |
3.39. ProductionRecordInfo
| Name | Schema |
|---|---|
appliedProduct |
|
associatedActivities |
< integer (int64) > array |
comment |
string |
commentsThreadId |
integer (int64) |
dimensions |
< DimensionInfo > array |
endTime |
string (date-time) |
eventName |
string |
eventStatus |
|
isLockEventData |
boolean |
product |
|
productionRecordId |
integer (int64) |
productionStatus |
|
products |
< IdNameValue > array |
sheetId |
integer (int64) |
startTime |
string (date-time) |
statusOptions |
< IdNameValue > array |
unit |
3.40. ProductionRecordInfoResource
| Name | Schema |
|---|---|
appliedProduct |
|
associatedActivities |
< integer (int64) > array |
comment |
string |
commentsThreadId |
integer (int64) |
dimensions |
< DimensionInfo > array |
endTime |
string (date-time) |
eventName |
string |
eventStatus |
|
isLockEventData |
boolean |
links |
< Link > array |
product |
|
productionRecordId |
integer (int64) |
productionStatus |
|
products |
< IdNameValue > array |
sheetId |
integer (int64) |
startTime |
string (date-time) |
statusOptions |
< IdNameValue > array |
unit |
3.42. ReasonTreeNodeDto
| Name | Schema |
|---|---|
categoryId |
integer (int64) |
categoryName |
string |
children |
< ReasonTreeNodeDto > array |
nodeId |
integer (int64) |
parentNodeId |
integer (int64) |
reasonId |
integer (int64) |
reasonLevel |
integer (int32) |
reasonName |
string |
treeId |
integer (int64) |
3.43. Resource«ActivityInfo»
| Name | Schema |
|---|---|
activityId |
integer (int64) |
activityName |
string |
activityType |
|
asset |
|
commentHistory |
< Resource«CommentInfo» > array |
commentsThreadId |
integer (int64) |
completedTime |
string (date-time) |
completedType |
|
customFormData |
|
displayTypeId |
integer (int64) |
dueIn |
integer (int64) |
duration |
integer (int64) |
durationIn |
string |
estimatedStartTime |
string (date-time) |
eventNumber |
string |
hasAvailableCells |
boolean |
hasVariableAliasing |
boolean |
isLikelyOverdueActivity |
boolean |
isOverdueActivity |
boolean |
keyId |
integer (int64) |
keyTime |
string (date-time) |
line |
|
links |
< Link > array |
locked |
boolean |
mytime |
string (date-time) |
overdueComment |
string |
overdueCommentRequired |
boolean |
overdueCommentsThreadId |
integer (int64) |
overrideLockPermission |
boolean |
percentageComplete |
number (float) |
processOrder |
|
product |
|
sheetId |
integer (int64) |
sheetName |
string |
sheetVariableTitle |
string |
skipComment |
string |
skipCommentRequired |
boolean |
skipCommentsThreadId |
integer (int64) |
startTime |
string (date-time) |
status |
enum (NotValidStatus, NotStarted, InProgress, Skipped, Released, Completed) |
statusId |
integer (int64) |
targetDuration |
number (double) |
timeDue |
string (date-time) |
user |
3.44. Resource«ActivityVariableInfo»
| Name | Description | Schema |
|---|---|---|
arrayId |
integer (int64) |
|
available |
boolean |
|
average |
object |
|
canceled |
boolean |
|
commentThreadId |
integer (int64) |
|
description |
string |
|
eSignatureId |
integer (int64) |
|
eSignatureLevel |
integer (int64) |
|
engineeringUnits |
string |
|
entryBy |
Entry by |
string |
entryById |
Entry by id |
integer (int64) |
entryOn |
Entry on |
string (date-time) |
externalLink |
string |
|
history |
< ActivityVariableHistoryInfo > array |
|
inputTag |
string |
|
isEditable |
boolean |
|
isMandatory |
boolean |
|
isUserDefined |
boolean |
|
links |
< Link > array |
|
lowerControlLimit |
object |
|
lowerEntryLimit |
object |
|
lowerQuartile |
object |
|
lowerRejectLimit |
object |
|
lowerUserLimit |
object |
|
lowerWarningLimit |
object |
|
maximum |
object |
|
median |
object |
|
minimum |
object |
|
order |
integer (int64) |
|
parentVariableId |
Parent Variable Id of a Variable |
string |
precision |
integer (int64) |
|
source |
string |
|
sourceId |
integer (int64) |
|
spcCalculationType |
Name of SPC calcuation type for variable |
string |
spcCalculationTypeId |
Id of SPC calcuation type for variable |
integer (int64) |
spcGroupVariableType |
Name of SPC Group variable type |
string |
spcGroupVariableTypeId |
Id of SPC Group variable type for variable |
integer (int64) |
target |
object |
|
targetControl |
object |
|
targetFreq |
integer (int32) |
|
testId |
integer (int64) |
|
type |
string |
|
typeEnum |
< IdNameValue > array |
|
typeId |
integer (int64) |
|
upperControlLimit |
object |
|
upperEntryLimit |
object |
|
upperQuartile |
object |
|
upperRejectLimit |
object |
|
upperUserLimit |
object |
|
upperWarningLimit |
object |
|
value |
object |
|
variableId |
integer (int64) |
|
variableName |
string |
|
variableState |
enum (Reject, Warning, Target, User, Control) |
3.45. Resource«CommentInfo»
| Name | Schema |
|---|---|
addlInfo |
string |
addlInfo2 |
string |
commentId |
integer (int64) |
commentText |
string |
commentTime |
string (date-time) |
commentType |
string |
links |
< Link > array |
threadId |
integer (int64) |
user |
3.46. Resource«ProductGroup»
| Name | Schema |
|---|---|
description |
string |
links |
< Link > array |
productGroupId |
integer (int64) |
3.47. Resource«ProductionRecordInfo»
| Name | Schema |
|---|---|
appliedProduct |
|
associatedActivities |
< integer (int64) > array |
comment |
string |
commentsThreadId |
integer (int64) |
dimensions |
< DimensionInfo > array |
endTime |
string (date-time) |
eventName |
string |
eventStatus |
|
isLockEventData |
boolean |
links |
< Link > array |
product |
|
productionRecordId |
integer (int64) |
productionStatus |
|
products |
< IdNameValue > array |
sheetId |
integer (int64) |
startTime |
string (date-time) |
statusOptions |
< IdNameValue > array |
unit |
3.48. Resource«ServiceHealthStatus»
| Name | Description | Schema |
|---|---|---|
isRunning |
The status of the service. Returns true if running, else false |
boolean |
links |
< Link > array |
|
reason |
Reason why the service is not running. Returned only when the service is down and if there is a reason for failure |
string |
3.49. Resource«UserDefinedRecordInfo»
| Name | Schema |
|---|---|
ack |
boolean |
ackBy |
|
ackInitialState |
boolean |
ackTime |
string (date-time) |
action1 |
|
action2 |
|
action3 |
|
action4 |
|
asset |
|
associatedActivities |
< integer (int64) > array |
cause1 |
|
cause2 |
|
cause3 |
|
cause4 |
|
comment |
string |
commentsThreadId |
integer (int64) |
endTime |
string (date-time) |
eventHeaderInfo |
|
eventName |
string |
eventStatus |
|
eventSubType |
|
isLockEventData |
boolean |
links |
< Link > array |
reasonHeaderInfo |
|
reasonTreeNodeDto |
|
sheetId |
integer (int64) |
startTime |
string (date-time) |
statusOptions |
< IdNameValue > array |
unitId |
integer (int64) |
userDefinedRecordId |
integer (int64) |
3.50. Resource«VariablePage»
| Name | Schema |
|---|---|
id |
integer (int64) |
isInclusiveSpecCalc |
boolean |
links |
< Link > array |
title |
string |
variableScrolling |
boolean |
variables |
< Resource«ActivityVariableInfo» > array |
3.51. ServiceHealthStatus
| Name | Description | Schema |
|---|---|---|
isRunning |
The status of the service. Returns true if running, else false |
boolean |
reason |
Reason why the service is not running. Returned only when the service is down and if there is a reason for failure |
string |
3.52. SheetColumnRecordInfo
| Name | Schema |
|---|---|
associatedActivities |
< integer (int64) > array |
comment |
string |
commentsThreadId |
integer (int64) |
sheetId |
integer (int64) |
timestamp |
string (date-time) |
unitId |
integer (int64) |
3.53. TestHistoryRecord
| Name | Schema |
|---|---|
canceled |
boolean |
enteredOn |
string (date-time) |
entryBy |
string |
performedBy |
string |
value |
object |
verifiedBy |
string |
3.54. TimeSelectionRange
| Name | Description | Schema |
|---|---|---|
endTime |
The startTime range |
string |
eventEpochEndTime |
integer (int64) |
|
eventEpochStartTime |
The startTime |
integer (int64) |
startTime |
The startTime range |
string |
3.56. UserDefinedRecordInfo
| Name | Schema |
|---|---|
ack |
boolean |
ackBy |
|
ackInitialState |
boolean |
ackTime |
string (date-time) |
action1 |
|
action2 |
|
action3 |
|
action4 |
|
asset |
|
associatedActivities |
< integer (int64) > array |
cause1 |
|
cause2 |
|
cause3 |
|
cause4 |
|
comment |
string |
commentsThreadId |
integer (int64) |
endTime |
string (date-time) |
eventHeaderInfo |
|
eventName |
string |
eventStatus |
|
eventSubType |
|
isLockEventData |
boolean |
reasonHeaderInfo |
|
reasonTreeNodeDto |
|
sheetId |
integer (int64) |
startTime |
string (date-time) |
statusOptions |
< IdNameValue > array |
unitId |
integer (int64) |
userDefinedRecordId |
integer (int64) |
3.57. UserDefinedUpdates
| Name | Schema |
|---|---|
commentText |
string |
commentThreadId |
integer (int64) |
eventId |
integer (int64) |
testId |
integer (int64) |
3.58. UserSettingRequest
| Name | Description | Schema |
|---|---|---|
appId |
integer (int32) |
|
data |
The application specific settings, Eg:- 'App Name' : {'property1' : 'value' , 'property2' : 'value'} } |
object |
viewName |
string |
3.59. UserSettingResource
| Name | Description | Schema |
|---|---|---|
appId |
integer (int32) |
|
data |
object |
|
defaultSetting |
Example : |
boolean |
links |
< Link > array |
|
viewName |
string |
3.60. VariableInfo
| Name | Schema |
|---|---|
isDisplayUnits |
boolean |
lockUnavailableCells |
boolean |
3.61. VariablePage
| Name | Schema |
|---|---|
id |
integer (int64) |
isInclusiveSpecCalc |
boolean |
title |
string |
variableScrolling |
boolean |
variables |
< Resource«ActivityVariableInfo» > array |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : http://localhost:8080/uaa/oauth/authorize
Token URL : http://localhost:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : http://localhost:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : http://localhost:8080/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : http://localhost:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |