Jump to

• Request
• Response

Create a Dashboard

post

/api/dashboard/Dashboards

Creates a new dashboard.
The minimum required properties in the request body are:

• DashboardName
• OwnerUserID
• OwnerUserGroupID
• Viewers
• PanelParams

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

• DashboardName: string
  The dashboard 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: Basic Services Dashboard
• HideHeader: integer
  Whether the header should be shown when the dashboard is rendered (1) or not (0).

  Example: 0
• MaxColumns: integer
  The maximum number of columns the dashboard will render before wrapping additional panels onto the next row.

  Example: 4
• OwnerUserGroupID: integer
  The owner user group ID.

  Example: 0
• OwnerUserID: integer
  The ID of the user that owns the dashboard. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.

  Example: 0
• PanelParams: string
  A JSON string of parameters relating to the panel.

  Example: [{"PartTypeID":"6","width":100,"DashboardName":"Basic Services Dashboard","InitialExpansion":"0","InitialExpansionDynamic":"1","InitialView":"Summary","InitialViewDynamic":"1","LinkTarget":"NewWindow","LinkTargetDynamic":"1","PanelName":"Test","PartTypeID":"6","RefreshRate":"","RootID":"root","RootIDDynamic":"1","ShowToolbar":"1","SummaryInitialExpansion":"all","SummaryInitialExpansionDynamic":"1","SummaryNodeSize":"Normal","SummaryNodeSizeDynamic":"1","SummaryTreeType":"LeftToRight","SummaryTreeTypeDynamic":"1","TimeRangeDynamic":"1","TimeRange":"now-24h..now..","Width":"1","recordID":"DashboardsDashboard","width":"1","AutoHeight":1}]
• ReloadRate: integer
  The number of seconds between automatically refreshing the content of panels on the dashboard. Use null to prevent the dashboard from auto refreshing.

  Example: oracle.doceng.json.BetterJsonNull@740fefc6
• Viewers: array Viewers
  The list of user groups that can view the dashboard.

{
    "type":"object",
    "properties":{
        "DashboardName":{
            "description":"The dashboard 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":"Basic Services Dashboard"
        },
        "OwnerUserID":{
            "$ref":"#/components/schemas/dashboardDashboardsRead/properties/OwnerUserID"
        },
        "OwnerUserGroupID":{
            "$ref":"#/components/schemas/dashboardDashboardsRead/properties/OwnerUserGroupID"
        },
        "HideHeader":{
            "$ref":"#/components/schemas/dashboardDashboardsRead/properties/HideHeader"
        },
        "Viewers":{
            "$ref":"#/components/schemas/dashboardDashboardsRead/properties/Viewers"
        },
        "PanelParams":{
            "$ref":"#/components/schemas/dashboardDashboardsRead/properties/PanelParams"
        },
        "ReloadRate":{
            "$ref":"#/components/schemas/dashboardDashboardsRead/properties/ReloadRate"
        },
        "MaxColumns":{
            "$ref":"#/components/schemas/dashboardDashboardsRead/properties/MaxColumns"
        }
    }
}

Nested Schema : Viewers

Type: array

The list of user groups that can view the dashboard.

Show Source

• Array of: object items

{
    "description":"The list of user groups that can view the dashboard.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserGroupID":{
                "description":"The user group ID.",
                "type":"integer"
            },
            "UserGroupName":{
                "description":"The user group name.",
                "type":"string"
            }
        }
    },
    "example":[
    ]
}

Nested Schema : items

Type: object

Show Source

• UserGroupID: integer
  The user group ID.
• UserGroupName: string
  The user group name.

{
    "type":"object",
    "properties":{
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"integer"
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string"
        }
    }
}

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 dashboard.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/dashboardDashboardsRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

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 dashboard.
• total: integer
  The total number of results regardless of paging.

  Example: 1

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

Nested Schema : data

Type: array

The properties of the new dashboard.

Show Source

• Array of: object dashboardDashboardsRead

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

Nested Schema : dashboardDashboardsRead

Type: object

Show Source

• DashboardID: integer
  The dashboard ID.

  Example: 12
• DashboardName: string
  The dashboard name.

  Example: Basic Services Dashboard
• DashboardTypeID: integer
  Dashboard Type ID

  Example: 1
• DashboardTypeName: string
  The dashboard type name.

  Example: Basic
• HideHeader: integer
  Whether the header should be shown when the dashboard is rendered (1) or not (0).

  Example: 0
• MaxColumns: integer
  The maximum number of columns the dashboard will render before wrapping additional panels onto the next row.

  Example: 4
• Owner: string
  The name of the owner.

  Example: [Public to All Users and Groups]
• OwnerUserGroupID: integer
  The owner user group ID.

  Example: 0
• OwnerUserID: integer
  The ID of the user that owns the dashboard. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.

  Example: 0
• PanelParams: string
  A JSON string of parameters relating to the panel.

  Example: [{"PartTypeID":"6","width":100,"DashboardName":"Basic Services Dashboard","InitialExpansion":"0","InitialExpansionDynamic":"1","InitialView":"Summary","InitialViewDynamic":"1","LinkTarget":"NewWindow","LinkTargetDynamic":"1","PanelName":"Test","PartTypeID":"6","RefreshRate":"","RootID":"root","RootIDDynamic":"1","ShowToolbar":"1","SummaryInitialExpansion":"all","SummaryInitialExpansionDynamic":"1","SummaryNodeSize":"Normal","SummaryNodeSizeDynamic":"1","SummaryTreeType":"LeftToRight","SummaryTreeTypeDynamic":"1","TimeRangeDynamic":"1","TimeRange":"now-24h..now..","Width":"1","recordID":"DashboardsDashboard","width":"1","AutoHeight":1}]
• ReloadRate: integer
  The number of seconds between automatically refreshing the content of panels on the dashboard. Use null to prevent the dashboard from auto refreshing.

  Example: oracle.doceng.json.BetterJsonNull@740fefc6
• Viewers: array Viewers
  The list of user groups that can view the dashboard.

{
    "type":"object",
    "properties":{
        "DashboardTypeID":{
            "description":"Dashboard Type ID",
            "type":"integer",
            "example":"1"
        },
        "PanelParams":{
            "description":"A JSON string of parameters relating to the panel.",
            "type":"string",
            "example":"[{\"PartTypeID\":\"6\",\"width\":100,\"DashboardName\":\"Basic Services Dashboard\",\"InitialExpansion\":\"0\",\"InitialExpansionDynamic\":\"1\",\"InitialView\":\"Summary\",\"InitialViewDynamic\":\"1\",\"LinkTarget\":\"NewWindow\",\"LinkTargetDynamic\":\"1\",\"PanelName\":\"Test\",\"PartTypeID\":\"6\",\"RefreshRate\":\"\",\"RootID\":\"root\",\"RootIDDynamic\":\"1\",\"ShowToolbar\":\"1\",\"SummaryInitialExpansion\":\"all\",\"SummaryInitialExpansionDynamic\":\"1\",\"SummaryNodeSize\":\"Normal\",\"SummaryNodeSizeDynamic\":\"1\",\"SummaryTreeType\":\"LeftToRight\",\"SummaryTreeTypeDynamic\":\"1\",\"TimeRangeDynamic\":\"1\",\"TimeRange\":\"now-24h..now..\",\"Width\":\"1\",\"recordID\":\"DashboardsDashboard\",\"width\":\"1\",\"AutoHeight\":1}]"
        },
        "HideHeader":{
            "description":"Whether the header should be shown when the dashboard is rendered (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "ReloadRate":{
            "description":"The number of seconds between automatically refreshing the content of panels on the dashboard. Use <b>null</b> to prevent the dashboard from auto refreshing.",
            "type":"integer",
            "nullable":true,
            "example":null
        },
        "MaxColumns":{
            "description":"The maximum number of columns the dashboard will render before wrapping additional panels onto the next row.",
            "type":"integer",
            "example":"4"
        },
        "DashboardID":{
            "description":"The dashboard ID.",
            "type":"integer",
            "example":"12"
        },
        "DashboardName":{
            "description":"The dashboard name.",
            "type":"string",
            "example":"Basic Services Dashboard"
        },
        "OwnerUserID":{
            "description":"The ID of the user that owns the dashboard. This can never be an externally-authenticated transient user. <b>0</b> means it is public to all users in the owning group.",
            "type":"integer",
            "example":"0"
        },
        "OwnerUserGroupID":{
            "description":"The owner user group ID.",
            "type":"integer",
            "example":"0"
        },
        "DashboardTypeName":{
            "description":"The dashboard type name.",
            "type":"string",
            "example":"Basic"
        },
        "Owner":{
            "description":"The name of the owner.",
            "type":"string",
            "example":"[Public to All Users and Groups]"
        },
        "Viewers":{
            "description":"The list of user groups that can view the dashboard.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "UserGroupID":{
                        "description":"The user group ID.",
                        "type":"integer"
                    },
                    "UserGroupName":{
                        "description":"The user group name.",
                        "type":"string"
                    }
                }
            },
            "example":[
            ]
        }
    }
}

Nested Schema : Viewers

Type: array

The list of user groups that can view the dashboard.

Show Source

• Array of: object items

{
    "description":"The list of user groups that can view the dashboard.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserGroupID":{
                "description":"The user group ID.",
                "type":"integer"
            },
            "UserGroupName":{
                "description":"The user group name.",
                "type":"string"
            }
        }
    },
    "example":[
    ]
}

Nested Schema : items

Type: object

Show Source

• UserGroupID: integer
  The user group ID.
• UserGroupName: string
  The user group name.

{
    "type":"object",
    "properties":{
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"integer"
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string"
        }
    }
}

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