1. Overview

The activities app impl service contains a collection of RESTful service calls to retrive information relevent to comments in manufacturing execution.
Description of endpoints can be found in the section headers for each collection of relevent resources.

1.1. URI scheme

Host : localhost
BasePath : /activities-app-service/

1.2. Tags

  • activity-controller : Activity Controller

  • activity-creator-controller : Activity Creator Controller

  • activity-editor-commands-controller : Activity Editor Commands Controller

  • activity-editor-controller : Activity Editor Controller

  • activity-history-controller : Activity History Controller

  • activity-sheet-controller : Activity Sheet Controller

  • activity-viewer-controller : Activity Viewer Controller

  • esignature-controller : Esignature Controller

  • historian-variable-array-data-controller : Historian Variable Array Data Controller

  • monitoring-controller : Monitoring Controller

  • production-event-controller : Production Event Controller

  • test-history-records-controller : Test History Records Controller

  • user-defined-event-controller : User Defined Event Controller

  • user-info-controller : User Info Controller

  • user-settings-controller : User Settings Controller

  • variable-editor-controller : Variable Editor Controller

  • variable-header-controller : Variable Header Controller

  • variable-history-controller : Variable History Controller

  • variable-test-data-controller : Variable Test Data Controller

2. Resources

2.1. Activity-controller

Activity Controller

2.1.1. Fetches List of records based on the list of activity Ids passed

GET /api/activities
Parameters
Type Name Description Schema

Query

activityIds
required

List of activity ids whose records needs to be fetched

< integer (int64) > array(multi)
Responses
HTTP Code Description Schema

200

OK

< ActivityInfo > array

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2. Activity-creator-controller

Activity Creator Controller

2.2.1. Create product change event

POST /activity-creator/productChangeEvent
Parameters
Type Name Description Schema

Body

productChangeRequest
optional

ProductChangeRequestInfo object to create product change event

ProductChangeRequestInfo
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.2. Fetches product change state event details

GET /activity-creator/productChangeEvent
Parameters
Type Name Description Schema

Query

unitId
optional

Unit id to fetch the product change event

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ProductChangeCreatorInfo

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.3. Fetches product change event for units

GET /activity-creator/productChangeEvent/{eventType}/machines/displays
Parameters
Type Name Description Schema

Path

eventType
optional

Comma separated eventTypes to filter activities, can be UDE, Production, TimeBased Event and Product Change

enum (1, 2, 23, 25)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.4. Fetches product changed events product codes

GET /activity-creator/productChangeEvent/{productGroupId}/productCodes
Parameters
Type Name Description Schema

Path

productGroupId
optional

Product group id to fetch prodcut change event code

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ActivityRecord

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.5. Create production event

POST /activity-creator/production
Parameters
Type Name Description Schema

Body

createProductionRecordInfo
optional

ProductionRecordInfo Object to create Production Event

ProductionRecordInfo
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden , Unit is not configured

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.6. Fetches production record state details

GET /activity-creator/production
Parameters
Type Name Description Schema

Query

sheetId
optional

Sheet id to get production record details

integer (int64)

Query

unitId
optional

Unit id to get production record details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.7. Create time based event

POST /activity-creator/sheetColumn
Parameters
Type Name Description Schema

Body

createSheetColumnRecord
optional

SheetColumnRecordInfo Object to create Timed Based Event

SheetColumnRecordInfo
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden , Unot is not configured

No Content

422

Unprocessable Entity

No Content

500

Internal Server Error

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.8. Fetches time based event state details

GET /activity-creator/sheetColumn
Parameters
Type Name Description Schema

Query

sheetId
optional

Sheet id to get Time Based record details

integer (int64)

Query

unitId
optional

Unit id to get Time Based record details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.9. Create user defined event

POST /activity-creator/userDefined
Parameters
Type Name Description Schema

Body

addUserDefinedRecordInfo
optional

UserDefinedRecordInfo Object to create user defined event

UserDefinedRecordInfo
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden , Unot is not configured

No Content

500

Internal Server Error

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.10. Fetches user defined record state details

GET /activity-creator/userDefined
Parameters
Type Name Description Schema

Query

sheetId
optional

Sheet id to get user defined record details

integer (int64)

Query

unitId
optional

Unit id to get user defined record details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.11. Fetches sheet displays based on event type enum

GET /activity-creator/{eventType}/displays
Parameters
Type Name Description Schema

Path

eventType
optional

Comma separated eventTypes to filter activities, can be UDE, Production, TimeBased Event and Product Change

enum (1, 2, 23, 25)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden, No machine is available

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3. Activity-editor-commands-controller

Activity Editor Commands Controller

2.3.1. Perform Release on Activities

POST /activityEditorCommands/releaseActivities
Parameters
Type Name Description Schema

Body

activityIds
optional

activityIds to release

< integer (int64) > array
Responses
HTTP Code Description Schema

200

OK

ActivityCommandResponse

400

Bad Request , Invalid data is supplied

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.2. Perform Skip on Activities

POST /activityEditorCommands/skipActivities
Parameters
Type Name Description Schema

Body

activityIds
optional

activityIds to Skip

< integer (int64) > array
Responses
HTTP Code Description Schema

200

OK

ActivityCommandResponse

400

Bad Request , Invalid data is supplied

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4. Activity-editor-controller

Activity Editor Controller

2.4.1. Fetches activity comments

GET /activity-editor/comment
Parameters
Type Name Description Schema

Query

assetId
optional

Asset id of an activity to get comment details

integer (int64)

Query

commentId
optional

Comment id of an activity to get comment details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable , EntityModel access is not allowed

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.2. Add activity comments

POST /activity-editor/{activityId}/comments
Parameters
Type Name Description Schema

Path

activityId
optional

Activity id of an activity to which the activity comments will be added

integer (int64)

Body

statusInfo
optional

ActivityStatusRequest object to add activity comments

ActivityStatusRequest
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request , Invalid data is supplied

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.3. Fetches activity comments

GET /activity-editor/{activityId}/comments
Parameters
Type Name Description Schema

Path

activityId
optional

Activity id of an activity to get comments details

integer (int64)

Query

commentType
optional

Type of comments for an activity can be General, Overdue, Skip and Activity Detail Comment

< enum (GENERAL, OVERDUE, SKIP, ACTIVITY_DETAIL) > array(multi)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.4. Update activity comments

PUT /activity-editor/{activityId}/comments/{commentThreadId}/{commentId}
Parameters
Type Name Description Schema

Path

activityId
optional

Activity id of an activity to update comments

integer (int64)

Path

commentId
optional

Comment id of an activity to update comment details

integer (int64)

Path

commentThreadId
optional

Chained commentThreadId to update activity comments

integer (int64)

Query

unitId
optional

Unit id of an activity to update comment

integer (int64)

Body

activityInfo
optional

ActivityStatusRequest object to update activity comments

ActivityStatusRequest
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable , EntityModel access is not allowed

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.5. Delete activity comments

DELETE /activity-editor/{activityId}/comments/{commentThreadId}/{commentId}
Parameters
Type Name Description Schema

Path

activityId
optional

activity id of an activity to delete a comments

integer (int64)

Path

commentId
optional

Comment id of an activity to delete comment details

integer (int64)

Path

commentThreadId
optional

Chained comment thread id to delete activity comments

integer (int64)

Query

commentType
optional

Type of comment can be General, Overdue and Skip

string

Query

unitId
optional

Unit id of an activity to delete comments data

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content

503

Service Unavailable , EntityModel access is not allowed

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5. Activity-history-controller

Activity History Controller

2.5.1. Fetches the activity records

GET /activity-history
Parameters
Type Name Description Schema Default

Query

activityId
optional

Activity id to get the page that contains this activity. Page parameter is ignored if activity id is provided

integer (int64)

Query

batchNumber
optional

Filtering activities by batch number

string

Query

completeType
optional

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
optional

End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection

string (date-time)

Query

equipments
optional

Comma separated list of unit ids

string

Query

eventNumber
optional

Filtering activities by event number

string

Query

eventTypes
optional

Comma separated eventTypes to filter activities, can be UDE, Production, TimeBased Event and Product Change

enum (1, 2, 23, 25)

Query

excludeActionLinks
optional

Optional flag telling the api whether to include hatheos links for actions Perform, Skip, in progress, Complete, Release and get comments in the response, defaults to true

boolean

"false"

Query

isOverdue
optional

If true returns only overdue activities.

integer (int32)

Query

page
optional

Results per page you want to retrieve (0..500)

integer (int32)

0

Query

processOrderName
optional

Filtering activities by process order name

string

Query

processOrders
optional

Comma separated list of process order ids

string

Query

productCode
optional

Filtering activities by product code

string

Query

products
optional

Comma separated list of product ids

string

Query

size
optional

Number of records per page.

integer (int32)

20

Query

sortColumn
optional

Optional sort column of activities, can be Activity, TimeDue, DueIn, PercentComplete, UserName, Duration, EndTime

string

Query

sortOrder
optional

Ascending or descending order of data

string

Query

startTime
optional

Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection

string (date-time)

Query

status
optional

Comma saperated list of activity status, can be 1-Not Started, 2-In Progress, 3-Complete, 4-Skipped, 5-Released

string

Query

timeSelection
optional

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int64)

Query

timeZone
optional

Time zone of startTime and endTime

string

"UTC"

Query

variables
optional

Filtering activities by variable name.

string
Responses
HTTP Code Description Schema

200

OK

ActivityViewerStateResource

204

No Content, Unit is not configured

HttpErrorResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.2. Fetches the activity details by activity id

GET /activity-history/activity/{activityId}
Parameters
Type Name Description Schema

Path

activityId
optional

activity id of activity to get the activity record

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content

503

Service Unavailable , EntityModel access is not allowed

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.3. Update activity record

PUT /activity-history/activity/{id}
Parameters
Type Name Description Schema

Path

id
optional

Id of activity id to update the activity record

integer (int64)

Body

statusInfo
optional

ActivityStatusRequest object to update an activity record

ActivityStatusRequest
Responses
HTTP Code Description Schema

200

OK

ActivityRecord

401

Unauthorized

No Content

403

Forbidden , User is not allowed to update the activity record

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.4. This end point is used to clear the information of activities. This would be deprecated to the future

DELETE /activity-history/cache
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.5. Fetches activites view options like time selections, view by groups and create activities details

GET /activity-history/context-loader
Caution

operation.deprecated
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.6. Activities equipment options

GET /activity-history/equipments
Responses
HTTP Code Description Schema

200

OK

object

204

No Content , Unit is not configured

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.7. Activities filter options

GET /activity-history/filter-options
Caution

operation.deprecated
Responses
HTTP Code Description Schema

200

OK

object

204

No Content , Unit is not configured

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.8. Fetches the time selection intervals

GET /activity-history/time-selection
Parameters
Type Name Description Schema

Query

equipmentId
optional

Comma separated list of equipment Ids.

< string > array(multi)

Query

equipmentType
optional

Equipment type values are 1 for Units, 2 for Lines, 3 for Departments.

integer (int32)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

TimeSelectionRange

204

No Content

TimeSelectionRange

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.9. Fetches the time Selection options available for activities app

GET /activity-history/timeSelectionOptions
Responses
HTTP Code Description Schema

200

OK

< IdNameValue > array

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6. Activity-sheet-controller

Activity Sheet Controller

2.6.1. Fetches Sheet permissions

GET /api/activitySheet/permissions
Parameters
Type Name Description Schema

Query

sheetIds
required

List of Sheet ids

< integer (int64) > array(multi)
Responses
HTTP Code Description Schema

200

OK

object

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7. Activity-viewer-controller

Activity Viewer Controller

2.7.1. Fetches the activity records

GET /activity-viewer
Parameters
Type Name Description Schema Default

Query

activityId
optional

Activity id to get the page that contains this activity. Page parameter is ignored if activity id is provided

integer (int64)

Query

batchNumber
optional

Filtering activities by batch number

string

Query

completeType
optional

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
optional

End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection

string (date-time)

Query

equipments
optional

Comma separated list of unit ids

string

Query

eventNumber
optional

Filtering activities by event number

string

Query

eventTypes
optional

Comma separated eventTypes to filter activities, can be UDE, Production, TimeBased Event and Product Change

enum (1, 2, 23, 25)

Query

excludeActionLinks
optional

Optional flag telling the api whether to include hatheos links for actions Perform, Skip, in progress, Complete, Release and get comments in the response, defaults to true

boolean

"false"

Query

isOverdue
optional

If true returns only overdue activities.

integer (int32)

Query

page
optional

Results per page you want to retrieve (0..500)

integer (int32)

0

Query

processOrderName
optional

Filtering activities by process order name

string

Query

processOrders
optional

Comma separated list of process order ids

string

Query

productCode
optional

Filtering activities by product code

string

Query

products
optional

Comma separated list of product ids

string

Query

size
optional

Number of records per page.

integer (int32)

20

Query

sortColumn
optional

Optional sort column of activities, can be Activity, TimeDue, DueIn, PercentComplete, UserName, Duration, EndTime

string

Query

sortOrder
optional

Ascending or descending order of data

string

Query

startTime
optional

Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection

string (date-time)

Query

status
optional

Comma saperated list of activity status, can be 1-Not Started, 2-In Progress, 3-Complete, 4-Skipped, 5-Released

string

Query

timeSelection
optional

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int64)

Query

timeZone
optional

Time zone of startTime and endTime

string

"UTC"

Query

variables
optional

Filtering activities by variable name.

string
Responses
HTTP Code Description Schema

200

OK

ActivityViewerStateResource

204

No Content, Unit is not configured

HttpErrorResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.2. Fetches List of activityIds by testRecordId

GET /activity-viewer/activities
Parameters
Type Name Description Schema

Query

testRecordId
required

Test record id to get the list of activity ids

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

object

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.3. Fetches the activity records

GET /activity-viewer/activities/{viewBy}
Parameters
Type Name Description Schema Default

Path

viewBy
required

viewBy

enum (Product, ProcessOrder, Equipment, Event, Activity)

Query

activityId
optional

Activity id to get the page that contains this activity. Page parameter is ignored if activityId is provided

integer (int64)

Query

batchNumber
optional

Filtering activities by batch number

string

Query

completeType
optional

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
optional

Filtering activities by display type can be 0-Standard or 1-Custom

integer (int32)

Query

endTime
optional

End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection

string (date-time)

Query

equipments
required

Comma separated list of unit ids

string

Query

eventNumber
optional

Filtering activities by event number

string

Query

eventTypes
optional

Comma separated eventTypes to filter activities, can be UDE, Production, TimeBased Event and Product Change

enum (1, 2, 23, 25)

Query

isOverdue
optional

If true returns only overdue activities.

integer (int32)

Query

processOrderName
optional

Filtering activities by process order name

string

Query

processOrders
optional

Comma separated list of process order ids

string

Query

productCode
optional

Filtering activities by product code

string

Query

products
optional

Comma separated list of product ids

string

Query

startTime
optional

Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection

string (date-time)

Query

status
optional

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
optional

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int64)

Query

timeZone
optional

Time zone of startTime and endTime

string

"UTC"

Query

variables
optional

Filtering activities by variable name.

string
Responses
HTTP Code Description Schema

200

OK

ActivityViewerStateResource

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.4. Fetches the activity details by activity id

GET /activity-viewer/activity/{activityId}
Parameters
Type Name Description Schema

Path

activityId
optional

activity id of activity to get the activity record

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content

503

Service Unavailable , EntityModel access is not allowed

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.5. Update activity record

PUT /activity-viewer/activity/{id}
Parameters
Type Name Description Schema

Path

id
optional

Id of activity id to update the activity record

integer (int64)

Body

statusInfo
optional

ActivityStatusRequest object to update an activity record

ActivityStatusRequest
Responses
HTTP Code Description Schema

200

OK

ActivityRecord

401

Unauthorized

No Content

403

Forbidden , User is not allowed to update the activity record

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.6. This end point is used to clear the information of activities. This would be deprecated to the future

DELETE /activity-viewer/cache
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.7. Fetches activites view options like time selections, view by groups and create activities details

GET /activity-viewer/context-loader
Caution

operation.deprecated
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.8. Activities equipment options

GET /activity-viewer/equipments
Responses
HTTP Code Description Schema

200

OK

object

204

No Content , Unit is not configured

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.9. Activities filter options

GET /activity-viewer/filter-options
Caution

operation.deprecated
Responses
HTTP Code Description Schema

200

OK

object

204

No Content , Unit is not configured

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.10. Fetches the time selection intervals

GET /activity-viewer/time-selection
Parameters
Type Name Description Schema

Query

equipmentId
optional

Comma separated list of equipment Ids.

< string > array(multi)

Query

equipmentType
optional

Equipment type values are 1 for Units, 2 for Lines, 3 for Departments.

integer (int32)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

TimeSelectionRange

204

No Content

TimeSelectionRange

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.11. Fetches the time Selection options available for activities app

GET /activity-viewer/timeSelectionOptions
Responses
HTTP Code Description Schema

200

OK

< IdNameValue > array

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8. Esignature-controller

Esignature Controller

2.8.1. Fetches approvers list, having access a given sheet

GET /esignatureApprovers
Parameters
Type Name Description Schema

Query

sheetId
optional

sheet id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.9. Historian-variable-array-data-controller

Historian Variable Array Data Controller

2.9.1. Get information about the data values for an array data type variable’s historian tag

GET /historianVariableArrayData
Parameters
Type Name Description Schema

Query

arrayId
optional

ArrayId whose data points need to be pulled in

integer (int64)

Query

historianInputTag
optional

Input tag column value for a historian variable

string
Responses
HTTP Code Description Schema

200

OK

HistorianTagDataPointResponse

400

Bad Request

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10. Monitoring-controller

Monitoring Controller

2.10.1. Fetches status for proficy message bridge

GET /monitoring-viewer/messageBridgeStatus
Responses
HTTP Code Description Schema

200

OK

EntityModel«ServiceHealthStatus»

204

No Content, no service exists

EntityModel«ServiceHealthStatus»

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10.2. Fetches status for proficy message bridge

GET /monitoring-viewer/messagingStatus
Responses
HTTP Code Description Schema

200

OK

EntityModel«ServiceHealthStatus»

204

No Content, no service exists

EntityModel«ServiceHealthStatus»

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10.3. Fetches status for rabbit mq

GET /monitoring-viewer/rmqStatus
Responses
HTTP Code Description Schema

200

OK

EntityModel«ServiceHealthStatus»

204

No Content, no service exists

EntityModel«ServiceHealthStatus»

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.11. Production-event-controller

Production Event Controller

2.11.1. Fetches a production record

GET /productionEvent
Parameters
Type Name Description Schema

Query

eventId
optional

Event id of an event to get a production record

integer (int64)

Query

sheetId
optional

Sheet id to get the event header of production event

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ProductionRecordInfoResource

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.11.2. Update a production record by event id

PUT /productionEvent
Parameters
Type Name Description Schema

Query

eventId
optional

Event id of an event to update a production record

integer (int64)

Body

updatedProductionRecordInfo
optional

ProductionRecordInfo object to update the production record

ProductionRecordInfo
Responses
HTTP Code Description Schema

200

OK

ProductionRecordInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

412

Precondition Failed

No Content

500

Internal Server Error

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.11.3. Fetches a production record status by event id

GET /productionEvent/productionEventStatusOptions
Parameters
Type Name Description Schema

Query

eventId
optional

Event id of an event to get a production record status

integer (int64)
Responses
HTTP Code Description Schema

200

OK

CollectionResource«IdNameValue»

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found, EntityModel is not found.

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.11.4. Creates production event comments

POST /productionEvent/{eventId}/comments
Parameters
Type Name Description Schema

Path

eventId
optional

Event id of an event to create a production event comments

integer (int64)

Query

sheetId
required

sheetId

integer (int64)

Body

productionEventUpdates
optional

ProductionEventUpdates object to create a prodcution event comment

ProductionEventUpdates
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.11.5. Fetches a production record status by event id

GET /productionEvent/{eventId}/comments
Parameters
Type Name Description Schema

Path

eventId
optional

Event id of an event to get a production record status

integer (int64)

Query

sheetId
optional

Sheet id to get a production event comment

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.11.6. Update a production event comment

PUT /productionEvent/{eventId}/comments/{commentId}
Parameters
Type Name Description Schema

Path

commentId
optional

Comment id of the comment to update

integer (int64)

Path

eventId
optional

Event id of an event to update a production event comments

integer (int64)

Query

commentThreadId
required

Comment thread id of the comment to update

integer (int64)

Query

sheetId
optional

Sheet id to update a production event comments

integer (int64)

Body

productionEventUpdates
optional

ProductionEventUpdates Object to update a comment

ProductionEventUpdates
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.11.7. Delete production record state details

DELETE /productionEvent/{eventId}/comments/{commentId}
Parameters
Type Name Description Schema

Path

commentId
optional

Comment thread id of the comment to delete

integer (int64)

Path

eventId
optional

Event id of an event to delete a production event comments

integer (int64)

Query

commentThreadId
required

Comment thread id of the comment to delete

integer (int64)

Query

sheetId
optional

Sheet id to update a production event comments

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.12. Test-history-records-controller

Test History Records Controller

2.12.1. Fetches the esignature test value records history

GET /testHistory
Parameters
Type Name Description Schema Default

Query

page
optional

Page number to fetch. Defaults to 0

integer (int32)

0

Query

size
optional

Number of records per page. Defaults to 20

integer (int32)

20

Query

testId
optional

Test Id whose history values is to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< TestHistoryRecord > array

401

Unauthorized

No Content

500

Internal Server error, See logs for details

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13. User-defined-event-controller

User Defined Event Controller

2.13.1. Fetches user defined record details

GET /userDefinedEvent
Parameters
Type Name Description Schema

Query

eventId
required

Event id of an event to get user defined record details

integer (int64)

Query

sheetId
required

Sheet id to get user defined record details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.2. Update user defined record details

PUT /userDefinedEvent
Parameters
Type Name Description Schema

Query

eventId
required

Event id of an event to update user defined record details

integer (int64)

Body

updatedUserDefinedRecordInfo
optional

UserDefinedRecordInfo object to update user defined record

UserDefinedRecordInfo
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.3. Fetches user defined status options

GET /userDefinedEvent/userDefinedEventStatusOptions
Parameters
Type Name Description Schema

Query

eventId
required

Event id of an event to get user defined record status options

integer (int64)
Responses
HTTP Code Description Schema

200

OK

CollectionResource«IdNameValue»

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.4. Create user defined event comments

POST /userDefinedEvent/{eventId}/comments
Parameters
Type Name Description Schema

Path

eventId
optional

Event id to get Userdefined record comment details

integer (int64)

Query

sheetId
required

Sheet id to fetch user defined comments details

integer (int64)

Body

userDefinedEventUpdates
required

UserDefinedUpdates object to create user defined event comment

UserDefinedUpdates
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.5. Fetches userdefined record comments details

GET /userDefinedEvent/{eventId}/comments
Parameters
Type Name Description Schema

Path

eventId
optional

Event id of an event to get user defined event comments

integer (int64)

Query

sheetId
required

Sheet id to fetch user defined comments details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.6. Delete user defined event comments based on comment id

DELETE /userDefinedEvent/{eventId}/comments/{commentId}
Parameters
Type Name Description Schema

Path

commentId
optional

Comment id to delete user defined event comment details

integer (int64)

Path

eventId
optional

Event id of an event to delete user defined record comment details

integer (int64)

Query

commentThreadId
optional

comment thread id to delete user defined event comment details

integer (int64)

Query

sheetId
optional

Sheet id to update user defined event comment details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.7. Update existing user defined record comments based on comment thread id and comment id

PUT /userDefinedEvent/{eventId}/comments/{commentThreadId}/{commentId}
Parameters
Type Name Description Schema

Path

commentId
optional

Comment id to update user defined event comment details

integer (int64)

Path

commentThreadId
optional

comment thread id to update user defined event comment details

integer (int64)

Path

eventId
optional

Event id of an event to update user defined record comment details

integer (int64)

Query

sheetId
optional

Sheet id to update user defined event comment details

integer (int64)

Body

userDefinedEventUpdates
optional

UserDefinedUpdates Object to update user defined event comment details

UserDefinedUpdates
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.14. User-info-controller

User Info Controller

2.14.1. userInfo

GET /userInfo
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

401

Unauthorized

No Content

404

Not Found

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.15. User-settings-controller

User Settings Controller

2.15.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema

Body

userSettingsRequest
optional

User Setting Object

UserSettingRequest
Responses
HTTP Code Description Schema

201

Created

UserSettingResponseResource

204

No Content, Error retrieving created user settings

HttpErrorResponse

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

App ID not found in privilege set

HttpErrorResponse

409

Conflict, User Setting already exists. Use a PUT to update

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.15.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

UserSettingResponseResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.15.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema

Body

request
optional

User Preference Object

UserSettingRequest
Responses
HTTP Code Description Schema

200

OK

UserSettingResponseResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, There is no saved User settings for the logged in user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.15.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

object

204

Success

string

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, User Setting not found

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.15.5. Get Privilege Sets

GET /v2/settings/apps
Parameters
Type Name Description Schema

Query

appName
optional

appName

string
Responses
HTTP Code Description Schema

200

OK

< PrivilegeSet > array

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16. Variable-editor-controller

Variable Editor Controller

2.16.1. Fetches activity variables details

GET /variable-editor
Parameters
Type Name Description Schema Default

Query

activityId
required

Activity id of an activity to get edit state of an activity

integer (int64)

Query

enableVariableScrolling
optional

Enable variable scrolling for scrolling activities variables

boolean

"false"

Query

page
optional

Page Number (0..500)

integer (int32)

0

Query

size
optional

Number of records per page.

integer (int32)

20

Query

variableFilter
optional

variableFilter used to encoding. The default value is UTF-8

string
Responses
HTTP Code Description Schema

200

OK

ActivityEditorState

204

No Content

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.2. Update activity variable from edit state

PUT /variable-editor
Parameters
Type Name Description Schema

Query

activityId
optional

Activity id of an activity to update activity variable

integer (int64)

Query

variableId
optional

Variable id of an activity to update activity variable

integer (int64)

Body

activityVariableUpdates
optional

ActivityVariableUpdates object to update acitivity variables

ActivityVariableUpdates
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.3. Fetches production event information for an activity

GET /variable-editor/productionEvent
Parameters
Type Name Description Schema

Query

eventId
optional

Event id of events to get production event for an activity

integer (int64)

Query

sheetId
optional

Sheet id to get production event for an activity

integer (int64)
Responses
HTTP Code Description Schema

200

OK

EntityModel«ProductionRecordInfo»

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.4. Update production record

PUT /variable-editor/productionEvent
Parameters
Type Name Description Schema

Query

eventId
optional

Event id of events to get produciton event status for an activity

integer (int64)

Body

updatedProductionRecordInfo
optional

ProductionRecordInfo object to update production event for an activity

ProductionRecordInfo
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.5. Fetches production event status options for an event

GET /variable-editor/productionEventStatusOptions
Parameters
Type Name Description Schema

Query

eventId
optional

Event id of events to get produciton event status for an activity

integer (int64)
Responses
HTTP Code Description Schema

200

OK

CollectionResource«IdNameValue»

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.6. Fetches user defined event information for an activity

GET /variable-editor/userDefinedEvent
Parameters
Type Name Description Schema

Query

eventId
optional

Event id of events to get user defined event for an activity

integer (int64)

Query

sheetId
optional

Sheet id get user defined event for an activity

integer (int64)
Responses
HTTP Code Description Schema

200

OK

EntityModel«UserDefinedRecordInfo»

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.7. Update user defined event information for an activity

PUT /variable-editor/userDefinedEvent
Parameters
Type Name Description Schema

Query

eventId
optional

Event id of events to update user defined event for an activity

integer (int64)

Body

updatedUserDefinedRecordInfo
optional

UserDefinedRecordInfo object to update user defined event for an activity

UserDefinedRecordInfo
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.8. Fetches user defined event status options for an event

GET /variable-editor/userDefinedEventStatusOptions
Parameters
Type Name Description Schema

Query

eventId
optional

Event id of events to get user defined status for an activity

integer (int64)
Responses
HTTP Code Description Schema

200

OK

CollectionResource«IdNameValue»

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.9. Add variable comments

POST /variable-editor/{variableId}/comments
Parameters
Type Name Description Schema

Path

variableId
optional

Variable id of an activity to add variable comments

integer (int64)

Query

activityId
optional

Activity id of an activity to add variable comments

integer (int64)

Body

activityVariableUpdates
optional

ActivityVariableUpdates object to add variable comments

ActivityVariableUpdates
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.10. Fetches variable comments

GET /variable-editor/{variableId}/comments
Parameters
Type Name Description Schema

Path

variableId
optional

Variable id of an activity to get variables comments

integer (int64)

Query

activityId
optional

Activity id of an activity to get variables comments

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

No Content

503

Service Unavailable, EntityModel access is not allowed

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.11. Update variable comments record

PUT /variable-editor/{variableId}/comments/{commentId}
Parameters
Type Name Description Schema

Path

commentId
optional

Comment id of an activity to update variable comments

integer (int64)

Path

variableId
optional

Variable id of an activity to update variable comments

integer (int64)

Query

activityId
optional

Activity id of an activity to update variable comments

integer (int64)

Query

commentThreadId
optional

Comment Thread Id of an activity to update variable comments

integer (int64)

Body

commentInfo
optional

CommentInfo objcet to update a variable comments

CommentInfo
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable, EntityModel access is not allowed

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.16.12. Delete varible comments

DELETE /variable-editor/{variableId}/comments/{commentId}
Parameters
Type Name Description Schema

Path

commentId
optional

Comment id of an activity to delete a variable comments

integer (int64)

Path

variableId
optional

Varible id of an activity to delete a variable comments

integer (int64)

Query

activityId
optional

Activity id of an activity to delete a variable comments

integer (int64)

Query

commentThreadId
optional

Comment thread id of an activity to delete a variable comments

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable, EntityModel access is not allowed

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.17. Variable-header-controller

Variable Header Controller

2.17.1. Fetches activity header details

GET /variable-header
Parameters
Type Name Description Schema

Query

activityId
optional

Activity id of an activity to get activity header

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ActivityHeaderInfo

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.18. Variable-history-controller

Variable History Controller

2.18.1. Fetches the history of Activity along with the test data on each activity

GET /variable-history
Parameters
Type Name Description Schema Default

Query

activityId
required

activityId

integer (int64)

Query

directionBackward
optional

Optional Input parameter for direction to determine if returned activities come before or after activityId

boolean

Query

isInclusive
optional

Optional Input parameter for is inclusive to determine whether to include the activity details of the activityId passed as the first parameter

boolean

Query

sameProduct
optional

Fetch the details of activities with same product as the activityId given in first parameter

boolean

Query

sheetId
optional

Sheet id to get variable history of an activity

integer (int64)

Query

size
optional

Number of records to fetch

integer (int32)

20

Query

startActivityId
optional

Start activity id to get the starting point for the variable history

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.19. Variable-test-data-controller

Variable Test Data Controller

2.19.1. Gets the list of variable and test data along with the specifications for the list of variable ids passed. Currently only supporting Production Events, User Defined Events and Time based Events

GET /api/variablesTestData
Parameters
Type Name Description Schema

Query

activityId
optional

Fetch the variable test data for this activity. Would be given 1st priority if there are other filters too. Should be the same event type as the variables supplied

integer (int64)

Query

eventId
optional

Fetch the variable test data for this event. Would be given 2nd priority if there are other filters too. Event type would be derived from the variable itself, for time based events this field should be ISO 8601 format Date time (yyyy-MM-dd’T’HH:mm:ss.SSSZ)

object

Query

lastKnownValue
optional

Fetch the details when this variable test stubbed a non null value. Would be given 4th priority if there are other filters too.

boolean

Query

resultOn
optional

Fetch the variable test data at this time if exists ISO 8601 format Date time (yyyy-MM-dd’T’HH:mm:ss.SSSZ). Would be given 3th priority if there are other filters too.

string (date-time)

Query

variableIds
required

Comma seprated variable ids to get the details. All the variable ids should be of same event type, and uniy. Mixed mode wrt to event types or production units not supported

< integer (int64) > array(multi)
Responses
HTTP Code Description Schema

200

OK

< VariableTestDetails > array
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

3. Definitions

3.1. ActivityCommandResponse

Name Schema

message
optional

string

3.2. ActivityCustomForm

Name Schema

customActivityUser
optional

User

externalURL
optional

string

openURL
optional

IdNameValue

3.3. ActivityEditorState

Name Schema

activityInfo
optional

EntityModel«ActivityInfo»

eventInfo
optional

EventInfo

variableInfo
optional

VariableInfo

variablePages
optional

PagedModel«EntityModel«VariablePage»»

3.4. ActivityHeaderInfo

Name Schema

activityDescription
optional

string

activityTypeId
optional

integer (int64)

endTime
optional

string (date-time)

isAppliedProduct
optional

boolean

isDisplayUnits
optional

boolean

isLocked
optional

boolean

keyId
optional

string (date-time)

keyId1
optional

integer (int64)

lockEventData
optional

boolean

lockUnavailableCells
optional

boolean

processOrder
optional

string

product
optional

string

sheetId
optional

integer (int64)

startTime
optional

string (date-time)

unitId
optional

integer (int64)

user
optional

IdNameValue

3.5. ActivityInfo

Name Description Schema

activityDetailCommentThreadId
optional

integer (int64)

activityId
optional

integer (int64)

activityName
optional

string

activityType
optional

IdNameValue

asset
optional

BaseAssetInfo

autoComplete
optional

boolean

commentHistory
optional

< EntityModel«CommentInfo» > array

commentsThreadId
optional

integer (int64)

completedTime
optional

string (date-time)

completedType
optional

IdNameValue

customFormData
optional

ActivityCustomForm

displayTypeId
optional

integer (int64)

dueIn
optional

integer (int64)

duration
optional

integer (int64)

durationIn
optional

string

estimatedStartTime
optional

string (date-time)

eventNumber
optional

string

hasAvailableCells
optional

boolean

hasVariableAliasing
optional

boolean

isLikelyOverdueActivity
optional

boolean

isOverdueActivity
optional

boolean

keyId
optional

integer (int64)

keyTime
optional

string (date-time)

line
optional

BaseAssetInfo

locked
optional

boolean

mytime
optional

This property would be deprecated in the feature as its not being used anywhere in the product

string (date-time)

overdueComment
optional

string

overdueCommentRequired
optional

boolean

overdueCommentsThreadId
optional

integer (int64)

overrideLockPermission
optional

boolean

percentageComplete
optional

number (float)

priority
optional

integer (int64)

processOrder
optional

IdNameValue

product
optional

Product

sheetId
optional

integer (int64)

sheetName
optional

string

sheetVariableTitle
optional

string

skipComment
optional

string

skipCommentRequired
optional

boolean

skipCommentsThreadId
optional

integer (int64)

startTime
optional

string (date-time)

status
optional

enum (NotValidStatus, NotStarted, InProgress, Skipped, Released, Completed)

statusId
optional

integer (int64)

targetDuration
optional

number (double)

testsToComplete
optional

integer (int64)

timeDue
optional

string (date-time)

user
optional

ActivityUsers

3.6. ActivityRecord

Name Description Schema

activityId
optional

Unique identifier of an activity

integer (int64)

activityType
optional

The info of an activity type

IdNameValue

asset
optional

The Asset (Unit) that identifies this location

BaseAssetInfo

autoComplete
optional

Defines an activity is auto complete
Example : false

boolean

commentsThreadId
optional

Thread Id of the comment to fetch the comments associated to it

integer (int64)

completedType
optional

Whether the activity was completed by user or system

IdNameValue

department
optional

The Department this location belongs to

BaseAssetInfo

description
optional

The description of an activity

string

displayTypeId
optional

Unique identifier for this display type

integer (int64)

dueIn
optional

The duration an activity is due in

integer (int64)

duration
optional

The duartion an activity is completed in

integer (int64)

endTime
optional

The end time of an activity

string (date-time)

entryOn
optional

The time when an activity happen

string (date-time)

estimatedStartTime
optional

estimatedStartTime for activity

string (date-time)

eventNumber
optional

Creates a key an event can be-time Based event and product change event of an activity

string

executionStartTime
optional

The time when an activity actually started executing

string (date-time)

extendedInfo
optional

The mode of the custom form can be payload, embedded and the external opening of an activity to the another browser

string

externalLink
optional

An activity opens to an external link in another browser that is a custom activity

string

generalComment
optional

General comment associated with an activity

string

hasAvailableCells
optional

Checks for the cells availability
Example : false

boolean

hasVariableAliasing
optional

Whether the activity variable hasVariableAliasing
Example : false

boolean

keyId
optional

Event id of an activity

integer (int64)

keyTime
optional

Creates a time stamp for an event can be-time Based event and product change event of an activity

string (date-time)

line
optional

The Line this location belongs to

BaseAssetInfo

locked
optional

An activity is locked
Example : false

boolean

overdueComment
optional

The overdue comment of an activity

string

overdueCommentRequired
optional

The overdue comment is required
Example : false

boolean

overdueCommentsThreadId
optional

Overdue comment thread this record is part of

integer (int64)

overrideLockPermission
optional

Permission to override the lock if an activity is locked by the user
Example : false

boolean

percentComplete
optional

The percentage by which an activity is completed

number (double)

priority
optional

integer (int64)

processOrder
optional

An activity process order related to

IdNameValue

product
optional

The product activity is performed on

IdNameValue

sheet
optional

The info of the sheet associalted with an activity

IdNameValue

skipComment
optional

The skip comment of an activity

string

skipCommentRequired
optional

The skip comment is required
Example : false

boolean

skipCommentsThreadId
optional

Skip comment thread this record is part of

integer (int64)

startTime
optional

The start time of an activity

string (date-time)

status
optional

The info of the status of an activity

IdNameValue

tag
optional

string

targetDuration
optional

The target duration when an activity actually complete

number (double)

testsToComplete
optional

Unique identifier of this comment record

integer (int64)

timeDue
optional

The time by which an activity is due

string (date-time)

title
optional

The title of an activity

string

user
optional

The user performing on an activity can be a syatem user

ActivityUsers

3.7. ActivityStatusRequest

Name Schema

commentText
optional

string

commentType
optional

string

status
optional

integer (int64)

3.8. ActivityUsers

Name Description Schema

id
optional

Unique indentifier for the user id

integer (int64)

name
optional

The user name who is performing on an activity

string

systemUser
optional

Defines if user is a system user
Example : false

boolean

3.9. ActivityVariableHistoryInfo

Name Schema

precision
optional

integer (int64)

testId
optional

integer (int64)

testTime
optional

string (date-time)

typeId
optional

integer (int64)

value
optional

object

variableId
optional

integer (int64)

3.10. ActivityVariableInfo

Name Description Schema

arrayId
optional

integer (int64)

available
optional

boolean

average
optional

object

canceled
optional

boolean

commentThreadId
optional

integer (int64)

description
optional

string

eSignatureId
optional

integer (int64)

eSignatureLevel
optional

integer (int64)

engineeringUnits
optional

string

entryBy
optional

Entry by

string

entryById
optional

Entry by id

integer (int64)

entryOn
optional

Entry on

string (date-time)

externalLink
optional

string

history
optional

< ActivityVariableHistoryInfo > array

inputTag
optional

string

isEditable
optional

boolean

isMandatory
optional

boolean

isUserDefined
optional

boolean

lowerControlLimit
optional

object

lowerEntryLimit
optional

object

lowerQuartile
optional

object

lowerRejectLimit
optional

object

lowerUserLimit
optional

object

lowerWarningLimit
optional

object

maximum
optional

object

median
optional

object

minimum
optional

object

order
optional

integer (int64)

parentVariableId
optional

Parent Variable Id of a Variable

string

precision
optional

integer (int64)

source
optional

string

sourceId
optional

integer (int64)

spcCalculationType
optional

Name of SPC calcuation type for variable

string

spcCalculationTypeId
optional

Id of SPC calcuation type for variable

integer (int64)

spcGroupVariableType
optional

Name of SPC Group variable type

string

spcGroupVariableTypeId
optional

Id of SPC Group variable type for variable

integer (int64)

target
optional

object

targetControl
optional

object

targetFreq
optional

integer (int32)

testId
optional

integer (int64)

type
optional

string

typeEnum
optional

< IdNameValue > array

typeId
optional

integer (int64)

upperControlLimit
optional

object

upperEntryLimit
optional

object

upperQuartile
optional

object

upperRejectLimit
optional

object

upperUserLimit
optional

object

upperWarningLimit
optional

object

value
optional

object

variableId
optional

integer (int64)

variableName
optional

string

variableState
optional

enum (Reject, Warning, Target, User, Control)

3.11. ActivityVariableUpdates

Name Schema

activityId
optional

integer (int64)

canceled
optional

boolean

commentText
optional

string

commentThreadId
optional

integer (int64)

esignatureId
optional

integer (int64)

testId
optional

integer (int64)

value
optional

string

variableId
optional

integer (int64)

3.12. ActivityViewerStateResource

Name Schema

activityEndTime
optional

string (date-time)

activityOverviews
optional

PagedModel«EntityModel«ActivityInfo»»

activityStartTime
optional

string (date-time)

currentPage
optional

integer (int32)

links
optional

Links

numActivitiesRemaining
optional

integer (int32)

overdueCount
optional

integer (int32)

3.13. BaseAssetInfo

Name Description Schema

assetId
optional

The asset Id

integer (int64)

name
optional

The name of the asset

string

type
optional

The type of the asset

enum (Department, Line, Unit, Group, Variable, ProcessOrder)

3.14. CollectionMetadata

Name Schema

totalElements
optional

integer (int32)

3.15. CollectionResource«IdNameValue»

Name Schema

collection
optional

CollectionMetadata

content
optional

< IdNameValue > array

links
optional

Links

3.16. CollectionResource«ReasonHeaderInfo»

Name Schema

collection
optional

CollectionMetadata

content
optional

< ReasonHeaderInfo > array

links
optional

Links

3.17. CollectionResource«ReasonTreeNodeDto»

Name Schema

collection
optional

CollectionMetadata

content
optional

< ReasonTreeNodeDto > array

links
optional

Links

3.18. CommentInfo

Name Schema

addlInfo
optional

string

addlInfo2
optional

string

commentId
optional

integer (int64)

commentText
optional

string

commentTime
optional

string (date-time)

commentType
optional

string

threadId
optional

integer (int64)

user
optional

IdNameValue

3.19. DimensionInfo

Name Schema

dimensionId
optional

string

finalValue
optional

number (double)

initialValue
optional

number (double)

name
optional

string

unitOfMeasure
optional

string

3.20. EntityModel«ActivityInfo»

Name Description Schema

activityDetailCommentThreadId
optional

integer (int64)

activityId
optional

integer (int64)

activityName
optional

string

activityType
optional

IdNameValue

asset
optional

BaseAssetInfo

autoComplete
optional

boolean

commentHistory
optional

< EntityModel«CommentInfo» > array

commentsThreadId
optional

integer (int64)

completedTime
optional

string (date-time)

completedType
optional

IdNameValue

customFormData
optional

ActivityCustomForm

displayTypeId
optional

integer (int64)

dueIn
optional

integer (int64)

duration
optional

integer (int64)

durationIn
optional

string

estimatedStartTime
optional

string (date-time)

eventNumber
optional

string

hasAvailableCells
optional

boolean

hasVariableAliasing
optional

boolean

isLikelyOverdueActivity
optional

boolean

isOverdueActivity
optional

boolean

keyId
optional

integer (int64)

keyTime
optional

string (date-time)

line
optional

BaseAssetInfo

links
optional

Links

locked
optional

boolean

mytime
optional

This property would be deprecated in the feature as its not being used anywhere in the product

string (date-time)

overdueComment
optional

string

overdueCommentRequired
optional

boolean

overdueCommentsThreadId
optional

integer (int64)

overrideLockPermission
optional

boolean

percentageComplete
optional

number (float)

priority
optional

integer (int64)

processOrder
optional

IdNameValue

product
optional

Product

sheetId
optional

integer (int64)

sheetName
optional

string

sheetVariableTitle
optional

string

skipComment
optional

string

skipCommentRequired
optional

boolean

skipCommentsThreadId
optional

integer (int64)

startTime
optional

string (date-time)

status
optional

enum (NotValidStatus, NotStarted, InProgress, Skipped, Released, Completed)

statusId
optional

integer (int64)

targetDuration
optional

number (double)

testsToComplete
optional

integer (int64)

timeDue
optional

string (date-time)

user
optional

ActivityUsers

3.21. EntityModel«ActivityVariableInfo»

Name Description Schema

arrayId
optional

integer (int64)

available
optional

boolean

average
optional

object

canceled
optional

boolean

commentThreadId
optional

integer (int64)

description
optional

string

eSignatureId
optional

integer (int64)

eSignatureLevel
optional

integer (int64)

engineeringUnits
optional

string

entryBy
optional

Entry by

string

entryById
optional

Entry by id

integer (int64)

entryOn
optional

Entry on

string (date-time)

externalLink
optional

string

history
optional

< ActivityVariableHistoryInfo > array

inputTag
optional

string

isEditable
optional

boolean

isMandatory
optional

boolean

isUserDefined
optional

boolean

links
optional

Links

lowerControlLimit
optional

object

lowerEntryLimit
optional

object

lowerQuartile
optional

object

lowerRejectLimit
optional

object

lowerUserLimit
optional

object

lowerWarningLimit
optional

object

maximum
optional

object

median
optional

object

minimum
optional

object

order
optional

integer (int64)

parentVariableId
optional

Parent Variable Id of a Variable

string

precision
optional

integer (int64)

source
optional

string

sourceId
optional

integer (int64)

spcCalculationType
optional

Name of SPC calcuation type for variable

string

spcCalculationTypeId
optional

Id of SPC calcuation type for variable

integer (int64)

spcGroupVariableType
optional

Name of SPC Group variable type

string

spcGroupVariableTypeId
optional

Id of SPC Group variable type for variable

integer (int64)

target
optional

object

targetControl
optional

object

targetFreq
optional

integer (int32)

testId
optional

integer (int64)

type
optional

string

typeEnum
optional

< IdNameValue > array

typeId
optional

integer (int64)

upperControlLimit
optional

object

upperEntryLimit
optional

object

upperQuartile
optional

object

upperRejectLimit
optional

object

upperUserLimit
optional

object

upperWarningLimit
optional

object

value
optional

object

variableId
optional

integer (int64)

variableName
optional

string

variableState
optional

enum (Reject, Warning, Target, User, Control)

3.22. EntityModel«CommentInfo»

Name Schema

addlInfo
optional

string

addlInfo2
optional

string

commentId
optional

integer (int64)

commentText
optional

string

commentTime
optional

string (date-time)

commentType
optional

string

links
optional

Links

threadId
optional

integer (int64)

user
optional

IdNameValue

3.23. EntityModel«ProductGroup»

Name Schema

description
optional

string

links
optional

Links

productGroupId
optional

integer (int64)

3.24. EntityModel«ProductionRecordInfo»

Name Schema

appliedProduct
optional

IdNameValue

associatedActivities
optional

< integer (int64) > array

comment
optional

string

commentsThreadId
optional

integer (int64)

dimensions
optional

< DimensionInfo > array

endTime
optional

string (date-time)

eventName
optional

string

eventStatus
optional

IdNameValue

isLockEventData
optional

boolean

links
optional

Links

product
optional

IdNameValue

productionRecordId
optional

integer (int64)

productionStatus
optional

IdNameValue

products
optional

< IdNameValue > array

sheetId
optional

integer (int64)

startTime
optional

string (date-time)

statusOptions
optional

< IdNameValue > array

unit
optional

IdNameValue

3.25. EntityModel«ServiceHealthStatus»

Name Description Schema

isRunning
optional

The status of the service. Returns true if running, else false
Example : false

boolean

links
optional

Links

reason
optional

Reason why the service is not running. Returned only when the service is down and if there is a reason for failure

string

3.26. EntityModel«UserDefinedRecordInfo»

Name Schema

ack
optional

boolean

ackBy
optional

IdNameValue

ackInitialState
optional

boolean

ackTime
optional

string (date-time)

action1
optional

IdNameValue

action2
optional

IdNameValue

action3
optional

IdNameValue

action4
optional

IdNameValue

asset
optional

IdNameValue

associatedActivities
optional

< integer (int64) > array

cause1
optional

IdNameValue

cause2
optional

IdNameValue

cause3
optional

IdNameValue

cause4
optional

IdNameValue

comment
optional

string

commentsThreadId
optional

integer (int64)

endTime
optional

string (date-time)

eventHeaderInfo
optional

EventHeaderInfo

eventName
optional

string

eventStatus
optional

IdNameValue

eventSubType
optional

IdNameValue

isLockEventData
optional

boolean

links
optional

Links

reasonHeaderInfo
optional

CollectionResource«ReasonHeaderInfo»

reasonTreeNodeDto
optional

CollectionResource«ReasonTreeNodeDto»

sheetId
optional

integer (int64)

startTime
optional

string (date-time)

statusOptions
optional

< IdNameValue > array

unitId
optional

integer (int64)

userDefinedRecordId
optional

integer (int64)

3.27. EntityModel«VariablePage»

Name Schema

id
optional

integer (int64)

isInclusiveSpecCalc
optional

boolean

links
optional

Links

title
optional

string

variableScrolling
optional

boolean

variables
optional

< EntityModel«ActivityVariableInfo» > array

3.28. Error

Name Schema

code
optional

string

details
optional

object

3.29. EventHeaderInfo

Name Schema

eventStartsInfo
optional

integer (int64)

productInfo
optional

IdNameValue

unit
optional

BaseAssetInfo

user
optional

IdNameValue

3.30. EventInfo

Name Schema

eventId
optional

integer (int64)

lockEventData
optional

boolean

3.31. HistorianTagDataPoint

Name Schema

dataPoint
optional

number (double)

deviationPoint
optional

number (double)

tagName
optional

string

3.32. HistorianTagDataPointResponse

Name Schema

content
optional

< HistorianTagDataPoint > array

links
optional

Links

3.33. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.34. IdNameValue

Name Description Schema

id
optional

Unique identifier of this id of every pair/used across several services to represent a generic Id

integer (int64)

name
optional

Unique identifier of this name of every pair/used across several services to represent a generic name

string

3.35. Link

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

name
optional

string

profile
optional

string

rel
optional

LinkRelation

template
optional

UriTemplate

templated
optional

boolean

title
optional

string

type
optional

string

3.36. LinkRelation

Type : object

3.37. Links

Name Schema

empty
optional

boolean

3.38. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.39. PagedModel«EntityModel«ActivityInfo»»

Name Schema

content
optional

< EntityModel«ActivityInfo» > array

links
optional

Links

page
optional

PageMetadata

3.40. PagedModel«EntityModel«VariablePage»»

Name Schema

content
optional

< EntityModel«VariablePage» > array

links
optional

Links

page
optional

PageMetadata

3.41. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.42. Product

Name Description Schema

code
optional

Product code for activity Product

string

id
optional

Product Id for activity Product

integer (int64)

isAppliedProduct
optional

flag to differentiate between AppliedProduct is current Product
Example : false

boolean

name
optional

Product name for activity Product

string

3.43. ProductChangeCreatorInfo

Name Schema

allProducts
optional

< ProductInfo > array

header
optional

ProductChangeEventHeaderInfo

productChangeHistory
optional

< ProductChangeHistoryInfo > array

productGroup
optional

< EntityModel«ProductGroup» > array

startTime
optional

string (date-time)

3.44. ProductChangeEventHeaderInfo

Name Schema

unitInfo
optional

IdNameValue

user
optional

IdNameValue

3.45. ProductChangeHistoryInfo

Name Schema

endTime
optional

string (date-time)

id
optional

integer (int64)

productCode
optional

string

productDescription
optional

string

productId
optional

integer (int64)

startTime
optional

string (date-time)

3.46. ProductChangeRequestInfo

Name Schema

eventId
optional

integer (int64)

productId
optional

integer (int64)

timeStamp
optional

string (date-time)

unitId
optional

integer (int64)

3.47. ProductGroup

Name Schema

description
optional

string

productGroupId
optional

integer (int64)

3.48. ProductInfo

Name Schema

code
optional

string

description
optional

string

productFamilyId
optional

integer (int64)

productId
optional

integer (int64)

3.49. ProductionEventUpdates

Name Schema

commentText
optional

string

commentThreadId
optional

integer (int64)

eventId
optional

integer (int64)

testId
optional

integer (int64)

3.50. ProductionRecordInfo

Name Schema

appliedProduct
optional

IdNameValue

associatedActivities
optional

< integer (int64) > array

comment
optional

string

commentsThreadId
optional

integer (int64)

dimensions
optional

< DimensionInfo > array

endTime
optional

string (date-time)

eventName
optional

string

eventStatus
optional

IdNameValue

isLockEventData
optional

boolean

product
optional

IdNameValue

productionRecordId
optional

integer (int64)

productionStatus
optional

IdNameValue

products
optional

< IdNameValue > array

sheetId
optional

integer (int64)

startTime
optional

string (date-time)

statusOptions
optional

< IdNameValue > array

unit
optional

IdNameValue

3.51. ProductionRecordInfoResource

Name Schema

appliedProduct
optional

IdNameValue

associatedActivities
optional

< integer (int64) > array

comment
optional

string

commentsThreadId
optional

integer (int64)

dimensions
optional

< DimensionInfo > array

endTime
optional

string (date-time)

eventName
optional

string

eventStatus
optional

IdNameValue

isLockEventData
optional

boolean

links
optional

Links

product
optional

IdNameValue

productionRecordId
optional

integer (int64)

productionStatus
optional

IdNameValue

products
optional

< IdNameValue > array

sheetId
optional

integer (int64)

startTime
optional

string (date-time)

statusOptions
optional

< IdNameValue > array

unit
optional

IdNameValue

3.52. ReasonHeaderInfo

Name Schema

levelName
optional

string

reasonLevel
optional

integer (int32)

3.53. ReasonTreeNodeDto

Name Schema

categoryId
optional

integer (int64)

categoryName
optional

string

children
optional

< ReasonTreeNodeDto > array

nodeId
optional

integer (int64)

parentNodeId
optional

integer (int64)

reasonId
optional

integer (int64)

reasonLevel
optional

integer (int32)

reasonName
optional

string

treeId
optional

integer (int64)

3.54. ServiceHealthStatus

Name Description Schema

isRunning
optional

The status of the service. Returns true if running, else false
Example : false

boolean

reason
optional

Reason why the service is not running. Returned only when the service is down and if there is a reason for failure

string

3.55. SheetColumnRecordInfo

Name Schema

associatedActivities
optional

< integer (int64) > array

comment
optional

string

commentsThreadId
optional

integer (int64)

sheetId
optional

integer (int64)

timestamp
optional

string (date-time)

unitId
optional

integer (int64)

3.56. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

enum (, ?, &, /, #, *)

3.57. TemplateVariables

Type : object

3.58. TestHistoryRecord

Name Schema

canceled
optional

boolean

enteredOn
optional

string (date-time)

entryBy
optional

string

performedBy
optional

string

value
optional

object

verifiedBy
optional

string

3.59. TestValueSpecifications

Name Description Schema

dataTypeId
optional

Unique identifier for this dataType

integer (int64)

eSignatureLevel
optional

integer (int64)

esignatureLevel
optional

eSignatureId for autolog variable. 0 for undefined,1 for user level,2 for approver level

integer (int64)

lowerControlLimit
optional

Defines the lower value can be filled for a varibale

object

lowerEntryLimit
optional

The lower entry of the variable

object

lowerRejectLimit
optional

The lower reject limit of the variable

object

lowerUserLimit
optional

The lower limit user can fill for a variable

object

lowerWarningLimit
optional

The lower warining to enter the variable

object

target
optional

Defines the exact target of the variables

object

targetControl
optional

Deifnes the variables values are under control

object

targetFreq
optional

Defines the target frequency of the variables

integer (int32)

upperControlLimit
optional

Defines the upper value can be filled for a varibale

object

upperEntryLimit
optional

The upper entry of the variable

object

upperRejectLimit
optional

The upper reject limit of the variable

object

upperUserLimit
optional

The upper limit user can fill for a variable

object

upperWarningLimit
optional

The upper warining to enter the variable

object

variableId
optional

Unique identifier of this variable

integer (int64)

3.60. TimeSelectionRange

Name Description Schema

endTime
optional

The startTime range

string

eventEpochEndTime
optional

integer (int64)

eventEpochStartTime
optional

The startTime

integer (int64)

startTime
optional

The startTime range

string

3.61. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

TemplateVariables

3.62. User

Name Schema

password
optional

string

userName
optional

string

3.63. UserDefinedRecordInfo

Name Schema

ack
optional

boolean

ackBy
optional

IdNameValue

ackInitialState
optional

boolean

ackTime
optional

string (date-time)

action1
optional

IdNameValue

action2
optional

IdNameValue

action3
optional

IdNameValue

action4
optional

IdNameValue

asset
optional

IdNameValue

associatedActivities
optional

< integer (int64) > array

cause1
optional

IdNameValue

cause2
optional

IdNameValue

cause3
optional

IdNameValue

cause4
optional

IdNameValue

comment
optional

string

commentsThreadId
optional

integer (int64)

endTime
optional

string (date-time)

eventHeaderInfo
optional

EventHeaderInfo

eventName
optional

string

eventStatus
optional

IdNameValue

eventSubType
optional

IdNameValue

isLockEventData
optional

boolean

reasonHeaderInfo
optional

CollectionResource«ReasonHeaderInfo»

reasonTreeNodeDto
optional

CollectionResource«ReasonTreeNodeDto»

sheetId
optional

integer (int64)

startTime
optional

string (date-time)

statusOptions
optional

< IdNameValue > array

unitId
optional

integer (int64)

userDefinedRecordId
optional

integer (int64)

3.64. UserDefinedUpdates

Name Schema

commentText
optional

string

commentThreadId
optional

integer (int64)

eventId
optional

integer (int64)

testId
optional

integer (int64)

3.65. UserSettingRequest

Name Description Schema

appId
optional

integer (int32)

data
optional

The application specific settings, Eg:- 'App Name' : {'property1' : 'value' , 'property2' : 'value'} }
Example : {
"AppKey1" : {
"property1" : { },
"property2" : { },
"property3" : { }
},
"AppKey2" : {
"property1" : { },
"property2" : { },
"property3" : { }
},
"AppKey3" : {
"property1" : { },
"property2" : { },
"property3" : { }
}
}

object

viewName
optional

string

3.66. UserSettingResponseResource

Name Description Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

Example : false

boolean

links
optional

< Link > array

viewName
optional

string

3.67. VariableInfo

Name Schema

isDisplayUnits
optional

boolean

lockUnavailableCells
optional

boolean

3.68. VariablePage

Name Schema

id
optional

integer (int64)

isInclusiveSpecCalc
optional

boolean

title
optional

string

variableScrolling
optional

boolean

variables
optional

< EntityModel«ActivityVariableInfo» > array

3.69. VariableTestDetails

Name Schema

engUnits
optional

string

resultOn
optional

string (date-time)

specifications
optional

TestValueSpecifications

state
optional

enum (Reject, Warning, Target, User, Control)

testId
optional

integer (int64)

testResult
optional

object

userDefinedDesc1
optional

string

userDefinedDesc2
optional

string

userDefinedDesc3
optional

string

variableDesc
optional

string

variableId
optional

integer (int64)

4. Security

4.1. access_token

Type : oauth2
Flow : accessCode
Token URL : http://localhost:8080/uaa/oauth/authorize
Token URL : http://localhost:8080/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : http://localhost:8080/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : http://localhost:8080/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : http://localhost:8080/uaa/oauth/token

Name Description

default

Default oauth2 scope.