1. Overview

The autolog-app-service contains a collection of RESTful service calls to retrieve information relevant to autolog in manufacturing execution.
Description of endpoints can be found in the section headers for each collection of relevant resources.

1.1. URI scheme

Host : localhost:40278
BasePath : /autolog-app-service/

1.2. Tags

  • data-type-controller : Data Type Controller

  • display-controller : Display Controller

  • event-details-controller : Event Details Controller

  • histogram-controller : Histogram Controller

  • product-change-controller : Product Change Controller

  • product-controller : Product Controller

  • production-event-controller : Production Event Controller

  • time-based-event-controller : Time Based Event Controller

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

  • user-settings-controller : User Settings Controller

  • variable-controller : Variable Controller

2. Resources

2.1. Data-type-controller

Data Type Controller

2.1.1. Get user-defined/custom-data types

GET /v1/data-type/user-defined
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

dataTypeId
optional

dataTypeId

integer (int64)
Responses
HTTP Code Description Schema

200

Success

< Phrase > array

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2. Display-controller

Display Controller

2.2.1. Get a display record

GET /v1/display
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Forbidden, User is not allowed to update the record

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.2. Get sheets detail

GET /v1/display/sheets
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

isActive
optional

isActive

boolean

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

sheetDesc
optional

sheetDesc

string

Query

sheetId
optional

sheetId

integer (int64)

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

Success

< SheetInfo > array

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.3. Get Event count for a sheet

GET /v1/display/{sheetid}/event/count
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Event or Batch Id list; comma separated

integer (int64)

Query

startDate
required

Start Date; example = 2022-08-03T10:50:17.717Z

string
Responses
HTTP Code Description Schema

200

Success

integer (int64)

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.4. Get events for a sheet

GET /v1/display/{sheetid}/events-detail
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Sheet Id

integer (int64)

Query

decimalSep
required

Decimal Separator

string

"."

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20

Query

startDate
required

Start Date; example = 2022-08-03T10:50:17.717Z

string
Responses
HTTP Code Description Schema

200

Success

PagedModel«EntityModel«EventDetails»»

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.5. Search events for a sheet

GET /v1/display/{sheetid}/events-search
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Sheet Id

integer (int64)

Query

decimalSep
required

Decimal Separator

string

"."

Query

exactSearch
required

Exact Text

boolean

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

searchText
required

Search Text

string

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

Success

PagedModel«EntityModel«EventDetails»»

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.6. Search events for a sheet

GET /v1/display/{sheetid}/events-search-without-test-data
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Sheet Id

integer (int64)

Query

exactSearch
required

Exact Text

boolean

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

searchText
required

Search Text

string

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

Success

< SheetEventInfo > array

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.7. Get sheet properties

GET /v1/display/{sheetid}/properties
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Sheet Id

integer (int64)

Query

GetOptions
optional

GetOptions

integer (int64)
Responses
HTTP Code Description Schema

200

OK

SheetProperties

401

Unauthorized

No Content

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.8. Get sheet security info

GET /v1/display/{sheetid}/security
Caution

operation.deprecated
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Sheet Id

integer (int64)
Responses
HTTP Code Description Schema

200

Success

SheetPermissions

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.9. Get sheet security info

GET /v1/display/{sheetid}/security-info
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Sheet Id

integer (int64)

Query

displayOptionCategoryId
optional

displayOptionCategoryId

integer (int64)
Responses
HTTP Code Description Schema

200

Success

< SheetsSecurityInfo > array

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.10. Get sheet event test data

GET /v1/display/{sheetid}/sheet-event-test-data
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Sheet Id

integer (int64)

Query

decimalSep
required

Decimal Separator

string

"."

Query

eventIds
required

eventIds

string
Responses
HTTP Code Description Schema

200

Success

< SheetVariableTestResult > array

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.11. Get sheets detail

GET /v1/display/{sheetid}/sheet-security-user-group
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Sheet Id

integer (int64)
Responses
HTTP Code Description Schema

200

Success

integer (int32)

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.12. Get events for a sheet

GET /v1/display/{sheetid}/sheet-type/{sheettypeid}/events
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Sheet Id

integer (int64)

Path

sheettypeid
required

Sheet type id

integer (int64)

Query

decimalSep
required

Decimal Separator

string

"."

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20

Query

startDate
required

Start Date; example = 2022-08-03T10:50:17.717Z

string

Query

variableIds
required

Variable Id list; comma separated

string
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.13. Get variables for a sheet

GET /v1/display/{sheetid}/variables
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

sheetid
required

Sheet Id

integer (int64)

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3. Event-details-controller

Event Details Controller

2.3.1. Get event details

GET /v1/eventDetails
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

eventId
required

eventId

integer (int64)

Query

eventType
required

eventType

integer (int64)
Responses
HTTP Code Description Schema

200

OK

EventDetailsInfo

401

Unauthorized

No Content

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.2. deleting event details

DELETE /v1/eventDetails
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

eventId
optional

eventId

integer (int64)

Query

eventType
required

eventType

integer (int64)

Query

resultOn
optional

resultOn

string

Query

sheetId
optional

sheetId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.3. Event Dimensions

PUT /v1/eventDetails/eventDimensions
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Body

eventDimensionDetails
required

eventDimensionDetails

EventDimensionDetails
Responses
HTTP Code Description Schema

200

OK

EventDimensionDetails

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.4. Get event history

GET /v1/eventDetails/history
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

eventId
required

eventId

integer (int64)

Query

eventType
required

eventType

integer (int64)
Responses
HTTP Code Description Schema

200

OK

EventHistoryDto

401

Unauthorized

No Content

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4. Histogram-controller

Histogram Controller

2.4.1. Get a histogram record

GET /histogram-data/{variableId}/histogram
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

variableId
optional

variable id

integer (int64)

Query

InTimeZone
optional

InTimeZone

string

Query

endTime
optional

end time

string

Query

sheetId
optional

sheet id

integer (int64)

Query

startTime
optional

start time

string
Responses
HTTP Code Description Schema

200

OK

HistogramData

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by histogram Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5. Product-change-controller

Product Change Controller

2.5.1. Create product change event

POST /v1/product-change-event
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Body

ProductChange
required

ProductChange

ProductChange
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.2. Get product change event creator state

GET /v1/product-change-event/creator-state
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

unitId
required

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.6. Product-controller

Product Controller

2.6.1. Get products

GET /v1/product
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

code
optional

code

string

Query

description
optional

description

string

Query

familyIds
optional

familyIds

string

Query

groupIds
optional

groupIds

string

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

serialized
optional

serialized

boolean

Query

size
optional

Number of resources to return per page.

integer (int32)

20

Query

unitIds
optional

Unit Ids of Product.

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

200

Success

ProductPage

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7. Production-event-controller

Production Event Controller

2.7.1. Create production event

POST /v1/production-event
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Body

productionEventRequest
required

productionEventRequest

ProductionEventRequest
Responses
HTTP Code Description Schema

200

OK

object

201

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.2. Get production event creator state

GET /v1/production-event/creator-state
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

sheetId
required

sheetId

integer (int64)

Query

unitId
required

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.8. Time-based-event-controller

Time Based Event Controller

2.8.1. Create time based event

POST /v1/time-based-event
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Body

udeRequest
required

udeRequest

TimeBasedEventRequest
Responses
HTTP Code Description Schema

200

OK

object

201

Accepted

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.8.2. Get time based event creator state

GET /v1/time-based-event/creator-state
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

sheetId
required

sheetId

integer (int64)
Responses
HTTP Code Description Schema

200

Success

TimeBasedEventCreatorInfo

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.9. User-defined-event-controller

User Defined Event Controller

2.9.1. Create user defined event

POST /v1/user-defined-event
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Body

udeRequest
required

udeRequest

UserDefinedRequest
Responses
HTTP Code Description Schema

200

OK

UserDefinedRecord

202

Success

UserDefinedRecord

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.9.2. Get user defined event creator state

GET /v1/user-defined-event/creator-state
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

sheetId
required

sheetId

integer (int64)

Query

unitId
required

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.9.3. Get user defined future events after a particular start time, based on parameters

GET /v1/user-defined-event/future-events
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Query

endTime
required

End Time; example = 2022-09-03T10:50:17.717Z

string

Query

numberOfEvent
required

numberOfEvent

integer (int64)

Query

sheetId
required

sheetId

integer (int64)

Query

startTime
required

Start Time; example = 2022-08-03T10:50:17.717Z

string

Query

unitId
required

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10. User-settings-controller

User Settings Controller

2.10.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Body

userSettingsRequest
required

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Body

request
required

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10.5. Get Privilege Sets

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

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.11. Variable-controller

Variable Controller

2.11.1. Get Variable Specification

GET /variable/specification/{variable}/{product}
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

product
required

Product Id

integer (int64)

Path

variable
required

Variable Id

integer (int64)

Query

resultOn
required

Result On

string
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

No Content

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.11.2. Create Test Value

POST /variable/test-value
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Body

testsDataRequest
optional

TestValueRecord object to update a test value record

TestsDataRequest
Responses
HTTP Code Description Schema

200

Success

TestsDataResponse

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

No Content

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.11.3. Get test value history and Variable Specification

GET /variable/test-value-history-var-spec/{variable}/{product}
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

product
required

Product Id

integer (int64)

Path

variable
required

Variable Id

integer (int64)

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

resultOn
required

Result On

string

Query

size
optional

Number of resources to return per page.

integer (int32)

20

Query

test_id
optional

Test Id

integer (int64)

0
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

HttpErrorResponse

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.11.4. Get test value history

GET /variable/test-value-history/{testid}
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

testid
required

Test Id

integer (int64)

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

No Content

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.11.5. Update Test Value

PUT /variable/test-value/{id}
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

"site-0"

Path

id
required

Test Id

integer (int64)

Body

testDataRequest
required

testDataRequest

TestsDataRequest
Responses
HTTP Code Description Schema

200

Success

TestsDataResponse

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the record

No Content

404

Not Found, Resource is not found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

3. Definitions

3.1. 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.2. EntityModel«EventDetails»

Name Description Schema

acknowledge
optional

boolean

actualProduct
optional

Unique identifier Actual Product

integer (int64)

actualProductCode
optional

Actual Product Code

string

appliedProduct
optional

Identifier for appliedProduct

integer (int64)

appliedProductCode
optional

Applied Product Code

string

approverReasonId
optional

Identifier for approverReasonId

integer (int64)

approverUserId
optional

Identifier for approverUserId

integer (int64)

commentId
optional

Identifier for commentId

integer (int64)

componentId
optional

Identifier for componentIdAcknowledge

integer (int64)

conformance
optional

Identifier for conformance

integer (int64)

eventId
optional

Identifier for eventId

integer (int64)

eventNum
optional

Identifier for eventNum

string

eventStatus
optional

Identifier for eventStatus

integer (int64)

eventStatusDesc
optional

Production Status Description or Event Status Description

string

links
optional

Links

puId
optional

Identifier for puId

integer (int64)

resultOn
optional

Identifier for resultOn

string (date-time)

sourceEventId
optional

Identifier for sourceEventId

integer (int64)

sourceEventNum
optional

Identifier for sourceEventNum

string

testingPercntgComplete
optional

Identifier for testingPercntgComplete

integer (int64)

testingStatus
optional

Identifier for testingStatus

integer (int64)

testsDetails
optional

< TestsDetails > array

userReasonId
optional

Identifier for userReasonId

integer (int64)

userSignOffId
optional

Identifier for userSignOffId

integer (int64)

3.3. Error

Name Schema

code
optional

string

details
optional

object

3.4. EventDetails

Name Description Schema

acknowledge
optional

boolean

actualProduct
optional

Unique identifier Actual Product

integer (int64)

actualProductCode
optional

Actual Product Code

string

appliedProduct
optional

Identifier for appliedProduct

integer (int64)

appliedProductCode
optional

Applied Product Code

string

approverReasonId
optional

Identifier for approverReasonId

integer (int64)

approverUserId
optional

Identifier for approverUserId

integer (int64)

commentId
optional

Identifier for commentId

integer (int64)

componentId
optional

Identifier for componentIdAcknowledge

integer (int64)

conformance
optional

Identifier for conformance

integer (int64)

eventId
optional

Identifier for eventId

integer (int64)

eventNum
optional

Identifier for eventNum

string

eventStatus
optional

Identifier for eventStatus

integer (int64)

eventStatusDesc
optional

Production Status Description or Event Status Description

string

puId
optional

Identifier for puId

integer (int64)

resultOn
optional

Identifier for resultOn

string (date-time)

sourceEventId
optional

Identifier for sourceEventId

integer (int64)

sourceEventNum
optional

Identifier for sourceEventNum

string

testingPercntgComplete
optional

Identifier for testingPercntgComplete

integer (int64)

testingStatus
optional

Identifier for testingStatus

integer (int64)

testsDetails
optional

< TestsDetails > array

userReasonId
optional

Identifier for userReasonId

integer (int64)

userSignOffId
optional

Identifier for userSignOffId

integer (int64)

3.5. EventDetailsInfo

Name Schema

actionLevel1
optional

integer (int64)

actionLevel2
optional

integer (int64)

actionLevel3
optional

integer (int64)

actionLevel4
optional

integer (int64)

actionName1
optional

string

actionName2
optional

string

actionName3
optional

string

actionName4
optional

string

appliedProduct
optional

string

causeLevel1
optional

integer (int64)

causeLevel2
optional

integer (int64)

causeLevel3
optional

integer (int64)

causeLevel4
optional

integer (int64)

causeName1
optional

string

causeName2
optional

string

causeName3
optional

string

causeName4
optional

string

customerOrderNumber
optional

string

description
optional

string

detailsDuration
optional

string

endTime
optional

string (date-time)

eventId
optional

integer (int64)

eventNum
optional

string

eventStatus
optional

string

eventType
optional

string

finalDimensionA
optional

string

finalDimensionX
optional

string

finalDimensionY
optional

string

finalDimensionZ
optional

string

initialDimensionA
optional

string

initialDimensionX
optional

string

initialDimensionY
optional

string

initialDimensionZ
optional

string

originalProduct
optional

string

patternCode
optional

string

processOrder
optional

string

productUnitId
optional

integer (int64)

researchCloseDate
optional

string (date-time)

researchOpenDate
optional

string (date-time)

researchStatusDecription
optional

string

startTime
optional

string (date-time)

status
optional

string

unitName
optional

string

userDefinedEventId
optional

integer (int64)

userName
optional

string

3.6. EventDimensionDetails

Name Schema

eventId
optional

integer (int64)

finalDimA
optional

string

finalDimX
optional

string

finalDimY
optional

string

finalDimZ
optional

string

3.7. EventHeaderInfo

Name Schema

eventStarts
optional

integer (int64)

product
optional

IdNameValue

unit
optional

BaseAssetInfo

user
optional

IdNameValue

3.8. EventHistoryDetails

Name Schema

dimensionA
optional

string

dimensionX
optional

string

dimensionY
optional

string

dimensionZ
optional

string

entryOn
optional

string (date-time)

orderNumber
optional

string

shipmntNumber
optional

string

3.9. EventHistoryDto

Name Schema

eventHistoryDetails
optional

< EventHistoryDetails > array

eventHistoryInfo
optional

< EventHistoryInfo > array

udeHistoryDetails
optional

< UdeHistoryDetails > array

3.10. EventHistoryInfo

Name Schema

appliedProduct
optional

string

endTime
optional

string

entryOn
optional

string (date-time)

eventNum
optional

string

originalProduct
optional

string

status
optional

string

userName
optional

string

3.11. HistogramData

Name Description Schema

value
optional

Uniquee identifier for this value

number (double)

variableId
optional

Unique identifier for this productId

integer (int64)

3.12. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.13. 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.14. Link

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

name
optional

string

profile
optional

string

rel
optional

string

template
optional

UriTemplate

templated
optional

boolean

title
optional

string

type
optional

string

3.15. Links

Name Schema

empty
optional

boolean

3.16. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.17. PagedModel«EntityModel«EventDetails»»

Name Schema

content
optional

< EntityModel«EventDetails» > array

links
optional

Links

page
optional

PageMetadata

3.18. Permission

Name Schema

permissionName
optional

string

permissionValue
optional

boolean

3.19. Phrase

Name Schema

active
optional

boolean

changedDate
optional

string

commentRequired
optional

boolean

dataTypeId
optional

integer (int64)

oldPhrase
optional

string

phraseId
optional

integer (int64)

phraseOrder
optional

integer (int64)

phraseValue
optional

string

3.20. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.21. Product

Name Description Schema

code
optional

The product code

string

description
optional

The description of the product

string

descriptionGlobal
optional

The description of the product global

string

eventEsignatureLevel
optional

The event Esiganature level

integer (int64)

externalLink
optional

Product External Link

string

externalRevision
optional

The external revision

integer (int64)

id
optional

The unique ID of the product

integer (int64)

isSerialized
optional

The product Id is serialized or not

boolean

links
optional

< Link > array

productChangeEsignatureLevel
optional

The product change Esiganature level

integer (int64)

productFamilyId
optional

The id of the product family this product is a member of

integer (int64)

productGroupId
optional

The id of the product group this product is a member of

integer (int64)

3.22. ProductChange

Name Description Schema

productId
required

Unique identifier of product

integer (int64)

timeStamp
required

Time the product was requested to change; Example: 2022-09-14T10:50:01Z
Example : "2022-09-14T10:50:01Z"

string

unitId
required

Unique identifier of unit

integer (int64)

3.23. ProductPage

Name Schema

content
optional

< Product > array

links
optional

< Link > array

page
optional

PageMetadata

3.24. ProductionEventRequest

Name Description Schema

commentsThreadId
optional

integer (int64)

endTime
required

Production Event end time

string (date-time)

eventName
optional

string

productId
optional

integer (int64)

productionStatusId
optional

integer (int64)

startTime
required

Production Event start time

string (date-time)

unitId
optional

integer (int64)

3.25. SheetEventInfo

Name Description Schema

acknowledge
optional

boolean

actualProduct
optional

Unique identifier Actual Product

integer (int64)

actualProductCode
optional

Actual Product Code

string

appliedProduct
optional

Unique identifier for appliedProduct

integer (int64)

appliedProductCode
optional

Applied Product Code

string

approverReasonId
optional

Unique identifier for approverReasonId

integer (int64)

approverUserId
optional

Unique identifier for approverUserId

integer (int64)

commentId
optional

Unique identifier for commentId

integer (int64)

componentId
optional

Unique identifier for componentIdAcknowledge

integer (int64)

conformance
optional

Unique identifier for conformance

integer (int64)

eventId
optional

Unique identifier for eventId

integer (int64)

eventNum
optional

Unique identifier for eventNum

string

eventStatus
optional

Unique identifier for eventStatus

integer (int64)

eventStatusDesc
optional

Production Status Description or Event Status Description

string

puId
optional

Unique identifier for puId

integer (int64)

resultOn
optional

Unique identifier for resultOn

string (date-time)

sourceEventId
optional

Unique identifier for sourceEventId

integer (int64)

sourceEventNum
optional

Unique identifier for sourceEventNum

string

testingPercntgComplete
optional

Unique identifier for testingPercntgComplete

integer (int64)

testingStatus
optional

Unique identifier for testingStatus

integer (int64)

userReasonId
optional

Unique identifier for userReasonId

integer (int64)

userSignOffId
optional

Unique identifier for userSignOffId

integer (int64)

3.26. SheetInfo

Name Schema

active
optional

boolean

deptDesc
optional

string

deptId
optional

integer (int64)

eventSubTypeDesc
optional

string

eventSubtypeId
optional

integer (int64)

eventType
optional

integer (int64)

eventTypeDesc
optional

string

lineDesc
optional

string

lineId
optional

integer (int64)

masterUnit
optional

integer (int64)

productionUnit
optional

integer (int64)

sheetDesc
optional

string

sheetGroupDesc
optional

string

sheetGroupId
optional

integer (int64)

sheetId
optional

integer (int64)

sheetSecurityGroupId
optional

string

sheetType
optional

integer (int64)

sheetTypeDesc
optional

string

unitDesc
optional

string

unitId
optional

integer (int64)

3.27. SheetPermissions

Name Schema

content
optional

< string, < Permission > array > map

links
optional

< Link > array

3.28. SheetProperties

Name Schema

columnHeaders
optional

integer (int64)

columnNumbering
optional

integer (int64)

eventPrompt
optional

string

eventSubtypeId
optional

integer (int64)

eventType
optional

integer (int64)

initalCount
optional

integer (int64)

interval
optional

integer (int64)

intervalOffset
optional

integer (int64)

isActive
optional

boolean

masterUnit
optional

integer (int64)

maximumCount
optional

integer (int64)

rowHeaders
optional

integer (int64)

rowNumbering
optional

integer (int64)

serverName
optional

string

sheetDescription
optional

string

sheetId
optional

integer (int64)

sheetType
optional

string

sheetTypeId
optional

integer (int64)

3.29. SheetVariableTestResult

Name Schema

ack
optional

boolean

alarmDesc
optional

string

alarmEndTime
optional

string (date-time)

alarmId
optional

integer (int64)

alarmPriorityDesc
optional

string

alarmPriorityId
optional

integer (int64)

alarmStartTime
optional

string (date-time)

arrayId
optional

integer (int64)

canceled
optional

boolean

commentId
optional

integer (int64)

entryBy
optional

integer (int64)

entryOn
optional

string (date-time)

esignatureLevel
optional

integer (int32)

eventId
optional

integer (int64)

hasHistory
optional

boolean

locked
optional

boolean

lowerControl
optional

string

lowerEntry
optional

string

lowerReject
optional

string

lowerUser
optional

string

lowerWarning
optional

string

prodId
optional

integer (int64)

puid
optional

integer (int64)

result
optional

string

resultOn
optional

string (date-time)

target
optional

string

testFrequency
optional

integer (int64)

testId
optional

integer (int64)

upperControl
optional

string

upperEntry
optional

string

upperReject
optional

string

upperUser
optional

string

upperWarning
optional

string

varId
optional

integer (int64)

varMandatory
optional

boolean

3.30. SheetsSecurityInfo

Name Schema

displayOptionAccessId
optional

string

displayOptionCategoryDesc
optional

string

displayOptionDesc
optional

string

displayOptionId
optional

integer (int64)

displayOptionLongDesc
optional

string

displayOptionMax
optional

integer (int64)

displayOptionMin
optional

integer (int64)

displayOptionRequired
optional

boolean

esignature
optional

boolean

fieldTypeDesc
optional

string

fieldTypeId
optional

integer (int64)

spLookup
optional

string

storeId
optional

integer (int64)

value
optional

string

3.31. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

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

3.32. TemplateVariables

Type : object

3.33. TestsDataRequest

Name Schema

commentId
optional

integer (int64)

eventId
optional

integer (int64)

result
optional

string

resultOn
optional

string

varId
optional

integer (int64)

3.34. TestsDataResponse

Name Schema

cancelled
optional

boolean

commentId
optional

integer (int64)

eventId
optional

integer (int64)

result
optional

string

resultOn
optional

string

testId
optional

integer (int64)

varId
optional

integer (int64)

3.35. TestsDetails

Name Schema

ack
optional

boolean

alarmDesc
optional

string

alarmEndTime
optional

string (date-time)

alarmId
optional

integer (int64)

alarmPriorityDesc
optional

string

alarmPriorityId
optional

integer (int64)

alarmStartTime
optional

string (date-time)

arrayId
optional

integer (int64)

canceled
optional

boolean

commentId
optional

integer (int64)

entryBy
optional

integer (int64)

entryOn
optional

string (date-time)

esignatureLevel
optional

integer (int32)

eventId
optional

integer (int64)

hasHistory
optional

boolean

locked
optional

boolean

lowerControl
optional

string

lowerEntry
optional

string

lowerReject
optional

string

lowerUser
optional

string

lowerWarning
optional

string

prodId
optional

integer (int64)

puid
optional

integer (int64)

result
optional

string

resultOn
optional

string (date-time)

target
optional

string

testFrequency
optional

integer (int64)

testId
optional

integer (int64)

upperControl
optional

string

upperEntry
optional

string

upperReject
optional

string

upperUser
optional

string

upperWarning
optional

string

varId
optional

integer (int64)

varMandatory
optional

boolean

3.36. TimeBasedEventCreatorInfo

Name Description Schema

availableTime
required

Time the product was requested to change; Example: 2022-09-14T10:50:01Z
Example : "2022-09-14T10:50:01Z"

string

eventHeaderInfo
optional

EventHeaderInfo

3.37. TimeBasedEventRequest

Name Schema

commentsThreadId
optional

integer (int64)

sheetId
optional

integer (int64)

timestamp
optional

string (date-time)

3.38. UdeHistoryDetails

Name Schema

detailDuraion
optional

string

endTime
optional

string (date-time)

eventType
optional

string

productUnitDescription
optional

string

startTime
optional

string (date-time)

status
optional

string

userDefinedEventDescription
optional

string

userDefinedEventId
optional

integer (int64)

userId
optional

integer (int64)

3.39. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

< TemplateVariable > array

3.40. UserDefinedRecord

Name Description Schema

ack
optional

The time start time to research of user defined record

boolean

ackBy
optional

IdNameValue

ackOn
optional

string (date-time)

action1
optional

The Level 1 Action of the user defined record.

IdNameValue

action2
optional

The Level 2 Action of the user defined record.

IdNameValue

action3
optional

The Level 3 Action of the user defined record.

IdNameValue

action4
optional

The Level 4 Action of the user defined record.

IdNameValue

actionCommentsThreadId
optional

Action comment thread this record is part of

integer (int64)

asset
optional

The asset/unit this location belongs to

BaseAssetInfo

cause1
optional

The Level 1 Cause (Reason) of the user defined record.

IdNameValue

cause2
optional

The Level 2 Cause (Reason) of the user defined record.

IdNameValue

cause3
optional

The Level 3 Cause (Reason) of the user defined record.

IdNameValue

cause4
optional

The Level 4 Cause (Reason) of the user defined record.

IdNameValue

causeCommentsThreadId
optional

Cause comment thread this record is part of

integer (int64)

commentsThreadId
optional

Comment thread this record is part of

integer (int64)

conformance
optional

integer (int64)

department
optional

The Department this location belongs to

BaseAssetInfo

duration
optional

The duration of the user defined record.

integer (int64)

eSignatureId
optional

integer (int64)

endTime
optional

The end time of the user defined event

string (date-time)

eventName
optional

The name of an event

string

eventStatus
optional

The info of an event status

IdNameValue

eventSubType
optional

The info of an event type

IdNameValue

isLockEventData
optional

Defines that event is locked or not

boolean

line
optional

The Line this location belongs to

BaseAssetInfo

parentUserDefinedEventId
optional

integer (int64)

productionEventId
optional

integer (int64)

reasonTreeDataId
optional

The reason treeid of user defined record.

integer (int64)

researchCloseDate
optional

The time end time to research of user defined record

string (date-time)

researchCommentsThreadId
optional

Research comment thread this record is part of

integer (int64)

researchOpenDate
optional

The time start time to research of user defined record

string (date-time)

researchStatus
optional

The research status of user defined record.

IdNameValue

researchUser
optional

IdNameValue

startTime
optional

The start time of the user defined event starts

string (date-time)

testPercentComplete
optional

integer (int64)

testingStatus
optional

IdNameValue

user
optional

The user defines the user defined record.

IdNameValue

userDefinedRecordId
optional

Unique identifier of this userdefined record

integer (int64)

3.41. UserDefinedRequest

Name Description Schema

cause1
optional

integer (int64)

cause2
optional

integer (int64)

cause3
optional

integer (int64)

cause4
optional

integer (int64)

commentsThreadId
optional

integer (int64)

endTime
required

User Defined Event End Time; Example: 2022-09-14T10:50:01Z
Example : "2022-09-14T10:50:01Z"

string (date-time)

eventName
optional

string

eventStatus
optional

integer (int64)

eventSubType
optional

integer (int64)

startTime
required

User Defined Event Start Time; Example: 2022-09-14T10:50:01Z
Example : "2022-09-14T10:50:01Z"

string (date-time)

unitId
optional

integer (int64)

userDefinedRecordId
optional

integer (int64)

3.42. 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.43. UserSettingResponseResource

Name Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

boolean

links
optional

< Link > array

viewName
optional

string

4. Security

4.1. access_token

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

Name Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name Description

default

Default oauth2 scope.

4.4. client_creds

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

Name Description

default

Default oauth2 scope.