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 Equipment
All equipment methods use the same base URL.

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
    - REST API for Equipment
      All equipment methods use the same base URL.
      - Get Equipment Instances
        Returns a list of equipment instances that matches the provided criteria. The hierarchy is also returned to allow for duplicate names for equipment instances.
      - Get Single Equipment Instance
        Returns the details of a specific equipment instance and, optionally, the properties. The hierarchy is also returned to allow for duplicate names for equipment instances.
      - Get Equipment Property by Name
        Returns the details of the named property for the specified equipment instance.
      - Update an Equipment Property
        You can update the details of a property for a specific equipment instance.
      - Equipment 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.
eSOP
ActiveX Task Controls
Service Interfaces
Operator Task List in the Workflow Client
Best Practices

REST API for Equipment

All equipment methods use the same base URL.

Base URL

https:/<serverName>:<port>/ProficyWebApi/api/Equipment

<serverName> is the hostname where the Proficy SOA server is running.
<port> default is 8444.

Authentication is required on each request. Basic authentication with username and password must be provided in the Authorization header.