For detailed technical API documentation: DiManEx Technical Documentation

1. Overview

The APIs functional documentation serves as a comprehensive guide for developers and integrators who wish to utilize the application’s APIs for various purposes. This documentation outlines the available APIs, their functionalities, and the necessary steps to interact with them effectively.

By leveraging the power of these APIs, developers can unlock new possibilities and create innovative solutions that seamlessly integrate with the DiManEx application, enhancing productivity and streamlining processes across various domains.

2. Access and Authentication

Authentication with an API key will be required in the DiManEx technical documentation

The DiManEx API leverages API keys for authentication purposes. These keys can be generated at the customer account level.

2.1 Generate Access and Secret Keys

  1. Click on the account name in the bottom left corner to navigate to the Profile section as a customer.

api key 1
Treat your API key as highly confidential information. Never disclose it to unauthorized individuals or include it in client-side code (such as web browsers or applications) where it could be exposed to potential security risks.

  1. Next, provide a unique title for the new API key and click on "GENERATE API KEY" to get a new Access Key and a Secret key.

api key 2

2.2 Generate and use API key to authenticate API requests

After generating the Access Key and Secret Key the final API key is formed by combining these two components separated by a colon (":"). The format for the API key is as follows:

[Access Key]:[Secret Key]

For example, if your Access Key is "abc123" and your Secret Key is "xyz456", then your final API key would be:

abc123:xyz456

This API key should be included in the request headers when making API calls for authentication purposes. The API key is passed using the X-DMNX-AUTH header with the API key value. Here’s an example of how you might include the API key in an API request using CURL:

curl --request GET \
     --url https://api.example.com/endpoint \
     --header 'X-DMNX-AUTH: abc123:xyz456'

2.3 Removing an API key

Follow the below steps to remove an API key and safeguard your account’s integrity. For enhanced security, we advise removing your API key if you suspect any potential compromise.

  1. As a customer, navigate to Profile section.

  2. Find the key you would like to remove.

  3. Click on the red bin icon to remove the API key.

api key 3

3. API Usage Scenarios

3.1. Data Correction

3.1.1 Bulk Data Upload

The Bulk Data Upload functionality allows users to upload large numbers of parts at once and correct any data points that require updating. This feature is particularly useful when dealing with bulk data operations, enabling efficient data correction for multiple parts simultaneously.

UI Based

  1. Go to the 'Data Management' page, click on 'New Part', click on 'Upload Bulk Parts' (redirects to 'Parts Bulk Upload' page), and click on 'Manual Import'.

bulk data 1

  1. Upload the files containing parts data to the designated area (as shown in the image below). The system will automatically import the parts.

bulk data 2

Corresponding API

  1. Uploaded files will be added to the job list on the Data Import page. Click on the 'View' button next to a specific job to view its specific logging details.

bulk data 3

Corresponding API

  1. From the job list, select the relevant job for the uploaded data. Map the correct data-points: DiManEx Field with Source Field.

bulk data 4

Corresponding API

  1. Finally, select the relevant parts to be uploaded and click the 'Import' button to import the data.

bulk data 5

Corresponding API

API Based

 — API to upload part data file:

Corresponding UI

POST ⇒ /zuul/storage/import

  • Query Parameters

    • dataType as a String value:

      • Available values : PART

      • Default value : PART

  • Request Body

    [ EMPTY ]

 

 — APIs to get jobs list and their information:

Corresponding UI

For job list:

GET ⇒ /api/integration-source-types

  • Query Parameters

    • filterDTO as an Object:

      {
  "sort": "string",
  "query": "string"
}

  • Request Body

    [ EMPTY ]

GET ⇒ /api/integration-source-jobs

  • Query Parameters

    • searchContext as an Object:

      {
  "page": 0,
  "count": 0,
  "query": "",
  "sort": ""
}

  • Request Body

    [ EMPTY ]

For logging details of a specific job:

GET ⇒ api/etl-logging-details/stages

  • Query Parameters

    No Parameters

  • Request Body

    [ EMPTY ]

GET ⇒ /api/etl-logging-details/job-info

  • Query Parameters

    • jobId as a String value

    • etlImportStage as a String value:

      • Available values : ALL, INITIALIZATION, MAPPING, VALIDATION, STAGING, ETL_IMPORT

      • Default value : VALIDATION

  • Request Body

    [ EMPTY ]

 

 — APIs to select records and import data of selected records:

Corresponding UI

To select the records to import:

PUT ⇒ /api/etl-staging/import-selection

  • Query Parameters

    • jobId as a String value

    • doSelect as a Boolean value

    • dataType as a String value:

      • Available values : PART

      • Default value : PART

    • searchContext as an object:

      {
  "page": 0,
  "count": 0,
  "query": "",
  "sort": ""
}

  • Request Body

    [ EMPTY ]

To import the data of selected records:

PUT ⇒ /api/integration-source/jobs/{id}/approval-view-state

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "query": {
    "values": {
      "filters": []
    },
    "queryString": false
  },
  "finalMappingDescription": [
    {
      "fromField": "string",
      "toField": "string"
    }
  ],
  "sort": ""
}

POST ⇒ /api/etl-staging/import

  • Query Parameters

    • jobId as a String value

    • dataType as a String value:

      • Available values : PART

      • Default value : PART

  • Request Body

    [ EMPTY ]

3.1.2 Parts Details View

The Parts Details View functionality enables users to view and modify detailed information about individual parts. It provides a comprehensive interface to access and update various data points associated with each part, such as economical and technical parameters, specifications, descriptions, and other relevant details.

In a single part details view, with UIs only one data point can be updated at a time, but with the API, multiple data points can be updated within a single API call, providing a convenient and efficient way to perform bulk data corrections.
UI Based

  1. Go to 'Data Management' page and select a part from the 'Parts' section to go into the part details view.

  2. Inside part details view, find the 'Add/Edit Part Data' section.

  3. Fill out the necessary data points.

parts details

Corresponding API

API Based

 — APIs to get a single part and update its data points:

Corresponding UI

PATCH ⇒ /api/parts/{id}

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "field": "properties",
  "value": {"property1": "value1", "property2": "value2"},
  "admin_notification": true
}

 

3.2. Digitization

The Digitization feature enables users to request the conversion of physical parts or models into digital representations. This process is particularly useful for creating digital twins, virtual simulations, or preparing data for various manufacturing processes. The Digitization APIs provided by DiManEx allow developers to integrate this functionality seamlessly into their applications.

Stay alert with the part status as it will be changing at each stage in the process mentioning the current status of the part.

Once a part is uploaded, the digitization process for that specific part will begin.

3.2.1 Track 1

Track 1 is used to upload and digitize STL or 3D files.

UI Based

  • If the STL/3D file is rejected due to insufficient data,

    1. two buttons, 'Approve Suggested Changes' and 'Reject Suggested Changes', will appear in 'Supply Chain Analytics' and 'Engineering' tabs.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

digitization t1 1

Corresponding API

  1. From either tab, click the 'Approve Suggested Changes' button to approve the changes, or the 'Reject Suggested Changes' button to reject the changes.

  1. Once the suggested changes are approved, wait for the AM to upload the updated STL/3D file. Upon receiving the updated file, two buttons, 'Approve Updated STL File' and 'Reject Updated STL File' (or 'Approve Files' and 'Reject Files' if the user is in the 3D file work path), will appear in the same tabs mentioned earlier.

STL file work path:

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

digitization t1 2

Corresponding API

3D file work path:

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

digitization t1 3

Corresponding API

  1. After reviewing the updated STL file, click the 'Approve Updated STL File'/'Approve Files' button to approve the file, or the 'Reject Updated STL File'/'Reject Files' button to reject the file.

API Based

 — API to approve the suggested changes:

Corresponding UI

for STL file:

POST ⇒ /api/bpm/parts/{id}/customer-approve-stl-file-changes-from-dsp

for 3D file:

POST ⇒ /api/bpm/parts/{id}/customer-approve-stl-file-changes-from-dsp

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string",
  "empty": true
}

 

 — API to reject the suggested changes:

Corresponding UI

for STL file: POST ⇒ /api/bpm/parts/{id}/customer-decline-stl-file-changes-from-dsp

for 3D file: POST ⇒ /api/bpm/parts/{id}/customer-reject-3d-file-changes-from-dsp

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string",
}

 

 — API to approve the updated STL/3D file:

Corresponding UI

for STL file: POST ⇒ /api/bpm/parts/{id}/customer-approve-updated-stl-file-changes-from-dsp

for 3D file: POST ⇒ /api/bpm/parts/{id}/customer-3d-file-work-approve-updated-3d-file

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string",
  "empty": true
}

 

 — API to reject the updated STL/3D file:

Corresponding UI

for STL file: POST ⇒ /api/bpm/parts/{id}/customer-decline-updated-stl-file-changes-from-dsp

for 3D file: POST ⇒ /api/bpm/parts/{id}/customer-3d-file-work-decline-updated-3d-file

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string"
}

3.2.2 Track 2

Track 2 is used to upload and digitize 2D drawings.

UI Based

  • If the 2D drawing is approved, two buttons, 'Approve Files' and 'Reject Files', will appear, allowing the approval or rejection of the AM uploaded STL/3D file(s).

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

digitization t2 1

Corresponding API

  • If the 2D drawing is rejected due to insufficient data, a button labeled 'Missing Data Added' will appear in the part details view, which can be used to confirm after adding the necessary data.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

digitization t2 2

Corresponding API

API Based

 — API to approve the step file from DSP:

Corresponding UI

POST ⇒ /api/bpm/parts/{id}/customer-action-approve-step-file-from-dsp

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string",
  "empty": true
}

 

 — API to reject the step file from DSP:

Corresponding UI

POST ⇒ /api/bpm/parts/{id}/customer-action-reject-step-file-from-dsp

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string"
}

 

 — API to add missing data based on the comment from DSP:

Corresponding UI

POST ⇒ /api/bpm/parts/{id}/customer-action-on-dsp-comment

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string"
}

3.2.3 Track 3

Track 3 is used to upload and digitize physical parts.

UI Based

  • In the part details view, the button 'Physical Part Shipped' will be present, which is used to confirm that the physical part has been shipped.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

digitization t3 1

Corresponding API

  • If rejection occurs due to insufficient data, a button labeled 'Missing Data Added' will appear in the part details view, which can be used to confirm after adding the necessary data.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

digitization t3 2

Corresponding API

  • If the physical part is approved, two buttons, 'Approve Files' and 'Reject Files', will appear, allowing the approval or rejection of the AM uploaded STL/3D file(s).

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

digitization t3 3

Corresponding API

API Based

 — API to confirm that physical part is shipped:

Corresponding UI

POST ⇒ /api/bpm/parts/{id}/pass-physical-item-to-dsp

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string",
  "empty": true
}

 

 — API to add missing data based on the comment from DSP:

Corresponding UI

POST ⇒ /api/bpm/parts/{id}/customer-action-on-dsp-comment-physical-item-track

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string"
}

 

 — APIs to approve and reject the step file from DSP:

Corresponding UI

POST ⇒ /api/bpm/parts/{id}/customer-action-approve-step-file-physical-item-track

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string",
  "empty": true
}

POST ⇒ /api/bpm/parts/{id}/customer-action-reject-step-file-physical-item-track

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string"
}

3.2.4 Common For All Tracks

This section contains UIs and APIs that are common for all the tracks: Track 1, Track 2, and Track 3.

UI Based

  • For all three tracks (Track 1, Track 2, and Track 3), if the files are:

→ approved, status will be changed to "PROGRESS - AM 3D FILE APPROVED"

digitization common 1

→ rejected, status will be changed to "REJECTED - PART IS NOT AM ELIGIBLE"

digitization common 2

  • In the part’s details view, the workflow history area can be used to see all the status changes and actions taken during the digitization process.

digitization common 3

Corresponding API 1 Corresponding API 2

API Based

 — API to get the log history:

Corresponding UI

GET ⇒ /api/workflows/{threadId}/history

  • Query Parameters

    • threadId as a String value

  • Request Body

    [ EMPTY ]

 

 — API to add comments to the log history:

Corresponding UI

PATCH ⇒ /api/workflows/{threadId}/parts/comments

  • Query Parameters

    • threadId as a String value

  • Request Body

    {
  "comment": "String"
}

 

3.3. Quoting

The quoting process allows users to request a quote for a part and start the pricing process. The APIs related to quoting enable developers to programmatically interact with this process.

UI Based

  1. Once the files are approved, navigate to a part’s details view.

  2. Go to either 'Supply Chain Analytics' or 'Engineering' tab.

  3. Click on 'Start Part Quotation'.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

quoting 1

Corresponding API

  1. Monitor any status changes here:

quoting 2

Corresponding API

  1. The list of quoted prices will be displayed here:

quoting 3

Corresponding API

  1. In the part’s details view, the workflow history area can be used to see all the status changes and actions taken during the quoting process.

quoting 4

Corresponding API Corresponding API

API Based

 — API to request a quotation:

Corresponding UI

POST ⇒ /api/bpm/parts/{id}/quotation/start

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "comment": "string",
  "empty": true
}

 

 — API to get the current status of the part:

Corresponding UI

GET ⇒ /api/parts/{id}

  • Query Parameters

    • id as a String value

    • fullNesting as a Boolean value

    • plusHeavyFields as a String value

  • Request Body

    [ EMPTY ]

 

 — API to view the quoted price list:

Corresponding UI

POST ⇒ /api/erp/parts-prices/{partId}/price-list-rate

  • Query Parameters

    • partId as a String value

  • Request Body

    [ EMPTY ]

 

 — API to get the workflow history:

Corresponding UI

GET ⇒ /api/workflows/{threadId}/history

  • Query Parameters

    • threadId as a String value

  • Request Body

    [ EMPTY ]

 

 — API to add comments to the log history:

Corresponding UI

PATCH ⇒ /api/workflows/{threadId}/parts/comments

  • Query Parameters

    • threadId as a String value

  • Request Body

    {
  "comment": "String"
}

 

3.4. Ordering

The ordering process allows users to place orders for parts based on an existing accepted quote. There are two main types of orders: Sample Orders and Print Orders. If a part is already verified, users can directly place Print Orders. However, if a part has not been previously verified, it will be required to initiate a Sample Order first. Upon receiving approval for the Sample Order, they can then proceed to place a Print Order for the respective part.

UI Based

Sample Order UIs

  1. After prices are provided for a part, a 'Order A Sample' button will appear in the part details view to place a sample order.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering sample 1

Corresponding API

  1. The sample order wizard will display the relevant order details, including pricing information.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering sample 2

  1. Click on the 'Add Services' button to include additional services in the order.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering sample 3

Corresponding APIs

  1. Adjust the quantity for both parts and services by clicking the '+' or '-' components under the 'QTY' column.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering sample 4

Corresponding API

  1. Clicking 'Next' will proceed to the billing step.

  2. In the billing step, choose an existing billing address from the dropdown list labeled "Billing To", or create a new one by clicking the "+" button next to the dropdown list.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering sample 5

Corresponding API 1 | Corresponding API 2

  1. Click 'Next' to proceed to the delivery address step. Here, you can select an existing delivery address or create a new one.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering sample 6

Corresponding API 1 | Corresponding API 2

  1. Click 'Next' to proceed to providing contact information. Choose existing contact info or create new contact details.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering sample 7

Corresponding API 1 | Corresponding API 2

  1. Click 'Next' to finalize and start/place the sample order.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering sample 8

Corresponding API 1 | Corresponding API 2 | Corresponding API 3 | Corresponding API 4

  • Provide a "PO Number" and upload a purchase order document if necessary : Corresponding API.

  • Alternatively, cancel the sample order by clicking 'Cancel' : Corresponding API.

  • Review the order details before clicking 'Start Sample Order' : Corresponding API.

  1. Continue reading here: Process after placing an order.

Print Order UIs

  1. To initiate the print order process, go to the parts list view > click on the blue cart icon for each part that needs to be ordered. This action adds the relevant parts to the order basket.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering print 1

Corresponding API 1 | Corresponding API 2

  1. Once the part(s) are in the order basket, click on the cart icon at the top right corner. This opens a small box displaying the selected parts for ordering, including a delete button (red bin icon) and a link labeled 'Proceed with order' to begin the ordering process.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering print 2

Corresponding API 1 | Corresponding API 2

  1. Clicking on 'Proceed with order' redirects to the order details view, showing relevant order details including workflow history.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering print 3

Corresponding API 1 | Corresponding API 2 | Corresponding API 3 | Corresponding API 4 | Corresponding API 5

  1. Click on 'Add Services' to include additional services in the order.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering print 4

Corresponding APIs

  1. Adjust the quantity for both parts and services by clicking the '+' or '-' components under the 'QTY' column.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering print 5

Corresponding API

  1. Click on 'Part' to add more parts to the order.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering print 6

Corresponding API 1 | Corresponding API 2

  1. Use the delete button (red bin icon) to remove parts from the order.

  2. Click 'Next' to proceed to the billing step.

  3. In the billing step, choose an existing billing address from the dropdown list labeled "Billing To", or create a new one by clicking the "+" button next to the dropdown list.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering print 7

Corresponding API 1 | Corresponding API 2

  1. Click 'Next' to proceed to the delivery address step. Here, you can select an existing delivery address or create a new one.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering print 8

Corresponding API 1 | Corresponding API 2

  1. Click 'Next' to proceed to providing contact information. Choose existing contact info or create new contact details.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering print 9

Corresponding API 1 | Corresponding API 2

  1. Click 'Next' to finalize and place the print order.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering print 10

Corresponding API 1 | Corresponding API 2 | Corresponding API 3 | Corresponding API 4

  1. Continue reading here: Process after placing an order.

UIs Common for Both Sample and Print Orders

  1. Once a sample or print order is placed, go to the order details view.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering common 1

Corresponding API 1 | Corresponding API 2

  1. Once the order is accepted and shipped, two buttons, 'Customer Order Delivered Partially' and 'Customer Order Delivered', will appear to let the customer confirm whether the order is partially or fully delivered.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering common 2

Corresponding API

  1. In the order’s details view, the workflow history area can be used to see all the status changes and actions taken during the ordering process.

[ TO BE RE-PLACED BY THE SCREENSHOTS FROM THE NEW UI ]

ordering common 3

Corresponding API

API Based

Sample Orders APIs

 — API to open a sample order:

Corresponding UI

POST ⇒ /api/customer-orders/sample/{partId}

  • Query Parameters

    • partId as a String value

  • Request Body

    [ EMPTY ]

 

 — API to get sample order details:

Corresponding UI

GET ⇒ /api/customer-orders/sample/{partId}

  • Query Parameters

    • partId as a String value

  • Request Body

    [ EMPTY ]

 

 — API to start/place a sample order:

Corresponding UI

POST ⇒ /api/bpm/parts/sample-orders/{sampleOrderId}/start

  • Query Parameters

    • sampleOrderId as a String value

  • Request Body

    [ EMPTY ]
Print Order APIs

 — API to open a print order:

Corresponding UI 1 | Corresponding UI 2

POST ⇒ /api/customer-orders/part

  • Query Parameters

    [ No Parameters ]

  • Request Body

    {
  "quantity": 2147483647,
  "lineNumber": 0,
  "priceListRate": 0,
  "priceListRateWithMargin": 0,
  "price": 0,
  "total": 0,
  "margin": 0,
  "discount": 0,
  "validFrom": 0,
  "validUpto": 0,
  "fileInfo": [
    {
      "fileUrl": "string",
      "fileType": "string",
      "fileName": "string",
      "officialStl": true,
      "approved": true,
      "approvedByAdmin": true,
      "size": 0,
      "created": 0
    }
  ],
  "machineInfo": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "materialInfo": {
    "id": "string",
    "name": "string"
  },
  "materialGroupInfo": {
    "id": "string",
    "name": "string"
  },
  "machineTechnologyInfo": {
    "id": "string",
    "name": "string"
  },
  "customerId": "string",
  "service": {
    "id": "string",
    "name": "string",
    "group": "string",
    "price": 0,
    "currency": {
      "name": "string",
      "symbol": "string"
    },
    "quantity": 2147483647
  },
  "color": {
    "id": 0,
    "ral": "string",
    "description": "string",
    "hex": "string",
    "rgb": "string",
    "sigma": "string",
    "pantone": "string",
    "createdAt": 0,
    "updatedAt": 0
  },
  "colo2": {
    "id": 0,
    "ral": "string",
    "description": "string",
    "hex": "string",
    "rgb": "string",
    "sigma": "string",
    "pantone": "string",
    "createdAt": 0,
    "updatedAt": 0
  },
  "color3": {
    "id": 0,
    "ral": "string",
    "description": "string",
    "hex": "string",
    "rgb": "string",
    "sigma": "string",
    "pantone": "string",
    "createdAt": 0,
    "updatedAt": 0
  },
  "color4": {
    "id": 0,
    "ral": "string",
    "description": "string",
    "hex": "string",
    "rgb": "string",
    "sigma": "string",
    "pantone": "string",
    "createdAt": 0,
    "updatedAt": 0
  },
  "color5": {
    "id": 0,
    "ral": "string",
    "description": "string",
    "hex": "string",
    "rgb": "string",
    "sigma": "string",
    "pantone": "string",
    "createdAt": 0,
    "updatedAt": 0
  },
  "currency": {
    "name": "string",
    "symbol": "string"
  },
  "confirmationReferenceNumber": "string",
  "rfqSupplierOrderId": "string",
  "economical": true,
  "id": "string",
  "name": "string",
  "externalId": "string"
}

 

 — API to get all opened print orders:

Corresponding UI 1 | Corresponding UI 2 | Corresponding UI 3

GET ⇒ /api/customer-orders/opened

  • Query Parameters

    No Parameters

  • Request Body

    [ EMPTY ]

 

 — API to remove an opened print order:

Corresponding UI 1 | Corresponding UI 2

DELETE ⇒ /api/customer-orders/part/{partId}

  • Query Parameters

    • partId as a String value

  • Request Body

    [ EMPTY ]

 

 — API to get workflow statuses:

Corresponding UI 1 | Corresponding UI 2

GET ⇒ /api/workflows/statuses

  • Query Parameters

    • searchContext as an Object:

      {
  "page": 0,
  "count": 0,
  "query": "workflowThreadsType=in=(CUSTOMER_ORDER)",
  "sort": "string"
}

  • Request Body

    [ EMPTY ]

 

 — API to get price list:

Corresponding UI 1 | Corresponding UI 2

GET ⇒ /api/erp/parts-prices/{partId}/price-list-rate

  • Query Parameters

    • partId as a String value

  • Request Body

    [ EMPTY ]

 

 — APIs to get all parts:

Corresponding UI

GET ⇒ /api/parts

  • Query Parameters

    • fullNesting as a Boolean value

      • Available values : true, false

      • Default value : false

    • plusHeavyFields as a String value

    • searchContext as an Object:

      {
  "page": 0,
  "count": 0,
  "query": "status=in=(1999);hasPrice==true",
  "sort": "partName"
}

  • Request Body

    [ EMPTY ]

 

 — API to start/place a print order:

Corresponding UI

POST ⇒ /api/bpm/customer-orders/{customerOrderId}/open-order

  • Query Parameters

    • customerOrderId as a String value

  • Request Body

    [ EMPTY ]
APIs Common for Both Sample and Print Orders

 — API to get the all services and add or update services in an order:

Corresponding UI 1 | Corresponding UI 2

GET ⇒ /api/services

  • Query Parameters

    • searchContext as an Object:

      {
  "page": 0,
  "count": 0,
  "query": "currency==EUR",
  "sort": ""
}

  • Request Body

    [ EMPTY ]

POST ⇒ /api/customer-orders/{id}/parts/{partId}/services

  • Query Parameters

    • id as a String value

    • partId as a String value

  • Request Body

    {
  "id": "ITEM-00001",
  "name": "Testing Services",
  "group": "Test Group Services",
  "price": 80,
  "currency": {
    "name": "EUR",
    "symbol": "€"
  },
  "quantity": 1,
  "currencyAndPrice": "€ 80"
}

PATCH ⇒ /api/customer-orders/{id}/parts/{partId}/services

  • Query Parameters

    • id as a String value

    • partId as a String value

      • Request Body

        {
  "id": "ITEM-00001",
  "name": "Testing Services",
  "group": "Test Group Services",
  "price": 80,
  "currency": {
    "name": "EUR",
    "symbol": "€"
  },
  "quantity": 1,
  "currencyAndPrice": "€ 80"
}

 

 — API to change quantity:

Corresponding UI 1 | Corresponding UI 2

POST ⇒ /api/customer-orders/{id}/part/quantity

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "quantity": 2147483647,
  "lineNumber": 0,
  "priceListRate": 0,
  "priceListRateWithMargin": 0,
  "price": 0,
  "total": 0,
  "margin": 0,
  "discount": 0,
  "validFrom": 0,
  "validUpto": 0,
  "fileInfo": [
    {
      "fileUrl": "string",
      "fileType": "string",
      "fileName": "string",
      "officialStl": true,
      "approved": true,
      "approvedByAdmin": true,
      "size": 0,
      "created": 0
    }
  ],
  "machineInfo": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "materialInfo": {
    "id": "string",
    "name": "string"
  },
  "materialGroupInfo": {
    "id": "string",
    "name": "string"
  },
  "machineTechnologyInfo": {
    "id": "string",
    "name": "string"
  },
  "customerId": "string",
  "service": {
    "id": "string",
    "name": "string",
    "group": "string",
    "price": 0,
    "currency": {
      "name": "string",
      "symbol": "string"
    },
    "quantity": 2147483647
  },
  "color": {
    "id": 0,
    "ral": "string",
    "description": "string",
    "hex": "string",
    "rgb": "string",
    "sigma": "string",
    "pantone": "string",
    "createdAt": 0,
    "updatedAt": 0
  },
  "colo2": {
    "id": 0,
    "ral": "string",
    "description": "string",
    "hex": "string",
    "rgb": "string",
    "sigma": "string",
    "pantone": "string",
    "createdAt": 0,
    "updatedAt": 0
  },
  "color3": {
    "id": 0,
    "ral": "string",
    "description": "string",
    "hex": "string",
    "rgb": "string",
    "sigma": "string",
    "pantone": "string",
    "createdAt": 0,
    "updatedAt": 0
  },
  "color4": {
    "id": 0,
    "ral": "string",
    "description": "string",
    "hex": "string",
    "rgb": "string",
    "sigma": "string",
    "pantone": "string",
    "createdAt": 0,
    "updatedAt": 0
  },
  "color5": {
    "id": 0,
    "ral": "string",
    "description": "string",
    "hex": "string",
    "rgb": "string",
    "sigma": "string",
    "pantone": "string",
    "createdAt": 0,
    "updatedAt": 0
  },
  "currency": {
    "name": "string",
    "symbol": "string"
  },
  "confirmationReferenceNumber": "string",
  "rfqSupplierOrderId": "string",
  "economical": true,
  "id": "string",
  "name": "string",
  "externalId": "string"
}

 

 — API to get the all addresses:

Corresponding UI 1 | Corresponding UI 2 | Corresponding UI 3 | Corresponding UI 4

GET ⇒ /api/organizations/addresses

  • Query Parameters

    • searchContext as an Object:

      {
  "page": 0,
  "count": 0,
  "query": "isDefault==1",
  "sort": ""
}

  • Request Body

    [ EMPTY ]

 

 — API to update the order with information from the current step:

Corresponding UI 1 | Corresponding UI 2 | Corresponding UI 3 | Corresponding UI 4 | Corresponding UI 5 | Corresponding UI 6 | Corresponding UI 7 | Corresponding UI 8

PATCH ⇒ /api/customer-orders/{id}

  • Query Parameters

    • id as a String value

  • Request Body

    {
  "field": "string",
  "value": "string",
}

 

 — API to get all contacts:

Corresponding UI 1 | Corresponding UI 2

GET ⇒ /api/organizations/contacts

  • Query Parameters

    • searchContext as an Object:

      {
  "page": 0,
  "count": 0,
  "query": "isDefault==1",
  "sort": ""
}

  • Request Body

    [ EMPTY ]

 

 — API to create a customer quotation:

Corresponding UI 1 | Corresponding UI 2

POST ⇒ /api/bpm/customer-orders/{customerOrderId}/create-customer-quotation

  • Query Parameters

    • customerOrderId as a String value

  • Request Body

    [ EMPTY ]

 

 — API to get customer order documents:

Corresponding UI 1 | Corresponding UI 2

GET ⇒ /api/customer-orders/documents

  • Query Parameters

    • searchContext as an Object:

      {
  "page": 0,
  "count": 0,
  "query": "order.id=in=({customerOrderId})",
  "sort": ""
}

  • Request Body

    [ EMPTY ]

 

 — API to upload purchase order document:

Corresponding UI 1 | Corresponding UI 2

POST ⇒ /zuul/storage/customer-orders/{customerOrderId}/documents/{orderDocumentTypeName}

  • Query Parameters

    • customerOrderId as a String value

    • orderDocumentTypeName as a String value

  • Request Body

    [ EMPTY ]

 

 — API to cancel an order:

Corresponding UI 1 | Corresponding UI 2

POST ⇒ /api/bpm/customer-orders/{customerOrderId}/cancel

  • Query Parameters

    • customerOrderId as a String value

  • Request Body

    {
  "comment": "string"
}

 

 — API to get order details:

Corresponding UI 1 | Corresponding UI 2 | Corresponding UI 3

GET ⇒ /api/customer-orders/{id}

  • Query Parameters

    • id as a String value

  • Request Body

    [ EMPTY ]

 

 — API to get workflow history:

Corresponding UI 1 | Corresponding UI 2

GET ⇒ /api/workflows/{threadId}/history

  • Query Parameters

    • threadId as a String value

  • Request Body

    [ EMPTY ]

 

 — API to confirm order delivery:

Corresponding UI

POST ⇒ /api/bpm/customer-orders/{customerOrderId}/follow-up

  • Query Parameters

    • customerOrderId as a String value

    • status as a String value: **"ORDER-DELIVERED-PARTIALLY"

      • "ORDER-DELIVERED"

  • Request Body

    {
  "comment": "string",
  "empty": true
}