How to: Use Plugin in Platform Order Management

6min
How to - Order Plugin
Order Plugin is used for validation/enrichment of Order initiated, get more information about Plugin Attributes﻿.
How to Create Order Plugin
To create the external plugin in Platform Order Service, check the details of the Order Plugin Attributes﻿ given. Sample JSON is provided further.
Sample JSON for Creating Order Plugin:
JSON
{
    "name": " Plugin",
    "description": "automation",
    "httpUrl": "https://www.google.com/",
    "httpMethod": "GET",
    "httpRequestBodyTemplate": [
        {
            "outputJsonPath": {}
        }
    ],
    "responseType": "ASYNC",
    "secretKey": "aksjd" //Use actual Secret Key
}

{
    "name": " Plugin",
    "description": "automation",
    "httpUrl": "https://www.google.com/",
    "httpMethod": "GET",
    "httpRequestBodyTemplate": [
        {
            "outputJsonPath": {}
        }
    ],
    "responseType": "ASYNC",
    "secretKey": "aksjd" //Use actual Secret Key
}
﻿
How to Update Order Plugin
To update the Update a plugin﻿ call the Update Plugin API endpoint and update the Order Plugin as shown below.
Sample JSON to Update Order Plugin:
JSON
{
    "name": "Update Plugin",
    "description": "automation test",
    "httpUrl": "https://www.google.com/",
    "httpMethod": "POST",
    "httpRequestBodyTemplate": [
        {
            "outputJsonPath": {}
        }
    ],
    "responseType": "ASYNC",
    "secretKey": "aksjd" //Use actual Secret Key
}
{
    "name": "Update Plugin",
    "description": "automation test",
    "httpUrl": "https://www.google.com/",
    "httpMethod": "POST",
    "httpRequestBodyTemplate": [
        {
            "outputJsonPath": {}
        }
    ],
    "responseType": "ASYNC",
    "secretKey": "aksjd" //Use actual Secret Key
}
﻿
How to Get Order Plugin by ID
To get details of any specific Order Plugin call the GET Order Plugin﻿﻿ by ID API endpoint and enter the plugin ID to fetch its details.
How To - WorkOrder Plugin
The WorkOrder plugin is used to define the sequence in which the plugins will be executed (in case of more than one plugin). Get more details about attributes of Creating Plugin Workflow﻿.
How to Create WorkOrder Plugin
Call the Create WorkOrder Plugin endpoint API and structure the payload as shown below.
Sample JSON for Creating WorkOrder Plugin:
JSON
{
    "name": "InitiateEvent",
    "description": "workflow for job completion",
    "tag": [
        {
            "name": "workOrderManager",
            "value": "workflow"
        },
        {
            "name": "containerManager",
            "value": "workflow"
        }
    ],
    "pre": {
        "plugins": [
            "Plugin1"
        ]
    },
    "main": {
        "plugins": [
            "Plugin2"
        ]
    }
}
{
    "name": "InitiateEvent",
    "description": "workflow for job completion",
    "tag": [
        {
            "name": "workOrderManager",
            "value": "workflow"
        },
        {
            "name": "containerManager",
            "value": "workflow"
        }
    ],
    "pre": {
        "plugins": [
            "Plugin1"
        ]
    },
    "main": {
        "plugins": [
            "Plugin2"
        ]
    }
}
﻿
How to Update the WorkOrder Plugin
To Update the WorkOrder Plugin call the API endpoint﻿ and update the WorkOrder plugin attributes.
How to Get WorkOrder Plugin
To fetch the WorkOrder plugin details call the GET WorkOrder Plugin﻿ API endpoint and pass the WorkOrder Plugin ID.
Updated 16 Aug 2023
Did this page help you?
How To: State Machine
Platform Order Attributes and Lifecycle