Validate a Parameter Set

Overview

POST /rest/parameterSets/validate

This endpoint is used to validate the parameters of a Parameter Set.

Required Permissions

Users can validate parameters of a Parameter Set.

Request

CODE

POST <service_url>/rest/parameterSets/validate

Request Body

The request body must be a JSON object with the following structure:

JSON

{
  "parameters": Object // The parameters in JSON format
}

Example Request Body

JSON

{
  "parameters": {
    "reportType": "statusDuration",
    "filterType": "project",
    "projectKey": "ITSAMPLE",
    "aggregationType": "tableList",
    "groupByFields": [
        "project",
        "date:year:created",
        "date:month:created"
    ],
    "averageDenominator": "nonNull",
    "multiVisitBehavior": "average",
    "timePeriod": "month",
    "statuses": [],
    "includeDeletedStatuses": true,
    "fields": [],
    "historyFields": [],
    "groups": [],
    "dbsMetrics": [],
    "assignees": [],
    "dateRangeField": "created",
    "startDate": "",
    "endDate": "",
    "trimHistoryStartDate": "",
    "trimHistoryEndDate": "",
    "calendar": "normalHours",
    "dayLength": "24HourDays",
    "pageSize": 10,
    "startIssueIndex": 0,
    "sortBy": "",
    "sortByDeleted": "",
    "sortDir": "desc",
    "filters": {
        "valueFilters": [],
        "hideEmptyRows": false
    },
    "outputType": "xls",
    "exportGroupByFields": [
        "project",
        "date:year:created",
        "date:month:created"
    ],
    "exportDateFormat": "",
    "exportDateTimeFormat": "",
    "exportEmptyValueToken": "hyphen",
    "exportDecimalSeparator": null,
    "exportCsvFieldSeparator": null,
    "exportValueQuotationMark": null,
    "viewFormat": "humanReadable",
    "visitCounts": false,
    "dataBars": false,
    "oneDimensionChartType": "pie",
    "twoDimensionsChartType": "stackedColumn",
    "dateChartType": "timeline",
    "oneDimensionChartPercentage": "off",
    "twoDimensionsChartPercentage": "off",
    "excludeCurrentState": false,
    "highlightsRules": []
  }
}

Example Requests

CODE

POST https://tis.obss.io/rest/parameterSets/validate

Response

Response Structure

CODE

{
  "valid": Boolean, // Indicates if the parameter set is valid
  "messages": Array<String> | null // Contains validation messages if any, otherwise null
}

Example Response Body

JSON

{
  "valid": true,
  "messages": null
}

Response Codes

200 OK: Indicates that the parameter set is valid.
400 Bad Request: If the request body is invalid.