Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 => TRUE

  Example: 0

{
    "type":"object",
    "properties":{
        "LinkGroupName":{
            "$ref":"#/components/schemas/linkLinkGroups/properties/LinkGroupName"
        },
        "Links":{
            "description":"Displays all of the links that are in the group.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                1004
            ]
        },
        "Remove":{
            "description":"Remove Link from other Link Groups. If checked, any links added to the group will be removed from other groups.\n\nAllowed Values:\n-  0 => FALSE\n-  1 => TRUE",
            "type":"boolean",
            "example":0
        }
    }
}

Nested Schema : Links

Type: array

Displays all of the links that are in the group.

Show Source

• Array of: integer

{
    "description":"Displays all of the links that are in the group.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1004
    ]
}

Example:

[
    1004
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the updated link group.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/linkLinkGroupsReadByID"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

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

{
    "description":"The response body for a successful update operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the updated link group.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the updated link group.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/linkLinkGroupsReadByID"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the updated link group.

Show Source

• Array of: object linkLinkGroupsReadByID

{
    "description":"The properties of the updated link group.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/linkLinkGroupsReadByID"
    }
}

Nested Schema : linkLinkGroupsReadByID

Type: object

Show Source

• 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 Group

  Example: 1

{
    "type":"object",
    "properties":{
        "LinkGroupName":{
            "description":"The name of the Link Group.",
            "type":"string",
            "example":"Root"
        },
        "ParentLinkGroupID":{
            "description":"LinkGroupID of Parent Group",
            "type":"integer",
            "example":1
        },
        "Links":{
            "description":"Displays all of the links that are in the group.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "LinkID":{
                        "$ref":"#/components/schemas/linkLinksRead/properties/LinkID"
                    },
                    "LinkName":{
                        "$ref":"#/components/schemas/linkLinksRead/properties/LinkName"
                    }
                }
            }
        }
    }
}

Nested Schema : Links

Type: array

Displays all of the links that are in the group.

Show Source

• Array of: object items

{
    "description":"Displays all of the links that are in the group.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "LinkID":{
                "$ref":"#/components/schemas/linkLinksRead/properties/LinkID"
            },
            "LinkName":{
                "$ref":"#/components/schemas/linkLinksRead/properties/LinkName"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• LinkID: integer
  Link ID specified for individual CRUD operations

  Example: 1004
• LinkName: string
  The name for the link.

  Example: Unified Assurance Knowledgebase

{
    "type":"object",
    "properties":{
        "LinkID":{
            "$ref":"#/components/schemas/linkLinksRead/properties/LinkID"
        },
        "LinkName":{
            "$ref":"#/components/schemas/linkLinksRead/properties/LinkName"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

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.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top