Jump to

• Request
• Response

Create a Link Group

post

/api/link/LinkGroups/

Creates a link group.
The minimum required properties in the request body are:

• LinkGroupName
• ParentLinkGroupID
• Links

Request

There are no request parameters for this operation.

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.
• ParentLinkGroupID: integer
  Parent Group ID for the new Link Group

  Example: 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 => TRUE

  Example: 0

{
    "type":"object",
    "properties":{
        "LinkGroupName":{
            "description":"The link group name.\n<br>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, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Root"
        },
        "ParentLinkGroupID":{
            "description":"Parent Group ID for the new Link Group",
            "type":"integer",
            "example":1
        },
        "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 SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new link group.",
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"The ID of the new link group.",
                            "type":"integer",
                            "example":7
                        }
                    }
                }
            }
        }
    ]
}

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

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: object data
  The properties of the new link group.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new link group.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The ID of the new link group.",
                    "type":"integer",
                    "example":7
                }
            }
        }
    }
}

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

{
    "description":"The properties of the new link group.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the new link group.",
            "type":"integer",
            "example":7
        }
    }
}

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