Move or Copy Links to a Different Group
put
/api/link/LinkGroups/updateLinks
Moves or copies links to a different group. To move, specify a source group in SourceLinkGroupID. To copy, do not specify a source group.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
id: integer
The ID of the destination link group.Example:
3
-
Links: array
Links
The list of link IDs.
-
SourceLinkGroupID: integer
The ID of the source link group. To move links, specify an ID. To copy links, do not use this parameter.Example:
Nested Schema : Links
Type:
array
The list of link IDs.
Show Source
-
Array of:
integer
Example:
[ 1, 2 ]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulAddOperation
The response body for a successful add operation.
-
object
type
Nested Schema : SuccessfulAddOperation
Type:
object
The response body for a successful add operation.
Show Source
-
message: string
The response message.Example:
Added 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 destination link group with the moved or copied links.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
array
The destination link group with the moved or copied links.
Show Source
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.