esignature-app-service

1. Overview

The service contains a collection of RESTful service calls to retrieve and update esignature domain related information in PA relevant to manufacturing execution.

Descriptions of these functions can be found in the section headers for each collection of relevant resources.

1.1. License information

The copyright to the computer software herein is the property of GE Digital.
The software may be used and/or copied only with the written permission of
GE Digital or in accordance with the terms and conditions stipulated in the
agreement/contract under which the software has been supplied
Terms of service : null

1.2. URI scheme

Host : localhost
BasePath : /

1.3. Tags

esignature-command-controller : Esignature Command Controller
esignature-editor-controller : Esignature Editor Controller

2. Resources

2.1. Esignature-command-controller

Esignature Command Controller

2.1.1. performEsignatue

POST /esignatureCommand/perform

Parameters

Type	Name	Description	Schema
Body	performerSign required	performerSign	EsignaturePerformerSignInfo

Type

Name

Description

Schema

Body

performerSign
required

performerSign

EsignaturePerformerSignInfo

Responses

HTTP Code	Description	Schema
200	OK	EsignatureInfo

HTTP Code

Description

Schema

200

EsignatureInfo

Consumes

application/json

Produces

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

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.1.2. verifyEsignatue

POST /esignatureCommand/verify

Parameters

Type	Name	Description	Schema
Body	verifierSign required	verifierSign	EsignatureVerifierSignInfo

Type

Name

Description

Schema

Body

verifierSign
required

verifierSign

EsignatureVerifierSignInfo

Responses

HTTP Code	Description	Schema
200	OK	EsignatureInfo

HTTP Code

Description

Schema

200

EsignatureInfo

Consumes

application/json

Produces

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

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. Esignature-editor-controller

Esignature Editor Controller

2.2.1. Get the Esignature Edit State details

GET /esignatureEditor

Parameters

Type Name Description Schema Default

Type	Name	Description	Schema	Default
Query	includePerformerReason optional	Flag indicating whether the Performer Reason should be retrieved	boolean	`"false"`
Query	includeVerifierReason optional	Flag indicating whether the Verifier Reason should be retrieved	boolean	`"false"`

Query

includePerformerReason
optional

Flag indicating whether the Performer Reason should be retrieved

boolean

"false"

Query

includeVerifierReason
optional

Flag indicating whether the Verifier Reason should be retrieved

boolean

"false"

Responses

HTTP Code	Description	Schema
200	OK	ESignatureEditorOverviewInfo
401	Unauthorized	No Content
500	Internal Server error, See logs for details	No Content

HTTP Code

Description

Schema

200

ESignatureEditorOverviewInfo

401

Unauthorized

No Content

500

Internal Server error, See logs for details

No Content

Produces

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

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

3. Definitions

3.1. Attachment

Name	Description	Schema
attachmentName optional	document name	string
attachmentType optional	attachment type	string
documentId optional	documentId of the document	string

Name

Description

Schema

attachmentName
optional

document name

string

attachmentType
optional

attachment type

string

documentId
optional

documentId of the document

string

3.2. BaseResponse

Name	Schema
data optional	object
links optional	< Link > array
message optional	string
statusCode optional	integer (int32)

Name

Schema

data
optional

object

links
optional

< Link > array

message
optional

string

statusCode
optional

integer (int32)

3.3. CommonCommentRecord

Name	Description	Schema
attachments optional	Comment Attachments	< Attachment > array
commentText optional	The text of the comment	string
commentType optional	CommentType that the comment is mapped to. Ex: 1 for Tests, 80 for Activities	string
entityId optional	EntityId’s instance Id for this comment	integer (int64)
entityType optional	Entity Type of Plant Apps or non-Plant Apps for this comment record	string

Name

Description

Schema

attachments
optional

Comment Attachments

< Attachment > array

commentText
optional

The text of the comment

string

commentType
optional

CommentType that the comment is mapped to. Ex: 1 for Tests, 80 for Activities

string

entityId
optional

EntityId’s instance Id for this comment

integer (int64)

entityType
optional

Entity Type of Plant Apps or non-Plant Apps for this comment record

string

3.4. ESignatureEditorOverviewInfo

Name	Schema
authenticationCachePeriod optional	integer (int64)
defaultPerformerReasonId1 optional	integer (int64)
defaultVerifierReasonId1 optional	integer (int64)
performerReasonTree optional	< ReasonTreeNodeDto > array
userName optional	string
verifierReasonTree optional	< ReasonTreeNodeDto > array

Name

Schema

authenticationCachePeriod
optional

integer (int64)

defaultPerformerReasonId1
optional

integer (int64)

defaultVerifierReasonId1
optional

integer (int64)

performerReasonTree
optional

< ReasonTreeNodeDto > array

userName
optional

string

verifierReasonTree
optional

< ReasonTreeNodeDto > array

3.5. EsignatureInfo

Name	Schema
performComment optional	BaseResponse
performNode optional	string
performReasonLevel1 optional	IdNameValue
performTime optional	string (date-time)
performingUserName optional	string
signatureId optional	integer (int64)
signingContext optional	object
verifyComment optional	BaseResponse
verifyNode optional	string
verifyReasonLevel1 optional	IdNameValue
verifyTime optional	string (date-time)
verifyingUserName optional	string

Name

Schema

performComment
optional

BaseResponse

performNode
optional

string

performReasonLevel1
optional

IdNameValue

performTime
optional

string (date-time)

performingUserName
optional

string

signatureId
optional

integer (int64)

signingContext
optional

object

verifyComment
optional

BaseResponse

verifyNode
optional

string

verifyReasonLevel1
optional

IdNameValue

verifyTime
optional

string (date-time)

verifyingUserName
optional

string

3.6. EsignaturePerformerSignInfo

Name	Schema
commentEntry optional	CommonCommentRecord
performNode optional	string
performReasonLevel1Id optional	integer (int64)
signingContext optional	object

Name

Schema

commentEntry
optional

CommonCommentRecord

performNode
optional

string

performReasonLevel1Id
optional

integer (int64)

signingContext
optional

object

3.7. EsignatureVerifierSignInfo

Name	Schema
commentEntry optional	CommonCommentRecord
signatureId optional	integer (int64)
signingContext optional	object
verifyNode optional	string
verifyReasonLevel1Id optional	integer (int64)

Name

Schema

commentEntry
optional

CommonCommentRecord

signatureId
optional

integer (int64)

signingContext
optional

object

verifyNode
optional

string

verifyReasonLevel1Id
optional

integer (int64)

3.8. IdNameValue

Name	Description	Schema
id optional	The unique ID of the entity	integer (int64)
name optional	The name of the entity	string

Name

Description

Schema

id
optional

The unique ID of the entity

integer (int64)

name
optional

The name of the entity

string

3.9. Link

Name	Schema
href optional	string
rel optional	string
templated optional	boolean

Name

Schema

href
optional

string

rel
optional

string

templated
optional

boolean

3.10. ReasonTreeNodeDto

Name Description Schema

Name	Description	Schema
categoryId optional	The categoryId of the reason	integer (int64)
categoryName optional	The category name of reason	string
children optional	The List of the reasonTreeNode	< ReasonTreeNodeDto > array
commentRequired optional	flag to check if reason is mendatory Example : `false`	boolean
links optional		< Link > array
nodeId optional	The Unique identifier of node	integer (int64)
parentNodeId optional	The Unique identifier of parentNode	integer (int64)
reasonId optional	The Unique identifier of reason	integer (int64)
reasonLevel optional	The level can be 1-level1 2-level2 3-level3 4-level4 of reason	integer (int32)
reasonName optional	The name of the reason	string
treeId optional	The Unique identifier of tree	integer (int64)

categoryId
optional

The categoryId of the reason

integer (int64)

categoryName
optional

The category name of reason

string

children
optional

The List of the reasonTreeNode

< ReasonTreeNodeDto > array

commentRequired
optional

flag to check if reason is mendatory
Example : false

boolean

links
optional

< Link > array

nodeId
optional

The Unique identifier of node

integer (int64)

parentNodeId
optional

The Unique identifier of parentNode

integer (int64)

reasonId
optional

The Unique identifier of reason

integer (int64)

reasonLevel
optional

The level can be 1-level1 2-level2 3-level3 4-level4 of reason

integer (int32)

reasonName
optional

The name of the reason

string

treeId
optional

The Unique identifier of tree

integer (int64)

4. Security

4.1. access_token

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

Name	Description
default	Default oauth2 scope.

Name

Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name	Description
default	Default oauth2 scope.

Name

Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name	Description
default	Default oauth2 scope.

Name

Description

default

Default oauth2 scope.

4.4. client_creds

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

Name	Description
default	Default oauth2 scope.

Name

Description

default

Default oauth2 scope.