Share

Get a list of all available operations

GET /api/v1/erp/operations returns all of the valid ERP operations for the user using the API.

Request schema

Method URL
GET /api/v1/erp/operations

Request header

*indicates required fields

Field Value type Description of values
*Authorization String Enter: Bearer access token.
X-User-Id Text Enter the email address of the user being impersonated. This value is required if you are using a two-legged token. If you are using a three-legged token, then this field is not required.

Response schema

Response payload includes an array of operations available to the company. The following information about each operation is returned:

Response body

Field Value type Description of values
id Integer Accepted values are 1, 2, and 3. Each number represents an operation:

  • 1 - Check connection to ERP system
  • 2 - Validate work order data in ERP system
  • 3 - Create a requisition in the ERP system
name String Name of the operation.
description String Description of the operation.

Sample response

[
  {
  "id": 1,
  "name": "Check connectivity to ERP system",
  "description": "Checks if mapped ERP system/wrapper is running at the moment"
  },
  {
  "id": 2,
  "name": "Validate JDE WorkOrder Number",
  "description": "Validates if the given JDE WorkOrder Number exists in ERP system"
  },
  {
  "id": 3,
  "name": "Create Requisitions",
  "description": "Create requisitions in the ERP system for the given payload"
  }
]

Was this information helpful?