Virima API Specification - DiscoveryPattern Services

The requests documented in this section are directed to DiscoveryPattern resources, which represent .

Contents

1 editRecordDiscoverPattern POST Interface
2 deleteRecord POST Interface
3 getPattern GET Interface
4 getSIProperties GET Interface
5 getUnClassifiedProcesses GET Interface
6 getAssetsCreatedFromThisPattern GET Interface

editRecordDiscoverPattern POST Interface

editRecordDiscoverPattern(POST) is called when user is trying to add/edit a discovery pattern.

If the id is -1 then, it create a new discovery pattern
else if id is there, then the record get edited else it throws an error.

Method: POST

Relative URL: discovery-pattern/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
addInputs	DiscoverPattern

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITRECORDDISCOVERPATTERN 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "triggerCondition":"?",
   "output":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "uniqueId":"?",
   "running":?,
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deleteRecord POST Interface

deleteRecord(POST) is called when user is trying to delete a discovery pattern.

Method: POST

Relative URL: discovery-pattern/delete

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
deleteRequest	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETERECORD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getPattern GET Interface

deleteRecord(POST) is called when user is trying to get a discovery pattern.

Method: GET

Relative URL: discovery-pattern/get/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
record	DiscoverPattern

Example Request:

Example Response:

{
   "id":2147483647,
   "name":"?",
   "triggerCondition":"?",
   "output":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "uniqueId":"?",
   "running":?,
   "createdBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

getSIProperties GET Interface

deleteRecord(POST) is called when user is trying to get all Software Instance properties.

While adding the properties for patten output, only Software Instance properties valid
All the properties added in an array and send to front end

Method: GET

Relative URL: discovery-pattern/get-si-properties

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
properties	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getUnClassifiedProcesses GET Interface

getUnClassifiedProcesses(GET) is called when user is trying to get particular UnClassified Process.

Method: GET

Relative URL: discovery-pattern/get-unclassified-processes/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
properties	DiscoverPattern

Example Request:

Example Response:

{
   "id":2147483647,
   "name":"?",
   "triggerCondition":"?",
   "output":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "uniqueId":"?",
   "running":?,
   "createdBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedBy": {
         "id":147848735,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

getAssetsCreatedFromThisPattern GET Interface

getAssetsCreatedFromThisPattern(GET) is called to get created Software Instances created from the custom pattern.

Method: GET

Relative URL: discovery-pattern/get-created-assets/id/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}