×

Have You Seen Workflow Lately? Click here to check out all the new features in the latest version.

Supercharge your GE solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Learn more about the Proficy 2024 releases, by signing up for one of our upcoming events.

Home
Building and Configuring Workflows
REST APIs
REST APIs
You can use the REST APIs to interact with the Workflow application over the Internet.
REST API for E-signatures
E-Signature Error Codes
If a REST operation fails, additional information about the error is available from both the response Error-Code header and the response body.

Workflow Products Documentation

Building and Configuring Workflows
- Workflow Design Basics
- Workflow Foundations
- Task Management for Administrators
- Task Configuration
- Task Step Configuration
- Global Subprocesses
- Basic Activities
- Schedules
- Faults
- Test Workflows
- Debug Workflows
- Track Data
- Web Services Service Provider
- Legacy Workflow Web Service
- Categories
- Completion Codes
- Actuals
- REST APIs
  - REST APIs
    You can use the REST APIs to interact with the Workflow application over the Internet.
    - REST APIs for User Activities
    - REST API for E-signatures
      - Create a New E-signature Record
        You can create a signature record based on a provided definition. A record must be created before it can be signed.
      - Sign an E-signature Record
        The signature record can be signed once for the performer, and, if required, a second time for the verifier. When all signatures are complete, the record is closed. To sign an existing signature record, you use the signature ID that is returned from the creation request.
      - Get an E-Signature Record
        You can retrieve an in-progress or completed signature record.
      - Cancel an E-Signature Record
        You can cancel an in-progress signature record.
      - E-Signature Error Codes
        If a REST operation fails, additional information about the error is available from both the response Error-Code header and the response body.
    - REST API for Equipment
      All equipment methods use the same base URL.

E-Signature Error Codes

If a REST operation fails, additional information about the error is available from both the response Error-Code header and the response body.

Signing Errors

Code	Description
	1000	Specifies that the resource ID that has been provided is not in a valid format.
	1001	Specifies that the credentials provided for the signing are invalid.
	1002	Specifies that the signer is not a member of the required group to perform the signing.
	1003	Specifies that the user has already signed as the performer and is attempting to sign as the verifier. The same user cannot both sign and verify the same record.
	1004	Specifies that the signer has been disallowed by the electronic signature system.
	1005	Specifies that all signings have already been completed for the related signature record.
	1006	Specifies that the signing information provided in the request body is malformed.
	1007	Specifies that an unknown error has occurred during signing.

Record Creation Errors

Code	Description
	1011	Specifies that an invalid group name has been designated as the Performer Group.
	1012	Specifies that an invalid group name has been designated as the Verifier Group.
	1013	Specifies that no description has been provided for the signature.
	1014	Specifies that a task, task step, or form ID was not included when the signature was created, and that the definition was not provided in the body.
	1015	Specifies that a signature has not been configured for task, task step, or form indicated.