PUT api/ReportBuilderReport
No documentation available.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| viewModel | No documentation available. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"ReportBuilderReportId": 1,
"SavedReportQueryId": 1,
"HasReportQueryChanged": true,
"CurrentStepIndex": 2,
"MaxReachedStepIndex": 3,
"IsReadOnly": true,
"ApplicationSection": "sample string 5",
"ReportData": {
"$id": "2",
"ReportQueryId": 1,
"LoadedReportQueryId": 1,
"TypeOfQuery": "sample string 1",
"AvailableQueries": {
"$id": "3",
"$values": [
{
"$id": "4",
"ReportBuilderQueryId": 1,
"Description": "sample string 2",
"QueryType": "sample string 3",
"HelpText": "sample string 4",
"Roles": {
"$id": "5",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"RolesString": "sample string 1, sample string 2, sample string 3",
"ApplicationSection": "sample string 5"
},
{
"$ref": "4"
},
{
"$ref": "4"
}
]
}
},
"Conditions": {
"$id": "6",
"FilterConditions": {
"$id": "7",
"$values": [
{
"$id": "8",
"SequenceNo": 1,
"ReportBuilderConditionId": 1,
"ColumnName": "sample string 2",
"ColumnDataType": "sample string 3",
"OperatorValue": "sample string 4",
"FilterValue": "sample string 5",
"AvailableColumns": {
"$id": "9",
"$values": [
{
"$id": "10",
"ReportBuilderReportColumnId": 1,
"ColumnName": "sample string 1",
"DataType": "sample string 2",
"IsDisplayed": true,
"DrillDownReportId": 1,
"ReportBuilderReportId": 1,
"UserHasAccessToDrillDownReport": true,
"SequenceNo": 5,
"DrillDownReportParameters": {
"$id": "11",
"$values": [
{
"$id": "12",
"DrillDownLinkId": 1,
"ReportBuilderReportColumnId": 1,
"CurrentReportColumnName": "sample string 1",
"DrillDownReportColumnName": "sample string 2"
},
{
"$ref": "12"
},
{
"$ref": "12"
}
]
}
},
{
"$ref": "10"
},
{
"$ref": "10"
}
]
}
},
{
"$ref": "8"
},
{
"$ref": "8"
}
]
},
"AvailableColumns": {
"$ref": "9"
}
},
"Columns": {
"$id": "13",
"QueryUsed": "sample string 1",
"LoadedColumnsDTO": {
"$id": "14",
"$values": [
{
"$ref": "10"
},
{
"$ref": "10"
},
{
"$ref": "10"
}
]
}
},
"Results": {
"$id": "15",
"IsExportingCsv": true,
"IsExportingExcel": true,
"IsReadOnly": true,
"LoadedColumns": {
"$id": "16",
"$values": [
{
"$ref": "10"
},
{
"$ref": "10"
},
{
"$ref": "10"
}
]
},
"Records": {
"$id": "17",
"$values": [
{
"$id": "18",
"Columns": {
"$id": "19",
"$values": [
{
"$id": "20",
"Name": "sample string 1",
"Value": "sample string 2",
"Url": "sample string 3",
"Data": "QEBA",
"ReferenceId": "sample string 4",
"ImageHeight": 1,
"ImageWidth": 1
},
{
"$ref": "20"
},
{
"$ref": "20"
}
]
}
},
{
"$ref": "18"
},
{
"$ref": "18"
}
]
},
"Request": {
"$id": "21",
"Filters": {
"$id": "22",
"$values": [
{
"$id": "23",
"<Field>k__BackingField": "sample string 1",
"<Operator>k__BackingField": "sample string 2",
"<Value>k__BackingField": {
"$id": "24"
},
"<Logic>k__BackingField": "sample string 4",
"<Filters>k__BackingField": {
"$id": "25",
"$values": [
{
"$ref": "23"
},
{
"$ref": "23"
},
{
"$ref": "23"
}
]
}
},
{
"$ref": "23"
},
{
"$ref": "23"
}
]
},
"Page": 1,
"PageSize": 2,
"Sort": {
"$id": "26",
"Field": "sample string 1",
"Dir": "sample string 2",
"SecondaryField": "sample string 3",
"SecondaryDir": "sample string 4",
"ThirdField": "sample string 5",
"ThirdDir": "sample string 6"
},
"PreviousPageSize": 3
},
"SearchResults": {
"$id": "27",
"TResults": {
"$id": "28",
"$values": [
{
"$ref": "18"
},
{
"$ref": "18"
},
{
"$ref": "18"
}
]
},
"FullResults": {
"$id": "29",
"$values": [
{
"$ref": "18"
},
{
"$ref": "18"
},
{
"$ref": "18"
}
]
},
"Validation": {
"$id": "30",
"SuccessOutput": {
"$id": "31"
},
"Success": true,
"ErrorMessages": null,
"WarningMessages": {
"$id": "32",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"InfoMessages": {
"$id": "33",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"DatabaseErrorMessage": "sample string 3",
"SuccessMessage": "sample string 4",
"RelatedKeyId": "sample string 5"
},
"Results": {
"$id": "34",
"$values": [
{
"$id": "35"
},
{
"$id": "36"
},
{
"$id": "37"
}
]
},
"Page": 1,
"PageSize": 1,
"PageCount": 1,
"Sort": {
"$ref": "26"
},
"Total": 2,
"IsExternal": true,
"UserRole": 0,
"Area": "sample string 4",
"MaxLayerSeachResultsExceededWarningMessage": "sample string 5",
"maxHeritageLayerSearchValue": 1,
"MaxResultsExceeded": true
},
"Validation": {
"$ref": "30"
}
},
"ReportDetails": {
"$id": "38",
"ReportName": "sample string 1",
"MenuName": "sample string 2",
"ReportPositionIds": {
"$id": "39",
"$values": [
1,
2,
3
]
},
"AllPositions": {
"$id": "40",
"$values": [
{
"$id": "41",
"Id": "sample string 1",
"Text": "sample string 2",
"OtherText": "sample string 3",
"OtherData": {
"$id": "42"
}
},
{
"$ref": "41"
},
{
"$ref": "41"
}
]
},
"MenuNames": {
"$id": "43",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"SelectedSecurityRestriction": "sample string 3",
"IsAdmin": true,
"HelpText": "sample string 5",
"ReportCreator": true,
"ReportCreatedBy": "sample string 7"
},
"SitecoreContents": {
"$id": "44",
"$values": [
{
"$id": "45",
"RowId": 1,
"SitecoreContentId": 2,
"ItemId": "1f7af833-7682-49f8-a77e-a7dcc5df8684",
"ItemTypeLovId": 4,
"ItemType": "sample string 5",
"ItemCode": "sample string 6",
"Content": "sample string 7",
"StageLovId": 1,
"Stage": "sample string 8",
"StepConfigId": 1,
"Step": "sample string 9",
"FieldName": "sample string 10",
"ContentData": "QEBA",
"PK": "sample string 7"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"Entity": {
"$id": "46",
"PK": 1
},
"Validation": {
"$ref": "30"
},
"PageAccess": {
"$id": "47",
"PageCode": "sample string 1",
"StepAccesses": {
"$id": "48",
"$values": [
{
"$id": "49",
"StageCode": "sample string 1",
"StepCode": "sample string 2"
},
{
"$ref": "49"
},
{
"$ref": "49"
}
]
},
"Positions": {
"$id": "50",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
}
},
"UserRole": 0
}
application/x-www-form-urlencoded
Sample:
Response Information
Response body formats
application/json, text/json
Sample:
{
"ReportBuilderReportId": 1,
"SavedReportQueryId": 1,
"HasReportQueryChanged": true,
"CurrentStepIndex": 2,
"MaxReachedStepIndex": 3,
"IsReadOnly": true,
"ApplicationSection": "sample string 5",
"ReportData": {
"$id": "2",
"ReportQueryId": 1,
"LoadedReportQueryId": 1,
"TypeOfQuery": "sample string 1",
"AvailableQueries": {
"$id": "3",
"$values": [
{
"$id": "4",
"ReportBuilderQueryId": 1,
"Description": "sample string 2",
"QueryType": "sample string 3",
"HelpText": "sample string 4",
"Roles": {
"$id": "5",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"RolesString": "sample string 1, sample string 2, sample string 3",
"ApplicationSection": "sample string 5"
},
{
"$ref": "4"
},
{
"$ref": "4"
}
]
}
},
"Conditions": {
"$id": "6",
"FilterConditions": {
"$id": "7",
"$values": [
{
"$id": "8",
"SequenceNo": 1,
"ReportBuilderConditionId": 1,
"ColumnName": "sample string 2",
"ColumnDataType": "sample string 3",
"OperatorValue": "sample string 4",
"FilterValue": "sample string 5",
"AvailableColumns": {
"$id": "9",
"$values": [
{
"$id": "10",
"ReportBuilderReportColumnId": 1,
"ColumnName": "sample string 1",
"DataType": "sample string 2",
"IsDisplayed": true,
"DrillDownReportId": 1,
"ReportBuilderReportId": 1,
"UserHasAccessToDrillDownReport": true,
"SequenceNo": 5,
"DrillDownReportParameters": {
"$id": "11",
"$values": [
{
"$id": "12",
"DrillDownLinkId": 1,
"ReportBuilderReportColumnId": 1,
"CurrentReportColumnName": "sample string 1",
"DrillDownReportColumnName": "sample string 2"
},
{
"$ref": "12"
},
{
"$ref": "12"
}
]
}
},
{
"$ref": "10"
},
{
"$ref": "10"
}
]
}
},
{
"$ref": "8"
},
{
"$ref": "8"
}
]
},
"AvailableColumns": {
"$ref": "9"
}
},
"Columns": {
"$id": "13",
"QueryUsed": "sample string 1",
"LoadedColumnsDTO": {
"$id": "14",
"$values": [
{
"$ref": "10"
},
{
"$ref": "10"
},
{
"$ref": "10"
}
]
}
},
"Results": {
"$id": "15",
"IsExportingCsv": true,
"IsExportingExcel": true,
"IsReadOnly": true,
"LoadedColumns": {
"$id": "16",
"$values": [
{
"$ref": "10"
},
{
"$ref": "10"
},
{
"$ref": "10"
}
]
},
"Records": {
"$id": "17",
"$values": [
{
"$id": "18",
"Columns": {
"$id": "19",
"$values": [
{
"$id": "20",
"Name": "sample string 1",
"Value": "sample string 2",
"Url": "sample string 3",
"Data": "QEBA",
"ReferenceId": "sample string 4",
"ImageHeight": 1,
"ImageWidth": 1
},
{
"$ref": "20"
},
{
"$ref": "20"
}
]
}
},
{
"$ref": "18"
},
{
"$ref": "18"
}
]
},
"Request": {
"$id": "21",
"Filters": {
"$id": "22",
"$values": [
{
"$id": "23",
"<Field>k__BackingField": "sample string 1",
"<Operator>k__BackingField": "sample string 2",
"<Value>k__BackingField": {
"$id": "24"
},
"<Logic>k__BackingField": "sample string 4",
"<Filters>k__BackingField": {
"$id": "25",
"$values": [
{
"$ref": "23"
},
{
"$ref": "23"
},
{
"$ref": "23"
}
]
}
},
{
"$ref": "23"
},
{
"$ref": "23"
}
]
},
"Page": 1,
"PageSize": 2,
"Sort": {
"$id": "26",
"Field": "sample string 1",
"Dir": "sample string 2",
"SecondaryField": "sample string 3",
"SecondaryDir": "sample string 4",
"ThirdField": "sample string 5",
"ThirdDir": "sample string 6"
},
"PreviousPageSize": 3
},
"SearchResults": {
"$id": "27",
"TResults": {
"$id": "28",
"$values": [
{
"$ref": "18"
},
{
"$ref": "18"
},
{
"$ref": "18"
}
]
},
"FullResults": {
"$id": "29",
"$values": [
{
"$ref": "18"
},
{
"$ref": "18"
},
{
"$ref": "18"
}
]
},
"Validation": {
"$id": "30",
"SuccessOutput": {
"$id": "31"
},
"Success": true,
"ErrorMessages": null,
"WarningMessages": {
"$id": "32",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"InfoMessages": {
"$id": "33",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"DatabaseErrorMessage": "sample string 3",
"SuccessMessage": "sample string 4",
"RelatedKeyId": "sample string 5"
},
"Results": {
"$id": "34",
"$values": [
{
"$id": "35"
},
{
"$id": "36"
},
{
"$id": "37"
}
]
},
"Page": 1,
"PageSize": 1,
"PageCount": 1,
"Sort": {
"$ref": "26"
},
"Total": 2,
"IsExternal": true,
"UserRole": 0,
"Area": "sample string 4",
"MaxLayerSeachResultsExceededWarningMessage": "sample string 5",
"maxHeritageLayerSearchValue": 1,
"MaxResultsExceeded": true
},
"Validation": {
"$ref": "30"
}
},
"ReportDetails": {
"$id": "38",
"ReportName": "sample string 1",
"MenuName": "sample string 2",
"ReportPositionIds": {
"$id": "39",
"$values": [
1,
2,
3
]
},
"AllPositions": {
"$id": "40",
"$values": [
{
"$id": "41",
"Id": "sample string 1",
"Text": "sample string 2",
"OtherText": "sample string 3",
"OtherData": {
"$id": "42"
}
},
{
"$ref": "41"
},
{
"$ref": "41"
}
]
},
"MenuNames": {
"$id": "43",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"SelectedSecurityRestriction": "sample string 3",
"IsAdmin": true,
"HelpText": "sample string 5",
"ReportCreator": true,
"ReportCreatedBy": "sample string 7"
},
"SitecoreContents": {
"$id": "44",
"$values": [
{
"$id": "45",
"RowId": 1,
"SitecoreContentId": 2,
"ItemId": "6ca6ea20-37bf-4399-b7cf-d94e6dabc777",
"ItemTypeLovId": 4,
"ItemType": "sample string 5",
"ItemCode": "sample string 6",
"Content": "sample string 7",
"StageLovId": 1,
"Stage": "sample string 8",
"StepConfigId": 1,
"Step": "sample string 9",
"FieldName": "sample string 10",
"ContentData": "QEBA",
"PK": "sample string 7"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"Entity": {
"$id": "46",
"PK": 1
},
"Validation": {
"$ref": "30"
},
"PageAccess": {
"$id": "47",
"PageCode": "sample string 1",
"StepAccesses": {
"$id": "48",
"$values": [
{
"$id": "49",
"StageCode": "sample string 1",
"StepCode": "sample string 2"
},
{
"$ref": "49"
},
{
"$ref": "49"
}
]
},
"Positions": {
"$id": "50",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
}
},
"UserRole": 0
}