Create a new plugin

1min
POST
Header Parameters
X-COREOS-TID
string
*
X-COREOS-REQUEST-ID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
*
Body Parameters
body
PluginRequestDetails
*
Description
Plugin create request
name
string
*
description
string
httpUrl
string
*
httpMethod
string<POST | GET | PUT>
*
httpHeaders
object
httpRequestBodyTemplate
TemplateSchema[]
*
dlqOnFailure
boolean
requestTimeout
number
callbackTimeout
number
responseType
string<ASYNC | SYNC>
*
secretKey
string
*
protocol
string<HTTP | GRPC>
maxConcurrentCalls
integer
Responses
201
OK
SuccessPluginResponse
error
Error
*
request
Request
*
data
object
400
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
data
object
401
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
data
object
Curl
JS
Ruby
Python
curl --location --globoff 'https://{base_url}/core/api/v1/orders/plugins' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "httpUrl": "",
  "httpMethod": "",
  "httpRequestBodyTemplate": [
    {
      "outputJsonPath": {}
    }
  ],
  "responseType": "",
  "secretKey": ""
}'
curl --location --globoff 'https://{base_url}/core/api/v1/orders/plugins' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "httpUrl": "",
  "httpMethod": "",
  "httpRequestBodyTemplate": [
    {
      "outputJsonPath": {}
    }
  ],
  "responseType": "",
  "secretKey": ""
}'
Responses
201
400
401
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
update work order status
Update a plugin