Update a Link Group
put
/api/link/LinkGroups/{id}
Updates the properties of the link Group that matches the specified ID.
Request
Path Parameters
-
id(required): integer
The link group ID.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
LinkGroupName: string
The link group name.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.Example:Root
-
Links: array
Links
Displays all of the links that are in the group.
-
Remove: boolean
Remove Link from other Link Groups. If checked, any links added to the group will be removed from other groups. Allowed Values: - 0 => FALSE - 1 => TRUEExample:
0
Nested Schema : Links
Type:
array
Displays all of the links that are in the group.
Show Source
Example:
[
1004
]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulUpdateOperation
The response body for a successful update operation.
-
object
type
Nested Schema : SuccessfulUpdateOperation
Type:
object
The response body for a successful update operation.
Show Source
-
message: string
The response message.Example:
Updated record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the updated link group.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : linkLinkGroupsReadByID
Type:
Show Source
object
-
LinkGroupName: string
The name of the Link Group.Example:
Root
-
Links: array
Links
Displays all of the links that are in the group.
-
ParentLinkGroupID: integer
LinkGroupID of Parent GroupExample:
1
Nested Schema : items
Type:
Show Source
object
-
LinkID: integer
Link ID specified for individual CRUD operationsExample:
1004
-
LinkName: string
The name for the link.Example:
Unified Assurance Knowledgebase
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.