Create Business Component

Creates a business component in the organizational structure.

 

URL

{RMUrl}/api/Organization/businesscomponents

 

REQUEST METHOD

POST

 

URL PARAMETERS

This feature does not have parameters.

 

FORM CONTENT

Level (Required): Level of business component to be created. Valid values: Strategic and Tactical.

Type (Optional): Type of the business component to be created. Valid values: Macro-Process, Organizational System, or any custom type registered in the Administration module.

Name (Required): Name of the business component to be created. Limit of 400 characters.

Responsible (Optional): Person responsible for the business component to be created.

Relevance (Required): Relevance of the business component to be created. Valid values: whole numbers between 1 and 5, with 1 (Very Low) and 5 (Very High).

Criticality (Optional): Criticality of the business component to be created. Valid values: whole numbers from 1 to 100.

Description (Optional): Description of the business component to be created.

AdditionalInformation (Optional): Additional information on the business component to be created.

CustomAttributes (Optional): List of objects with information on business component attributes. Each attribute is referenced by its variable name. Relationship-type attributes can be referenced by the Id field, the Caption field, or both. If both fields are provided, they must refer to the same object. It is recommended to use the Id field whenever possible. See Appendix 2: Format for Completing Attributes for the list of formats for the Id and Caption fields.

 

FORM CONTENT EXAMPLE

Create a tactical business component:

{

"Name":"Marketing Department",

"Relevance":"5",

"Criticality":"30",

"Responsible":{"Name":"John Smith"},

"Level":"Tactical",

"Type":"Organizational System",

"CustomAttributes":{

"businesscomponent_datetime":"\/Date(1336779900000)\/",

"businesscomponent_email":"test@example.com",

"businesscomponent_link":"http:\/\/www.example.com",

"businesscomponent_listofoptions":["b2","c3"],

"singlerelationship_asset_attribute":{

   "Id":"90a849c8-eb27-46e7-9b23-13c6ac26a694"}

"multiplerelationship_group_attribute":[{"Caption":"Finance Dept"},{"Caption":"Information Tech"},{"Caption":"Financial"},{"Caption":"Human Resources"}]

}

 

SUCCESS RESPONSE

Code of the newly created business component. Returns a string.