Edit Group

Allows a group in the Organization module to be edited.

 

URL

{RMUrl}/api/Organization/groups/<GroupID>

 

REQUEST METHOD

PUT

 

URL PARAMETER

GroupID: This parameter is provided in the URL and does not need to be sent through PUT.

 

FORM CONTENT

Name (Optional): Name of the group being edited. Limit of 400 characters.

Description (Optional): Description of the group being edited.

Email (Optional): E-mail address of the group being edited.

Responsible (Optional): Person responsible for the group being edited.

AdditionalInformation (Optional): Additional information on the group being edited.

CustomAttributes (Optional): List of objects with information on the attributes associated with the group. 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: Sending the value "null" in the CustomAttributes fields means that the values entered will be erased. In the other fields, "null" means that the values will be ignored.

 

REQUEST EXAMPLE

{RMUrl}/api/Organization/groups/55549ce4-56d4-475f-9483-555ca6b2976c

 

FORM CONTENT EXAMPLE

{

"Name":"IT Team",

"Description":"IT dept at ABC",

"Email":"informationtech_ny@example.com",

"Responsible":{ "Name":"Joseph Parks" },

"AdditionalInformation":"IT department at Company ABC’s New York branch"

}

 

SUCCESS RESPONSE

HTTP status code 204: NoContent