Virima API Specification - BSMService Services

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

Contents

1 editBSM POST Interface
2 getAllBSM GET Interface

editBSM POST Interface

Method: POST

Relative URL: bsm/edit-bsm

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	BSMViews

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITBSM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "uniqueId":"?",
   "internalName":"?",
   "sourceBlueprintListToInclude":"?",
   "targetBlueprintListToInclude":"?",
   "sourceBlueprintListToExclude":"?",
   "targetBlueprintListToExclude":"?",
   "relationshipsToInclude":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "relationshipsToExclude":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "archive":?,
   "ipConnections":?,
   "system":?,
   "used":?,
   "createdOn":?,
   "lastModifiedOn":?,
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "blueprintsToInclude":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "blueprintsToExclude":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

getAllBSM GET Interface

Method: GET

Relative URL: bsm/get-all-bsm

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":"?"
}