Plugin API Resource

WS to handle plugins

POST /api/plugins/export/json/{domainId}

Web service to Upload Objects To External Domain Source

Example of request:

{"objects":[{"objectId":"243993","classId":"14"}]}

Request Parameters
name type description constraints
domainId path - id of external domain long
Request Body
media type data type
application/json HdcObjectListWithDomainTO (JSON)
Response Body
media type data type description
application/json object (JSON) JSON Response with information about started long running process

Example of response:

{"processId":"45382499-84f9-4565-a251-71ecd48af821","state":"Started", "userName":"User name","startDate":"Fri Oct 02 11:22:28 CEST 2015","operationType":"TdxmImport"}

Example

Request
POST /api/plugins/export/json/{domainId}
Content-Type: application/json
Accept: application/json

                
{
  "domainName" : "...",
  "config" : {
    "exportAttachments" : true,
    "exportDocuments" : true,
    "description" : "...",
    "secondaryPerspectiveId" : 12345,
    "primaryPerspectiveId" : 12345,
    "exportFormat" : "FI2V13_DATAVIEW_006",
    "exportSubtree" : true,
    "exportGeometries" : true
  },
  "objects" : [ { }, { } ],
  "packageName" : "...",
  "domainId" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/plugins/import/json/{domainId}

Web service to Update Objects From External Domain Source

Example of request:

{"objects":[{"objectId":"243993","classId":"14"}]}

Request Parameters
name type description constraints
domainId path - id of external domain long
Request Body
media type data type
application/json HdcObjectListWithDomainTO (JSON)
Response Body
media type data type description
application/json object (JSON) JSON Response with information about started long running process

Example of response:

{"processId":"45382499-84f9-4565-a251-71ecd48af821","state":"Started", "userName":"User name","startDate":"Fri Oct 02 11:22:28 CEST 2015","operationType":"TdxmImport"}

Example

Request
POST /api/plugins/import/json/{domainId}
Content-Type: application/json
Accept: application/json

                
{
  "domainName" : "...",
  "config" : {
    "exportAttachments" : true,
    "exportDocuments" : true,
    "description" : "...",
    "secondaryPerspectiveId" : 12345,
    "primaryPerspectiveId" : 12345,
    "exportFormat" : "HDC_INTERNAL",
    "exportSubtree" : true,
    "exportGeometries" : true
  },
  "objects" : [ { }, { } ],
  "packageName" : "...",
  "domainId" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/plugins/properties/json/{domainId}

Web service to get properties from External Domain Source

Example of request:

{"objects":[{"objectId":"243993","classId":"14"}]}

Request Parameters
name type description constraints
domainId path - id of external domain long
Request Body
media type data type
application/json HdcObjectListWithDomainTO (JSON)
Response Body
media type data type description
application/json object (JSON) JSON Response with list of properties

Example of response:

{"list":[{"key":"Name","value":"objectName"},{"key":"ID","value":"1"},{"key":"Description","value":"Object description"}]}

Example

Request
POST /api/plugins/properties/json/{domainId}
Content-Type: application/json
Accept: application/json

                
{
  "domainName" : "...",
  "config" : {
    "exportAttachments" : true,
    "exportDocuments" : true,
    "description" : "...",
    "secondaryPerspectiveId" : 12345,
    "primaryPerspectiveId" : 12345,
    "exportFormat" : "HDC_INTERNAL",
    "exportSubtree" : true,
    "exportGeometries" : true
  },
  "objects" : [ { }, { } ],
  "packageName" : "...",
  "domainId" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

PUT /api/plugins/run/{pluginName}/{classId}/{objectId}

Run plugin with given name in the context of given object

Request Parameters
name type description constraints
classId path class ID of context object long
objectId path object ID of context object long
pluginName path name of event plugin  
Response Body
media type data type description
application/json HdcEventPluginProcessingResultTO (JSON) JSON Response with info about changed object

Example of response:

{labelChanged: false, classId: "Object ID", objLabel: "Object label", objectId: "Object ID"}

Example

Request
PUT /api/plugins/run/{pluginName}/{classId}/{objectId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

PUT /api/plugins/run/subtree/{pluginName}/{perspId}/{classId}/{objectId}

Run plugin with given name in the context of given object with its subtree in given perspective

Request Parameters
name type description constraints
classId path class ID of context object long
objectId path object ID of context object long
perspId path perspective ID to find subtree for object long
pluginName path name of event plugin  
Response Body
media type data type description
application/json ModifySubtreeProcessStateTO (JSON) JSON Response with info about started process

Example of response:

{"processId":"bbf2b1fc-e170-4400-a82e-ca3f5be31c9a","state":"Scheduled","userName":"John Bob","startDate":"2019-04-11T10:27:17.400819+02:00","operationType":"ModifySubTree"}

Example

Request
PUT /api/plugins/run/subtree/{pluginName}/{perspId}/{classId}/{objectId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }