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. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • esignature-commands-controller : Esignature Commands Controller

  • esignature-configuration-controller : Esignature Configuration Controller

  • esignature-controller : Esignature Controller

2. Resources

2.1. Esignature-commands-controller

Esignature Commands Controller

2.1.1. Creates a record in esignature table and uses the request token to capture performing user sign

POST /api/esignatureCommand/perform
Parameters
Type Name Description Schema

Body

performSignInfo
optional

Performer Sign Info

PerformSignInfo
Responses
HTTP Code Description Schema

200

OK

ESignatureRecordResource

201

CREATED

ESignatureRecordResource

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

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

Security
Type Name Scopes

oauth2

oauth

default

2.1.2. verify record performed by a user in esignature table and uses the request token to capture performing user sign

POST /api/esignatureCommand/verify
Parameters
Type Name Description Schema

Body

verifySignInfo
optional

Verifier Sign Info

VerifySignInfo
Responses
HTTP Code Description Schema

200

OK

ESignatureRecordResource

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

409

E-Signature Record already verified

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

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

Security
Type Name Scopes

oauth2

oauth

default

2.2. Esignature-configuration-controller

Esignature Configuration Controller

2.2.1. Fetches Esignature Configuration

GET /api/esignatureConfiguration
Responses
HTTP Code Description Schema

200

OK

EsignatureConfiguration

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

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

Security
Type Name Scopes

oauth2

oauth

default

2.3. Esignature-controller

Esignature Controller

2.3.1. Fetches List of Esignature for the given signature ids

GET /api/esignatures
Parameters
Type Name Description Schema Default

Query

esignatureIds
optional

List of esignatureIds

< integer (int64) > array(multi)

Query

page
optional

Page number to fetch. Defaults to 0

integer (int32)

0

Query

size
optional

Number of records per page. Defaults to 20

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

ESignatureRecordPage

401

Unauthorized

No Content

404

Not Found, Resource is not found.

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

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

Security
Type Name Scopes

oauth2

oauth

default

2.3.2. Fetches Esignature details for the given signature id

GET /api/esignatures/{id}
Parameters
Type Name Description Schema

Path

id
optional

E-Signature to fetch the e-signature detail

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ESignatureRecordResource

401

Unauthorized

No Content

404

Not Found, Resource is not found.

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

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

Security
Type Name Scopes

oauth2

oauth

default

3. Definitions

3.1. ESignatureRecord

Name Description Schema

performCommentId
optional

Id referring the comment from comments table entered by the performing user

integer (int64)

performNode
optional

Information capturing where the user performed the signature

string

performReasonLevel1Id
optional

The level 1 reason selected by the performing user

integer (int64)

performTime
optional

Time when esignature Performed

string (date-time)

performingUserName
optional

Name of user,who is performing e-signature

string

signatureId
optional

Signature record which needs to be updated

integer (int64)

signingContext
optional

JSON representing what this signature is used for

object

verifyCommentId
optional

Id referring the comment from comments table entered by the performing user

integer (int64)

verifyNode
optional

Information capturing where the user performed the signature

string

verifyReasonLevel1Id
optional

The level 1 reason selected by the performing user

integer (int64)

verifyTime
optional

Time when esignature verified

string (date-time)

verifyingUserName
optional

Name of user,who is verifying e-signature

string

3.2. ESignatureRecordPage

Name Schema

content
optional

< ESignatureRecord > array

links
optional

< Link > array

page
optional

PageMetadata

3.3. ESignatureRecordResource

Name Description Schema

links
optional

< Link > array

performCommentId
optional

Id referring the comment from comments table entered by the performing user

integer (int64)

performNode
optional

Information capturing where the user performed the signature

string

performReasonLevel1Id
optional

The level 1 reason selected by the performing user

integer (int64)

performTime
optional

Time when esignature Performed

string (date-time)

performingUserName
optional

Name of user,who is performing e-signature

string

signatureId
optional

Signature record which needs to be updated

integer (int64)

signingContext
optional

JSON representing what this signature is used for

object

verifyCommentId
optional

Id referring the comment from comments table entered by the performing user

integer (int64)

verifyNode
optional

Information capturing where the user performed the signature

string

verifyReasonLevel1Id
optional

The level 1 reason selected by the performing user

integer (int64)

verifyTime
optional

Time when esignature verified

string (date-time)

verifyingUserName
optional

Name of user,who is verifying e-signature

string

3.4. Error

Name Schema

code
optional

string

details
optional

object

3.5. EsignatureConfiguration

Name Description Schema

performerAuthenticationCacheDuration
optional

E-Signature Inactivity Period in minutes,Duration for which a client session for the Performer should be kept authenticated

integer (int64)

performerDefaultReasonId
optional

Default performer reason for approving an Electronic Signature transaction

integer (int64)

performerDefaultReasonTreeId
optional

Reason Tree used to provide the performer Default reason for approving an Electronic Signature transaction

integer (int64)

requirePerformerAuthenticationAlways
optional

Require Password-Only authentication for all Updates after initial authentication (overrides the inactivity period and prompts for password for perform level esignature)
Example : false

boolean

verifierDefaultReasonId
optional

Default verifier reason for approving an Electronic Signature transaction

integer (int64)

verifierDefaultReasonTreeId
optional

Reason Tree used to provide the verifier Default reason for approving an Electronic Signature transaction

integer (int64)

3.6. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.7. Link

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

rel
optional

string

templated
optional

boolean

title
optional

string

type
optional

string

3.8. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.9. PerformSignInfo

Name Description Schema

performCommentId
optional

Id referring the comment from comments table entered by the performing user

integer (int64)

performNode
optional

Information capturing where the user performed the signature

string

performReasonLevel1Id
optional

The level 1 reason selected by the performing user

integer (int64)

signingContext
optional

JSON representing what this signature is used for

object

3.10. VerifySignInfo

Name Description Schema

signatureId
optional

Signature record which needs to be updated

integer (int64)

signingContext
optional

JSON representing what this signature is used for, will override the existing context if this is not null

object

verifyCommentId
optional

Id referring the comment from comments table entered by the performing user

integer (int64)

verifyNode
optional

Information capturing where the user performed the signature

string

verifyReasonLevel1Id
optional

The level 1 reason selected by the performing user

integer (int64)

4. Security

4.1. oauth

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

Name Description

default

Default oauth2 scope.