Edits a business component in the organizational structure.
URL
{RMUrl}/api/Organization/businesscomponents/<BusinessComponentCode>
REQUEST METHOD
PUT
URL PARAMETER
BusinessComponentCode: This parameter is provided in the URL and does not need to be sent through PUT.
FORM CONTENT
Name (Optional): Business component name. Limit of 400 characters.
Responsible (Optional): Person responsible for the business component.
Relevance (Optional): Relevance of the business component. Valid values: whole numbers between 1 and 5, with 1 (Very Low) and 5 (Very High).
Criticality (Optional): Criticality of the business component. Valid values: whole numbers from 1 to 100.
Description (Optional): Business component description.
Additional Information (Optional): Additional information on the business component.
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.
Note: The "null" value in CustomAttributes fields indicates that the inserted values will be deleted. In the other fields, the "null" value means that the inserted values will be ignored.
FORM CONTENT EXAMPLE
Edit a business component:
{
"Name":"Marketing Department",
"Relevance":"3",
"Criticality":"30",
"Responsible":{"Name":"Mary Dawson"},
"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
HTTP status code 204: NoContent