Supercharge your Proficy solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Explore our Proficy 2024 releases!

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

Workflow IPI
Get Started
Tutorials
Orientation
Configure Your Environment
Security
Resource Information and Configuration
Data Administration
Forms and User Displays
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.
eSOP
ActiveX Task Controls
Service Interfaces
Operator Task List in the Workflow Client
Best Practices

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.

HTTP Method	URI Example	Default Port	Request Body	Return Value
PUT	https://serverName:port/ProficyWebApi/api/signatures	8444	Definition provided as JSON data. `{ "ValidPerformers":"PerformerGroupName", "VerifierRequired":"True", "ValidVerifiers":"VerifierGroupName", "Description":"Signing required" }`	Returns the signature record ID.