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 |
Performer Sign Info |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
CREATED |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json -
application/vnd.ge.mes.v1.full+json
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
Verifier Sign Info |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
409 |
E-Signature Record already verified |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json -
application/vnd.ge.mes.v1.full+json
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
Produces
-
application/json -
application/vnd.ge.mes.v1.full+json
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
List of esignatureIds |
< integer (int64) > array(multi) |
|
Query |
page |
Page number to fetch. Defaults to 0 |
integer (int32) |
|
Query |
size |
Number of records per page. Defaults to 20 |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found, Resource is not found. |
|
500 |
Internal Server Error |
Produces
-
application/json -
application/vnd.ge.mes.v1.full+json
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.3.2. Fetches Esignature details for the given signature id
GET /api/esignatures/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
E-Signature to fetch the e-signature detail |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found, Resource is not found. |
|
500 |
Internal Server Error |
Produces
-
application/json -
application/vnd.ge.mes.v1.full+json
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
3. Definitions
3.1. ESignatureRecord
| Name | Description | Schema |
|---|---|---|
performCommentId |
Id referring the comment from comments table entered by the performing user |
integer (int64) |
performNode |
Information capturing where the user performed the signature |
string |
performReasonLevel1Id |
The level 1 reason selected by the performing user |
integer (int64) |
performTime |
Time when esignature Performed |
string (date-time) |
performingUserName |
Name of user,who is performing e-signature |
string |
signatureId |
Signature record which needs to be updated |
integer (int64) |
signingContext |
JSON representing what this signature is used for |
object |
verifyCommentId |
Id referring the comment from comments table entered by the performing user |
integer (int64) |
verifyNode |
Information capturing where the user performed the signature |
string |
verifyReasonLevel1Id |
The level 1 reason selected by the performing user |
integer (int64) |
verifyTime |
Time when esignature verified |
string (date-time) |
verifyingUserName |
Name of user,who is verifying e-signature |
string |
3.2. ESignatureRecordPage
| Name | Schema |
|---|---|
content |
< ESignatureRecord > array |
links |
< Link > array |
page |
3.3. ESignatureRecordResource
| Name | Description | Schema |
|---|---|---|
links |
< Link > array |
|
performCommentId |
Id referring the comment from comments table entered by the performing user |
integer (int64) |
performNode |
Information capturing where the user performed the signature |
string |
performReasonLevel1Id |
The level 1 reason selected by the performing user |
integer (int64) |
performTime |
Time when esignature Performed |
string (date-time) |
performingUserName |
Name of user,who is performing e-signature |
string |
signatureId |
Signature record which needs to be updated |
integer (int64) |
signingContext |
JSON representing what this signature is used for |
object |
verifyCommentId |
Id referring the comment from comments table entered by the performing user |
integer (int64) |
verifyNode |
Information capturing where the user performed the signature |
string |
verifyReasonLevel1Id |
The level 1 reason selected by the performing user |
integer (int64) |
verifyTime |
Time when esignature verified |
string (date-time) |
verifyingUserName |
Name of user,who is verifying e-signature |
string |
3.4. Error
| Name | Schema |
|---|---|
code |
string |
details |
object |
3.5. EsignatureConfiguration
| Name | Description | Schema |
|---|---|---|
performerAuthenticationCacheDuration |
E-Signature Inactivity Period in minutes,Duration for which a client session for the Performer should be kept authenticated |
integer (int64) |
performerDefaultReasonId |
Default performer reason for approving an Electronic Signature transaction |
integer (int64) |
performerDefaultReasonTreeId |
Reason Tree used to provide the performer Default reason for approving an Electronic Signature transaction |
integer (int64) |
requirePerformerAuthenticationAlways |
Require Password-Only authentication for all Updates after initial authentication (overrides the inactivity period and prompts for password for perform level esignature) |
boolean |
verifierDefaultReasonId |
Default verifier reason for approving an Electronic Signature transaction |
integer (int64) |
verifierDefaultReasonTreeId |
Reason Tree used to provide the verifier Default reason for approving an Electronic Signature transaction |
integer (int64) |
3.6. HttpErrorResponse
| Name | Schema |
|---|---|
error |
|
path |
string |
timestamp |
string |
3.7. Link
| Name | Schema |
|---|---|
deprecation |
string |
href |
string |
hreflang |
string |
media |
string |
name |
string |
profile |
string |
rel |
string |
template |
|
templated |
boolean |
title |
string |
type |
string |
3.8. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.9. PerformSignInfo
| Name | Description | Schema |
|---|---|---|
performCommentId |
Id referring the comment from comments table entered by the performing user |
integer (int64) |
performNode |
Information capturing where the user performed the signature |
string |
performReasonLevel1Id |
The level 1 reason selected by the performing user |
integer (int64) |
signingContext |
JSON representing what this signature is used for |
object |
3.10. TemplateVariable
| Name | Schema |
|---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.11. UriTemplate
| Name | Schema |
|---|---|
variableNames |
< string > array |
variables |
< TemplateVariable > array |
3.12. VerifySignInfo
| Name | Description | Schema |
|---|---|---|
signatureId |
Signature record which needs to be updated |
integer (int64) |
signingContext |
JSON representing what this signature is used for, will override the existing context if this is not null |
object |
verifyCommentId |
Id referring the comment from comments table entered by the performing user |
integer (int64) |
verifyNode |
Information capturing where the user performed the signature |
string |
verifyReasonLevel1Id |
The level 1 reason selected by the performing user |
integer (int64) |
4. Security
4.1. access_token
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. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://10.181.213.136:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://10.181.213.136:8080/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://10.181.213.136:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |