Jump to

• Request
• Response

Update the Order of Metric Tabs

put

/api/metric/Categories/updateOrder

Updates the order of the metric tabs.

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

• NewOrder: array NewOrder
  The tab order index for the categories. An array of all CategoryIDs, which are reordered from 1 to N

{
    "type":"object",
    "properties":{
        "NewOrder":{
            "description":"The tab order index for the categories. An array of all CategoryIDs, which are reordered from 1 to N",
            "type":"array",
            "items":{
                "type":"integer"
            }
        }
    }
}

Nested Schema : NewOrder

Type: array

The tab order index for the categories. An array of all CategoryIDs, which are reordered from 1 to N

Show Source

• Array of: integer

{
    "description":"The tab order index for the categories. An array of all CategoryIDs, which are reordered from 1 to N",
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• data: array data
• message: string
  The response message.

  Example: Updated order
• success: boolean
  Whether the request was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the request 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 order"
        },
        "data":{
            "type":"array",
            "items":{
            },
            "example":[
            ]
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of:

{
    "type":"array",
    "items":{
    },
    "example":[
    ]
}

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":{
                "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

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

Nested Schema : items

Type: object

Back to Top