Create a Link
post
/api/link/Links/
Creates a link.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
LinkIcon: string
The image used to display for the link.Example:
fugue/address-book-open.png
-
LinkName: string
The name for the link.Example:
Unified Assurance Knowledgebase
-
LinkPath: string
The relative or absolute URL.Example:
/vendor/mediawiki/index.php/Main_Page
-
LinkTypeID: integer
Unique identifier for the type of link. Allowed Values: - 1 => External (the relative or absolute path separate from Unified Assurance) - 2 => Internal (the relative path to Unified Assurance UI packages) - 3 => Embedded (Embed the whole URL into the link and open the link as a side panel. This is useful if the URL has the same domain but falls outside the OUCA document root. E.g. "https:///saml/")Example:
1
-
OwnerUserGroupID: integer
Unique identifier for the user group owner of the link.Example:
0
-
OwnerUserID: integer
Unique identifier for the user owner of the link.Example:
0
-
Viewers: array
Viewers
Selection of user groups that have view-only access to link.
Nested Schema : Viewers
Type:
array
Selection of user groups that have view-only access to link.
Show Source
Nested Schema : items
Type:
Show Source
object
-
UserGroupID: integer
User Group ID
-
UserGroupName: string
User Group Name
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: array
data
The properties of the new link.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : linkLinksRead
Type:
Show Source
object
-
LinkIcon: string
The image used to display for the link.Example:
fugue/address-book-open.png
-
LinkID: integer
Link ID specified for individual CRUD operationsExample:
1004
-
LinkName: string
The name for the link.Example:
Unified Assurance Knowledgebase
-
LinkPath: string
The relative or absolute URL.Example:
/vendor/mediawiki/index.php/Main_Page
-
LinkTypeID: integer
Unique identifier for the type of link. Allowed Values: - 1 => External (the relative or absolute path separate from Unified Assurance) - 2 => Internal (the relative path to Unified Assurance UI packages) - 3 => Embedded (Embed the whole URL into the link and open the link as a side panel. This is useful if the URL has the same domain but falls outside the OUCA document root. E.g. "https:///saml/")Example:
1
-
LinkTypeName: string
Name of the link type.Example:
External
-
OwnerUserGroupID: integer
Unique identifier for the user group owner of the link.Example:
0
-
OwnerUserID: integer
Unique identifier for the user owner of the link.Example:
0
-
Viewers: array
Viewers
Selection of user groups that have view-only access to link.
Nested Schema : Viewers
Type:
array
Selection of user groups that have view-only access to link.
Show Source
Nested Schema : items
Type:
Show Source
object
-
UserGroupID: integer
User Group ID
-
UserGroupName: string
User Group Name
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