autolog-service

1. Overview

The autolog-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 relevent resources.

1.1. URI scheme

Host : localhost:34537
BasePath : /

1.2. Tags

data-type-controller : Data Type Controller
display-controller : Display Controller
event-details-controller : Event Details Controller
histogram-controller : Histogram Controller
tests-data-controller : Tests Data 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
Header	Site-Id required	Represents the id of the site to connect to	string
Query	dataTypeId optional	dataTypeId	integer (int64)

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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 activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

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 activity 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

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 sheets detail

GET /v1/display

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Header	Site-Id required	Represents the id of the site to connect to	string
Query	isActive optional	isActive	boolean
Query	page optional	Page number to return 0 to N.	integer (int32)	`0`
Query	puIds optional	puIds	string
Query	sheetDesc optional	sheetDesc	string
Query	sheetId optional	sheetId	integer (int64)
Query	size optional	Number of resources to return per page.	integer (int32)	`20`

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

isActive
optional

isActive

boolean

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

puIds
optional

puIds

string

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 activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

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 activity 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

Type

Name

Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.2. Get Event count for a sheet

GET /v1/display/{sheetid}/event/count

Parameters

Type	Name	Description	Schema
Header	Site-Id required	Represents the id of the site to connect to	string
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

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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 activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

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 activity 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

Type

Name

Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.3. Get events for a sheet

GET /v1/display/{sheetid}/events

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Header	Site-Id required	Represents the id of the site to connect to	string
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`
Query	startDate required	Start Date; example = 2022-08-03T10:50:17.717Z	string

Header

Site-Id
required

Represents the id of the site to connect to

string

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

Query

startDate
required

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

string

Responses

HTTP Code	Description	Schema
200	Success	< SheetEventDetails > array
400	Bad Request	No Content
401	Unauthorized	No Content
403	Forbidden, User is not allowed to update the activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

HTTP Code

Description

Schema

200

Success

< SheetEventDetails > array

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the activity 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

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

Type	Name	Description	Schema	Default
Header	Site-Id required	Represents the id of the site to connect to	string
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

Header

Site-Id
required

Represents the id of the site to connect to

string

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	< EventDetails > array
400	Bad Request	No Content
401	Unauthorized	No Content
403	Forbidden, User is not allowed to update the activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

HTTP Code

Description

Schema

200

Success

< EventDetails > array

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the activity 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

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

Type	Name	Description	Schema	Default
Header	Site-Id required	Represents the id of the site to connect to	string
Path	sheetid required	Sheet Id	integer (int64)
Query	decimalSep required	Decimal Separator	string	`"."`
Query	exactSearch required	Exact Text	boolean
Query	isFromGrid optional	From Grid	boolean	`"true"`
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`

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

sheetid
required

Sheet Id

integer (int64)

Query

decimalSep
required

Decimal Separator

string

"."

Query

exactSearch
required

Exact Text

boolean

Query

isFromGrid
optional

From Grid

boolean

"true"

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	< EventDetails > array
400	Bad Request	No Content
401	Unauthorized	No Content
403	Forbidden, User is not allowed to update the activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

HTTP Code

Description

Schema

200

Success

< EventDetails > array

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the activity 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

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

Type	Name	Description	Schema	Default
Header	Site-Id required	Represents the id of the site to connect to	string
Path	sheetid required	Sheet Id	integer (int64)
Query	exactSearch required	Exact Text	boolean
Query	isFromGrid optional	From Grid	boolean	`"false"`
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`

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

sheetid
required

Sheet Id

integer (int64)

Query

exactSearch
required

Exact Text

boolean

Query

isFromGrid
optional

From Grid

boolean

"false"

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 activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

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 activity 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

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
Header	Site-Id required	Represents the id of the site to connect to	string
Path	sheetid required	Sheet Id	integer (int64)
Query	GetOptions optional	GetOptions	integer (int64)

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

HTTP Code

Description

Schema

200

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

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 access level

GET /v1/display/{sheetid}/security

Parameters

Type	Name	Description	Schema
Header	Site-Id required	Represents the id of the site to connect to	string
Path	sheetid required	Sheet Id	integer (int64)

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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 activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

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 activity 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

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
Header	Site-Id required	Represents the id of the site to connect to	string
Path	sheetid required	Sheet Id	integer (int64)
Query	displayOptionCategoryId optional	displayOptionCategoryId	integer (int64)

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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 activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

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 activity 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

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

Type	Name	Description	Schema	Default
Header	Site-Id required	Represents the id of the site to connect to	string
Path	sheetid required	Sheet Id	integer (int64)
Query	decimalSep required	Decimal Separator	string	`"."`
Query	eventIds required	eventIds	string

Header

Site-Id
required

Represents the id of the site to connect to

string

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 activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

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 activity 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

Type

Name

Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.11. Get sheet variables test data

GET /v1/display/{sheetid}/sheet-variables-test-data

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Header	Site-Id required	Represents the id of the site to connect to	string
Path	sheetid required	Sheet Id	integer (int64)
Query	decimalSep required	Decimal Separator	string	`"."`
Query	eventIds optional	eventIds	string
Query	startDate required	Start Date; example = 2022-08-03T10:50:17.717Z	string
Query	variableIds required	Variable Id list; comma separated	string

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

sheetid
required

Sheet Id

integer (int64)

Query

decimalSep
required

Decimal Separator

string

"."

Query

eventIds
optional

eventIds

string

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	< SheetVariableTestResult > array
400	Bad Request	No Content
401	Unauthorized	No Content
403	Forbidden, User is not allowed to update the activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

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 activity 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

Type

Name

Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.12. Get variables for a sheet

GET /v1/display/{sheetid}/variables

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Header	Site-Id required	Represents the id of the site to connect to	string
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`

Header

Site-Id
required

Represents the id of the site to connect to

string

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	< SheetVariable > array
400	Bad Request	No Content
401	Unauthorized	No Content
403	Forbidden, User is not allowed to update the activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

HTTP Code

Description

Schema

200

Success

< SheetVariable > array

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden, User is not allowed to update the activity 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

Type

Name

Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.13. Get variables count for a sheet

GET /v1/display/{sheetid}/variables/count

Parameters

Type	Name	Description	Schema
Header	Site-Id required	Represents the id of the site to connect to	string
Path	sheetid required	Sheet Id	integer (int64)

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

sheetid
required

Sheet Id

integer (int64)

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 activity record	HttpErrorResponse
404	Not Found, Resource is not found	No Content
422	Unprocessable Entity	HttpErrorResponse
503	Service Unavailable	No Content

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 activity 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

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
Header	Site-Id required	Represents the id of the site to connect to	string
Query	eventId required	eventId	integer (int64)
Query	eventType required	eventType	integer (int64)

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

HTTP Code

Description

Schema

200

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

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
Header	Site-Id required	Represents the id of the site to connect to	string
Query	eventId optional	eventId	integer (int64)
Query	eventType required	eventType	integer (int64)
Query	resultOn optional	resultOn	string
Query	sheetId optional	sheetId	integer (int64)

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

HTTP Code

Description

Schema

200

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

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
Header	Site-Id required	Represents the id of the site to connect to	string
Body	eventDimensionDetails required	eventDimensionDetails	EventDimensionDetails

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

HTTP Code

Description

Schema

200

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

eventId
required

eventId

integer (int64)

Query

eventType
required

eventType

integer (int64)

Responses

HTTP Code

Description

Schema

200

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. Fetches histogram values for a product

GET /histogram-data/{variableId}/histogram

Parameters

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

< HistogramData > array

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessible 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.5. Tests-data-controller

Tests Data Controller

2.5.1. Create sheet variables test data

POST /v1/tests

Parameters

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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 activity 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. Update sheet variables test data

PUT /v1/tests/{id}

Parameters

Type

Name

Description

Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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 activity 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

3. Definitions

3.1. Error

Name

Schema

code
optional

string

details
optional

object

3.2. 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.3. 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.4. EventDimensionDetails

Name

Schema

eventId
optional

integer (int64)

finalDimA
optional

string

finalDimX
optional

string

finalDimY
optional

string

finalDimZ
optional

string

3.5. 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.6. EventHistoryDto

Name

Schema

eventHistoryDetails
optional

< EventHistoryDetails > array

eventHistoryInfo
optional

< EventHistoryInfo > array

udeHistoryDetails
optional

< UdeHistoryDetails > array

3.7. 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.8. HistogramData

Name

Description

Schema

value
optional

Uniquee identifier for this value

number (double)

variableId
optional

Unique identifier for this productId

integer (int64)

3.9. HttpErrorResponse

Name

Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.10. 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.11. RequestValidationErrorDetails

Error details for an HttpErrorResponse with an error code of RequestValidationError

Name

Description

Schema

validationErrors
optional

List of validation errors

< ValidationError > array

3.12. ResourceNotFoundErrorDetails

Error details for an HttpErrorResponse with an error code of ResourceNotFound

Name

Description

Schema

resourceId
optional

ID of the resource that was not found

object

resourceType
optional

Type of resource that was not found

enum (DataEntryPlan)

3.13. SheetEventDetails

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.14. 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.15. 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.16. 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.17. SheetVariable

Name

Schema

dataTypeDesc
optional

string

dataTypeId
optional

integer (int64)

dsdesc
optional

string

editable
optional

boolean

engUnits
optional

string

esignatureLevel
optional

integer (int32)

eventTypeDesc
optional

string

eventTypeId
optional

integer (int64)

externalLink
optional

string

forceSignEntry
optional

string

groupId
optional

integer (int64)

inputTag
optional

string

isactive
optional

boolean

iscalculation
optional

boolean

lineComment
optional

string

masterUnit
optional

integer (int64)

outputTag
optional

string

parentLineDesc
optional

string

parentLineId
optional

integer (int64)

parentUnitDesc
optional

string

parentUnitId
optional

integer (int64)

parentVariable
optional

integer (int64)

parentVariableDesc
optional

string

plDesc
optional

string

plid
optional

integer (int64)

puDesc
optional

string

puid
optional

integer (int64)

said
optional

integer (int64)

samplingInterval
optional

integer (int64)

samplingType
optional

integer (int64)

samplingTypeDesc
optional

string

spcCalculationTypeId
optional

integer (int64)

specComment
optional

string

specCount
optional

integer (int64)

specDesc
optional

string

specId
optional

integer (int64)

stringSpecificationSetting
optional

string

title
optional

string

unitComment
optional

string

userDefinedDataType
optional

boolean

varComment
optional

string

varDesc
optional

string

varId
optional

integer (int64)

varOrder
optional

integer (int64)

varPrecision
optional

integer (int64)

writeAccess
optional

integer (int64)

3.18. 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.19. 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.20. TestsDataRequest

Name

Schema

commentId
optional

integer (int64)

eventId
optional

integer (int64)

result
optional

string

resultOn
optional

string

varId
optional

integer (int64)

3.21. 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.22. 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.23. 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.24. UniqueConstraintViolationErrorDetails

Error details for an HttpErrorResponse with an error code of UniqueConstraintViolation

Name

Description

Schema

violatingProperties
optional

List of properties involved in the constraint violation

< ViolatingProperty > array

3.25. ValidationError

Error indicating a validation rule has been violated

Name

Description

Schema

message
optional

Validation error message

string

propertyName
optional

Name of the property that violated the validation rule

string

propertyValue
optional

Value of the property that violated the validation rule

object

ruleName
optional

Name of the validation rule that was violated

string

3.26. ValidationErrorDetails

Error details for an HttpErrorResponse with an error code of ValidationError

Name

Description

Schema

validationErrors
optional

List of validation errors

< ValidationError > array

3.27. ViolatingProperty

Represents a property involved in a constraint violation

Name

Description

Schema

propertyName
optional

Name of the property involved in the constraint violation

string

propertyValue
optional

Value of the property involved in the constraint violation

object

4. Security

4.1. access_token

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

Name

Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name

Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name

Description

default

Default oauth2 scope.

4.4. client_creds

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

Name

Description

default

Default oauth2 scope.