Create a Link Group
post
/api/link/LinkGroups/
Creates a link group.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
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
Parent Group ID for the new Link GroupExample:
1
-
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
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
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: object
data
The properties of the new link group.
Nested Schema : data
Type:
object
The properties of the new link group.
Show Source
-
id: integer
The ID of the new link group.Example:
7
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
Nested Schema : items
Type:
object