1. Overview
The activities 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-command-controller : Activity Command Controller
-
activity-controller : Activity Controller
-
activity-variable-controller : Activity Variable Controller
-
array-data-controller : Array Data Controller
-
product-change-controller : Product Change Controller
-
production-event-controller : Production Event Controller
-
sheet-column-controller : Sheet Column Controller
-
sheet-info-controller : Sheet Info Controller
-
test-value-controller : Test Value Controller
-
test-value-specifications-controller : Test Value Specifications Controller
-
time-selection-controller : Time Selection Controller
-
user-defined-event-controller : User Defined Event Controller
2. Resources
2.1. Activity-command-controller
Activity Command Controller
2.1.1. Activities to complete
POST /activityCommand/v1/completeActivities
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
activityIds |
Ids of activities to complete |
< integer (int64) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden , User is not allowed to complete the activities |
|
422 |
Unprocessable Entity |
2.2. Activity-controller
Activity Controller
2.2.1. Fetches activity records
GET /activity/v1/activities
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
activityId |
Activity id to get the page that contains this activity. Page parameter is ignored if activityId is provided |
string |
|
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 |
isOverdue |
If true returns only overdue activities. |
integer (int32) |
|
Query |
page |
Page to get the activity records. This is ignored if activityId is provided. |
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 |
Page size to get activity records |
integer (int32) |
|
Query |
sortColumn |
Optional sortColumn 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 |
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 |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
500 |
Internal Server Error |
No Content |
2.2.2. Fetches List of activityIds by testRecordId
GET /activity/v1/activities/activityId
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 |
< integer (int64) > array |
204 |
No Content |
< integer (int64) > array |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.2.3. Returns the list of supported event types
GET /activity/v1/activities/eventTypes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
equipments |
Comma separated list of unit ids |
string |
2.2.4. Fetches the activity record based on the group information user provided
GET /activity/v1/activities/group
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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 |
|
Query |
view |
View to get activities based on type |
enum (Product, ProcessOrder, Equipment, Event, Activity) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.2.5. Fetches the activities autolog sheet permissions
GET /activity/v1/activities/permissions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
sheetList |
Comma saperated sheet ids to get activities sheet permissions |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
404 |
Not Found, Rersource not found |
|
422 |
Unprocessble Entity |
|
500 |
Internal Server Error |
No Content |
2.2.6. Fetches activity record by activity id
GET /activity/v1/activities/{activityId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
activityId |
Activity id to get the activity record |
integer (int64) |
|
Query |
timeZone |
Time zone of startTime and endTime |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found , Resource not found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
No Content |
2.2.7. Update activity record
PUT /activity/v1/activities/{activityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of the activity to update an activity record |
integer (int64) |
Body |
activityRecord |
ActivityRecord object to update an activity record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
304 |
Not Modified, Resource is not modified while requesting again |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden , User is not allowed to update the activity record |
|
404 |
Not Found , Resoure is not found |
No Content |
422 |
Unprocessable Entity |
2.2.8. This end point is used to clear the information of activities. This would be deprecated to the future
DELETE /activity/v1/cache
2.2.9. Fetches Logged in user details
GET /activity/v1/loggedinuserid
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
integer (int64) |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
|
500 |
Internal Server Error |
No Content |
2.2.10. Fetches activity records
GET /activity/v2/activities
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
activityId |
Activity id to get the page that contains this activity. Page parameter is ignored if activityId is provided |
string |
|
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 |
isOverdue |
If true returns only overdue activities. |
integer (int32) |
|
Query |
page |
Page to get the activity records. This is ignored if activityId is provided. |
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 |
Page size to get activity records |
integer (int32) |
|
Query |
sortColumn |
Optional sortColumn 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 |
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 |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
500 |
Internal Server Error |
No Content |
2.2.11. Fetches activity record by activity id
GET /activity/v2/activities/{activityId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
activityId |
Activity id to get the activity record |
integer (int64) |
|
Query |
timeZone |
Time zone of startTime and endTime |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found , Resource not found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
No Content |
2.2.12. Update activity record
PUT /activity/v2/activities/{activityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of the activity to update an activity record |
integer (int64) |
Body |
activityRecord |
ActivityRecord object to update an activity record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
304 |
Not Modified, Resource is not modified while requesting again |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden , User is not allowed to update the activity record |
|
404 |
Not Found , Resoure is not found |
No Content |
422 |
Unprocessable Entity |
2.3. Activity-variable-controller
Activity Variable Controller
2.3.1. This end point is used to clear the information of varaibles. This would be deprecated to the future
DELETE /activity/v1/activities/variables/cache
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
activityId |
activityId of an activity to delete activity variable |
integer (int64) |
2.3.2. Fetches activity header details
GET /activity/v1/activities/{activityId}/header
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of an activity to get activity header info |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
2.3.3. Fetches activity record variables history
GET /activity/v1/activities/{activityId}/history
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of an activity to get activity record variables history |
integer (int64) |
Query |
directionBackward |
Optional input parameter for direction to determine if returned activities come before or after activity id |
boolean |
Query |
isInclusive |
Optional input parameter for isInclusive to determine if the time spec limits of a variable should be included or not (defaults to true |
boolean |
Query |
sameProduct |
For same product true would return last 20 currently running product activities and for false it would not consider same product activites |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessible Entity |
No Content |
500 |
Internal Server Error |
2.3.4. Fetches activity variable statistics are Minimum,Maximum,Median,LowerQuartile,UpperQuartile
GET /activity/v1/activities/{activityId}/statistics
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of an activity to get activity variable statistics |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessible Entity |
No Content |
500 |
Internal Server Error |
2.3.5. Fetches all the variables for that particular activity
GET /activity/v1/activities/{activityId}/variables
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of an activity to get activity record variables |
integer (int64) |
Query |
variableFilter |
Accept variables name and filters based on variables name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
2.3.6. Fetches variable details information based on the activity id and variable id
GET /activity/v1/activities/{activityId}/variables/{variableId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of an activity to get activity record variables |
integer (int64) |
Path |
variableId |
Variable id to get activity record variables |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
2.3.7. Update variable details information based on the activity id and variable id
PUT /activity/v1/activities/{activityId}/variables/{variableId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of an activity to update activity variables |
integer (int64) |
Path |
variableId |
Variable id of a variable to update activity variables |
integer (int64) |
Body |
updatedActivityVariable |
ActivityVariable object to update activity variables |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
No Content |
2.3.8. Fetches List of activities containing their variable counts
GET /activity/v1/activityVariableCounts
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
activityIds |
Comma separated List of activityIds |
string |
Query |
eventNumbers |
Comma separated List of eventNumbers |
string |
Query |
eventType |
Type of eventNumbers provided above [all the eventIds should belong to same type], /n This parameter will be used only when eventNumbers is provided otherwise it will be ignored. |
enum (UserDefinedEvent) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.4. Array-data-controller
Array Data Controller
2.4.1. Get the encoded values for the data stored in array data table for an array Id
GET /arrayData
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request, array id wrong |
No Content |
500 |
Internal Server Error, Failed to decode the data stored in DB |
No Content |
2.5. Product-change-controller
Product Change Controller
2.5.1. Creates product change event
POST /productchange/v1/events
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
productChangeRequest |
ProductChangeRequest object to create a product change event |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unproccesable Entity |
No Content |
500 |
Internal Server Error |
2.5.2. Fetches the product change event history
GET /productchange/v1/events/history
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitId |
Unit id to get product change event history |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocceable Entity |
No Content |
500 |
Internal Server Error |
2.5.3. Fetches the list of units which are authorized for product change
GET /productchange/v1/events/units
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitIds |
Comma separated unit ids to get available units for product change event |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
2.5.4. Fetches the activities of the product change based on the given timestamp
GET /productchange/v1/events/{resultOn}/activities
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
resultOn |
Time stamp to get product change event activities in the specified time |
string (date-time) |
Query |
unitId |
Unit id to get product change event activities |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
2.6. Production-event-controller
Production Event Controller
2.6.1. Create production event
POST /production/v1/events
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
createProductionRecord |
ProductionRecord object to add a production record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, The user is not allowed to create production event |
|
404 |
Not Found, Resouce is not found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
2.6.2. Fetches a collection of Production Events
GET /production/v1/events
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
|
Query |
size |
Number of records per page. |
integer (int32) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
timeSelection |
Time selection values |
integer (int64) |
|
Query |
unitIds |
Comma separated list of unit ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthrized |
No Content |
500 |
Internal Server Error |
No Content |
2.6.3. Fetches available times for production event
GET /production/v1/events/availableEditTimes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitId |
Unit id to get the available production record in specific time range |
integer (int64) |
2.6.4. Fetches event header details for production event
GET /production/v1/events/header
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
sheetId |
Sheet id to get the event header of production event |
integer (int64) |
Query |
unitId |
Unit id to get the event header of events |
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.6.5. Fetches next event number by unit id
GET /production/v1/events/nextEventNumber
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitId |
Unit id to get next event number for production event |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
No Content |
500 |
Internal Server Error |
2.6.6. Fetches products by unit id
GET /production/v1/events/products
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitId |
Unit id to get the products |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< IdNameValue > array |
400 |
Bad Request |
No Content |
404 |
Not Found, Resouce is not found |
2.6.7. Fetches a production record status option
GET /production/v1/events/statusOptions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitId |
Unit id to get the status options of the production record |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< IdNameValue > array |
401 |
Unauthorized |
No Content |
2.6.8. Fetches a production record
GET /production/v1/events/{eventId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to get a production record |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthrized |
No Content |
404 |
Not Found |
No Content |
2.6.9. Update a production record by event id
PUT /production/v1/events/{eventId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to update the production record |
integer (int64) |
Body |
updatedProductionRecord |
ProductionRecord object to update the production record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
2.6.10. Fetches activites by event id
GET /production/v1/events/{eventId}/activities
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to get the activities for production event |
integer (int64) |
2.6.11. Fetches a production record status by event id
GET /production/v1/events/{eventId}/status
|
Caution
|
operation.deprecated |
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to get the status of production record |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< IdNameValue > array |
404 |
Not Found, Resource is not found. |
No Content |
2.7. Sheet-column-controller
Sheet Column Controller
2.7.1. Add sheet column record
POST /sheet/v1/sheetColumnRecords
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
createSheetColumnRecord |
SheetColumnRecord object to create time based event |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, User is not allowed to add sheet column record. |
|
404 |
Not Found, Resource is not found. |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
2.7.2. Fetches sheet column header
GET /sheet/v1/sheetColumnRecords/header
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
sheetId |
Sheet id to get sheet column header |
integer (int64) |
2.7.3. Fetches the activities of the time based event based on the given sheet id and the timestamp
GET /sheet/v1/sheetColumnRecords/{sheetId}/{resultOn}/activities
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
resultOn |
Time stamp to get activities |
string (date-time) |
Path |
sheetId |
Sheet id to get activities |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Intrenal Server Error |
2.7.4. Fetches sheet column record by sheet id
GET /sheet/v1/sheetColumnRecords/{sheetId}/{timestamp}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
sheetId |
Sheet id to get sheet column record |
integer (int64) |
Path |
timestamp |
Time stamp to get sheet column record |
string (date-time) |
2.8. Sheet-info-controller
Sheet Info Controller
2.8.1. Fetches sheets information based on line, unit ids
GET /sheet/v1/sheetInfo
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventTypeIds |
eventTypeIds |
string |
Query |
lineIds |
Line ids to get sheets information |
string |
Query |
sheetGroupIds |
Sheet group ids to get sheets information |
string |
Query |
sheetIds |
Sheet ids to get sheets information |
string |
Query |
sheetTypeIds |
sheetTypeIds |
string |
Query |
unitIds |
unitIds |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< SheetInfoResource > array |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
2.8.2. Fetches sheet displays
GET /sheet/v1/sheetInfo/{eventType}/displays
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventType |
Event types to filter activities, can be UDE, Production, TimeBased Event and Product Change |
enum (1, 2, 4, 25) |
Query |
equipments |
Comma seperated list of unit ids |
string |
2.8.3. Fetches sheet information
GET /sheet/v1/sheetInfo/{sheetId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
sheetId |
Sheet id to get sheet details |
integer (int64) |
2.8.4. Fetches custom form information
GET /sheet/v1/sheetInfo/{sheetId}/customFormsInfo
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
sheetId |
Sheet id to get custom form data |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
2.8.5. Fetches sheet display options
GET /sheet/v1/sheetInfo/{sheetId}/displayOptions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
sheetId |
Sheet id to get activities sheet display options |
string |
Query |
displayOptionIds |
Display option ids to get activities sheet display options |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
2.9. Test-value-controller
Test Value Controller
2.9.1. Add test value record
POST /variables/v1/testValueRecords
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
updatedTestValueRecord |
TestValueRecord object to add a test value record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden , User is not allowed to add a test value record. |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
No Content |
2.9.2. Fetches test value record for an activity
GET /variables/v1/testValueRecords/activities/{activityId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
activityId |
Activity id of activity to get test value record |
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 |
2.9.3. Fetches test value record by test id
GET /variables/v1/testValueRecords/{testId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
testId |
Test id of a variable to get test value record |
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 |
2.9.4. Update test value record
PUT /variables/v1/testValueRecords/{testId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
testId |
Test id of variable to update test value record |
integer (int64) |
Body |
updatedTestValueRecord |
TestValueRecord object to update a test value record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Reuest |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, User is not allowed to update the test value record. |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
No Content |
2.10. Test-value-specifications-controller
Test Value Specifications Controller
2.10.1. Fetches test value specifications
GET /variables/v1/testValueSpecifications
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
startTime |
Time to get the test value specifications of variables |
string (date-time) |
Query |
variableIds |
The variables ids to get the test value specifications of variables |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< TestValueSpecifications > array |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
No Content |
500 |
Internal Server Error |
2.11. Time-selection-controller
Time Selection Controller
2.11.1. Fetches time selection intervals
GET /activity/v1/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 |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
2.11.2. Fetches the startTime and endTime based on the timeSelection provided
GET /activity/v1/timeOptions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
reportType |
Report type to get the different time interval for EX in case of report type 1 it would return 1-Current Day, 2-Previous Day, 7-User Defined, 8-Current Shift and 9-Previous shift. Other report type would return all the time selections |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
304 |
Not Modified |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES. |
No Content |
404 |
Not Found |
No Content |
2.12. User-defined-event-controller
User Defined Event Controller
2.12.1. Creates user defined event
POST /userDefined/v1/events
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
createUserDefinedRecord |
createUserDefinedRecord |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
2.12.2. Fetches available times for user defined event
GET /userDefined/v1/events/availableEditTimes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitId |
Unit id to get the available user defined record in a specific time range |
integer (int64) |
2.12.3. Fetches an event subType based on the sheet Id provided
GET /userDefined/v1/events/eventSubType
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
sheetId |
Sheet id to get the available times for user defined event |
integer (int64) |
2.12.4. Fetches event header details for user defined event
GET /userDefined/v1/events/header
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
sheetId |
Sheet id to get event header of events |
integer (int64) |
Query |
unitId |
Unit id to get the event header of events |
integer (int64) |
2.12.5. Fetches products by unit id
GET /userDefined/v1/events/products
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitId |
Unit id to get the products |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< IdNameValue > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
No Content |
2.12.6. Fetches a user defined record status option
GET /userDefined/v1/events/statusOptions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitId |
Unit id to get the status options of the user defined record |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< IdNameValue > array |
401 |
Unauthorized |
No Content |
404 |
Not Found, Resource not found |
No Content |
500 |
Internal Server Error |
2.12.7. Fetches a user defined record by event id
GET /userDefined/v1/events/{eventId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to get a user defind record |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found , Resource is not found. |
|
500 |
Internal Server Error |
No Content |
2.12.8. Update user defined event by event id
PUT /userDefined/v1/events/{eventId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to update the user defined record |
integer (int64) |
Body |
updatedUserDefinedRecord |
UserDefinedRecord object to update the user defined record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
|
500 |
Internal Server Error |
No Content |
2.12.9. Fetches activites by event id
GET /userDefined/v1/events/{eventId}/activities
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to get the activities for user defined event |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
No Content |
2.12.10. Fetches user defined event status
GET /userDefined/v1/events/{eventId}/status
|
Caution
|
operation.deprecated |
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
eventId |
Event id of an event to get the status of user defined record |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< IdNameValue > array |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
3. Definitions
3.1. ActivitiesVariableCountsResource
| Name | Schema |
|---|---|
content |
< ActivityVariableCounts > array |
links |
< Link > array |
3.3. ActivityEventType
| Name | Description | Schema |
|---|---|---|
eventId |
Unique identifier for an event |
integer (int64) |
id |
integer (int64) |
|
name |
string |
3.4. ActivityEventUnits
| Name | Description | Schema |
|---|---|---|
eventDesc |
Define an event in a descending order |
string |
eventId |
Unique identifier for an event |
integer (int64) |
id |
integer (int64) |
|
unit |
3.5. ActivityHeader
| Name | Description | Schema |
|---|---|---|
activityDescription |
The description of an activity |
string |
activityId |
Unique identifier for an activity |
integer (int64) |
activityTypeId |
Type of an activity can be- standard or custom activity |
integer (int64) |
endTime |
The end time of an activity |
string (date-time) |
isAppliedProduct |
flag for applied product |
boolean |
isDisplayUnits |
Display units an activity is associated with. |
boolean |
isLocked |
The value defines an activity is locked or not |
boolean |
keyId |
Creates a time stamp for an event can be-time Based event and product change event of an activity |
string (date-time) |
keyId1 |
Event id of an activity |
integer (int64) |
processOrder |
An activity this process order is requesting |
string |
product |
The product this activity belongs to |
string |
sheetId |
Unique identifier for this sheet |
integer (int64) |
startTime |
The start time of an activity |
string (date-time) |
unitId |
Unit this activity is associated with |
integer (int64) |
user |
User performing on an activity |
3.6. ActivityHeaderResource
| Name | Description | Schema |
|---|---|---|
activityDescription |
The description of an activity |
string |
activityId |
Unique identifier for an activity |
integer (int64) |
activityTypeId |
Type of an activity can be- standard or custom activity |
integer (int64) |
endTime |
The end time of an activity |
string (date-time) |
isAppliedProduct |
flag for applied product |
boolean |
isDisplayUnits |
Display units an activity is associated with. |
boolean |
isLocked |
The value defines an activity is locked or not |
boolean |
keyId |
Creates a time stamp for an event can be-time Based event and product change event of an activity |
string (date-time) |
keyId1 |
Event id of an activity |
integer (int64) |
links |
< Link > array |
|
processOrder |
An activity this process order is requesting |
string |
product |
The product this activity belongs to |
string |
sheetId |
Unique identifier for this sheet |
integer (int64) |
startTime |
The start time of an activity |
string (date-time) |
unitId |
Unit this activity is associated with |
integer (int64) |
user |
User performing on an activity |
3.7. 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.8. ActivityRecordResources
| Name | Schema |
|---|---|
content |
< ActivityRecord > array |
links |
< Link > array |
3.9. ActivityRecordV2
| 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.10. ActivityResponseResource
| Name | Description | Schema |
|---|---|---|
activityEndTime |
The end time of an activity |
string (date-time) |
activityRecords |
The List of activity records |
< ActivityRecord > array |
activityStartTime |
The start time of an activity |
string (date-time) |
currentPage |
The current page number |
integer (int32) |
links |
< Link > array |
|
overdueCount |
The count of overdue activities |
integer (int32) |
pageCount |
The page count of activities |
integer (int32) |
totalPagingRecords |
The count of toatal pages records |
integer (int32) |
3.11. ActivityResponseV2Resource
| Name | Description | Schema |
|---|---|---|
activityEndTime |
The end time of an activity |
string (date-time) |
activityRecords |
The List of activity records |
< ActivityRecordV2 > array |
activityStartTime |
The start time of an activity |
string (date-time) |
currentPage |
The current page number |
integer (int32) |
links |
< Link > array |
|
overdueCount |
The count of overdue activities |
integer (int32) |
pageCount |
The page count of activities |
integer (int32) |
totalPagingRecords |
The count of toatal pages records |
integer (int32) |
3.12. ActivitySheetDisplay
| Name | Description | Schema |
|---|---|---|
sheetDescription |
The sheet description associated with an activity |
string |
sheetId |
Unique identifier of this sheet |
integer (int32) |
unitInfo |
The Asset (Unit) that identifies this location |
3.13. ActivitySheetDisplayResources
| Name | Schema |
|---|---|
content |
< ActivitySheetDisplay > array |
links |
< Link > array |
3.14. 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.15. ActivityVariable
| Name | Description | Schema |
|---|---|---|
arrayId |
Id specifying relation of this test record with Array Data table |
integer (int64) |
available |
The value defines the availability of the variable |
boolean |
canceled |
Flag to cancel test entry |
boolean |
commentThreadId |
Thread Id of the comment to fetch the comments associated to variable |
integer (int64) |
description |
The variable description |
string |
engineeringUnits |
Engineering units of the variable |
string |
externalLink |
The variable is the part of the externalLink/opened in the different tab for custom activity |
string |
inputTag |
Historian Input from where this record gets the value |
string |
isEditable |
Flag showing if this Activity variable is editable or not by the User who requested for this record |
boolean |
isMandatory |
Flag showing if this Activity variable is mandatory for this record |
boolean |
isUserDefined |
The variable is user defined variable |
boolean |
order |
Define the variable order |
integer (int64) |
precision |
Define the number of decimals to be shown |
integer (int64) |
sheetId |
Unique identifier of this sheet |
integer (int64) |
source |
Define the variable source can be autolog |
string |
sourceId |
Unique indentifier for the source |
integer (int64) |
testId |
Unique indentifier for the test |
integer (int64) |
type |
Define the type of the variable can be float string and integer |
string |
typeEnum |
The variable is the part of the type |
< IdNameValue > array |
typeId |
Unique indentifier for the type |
integer (int64) |
value |
The value of the variable |
object |
variableId |
Unique indentifier for the variable |
integer (int64) |
variableName |
The variable alias name |
string |
3.16. ActivityVariableCounts
| Name | Schema |
|---|---|
activity |
|
eventId |
integer (int64) |
eventType |
enum (TimeBasedEvent, ProductionEvent, UserDefinedEvent, ProductChangeEvent) |
remainingMandatoryVariablesCount |
integer (int32) |
totalMandatoryVariablesCount |
integer (int32) |
totalVariablesCount |
integer (int32) |
3.17. ActivityVariableGroup
| Name | Description | Schema |
|---|---|---|
activity |
The name of an activity |
string |
activityId |
Unique identifier of this activity |
integer (int64) |
activityVariables |
The List of the activity variables |
< ActivityVariable > array |
displayTypeId |
Unique identifier of this display type |
integer (int64) |
isInclusiveSpecCalc |
The spec calculation of a variable |
boolean |
isSheetEditable |
Flag showing if grace time to edit activity variable is available for this record |
boolean |
prodChanged |
Product change of an activity |
boolean |
product |
The info of the product |
|
testTime |
The time when the variable is tested |
string (date-time) |
title |
The title of an activity variables |
string |
variableScrolling |
Variables can be scrolled |
boolean |
3.18. ActivityVariableGroupPage
| Name | Schema |
|---|---|
content |
< ActivityVariableGroupResource > array |
links |
< Link > array |
page |
3.19. ActivityVariableGroupResource
| Name | Description | Schema |
|---|---|---|
activity |
The name of an activity |
string |
activityId |
Unique identifier of this activity |
integer (int64) |
activityVariables |
The List of the activity variables |
< ActivityVariable > array |
displayTypeId |
Unique identifier of this display type |
integer (int64) |
isInclusiveSpecCalc |
The spec calculation of a variable |
boolean |
isSheetEditable |
Flag showing if grace time to edit activity variable is available for this record |
boolean |
links |
< Link > array |
|
prodChanged |
Product change of an activity |
boolean |
product |
The info of the product |
|
testTime |
The time when the variable is tested |
string (date-time) |
title |
The title of an activity variables |
string |
variableScrolling |
Variables can be scrolled |
boolean |
3.20. ActivityVariableGroupResources
| Name | Schema |
|---|---|
content |
< ActivityVariableGroup > array |
links |
< Link > array |
3.21. ActivityVariableResource
| Name | Description | Schema |
|---|---|---|
arrayId |
Id specifying relation of this test record with Array Data table |
integer (int64) |
available |
The value defines the availability of the variable |
boolean |
canceled |
Flag to cancel test entry |
boolean |
commentThreadId |
Thread Id of the comment to fetch the comments associated to variable |
integer (int64) |
description |
The variable description |
string |
engineeringUnits |
Engineering units of the variable |
string |
externalLink |
The variable is the part of the externalLink/opened in the different tab for custom activity |
string |
inputTag |
Historian Input from where this record gets the value |
string |
isEditable |
Flag showing if this Activity variable is editable or not by the User who requested for this record |
boolean |
isMandatory |
Flag showing if this Activity variable is mandatory for this record |
boolean |
isUserDefined |
The variable is user defined variable |
boolean |
links |
< Link > array |
|
order |
Define the variable order |
integer (int64) |
precision |
Define the number of decimals to be shown |
integer (int64) |
sheetId |
Unique identifier of this sheet |
integer (int64) |
source |
Define the variable source can be autolog |
string |
sourceId |
Unique indentifier for the source |
integer (int64) |
testId |
Unique indentifier for the test |
integer (int64) |
type |
Define the type of the variable can be float string and integer |
string |
typeEnum |
The variable is the part of the type |
< IdNameValue > array |
typeId |
Unique indentifier for the type |
integer (int64) |
value |
The value of the variable |
object |
variableId |
Unique indentifier for the variable |
integer (int64) |
variableName |
The variable alias name |
string |
3.22. ActivityViewByRecord
| Name | Description | Schema |
|---|---|---|
activityCount |
Count of activities |
integer (int64) |
id |
Unique identifier of this activity view by record |
integer (int64) |
name |
The name defines the activity is the part of group. product/equipment/event |
string |
overdueCount |
Count of an overdue activity |
integer (int64) |
3.23. ActivityViewByRecordResources
| Name | Schema |
|---|---|
content |
< ActivityViewByRecord > array |
links |
< Link > array |
3.24. ArrayData
| Name | Schema |
|---|---|
dataPoints |
< number (double) > array |
deviationDataPoints |
< number (double) > array |
elementSize |
integer (int32) |
numberOfElements |
integer (int32) |
pctGoodPoints |
< number (float) > array |
3.25. 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.26. BaseAssetInfoResource
| Name | Description | Schema |
|---|---|---|
assetId |
The asset Id |
integer (int64) |
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
3.27. CustomFormData
| Name | Description | Schema |
|---|---|---|
externalURL |
The link where the custom form are open |
string |
password |
Password require to open custom page |
string |
sheetId |
Unique identifier for this sheet id |
integer (int64) |
sheetVariableTitle |
The title of the sheet’s variable |
string |
urlOpenConfiguration |
Url configuration and user details for a custom form |
|
userName |
The user’s name performing on the custom form |
string |
3.28. CustomFormDataResources
| Name | Schema |
|---|---|
content |
< CustomFormData > array |
links |
< Link > array |
3.30. EventHeaderResource
| Name | Description | Schema |
|---|---|---|
eventStartsInfo |
The info an event starts in |
integer (int64) |
id |
integer (int64) |
|
links |
< Link > array |
|
productInfo |
The info the product is a part of the product family |
|
unit |
The Asset (Unit) that identifies this location |
|
user |
The user performing on an event |
3.31. EventSubTypeResource
| Name | Description | Schema |
|---|---|---|
ackRequired |
An event acknowledgement |
integer (int64) |
actionRequired |
An action performed on an event |
integer (int64) |
actionTreeId |
Unique identifier of action tree |
integer (int64) |
causeRequired |
Cause required for an event |
integer (int64) |
causeTreeId |
Unique identifier of cause tree |
integer (int64) |
commentId |
Comment id of a comment |
integer (int64) |
defaultAction1 |
Default action of an event |
integer (int64) |
defaultAction2 |
Default action of an event |
integer (int64) |
defaultAction3 |
Default action of an event |
integer (int64) |
defaultAction4 |
Default action of an event |
integer (int64) |
defaultCause1 |
Default cause of an event |
integer (int64) |
defaultCause2 |
Default cause of an event |
integer (int64) |
defaultCause3 |
Default cause of an event |
integer (int64) |
defaultCause4 |
Default cause of an event |
integer (int64) |
defaultEventStatus |
Default status of an event |
integer (int64) |
etId |
The id of an event |
integer (int64) |
eventReasonTreeDataId |
Unique identifier of this event reason tree data |
integer (int64) |
eventSubtypeDesc |
The description of an event subtype |
string |
eventSubtypeId |
Unique identifier of eventSubType |
integer (int64) |
links |
< Link > array |
3.32. FilterSummary
| Name | Description | Schema |
|---|---|---|
activityEventForUnits |
The List of activity’s events associated with the units |
< ActivityEventUnits > array |
activityEventTypes |
The List of activity event type |
< ActivityEventType > array |
3.34. 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.36. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.37. PagedResources«Resource«ActivityVariableGroup»»
| Name | Schema |
|---|---|
content |
< Resource«ActivityVariableGroup» > array |
links |
< Link > array |
page |
3.38. 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.39. ProductChangeEvent
| Name | Description | Schema |
|---|---|---|
currentEnd |
The end time of the product change |
string (date-time) |
currentStart |
The start time of the product change |
string (date-time) |
eventId |
Unique identifier for this product event |
integer (int64) |
modifiedEnd |
The time product change was ended |
string (date-time) |
modifiedStart |
The time product change was started |
string (date-time) |
productCode |
The product code |
string |
productId |
Unique identifier for this product |
integer (int64) |
3.40. ProductChangeHistory
| Name | Description | Schema |
|---|---|---|
endTime |
The end time of the product change |
string (date-time) |
id |
integer (int64) |
|
productCode |
The product code |
string |
productDescription |
The description of the product |
string |
productId |
Unique identifier for this product |
integer (int64) |
startTime |
The start time of the product change |
string (date-time) |
3.41. ProductChangeRequest
| Name | Description | Schema |
|---|---|---|
eventId |
Unique identifier of an event |
integer (int64) |
productId |
Unique identifier of this product |
string |
timeStamp |
The time the product was requested to change for |
string (date-time) |
unitId |
Unique identifier of this unit |
integer (int64) |
userID |
Unique identifier of this user |
integer (int32) |
3.42. ProductionEvent
| Name | Description | Schema |
|---|---|---|
appliedProduct |
The applied product of product family |
integer (int64) |
commentId |
Comment id for this event |
integer (int64) |
confirmed |
Confirmation flag for this event |
boolean |
entryOn |
The time product gets an entry on. |
string (date-time) |
eventId |
Unique eventId of this production record |
integer (int64) |
eventNumber |
Event number eventId of this production record |
string |
eventStatus |
EventStatus this production event belongs to |
integer (int64) |
eventSubTypeId |
EventSubTypeId this production event belongs to |
integer (int64) |
lotIdentifier |
Lot identifier this event |
string |
operationName |
Operation name of this event |
string |
sourceEvent |
Number of source event of this production event |
integer (int64) |
startTime |
StartTime of this production event |
string (date-time) |
testingComplete |
Production event start time |
integer (int64) |
testingStatus |
Number of testing completed |
integer (int64) |
timeStamp |
Timestamp for production event |
string (date-time) |
unitId |
The unitId this production event belongs to |
integer (int64) |
userId |
User id of this event |
integer (int64) |
3.43. ProductionEventPage
| Name | Schema |
|---|---|
content |
< Resource«ProductionEvent» > array |
links |
< Link > array |
page |
3.44. ProductionRecord
| Name | Description | Schema |
|---|---|---|
alternateEventName |
The alternate name of a product event. |
string |
appliedProduct |
The applied product of product family |
|
approvedReason |
Whenever an Approver signature is provided, a default reason can be automatically attached to the signature. |
|
approverUser |
An Approver signature is provided. |
|
asset |
The Asset (Unit) that identifies this location |
|
comment |
The entered comment of the production event record. |
string |
commentsThreadId |
The Comments Thread Id of the activity record.Points to a chain of comments. |
integer (int64) |
conformance |
conformance is used to test scheduling, grouped by product. |
integer (int64) |
customerOrderId |
Unique idetifier to creates a customer record based on the specified input parameter(s). |
integer (int64) |
customerOrderLineId |
Unique idetifier to creates a customer record based on performing on a line the specified input parameter(s). |
integer (int64) |
department |
The Department this location belongs to |
|
detailCommentsThreadId |
The details comments Thread Id of the activity record.Points to a chain of comments. |
integer (int64) |
detailESignatureId |
The details eSignature of the activity record.Points to a chain of comments. |
integer (int64) |
detailEntryOn |
The time product’s entry details are filled in. |
string (date-time) |
dimensionAName |
The name of the Adimension is commonly used as diameter in multi-dimensional products. |
string |
dimensionAUnit |
The name of the Adimension is commonly used as diameter in multi-dimensional products on a unit/Asset |
string |
dimensionXName |
The name of the Xdimension that defines how much is being produced on a specific production unit. |
string |
dimensionXUnit |
The name of the Xdimension that defines how much is being produced on a specific production unit/Asset. |
string |
dimensionYName |
The name of the Xdimension is commonly used as length in multi-dimensional products. |
string |
dimensionYUnit |
The name of the Xdimension is commonly used as length in multi-dimensional products on a specific unit/Asset. |
string |
dimensionZName |
The name of the Zdimension is commonly used as width in multi-dimensional products. |
string |
dimensionZUnit |
The name of the Zdimension is commonly used as width in multi-dimensional products on a unit/Asset |
string |
eSignatureId |
The eSignature of the user working on oroduction record event. |
integer (int64) |
endTime |
The end time of the production event |
string (date-time) |
entryOn |
The time product gets an entry on. |
string (date-time) |
eventName |
An event name |
string |
eventStatus |
The status of a production event |
|
eventSubType |
The subType of an event |
|
extendedInfo |
More info of the product of the product family |
string |
finalDimensionA |
The final Adimension of the product. |
number (double) |
finalDimensionX |
The final Xdimension of the product. |
number (double) |
finalDimensionY |
The final Ydimension of the product. |
number (double) |
finalDimensionZ |
The final Zdimension of the product. |
number (double) |
initialDimensionA |
The initial Adimension of the product. |
number (double) |
initialDimensionX |
The initial Xdimension of the product. |
number (double) |
initialDimensionY |
The initial Ydimension of the product. |
number (double) |
initialDimensionZ |
The initial Zdimension of the product. |
number (double) |
isLockEventData |
An event’s data is locked. |
boolean |
line |
The Line this location belongs to |
|
orientationX |
Spatial Xorientation of a product. The orientation can be important as product is moved through multiple processing steps. |
number (double) |
orientationY |
Spatial Yorientation of a product. |
number (double) |
orientationZ |
Spatial Zorientation of a product. |
number (double) |
product |
The product of product family |
|
productionPlanId |
The plan Id of the product |
integer (int64) |
productionRecordId |
Unique identifier of this production record |
integer (int64) |
productionSetupDetailId |
Product setup details including the location of the scheduled elements, the publication date of the schedule, the time range of the schedule |
integer (int64) |
productionStatus |
The staus of the product |
|
secondUser |
||
shipmentId |
The shipment Id of the product |
integer (int64) |
sourceEventId |
integer (int64) |
|
startTime |
The start time the production event starts |
string (date-time) |
testPercentComplete |
Percentage complete of the product. |
integer (int64) |
testingStatus |
The testing status of the product |
|
unit |
The Unit that defines the production event on |
|
user |
The user performig on the production record event. |
|
userReason |
The user working in a reason. |
|
userSignOffId |
The user’s signedoff Id. |
integer (int64) |
3.45. ProductionRecordResource
| Name | Description | Schema |
|---|---|---|
alternateEventName |
The alternate name of a product event. |
string |
appliedProduct |
The applied product of product family |
|
approvedReason |
Whenever an Approver signature is provided, a default reason can be automatically attached to the signature. |
|
approverUser |
An Approver signature is provided. |
|
asset |
The Asset (Unit) that identifies this location |
|
comment |
The entered comment of the production event record. |
string |
commentsThreadId |
The Comments Thread Id of the activity record.Points to a chain of comments. |
integer (int64) |
conformance |
conformance is used to test scheduling, grouped by product. |
integer (int64) |
customerOrderId |
Unique idetifier to creates a customer record based on the specified input parameter(s). |
integer (int64) |
customerOrderLineId |
Unique idetifier to creates a customer record based on performing on a line the specified input parameter(s). |
integer (int64) |
department |
The Department this location belongs to |
|
detailCommentsThreadId |
The details comments Thread Id of the activity record.Points to a chain of comments. |
integer (int64) |
detailESignatureId |
The details eSignature of the activity record.Points to a chain of comments. |
integer (int64) |
detailEntryOn |
The time product’s entry details are filled in. |
string (date-time) |
dimensionAName |
The name of the Adimension is commonly used as diameter in multi-dimensional products. |
string |
dimensionAUnit |
The name of the Adimension is commonly used as diameter in multi-dimensional products on a unit/Asset |
string |
dimensionXName |
The name of the Xdimension that defines how much is being produced on a specific production unit. |
string |
dimensionXUnit |
The name of the Xdimension that defines how much is being produced on a specific production unit/Asset. |
string |
dimensionYName |
The name of the Xdimension is commonly used as length in multi-dimensional products. |
string |
dimensionYUnit |
The name of the Xdimension is commonly used as length in multi-dimensional products on a specific unit/Asset. |
string |
dimensionZName |
The name of the Zdimension is commonly used as width in multi-dimensional products. |
string |
dimensionZUnit |
The name of the Zdimension is commonly used as width in multi-dimensional products on a unit/Asset |
string |
eSignatureId |
The eSignature of the user working on oroduction record event. |
integer (int64) |
endTime |
The end time of the production event |
string (date-time) |
entryOn |
The time product gets an entry on. |
string (date-time) |
eventName |
An event name |
string |
eventStatus |
The status of a production event |
|
eventSubType |
The subType of an event |
|
extendedInfo |
More info of the product of the product family |
string |
finalDimensionA |
The final Adimension of the product. |
number (double) |
finalDimensionX |
The final Xdimension of the product. |
number (double) |
finalDimensionY |
The final Ydimension of the product. |
number (double) |
finalDimensionZ |
The final Zdimension of the product. |
number (double) |
initialDimensionA |
The initial Adimension of the product. |
number (double) |
initialDimensionX |
The initial Xdimension of the product. |
number (double) |
initialDimensionY |
The initial Ydimension of the product. |
number (double) |
initialDimensionZ |
The initial Zdimension of the product. |
number (double) |
isLockEventData |
An event’s data is locked. |
boolean |
line |
The Line this location belongs to |
|
links |
< Link > array |
|
orientationX |
Spatial Xorientation of a product. The orientation can be important as product is moved through multiple processing steps. |
number (double) |
orientationY |
Spatial Yorientation of a product. |
number (double) |
orientationZ |
Spatial Zorientation of a product. |
number (double) |
product |
The product of product family |
|
productionPlanId |
The plan Id of the product |
integer (int64) |
productionRecordId |
Unique identifier of this production record |
integer (int64) |
productionSetupDetailId |
Product setup details including the location of the scheduled elements, the publication date of the schedule, the time range of the schedule |
integer (int64) |
productionStatus |
The staus of the product |
|
secondUser |
||
shipmentId |
The shipment Id of the product |
integer (int64) |
sourceEventId |
integer (int64) |
|
startTime |
The start time the production event starts |
string (date-time) |
testPercentComplete |
Percentage complete of the product. |
integer (int64) |
testingStatus |
The testing status of the product |
|
unit |
The Unit that defines the production event on |
|
user |
The user performig on the production record event. |
|
userReason |
The user working in a reason. |
|
userSignOffId |
The user’s signedoff Id. |
integer (int64) |
3.46. Resources«BaseAssetInfo»
| Name | Schema |
|---|---|
content |
< BaseAssetInfo > array |
links |
< Link > array |
3.47. Resources«ProductChangeHistory»
| Name | Schema |
|---|---|
content |
< ProductChangeHistory > array |
links |
< Link > array |
3.48. Resource«ActivityHeader»
| Name | Description | Schema |
|---|---|---|
activityDescription |
The description of an activity |
string |
activityId |
Unique identifier for an activity |
integer (int64) |
activityTypeId |
Type of an activity can be- standard or custom activity |
integer (int64) |
endTime |
The end time of an activity |
string (date-time) |
isAppliedProduct |
flag for applied product |
boolean |
isDisplayUnits |
Display units an activity is associated with. |
boolean |
isLocked |
The value defines an activity is locked or not |
boolean |
keyId |
Creates a time stamp for an event can be-time Based event and product change event of an activity |
string (date-time) |
keyId1 |
Event id of an activity |
integer (int64) |
links |
< Link > array |
|
processOrder |
An activity this process order is requesting |
string |
product |
The product this activity belongs to |
string |
sheetId |
Unique identifier for this sheet |
integer (int64) |
startTime |
The start time of an activity |
string (date-time) |
unitId |
Unit this activity is associated with |
integer (int64) |
user |
User performing on an activity |
3.49. Resource«ActivityVariableGroup»
| Name | Description | Schema |
|---|---|---|
activity |
The name of an activity |
string |
activityId |
Unique identifier of this activity |
integer (int64) |
activityVariables |
The List of the activity variables |
< ActivityVariable > array |
displayTypeId |
Unique identifier of this display type |
integer (int64) |
isInclusiveSpecCalc |
The spec calculation of a variable |
boolean |
isSheetEditable |
Flag showing if grace time to edit activity variable is available for this record |
boolean |
links |
< Link > array |
|
prodChanged |
Product change of an activity |
boolean |
product |
The info of the product |
|
testTime |
The time when the variable is tested |
string (date-time) |
title |
The title of an activity variables |
string |
variableScrolling |
Variables can be scrolled |
boolean |
3.50. Resource«ActivityVariable»
| Name | Description | Schema |
|---|---|---|
arrayId |
Id specifying relation of this test record with Array Data table |
integer (int64) |
available |
The value defines the availability of the variable |
boolean |
canceled |
Flag to cancel test entry |
boolean |
commentThreadId |
Thread Id of the comment to fetch the comments associated to variable |
integer (int64) |
description |
The variable description |
string |
engineeringUnits |
Engineering units of the variable |
string |
externalLink |
The variable is the part of the externalLink/opened in the different tab for custom activity |
string |
inputTag |
Historian Input from where this record gets the value |
string |
isEditable |
Flag showing if this Activity variable is editable or not by the User who requested for this record |
boolean |
isMandatory |
Flag showing if this Activity variable is mandatory for this record |
boolean |
isUserDefined |
The variable is user defined variable |
boolean |
links |
< Link > array |
|
order |
Define the variable order |
integer (int64) |
precision |
Define the number of decimals to be shown |
integer (int64) |
sheetId |
Unique identifier of this sheet |
integer (int64) |
source |
Define the variable source can be autolog |
string |
sourceId |
Unique indentifier for the source |
integer (int64) |
testId |
Unique indentifier for the test |
integer (int64) |
type |
Define the type of the variable can be float string and integer |
string |
typeEnum |
The variable is the part of the type |
< IdNameValue > array |
typeId |
Unique indentifier for the type |
integer (int64) |
value |
The value of the variable |
object |
variableId |
Unique indentifier for the variable |
integer (int64) |
variableName |
The variable alias name |
string |
3.51. Resource«ProductionEvent»
| Name | Description | Schema |
|---|---|---|
appliedProduct |
The applied product of product family |
integer (int64) |
commentId |
Comment id for this event |
integer (int64) |
confirmed |
Confirmation flag for this event |
boolean |
entryOn |
The time product gets an entry on. |
string (date-time) |
eventId |
Unique eventId of this production record |
integer (int64) |
eventNumber |
Event number eventId of this production record |
string |
eventStatus |
EventStatus this production event belongs to |
integer (int64) |
eventSubTypeId |
EventSubTypeId this production event belongs to |
integer (int64) |
links |
< Link > array |
|
lotIdentifier |
Lot identifier this event |
string |
operationName |
Operation name of this event |
string |
sourceEvent |
Number of source event of this production event |
integer (int64) |
startTime |
StartTime of this production event |
string (date-time) |
testingComplete |
Production event start time |
integer (int64) |
testingStatus |
Number of testing completed |
integer (int64) |
timeStamp |
Timestamp for production event |
string (date-time) |
unitId |
The unitId this production event belongs to |
integer (int64) |
userId |
User id of this event |
integer (int64) |
3.52. Resource«ProductionRecord»
| Name | Description | Schema |
|---|---|---|
alternateEventName |
The alternate name of a product event. |
string |
appliedProduct |
The applied product of product family |
|
approvedReason |
Whenever an Approver signature is provided, a default reason can be automatically attached to the signature. |
|
approverUser |
An Approver signature is provided. |
|
asset |
The Asset (Unit) that identifies this location |
|
comment |
The entered comment of the production event record. |
string |
commentsThreadId |
The Comments Thread Id of the activity record.Points to a chain of comments. |
integer (int64) |
conformance |
conformance is used to test scheduling, grouped by product. |
integer (int64) |
customerOrderId |
Unique idetifier to creates a customer record based on the specified input parameter(s). |
integer (int64) |
customerOrderLineId |
Unique idetifier to creates a customer record based on performing on a line the specified input parameter(s). |
integer (int64) |
department |
The Department this location belongs to |
|
detailCommentsThreadId |
The details comments Thread Id of the activity record.Points to a chain of comments. |
integer (int64) |
detailESignatureId |
The details eSignature of the activity record.Points to a chain of comments. |
integer (int64) |
detailEntryOn |
The time product’s entry details are filled in. |
string (date-time) |
dimensionAName |
The name of the Adimension is commonly used as diameter in multi-dimensional products. |
string |
dimensionAUnit |
The name of the Adimension is commonly used as diameter in multi-dimensional products on a unit/Asset |
string |
dimensionXName |
The name of the Xdimension that defines how much is being produced on a specific production unit. |
string |
dimensionXUnit |
The name of the Xdimension that defines how much is being produced on a specific production unit/Asset. |
string |
dimensionYName |
The name of the Xdimension is commonly used as length in multi-dimensional products. |
string |
dimensionYUnit |
The name of the Xdimension is commonly used as length in multi-dimensional products on a specific unit/Asset. |
string |
dimensionZName |
The name of the Zdimension is commonly used as width in multi-dimensional products. |
string |
dimensionZUnit |
The name of the Zdimension is commonly used as width in multi-dimensional products on a unit/Asset |
string |
eSignatureId |
The eSignature of the user working on oroduction record event. |
integer (int64) |
endTime |
The end time of the production event |
string (date-time) |
entryOn |
The time product gets an entry on. |
string (date-time) |
eventName |
An event name |
string |
eventStatus |
The status of a production event |
|
eventSubType |
The subType of an event |
|
extendedInfo |
More info of the product of the product family |
string |
finalDimensionA |
The final Adimension of the product. |
number (double) |
finalDimensionX |
The final Xdimension of the product. |
number (double) |
finalDimensionY |
The final Ydimension of the product. |
number (double) |
finalDimensionZ |
The final Zdimension of the product. |
number (double) |
initialDimensionA |
The initial Adimension of the product. |
number (double) |
initialDimensionX |
The initial Xdimension of the product. |
number (double) |
initialDimensionY |
The initial Ydimension of the product. |
number (double) |
initialDimensionZ |
The initial Zdimension of the product. |
number (double) |
isLockEventData |
An event’s data is locked. |
boolean |
line |
The Line this location belongs to |
|
links |
< Link > array |
|
orientationX |
Spatial Xorientation of a product. The orientation can be important as product is moved through multiple processing steps. |
number (double) |
orientationY |
Spatial Yorientation of a product. |
number (double) |
orientationZ |
Spatial Zorientation of a product. |
number (double) |
product |
The product of product family |
|
productionPlanId |
The plan Id of the product |
integer (int64) |
productionRecordId |
Unique identifier of this production record |
integer (int64) |
productionSetupDetailId |
Product setup details including the location of the scheduled elements, the publication date of the schedule, the time range of the schedule |
integer (int64) |
productionStatus |
The staus of the product |
|
secondUser |
||
shipmentId |
The shipment Id of the product |
integer (int64) |
sourceEventId |
integer (int64) |
|
startTime |
The start time the production event starts |
string (date-time) |
testPercentComplete |
Percentage complete of the product. |
integer (int64) |
testingStatus |
The testing status of the product |
|
unit |
The Unit that defines the production event on |
|
user |
The user performig on the production record event. |
|
userReason |
The user working in a reason. |
|
userSignOffId |
The user’s signedoff Id. |
integer (int64) |
3.53. Resource«SheetColumnRecord»
| Name | Description | Schema |
|---|---|---|
approverReason |
Approve the reason where the sheet is |
|
approverUser |
User approved for the sheet id |
|
commentsThreadId |
Comment thread this record is part of |
integer (int64) |
eSignatureId |
E-signatured for more security for changes approval in sheet id |
integer (int64) |
links |
< Link > array |
|
sheetId |
Unique identifier for this sheet id |
integer (int64) |
timestamp |
The time when the sheet is created |
string (date-time) |
userReason |
User’s reason for approving the sheet id |
|
userSignOff |
User sign off |
3.54. Resource«SheetInfo»
| Name | Description | Schema |
|---|---|---|
asset |
The Asset (Unit) that identifies this location |
|
department |
The Department this location belongs to |
|
eventSubType |
An event subtype the sheet is associated with |
|
eventType |
An event type the sheet is associated with |
|
interval |
An interval an event is available for |
integer (int64) |
line |
The Line this location belongs to |
|
links |
< Link > array |
|
offset |
The offset of an event |
integer (int64) |
sheetGroup |
The group of the sheet is associated with |
|
sheetId |
Unique identifier for this sheet id |
integer (int64) |
sheetName |
The name of the sheet |
string |
sheetType |
The type of the sheet |
3.55. Resource«UserDefinedRecord»
| Name | Description | Schema |
|---|---|---|
ack |
The time start time to research of user defined record |
boolean |
ackBy |
||
ackOn |
string (date-time) |
|
action1 |
The Level 1 Action of the user defined record. |
|
action2 |
The Level 2 Action of the user defined record. |
|
action3 |
The Level 3 Action of the user defined record. |
|
action4 |
The Level 4 Action of the user defined record. |
|
actionCommentsThreadId |
Action comment thread this record is part of |
integer (int64) |
asset |
The asset/unit this location belongs to |
|
cause1 |
The Level 1 Cause (Reason) of the user defined record. |
|
cause2 |
The Level 2 Cause (Reason) of the user defined record. |
|
cause3 |
The Level 3 Cause (Reason) of the user defined record. |
|
cause4 |
The Level 4 Cause (Reason) of the user defined record. |
|
causeCommentsThreadId |
Cause comment thread this record is part of |
integer (int64) |
commentsThreadId |
Comment thread this record is part of |
integer (int64) |
conformance |
integer (int64) |
|
department |
The Department this location belongs to |
|
duration |
The duration of the user defined record. |
integer (int64) |
eSignatureId |
integer (int64) |
|
endTime |
The end time of the user defined event |
string (date-time) |
eventName |
The name of an event |
string |
eventStatus |
The info of an event status |
|
eventSubType |
The info of an event type |
|
isLockEventData |
Defines that event is locked or not |
boolean |
line |
The Line this location belongs to |
|
links |
< Link > array |
|
parentUserDefinedEventId |
integer (int64) |
|
productionEventId |
integer (int64) |
|
reasonTreeDataId |
The reason treeid of user defined record. |
integer (int64) |
researchCloseDate |
The time end time to research of user defined record |
string (date-time) |
researchCommentsThreadId |
Research comment thread this record is part of |
integer (int64) |
researchOpenDate |
The time start time to research of user defined record |
string (date-time) |
researchStatus |
The research status of user defined record. |
|
researchUser |
||
startTime |
The start time of the user defined event starts |
string (date-time) |
testPercentComplete |
integer (int64) |
|
testingStatus |
||
user |
The user defines the user defined record. |
|
userDefinedRecordId |
Unique identifier of this userdefined record |
integer (int64) |
3.56. SheetColumnRecord
| Name | Description | Schema |
|---|---|---|
approverReason |
Approve the reason where the sheet is |
|
approverUser |
User approved for the sheet id |
|
commentsThreadId |
Comment thread this record is part of |
integer (int64) |
eSignatureId |
E-signatured for more security for changes approval in sheet id |
integer (int64) |
sheetId |
Unique identifier for this sheet id |
integer (int64) |
timestamp |
The time when the sheet is created |
string (date-time) |
userReason |
User’s reason for approving the sheet id |
|
userSignOff |
User sign off |
3.57. SheetColumnRecordResource
| Name | Description | Schema |
|---|---|---|
approverReason |
Approve the reason where the sheet is |
|
approverUser |
User approved for the sheet id |
|
commentsThreadId |
Comment thread this record is part of |
integer (int64) |
eSignatureId |
E-signatured for more security for changes approval in sheet id |
integer (int64) |
links |
< Link > array |
|
sheetId |
Unique identifier for this sheet id |
integer (int64) |
timestamp |
The time when the sheet is created |
string (date-time) |
userReason |
User’s reason for approving the sheet id |
|
userSignOff |
User sign off |
3.58. SheetDisplayOptions
| Name | Description | Schema |
|---|---|---|
displayOptionId |
Unique identifier of this display |
integer (int64) |
displayOptionsDesc |
The description of the display |
string |
displayValue |
The display value |
string |
displayValueDesc |
The display value description |
string |
sheetId |
Unique identifier of this sheet |
integer (int64) |
3.59. SheetDisplayOptionsResources
| Name | Schema |
|---|---|
content |
< SheetDisplayOptions > array |
links |
< Link > array |
3.60. SheetEventHeaderResource
| Name | Description | Schema |
|---|---|---|
eventStartsInfo |
The info of the time based event starts in |
integer (int64) |
links |
< Link > array |
|
user |
User working on time based event |
3.61. SheetInfo
| Name | Description | Schema |
|---|---|---|
asset |
The Asset (Unit) that identifies this location |
|
department |
The Department this location belongs to |
|
eventSubType |
An event subtype the sheet is associated with |
|
eventType |
An event type the sheet is associated with |
|
interval |
An interval an event is available for |
integer (int64) |
line |
The Line this location belongs to |
|
offset |
The offset of an event |
integer (int64) |
sheetGroup |
The group of the sheet is associated with |
|
sheetId |
Unique identifier for this sheet id |
integer (int64) |
sheetName |
The name of the sheet |
string |
sheetType |
The type of the sheet |
3.62. SheetInfoResource
| Name | Description | Schema |
|---|---|---|
asset |
The Asset (Unit) that identifies this location |
|
department |
The Department this location belongs to |
|
eventSubType |
An event subtype the sheet is associated with |
|
eventType |
An event type the sheet is associated with |
|
interval |
An interval an event is available for |
integer (int64) |
line |
The Line this location belongs to |
|
links |
< Link > array |
|
offset |
The offset of an event |
integer (int64) |
sheetGroup |
The group of the sheet is associated with |
|
sheetId |
Unique identifier for this sheet id |
integer (int64) |
sheetName |
The name of the sheet |
string |
sheetType |
The type of the sheet |
3.63. TestValueRecord
| Name | Description | Schema |
|---|---|---|
activityId |
ActivityId to whom this test value belongs to |
integer (int64) |
arrayId |
Unique identifier of this array |
integer (int64) |
asset |
The Asset (Unit) that identifies this location |
|
associatedEventRecordId |
Unique identifier of this associatedEventRecord |
integer (int64) |
canceled |
Example : |
boolean |
commentsThreadId |
The Comments Thread Id of the variable.Points to a chain of comments. |
integer (int64) |
dataTypeId |
Unique identifier of this dataType |
integer (int64) |
department |
The Department this location belongs to |
|
eSignatureId |
integer (int64) |
|
entryOn |
The time when the variable is entered in |
string (date-time) |
hasHistory |
Define varible has history |
integer (int64) |
isLocked |
Define the varible associated with an activity is enterted by user is locked |
integer (int64) |
line |
The line this location belongs to |
|
secondUser |
The second user performing on an activity |
|
testTime |
The test time of the variable |
string (date-time) |
testValue |
The test value of the variable |
object |
testValueRecordId |
Unique identifier of this testValueRecord |
integer (int64) |
user |
||
varPrecision |
Define variablePrecision |
integer (int64) |
variable |
The variable of an activity |
3.64. TestValueRecordResource
| Name | Description | Schema |
|---|---|---|
activityId |
ActivityId to whom this test value belongs to |
integer (int64) |
arrayId |
Unique identifier of this array |
integer (int64) |
asset |
The Asset (Unit) that identifies this location |
|
associatedEventRecordId |
Unique identifier of this associatedEventRecord |
integer (int64) |
canceled |
Example : |
boolean |
commentsThreadId |
The Comments Thread Id of the variable.Points to a chain of comments. |
integer (int64) |
dataTypeId |
Unique identifier of this dataType |
integer (int64) |
department |
The Department this location belongs to |
|
eSignatureId |
integer (int64) |
|
entryOn |
The time when the variable is entered in |
string (date-time) |
hasHistory |
Define varible has history |
integer (int64) |
isLocked |
Define the varible associated with an activity is enterted by user is locked |
integer (int64) |
line |
The line this location belongs to |
|
links |
< Link > array |
|
secondUser |
The second user performing on an activity |
|
testTime |
The test time of the variable |
string (date-time) |
testValue |
The test value of the variable |
object |
testValueRecordId |
Unique identifier of this testValueRecord |
integer (int64) |
user |
||
varPrecision |
Define variablePrecision |
integer (int64) |
variable |
The variable of an activity |
3.65. TestValueSpecifications
| Name | Description | Schema |
|---|---|---|
dataTypeId |
Unique identifier for this dataType |
integer (int64) |
lowerControlLimit |
Defines the lower value can be filled for a varibale |
object |
lowerEntryLimit |
The lower entry of the variable |
object |
lowerRejectLimit |
The lower reject limit of the variable |
object |
lowerUserLimit |
The lower limit user can fill for a variable |
object |
lowerWarningLimit |
The lower warining to enter the variable |
object |
target |
Defines the exact target of the variables |
object |
targetControl |
Deifnes the variables values are under control |
object |
targetFreq |
Defines the target frequency of the variables |
integer (int32) |
upperControlLimit |
Defines the upper value can be filled for a varibale |
object |
upperEntryLimit |
The upper entry of the variable |
object |
upperRejectLimit |
The upper reject limit of the variable |
object |
upperUserLimit |
The upper limit user can fill for a variable |
object |
upperWarningLimit |
The upper warining to enter the variable |
object |
variableId |
Unique identifier of this variable |
integer (int64) |
3.66. TestValueStatistics
| Name | Description | Schema |
|---|---|---|
average |
Defiens average value statistics for variable to test |
object |
dataTypeId |
Unique identifier for this dataType |
integer (int64) |
lowerQuartile |
The lowerQuartile of the variable |
object |
maximum |
Defiens minimum value statistics for variable to test |
object |
median |
Defiens median value statistics for variable to test |
object |
minimum |
Defiens maximum value statistics for variable to test |
object |
upperQuartile |
The upperQuartile of the variable |
object |
variableId |
Unique identifier for this varieble |
integer (int64) |
3.67. TestValueStatisticsResources
| Name | Schema |
|---|---|
content |
< TestValueStatistics > array |
links |
< Link > array |
3.68. TimeRangeResource
| Name | Description | Schema |
|---|---|---|
endTime |
The endTime |
string (date-time) |
links |
< Link > array |
|
startTime |
The startTime |
string (date-time) |
3.70. TimeSelectionRange
| Name | Description | Schema |
|---|---|---|
endTime |
The startTime range |
string |
eventEpochEndTime |
integer (int64) |
|
eventEpochStartTime |
The startTime |
integer (int64) |
startTime |
The startTime range |
string |
3.71. TimeSelectionResource
| Name | Schema |
|---|---|
content |
< TimeSelection > array |
links |
< Link > array |
3.72. UserDefinedRecord
| Name | Description | Schema |
|---|---|---|
ack |
The time start time to research of user defined record |
boolean |
ackBy |
||
ackOn |
string (date-time) |
|
action1 |
The Level 1 Action of the user defined record. |
|
action2 |
The Level 2 Action of the user defined record. |
|
action3 |
The Level 3 Action of the user defined record. |
|
action4 |
The Level 4 Action of the user defined record. |
|
actionCommentsThreadId |
Action comment thread this record is part of |
integer (int64) |
asset |
The asset/unit this location belongs to |
|
cause1 |
The Level 1 Cause (Reason) of the user defined record. |
|
cause2 |
The Level 2 Cause (Reason) of the user defined record. |
|
cause3 |
The Level 3 Cause (Reason) of the user defined record. |
|
cause4 |
The Level 4 Cause (Reason) of the user defined record. |
|
causeCommentsThreadId |
Cause comment thread this record is part of |
integer (int64) |
commentsThreadId |
Comment thread this record is part of |
integer (int64) |
conformance |
integer (int64) |
|
department |
The Department this location belongs to |
|
duration |
The duration of the user defined record. |
integer (int64) |
eSignatureId |
integer (int64) |
|
endTime |
The end time of the user defined event |
string (date-time) |
eventName |
The name of an event |
string |
eventStatus |
The info of an event status |
|
eventSubType |
The info of an event type |
|
isLockEventData |
Defines that event is locked or not |
boolean |
line |
The Line this location belongs to |
|
parentUserDefinedEventId |
integer (int64) |
|
productionEventId |
integer (int64) |
|
reasonTreeDataId |
The reason treeid of user defined record. |
integer (int64) |
researchCloseDate |
The time end time to research of user defined record |
string (date-time) |
researchCommentsThreadId |
Research comment thread this record is part of |
integer (int64) |
researchOpenDate |
The time start time to research of user defined record |
string (date-time) |
researchStatus |
The research status of user defined record. |
|
researchUser |
||
startTime |
The start time of the user defined event starts |
string (date-time) |
testPercentComplete |
integer (int64) |
|
testingStatus |
||
user |
The user defines the user defined record. |
|
userDefinedRecordId |
Unique identifier of this userdefined record |
integer (int64) |
3.73. UserDefinedRecordResource
| Name | Description | Schema |
|---|---|---|
ack |
The time start time to research of user defined record |
boolean |
ackBy |
||
ackOn |
string (date-time) |
|
action1 |
The Level 1 Action of the user defined record. |
|
action2 |
The Level 2 Action of the user defined record. |
|
action3 |
The Level 3 Action of the user defined record. |
|
action4 |
The Level 4 Action of the user defined record. |
|
actionCommentsThreadId |
Action comment thread this record is part of |
integer (int64) |
asset |
The asset/unit this location belongs to |
|
cause1 |
The Level 1 Cause (Reason) of the user defined record. |
|
cause2 |
The Level 2 Cause (Reason) of the user defined record. |
|
cause3 |
The Level 3 Cause (Reason) of the user defined record. |
|
cause4 |
The Level 4 Cause (Reason) of the user defined record. |
|
causeCommentsThreadId |
Cause comment thread this record is part of |
integer (int64) |
commentsThreadId |
Comment thread this record is part of |
integer (int64) |
conformance |
integer (int64) |
|
department |
The Department this location belongs to |
|
duration |
The duration of the user defined record. |
integer (int64) |
eSignatureId |
integer (int64) |
|
endTime |
The end time of the user defined event |
string (date-time) |
eventName |
The name of an event |
string |
eventStatus |
The info of an event status |
|
eventSubType |
The info of an event type |
|
isLockEventData |
Defines that event is locked or not |
boolean |
line |
The Line this location belongs to |
|
links |
< Link > array |
|
parentUserDefinedEventId |
integer (int64) |
|
productionEventId |
integer (int64) |
|
reasonTreeDataId |
The reason treeid of user defined record. |
integer (int64) |
researchCloseDate |
The time end time to research of user defined record |
string (date-time) |
researchCommentsThreadId |
Research comment thread this record is part of |
integer (int64) |
researchOpenDate |
The time start time to research of user defined record |
string (date-time) |
researchStatus |
The research status of user defined record. |
|
researchUser |
||
startTime |
The start time of the user defined event starts |
string (date-time) |
testPercentComplete |
integer (int64) |
|
testingStatus |
||
user |
The user defines the user defined record. |
|
userDefinedRecordId |
Unique identifier of this userdefined record |
integer (int64) |
4. Security
4.1. oauth
Type : oauth2
Flow : accessCode
Token URL : https://localhost:8443/oauth/authorize
Token URL : https://localhost:8443/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |