REST API for Unified Assurance Core

Create a Diagram Group

post

/api/diagram/DiagramGroups

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

DiagramGroupName
Diagrams

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

DiagramGroupName: string

The diagram group name.

Example: Test Group
Diagrams: array Diagrams

The list of diagrams IDs associated with the diagram group.
ParentDiagramGroupID: integer

The parent diagram group ID.

Example: 1
Remove: boolean

Whether to remove the diagram from other diagram groups (1) or not (2). A diagram can belong to multiple groups, but setting this to 1 makes the diagram appear only in the specified group.

Example: 0

{
    "type":"object",
    "properties":{
        "DiagramGroupName":{
            "description":"The diagram group name.",
            "type":"string",
            "example":"Test Group"
        },
        "ParentDiagramGroupID":{
            "description":"The parent diagram group ID.",
            "type":"integer",
            "example":"1"
        },
        "Diagrams":{
            "description":"The list of diagrams IDs associated with the diagram group.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                "897",
                "911"
            ]
        },
        "Remove":{
            "description":"Whether to remove the diagram from other diagram groups (<b>1</b>) or not (<b>2</b>). A diagram can belong to multiple groups, but setting this to <b>1</b> makes the diagram appear only in the specified group.",
            "type":"boolean",
            "example":"0"
        }
    }
}

Nested Schema : Diagrams

Type: array

The list of diagrams IDs associated with the diagram group.

Show Source

Array of: integer

{
    "description":"The list of diagrams IDs associated with the diagram group.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        "897",
        "911"
    ]
}

Example:

[
    "897",
    "911"
]

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new diagram group.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/diagramDiagramGroupReadByID"
                    }
                }
            }
        }
    ]
}

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: array data

The properties of the new diagram group.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new diagram group.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/diagramDiagramGroupReadByID"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the new diagram group.

Show Source

Array of: object diagramDiagramGroupReadByID

{
    "description":"The properties of the new diagram group.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/diagramDiagramGroupReadByID"
    }
}

Nested Schema : diagramDiagramGroupReadByID

Type: object

Show Source

DiagramGroupID: integer

The diagram group ID for individual CRUD operations.

Example: 3
DiagramGroupName: string

The diagram group name.

Example: Test Group
Diagrams: array Diagrams

The list of diagrams IDs associated with the diagram group.
ParentDiagramGroupID: integer

The parent diagram group ID.

Example: 1

{
    "type":"object",
    "properties":{
        "DiagramGroupName":{
            "description":"The diagram group name.",
            "type":"string",
            "example":"Test Group"
        },
        "DiagramGroupID":{
            "description":"The diagram group ID for individual CRUD operations.",
            "type":"integer",
            "example":"3"
        },
        "ParentDiagramGroupID":{
            "description":"The parent diagram group ID.",
            "type":"integer",
            "example":"1"
        },
        "Diagrams":{
            "description":"The list of diagrams IDs associated with the diagram group.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "DiagramID":{
                        "description":"The diagram ID.",
                        "type":"integer",
                        "example":"897"
                    },
                    "DiagramName":{
                        "description":"The diagram name.",
                        "type":"string",
                        "example":"2672 -- try 2"
                    }
                }
            },
            "example":[
                {
                    "DiagramID":"897",
                    "DiagramName":"2672 -- try 2"
                },
                {
                    "DiagramID":"911",
                    "DiagramName":"basic widgets with an on click link to oracle.com"
                }
            ]
        }
    }
}

Nested Schema : Diagrams

Type: array

The list of diagrams IDs associated with the diagram group.

Show Source

Array of: object items

{
    "description":"The list of diagrams IDs associated with the diagram group.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "DiagramID":{
                "description":"The diagram ID.",
                "type":"integer",
                "example":"897"
            },
            "DiagramName":{
                "description":"The diagram name.",
                "type":"string",
                "example":"2672 -- try 2"
            }
        }
    },
    "example":[
        {
            "DiagramID":"897",
            "DiagramName":"2672 -- try 2"
        },
        {
            "DiagramID":"911",
            "DiagramName":"basic widgets with an on click link to oracle.com"
        }
    ]
}

Example:

[
    {
        "DiagramID":"897",
        "DiagramName":"2672 -- try 2"
    },
    {
        "DiagramID":"911",
        "DiagramName":"basic widgets with an on click link to oracle.com"
    }
]

Nested Schema : items

Type: object

Show Source

DiagramID: integer

The diagram ID.

Example: 897
DiagramName: string

The diagram name.

Example: 2672 -- try 2

{
    "type":"object",
    "properties":{
        "DiagramID":{
            "description":"The diagram ID.",
            "type":"integer",
            "example":"897"
        },
        "DiagramName":{
            "description":"The diagram name.",
            "type":"string",
            "example":"2672 -- try 2"
        }
    }
}

Default Response

Failed operation

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.