POST api/ReportBuilderTemplate

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
viewModel
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "ApplicationTypes": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "Id": 1,
        "CodeDesc": "sample string 2",
        "AlternativeDesc": "sample string 3",
        "SystemCode": "sample string 4",
        "SequenceNo": 1
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "DelegationTypes": {
    "$id": "4",
    "$values": [
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "DocumentTypes": {
    "$id": "5",
    "$values": [
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "TemplateDeterminationOutcomes": {
    "$id": "6",
    "$values": [
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "TemplateSHRNominationTypes": {
    "$id": "7",
    "$values": [
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "Queries": {
    "$id": "8",
    "$values": [
      {
        "$id": "9",
        "Id": "sample string 1",
        "Text": "sample string 2",
        "OtherText": "sample string 3",
        "OtherData": {
          "$id": "10"
        }
      },
      {
        "$ref": "9"
      },
      {
        "$ref": "9"
      }
    ]
  },
  "StopWorkStepConfigIds": {
    "$id": "11",
    "$values": [
      1,
      2,
      3
    ]
  },
  "DetailQueryIds": {
    "$id": "12",
    "$values": [
      1,
      1,
      1
    ]
  },
  "DetailQueryRemovalSequenceNo": 1,
  "AssessmentReportStepConfigId": 1,
  "TemplateTypeYesNoLookupCodes": {
    "$id": "13",
    "$values": [
      {
        "$id": "14",
        "CodeLovId": 1,
        "CodeType": "sample string 2",
        "Description": "sample string 3",
        "AlternativeDesc": "sample string 4",
        "ShortDesc": "sample string 5",
        "ActiveFlag": true,
        "SequenceNo": 1,
        "SystemCode": "sample string 7",
        "IsStreetAddressFlag": true
      },
      {
        "$ref": "14"
      },
      {
        "$ref": "14"
      }
    ]
  },
  "UploadedFile": {
    "$id": "15",
    "FileAttachment": "QEBA",
    "FileUrl": "sample string 1",
    "IsFileTooLarge": true,
    "ParentKeyId": 1,
    "ParentFolderName": "sample string 3",
    "IsDisabled": true,
    "FileRequiredFlag": true,
    "DropzoneText": "sample string 6",
    "DisableAutomaticUpload": true,
    "SharepointFilePath": "sample string 8",
    "MaxFileCount": 1,
    "MaxFileSize": 1,
    "IsAttached": true,
    "FileTypeCode": "sample string 10",
    "DoesFileGenerate": true,
    "HasFileBeenGenerated": true,
    "IsShowingLink": true,
    "SubmittedVersionNo": 1,
    "ApplicationId": 14,
    "StampImagePath": "sample string 15",
    "CurrentApplicationStep": "sample string 16",
    "FetchStamped": true,
    "IsStepFile": true,
    "IsStepReadOnly": true,
    "IsSequenceNumberRequired": true,
    "IsAutoCommit": true,
    "StakeholderId": 22,
    "StakeholderType": "sample string 23",
    "DocumentTypes": {
      "$id": "16",
      "$values": [
        {
          "$ref": "14"
        },
        {
          "$ref": "14"
        },
        {
          "$ref": "14"
        }
      ]
    },
    "OtherFileTypeLovId": 24,
    "FileTypeName": "sample string 25",
    "AcceptedFileTypes": "sample string 26",
    "IsLabeled": true,
    "IsImage": true,
    "CreatedBy": "sample string 29",
    "ModifiedBy": "sample string 30",
    "UploadedFileScanDataId": "sample string 31",
    "ApplicationTypeCode": "sample string 32",
    "ActionToCall": "sample string 33",
    "IsUploadHeritageItem": true,
    "IsAllRecordsErrors": true,
    "UploadHeritageItems": {
      "$id": "17",
      "$values": [
        {
          "$id": "18",
          "ApplicationId": 1,
          "ItemId": 2,
          "Address": "sample string 3",
          "ModifiedDate": "2024-11-09T13:09:02.3579147+11:00",
          "ItemName": "sample string 5",
          "StreetNo": "sample string 6",
          "StreetAddress": "sample string 7",
          "Suburb": "sample string 8",
          "Postcode": "sample string 9",
          "PhysicalDescription": "sample string 10",
          "StatementSignificance": "sample string 11",
          "History": "sample string 12"
        },
        {
          "$ref": "18"
        },
        {
          "$ref": "18"
        }
      ]
    },
    "Entity": {
      "$id": "19",
      "PK": 1
    },
    "Validation": {
      "$id": "20",
      "SuccessOutput": {
        "$id": "21"
      },
      "Success": true,
      "ErrorMessages": null,
      "WarningMessages": {
        "$id": "22",
        "$values": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ]
      },
      "InfoMessages": {
        "$id": "23",
        "$values": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ]
      },
      "DatabaseErrorMessage": "sample string 3",
      "SuccessMessage": "sample string 4",
      "RelatedKeyId": "sample string 5"
    },
    "PageAccess": {
      "$id": "24",
      "PageCode": "sample string 1",
      "StepAccesses": {
        "$id": "25",
        "$values": [
          {
            "$id": "26",
            "StageCode": "sample string 1",
            "StepCode": "sample string 2"
          },
          {
            "$ref": "26"
          },
          {
            "$ref": "26"
          }
        ]
      },
      "Positions": {
        "$id": "27",
        "$values": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ]
      }
    },
    "UserRole": 0
  },
  "ReportBuilderTemplateLinkedStepViewModel": {
    "$id": "28",
    "ReportBuilderTemplateLinkedStepRequest": {
      "$id": "29",
      "Filters": {
        "$id": "30",
        "$values": [
          {
            "$id": "31",
            "<Field>k__BackingField": "sample string 1",
            "<Operator>k__BackingField": "sample string 2",
            "<Value>k__BackingField": {
              "$id": "32"
            },
            "<Logic>k__BackingField": "sample string 4",
            "<Filters>k__BackingField": {
              "$id": "33",
              "$values": [
                {
                  "$ref": "31"
                },
                {
                  "$ref": "31"
                },
                {
                  "$ref": "31"
                }
              ]
            }
          },
          {
            "$ref": "31"
          },
          {
            "$ref": "31"
          }
        ]
      },
      "Page": 1,
      "PageSize": 2,
      "Sort": {
        "$id": "34",
        "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
    },
    "StageId": 1,
    "TemplateApplicationTypeId": 2,
    "TemplateStageId": 3,
    "TemplateStepId": 4,
    "Stages": {
      "$id": "35",
      "$values": [
        {
          "$ref": "3"
        },
        {
          "$ref": "3"
        },
        {
          "$ref": "3"
        }
      ]
    },
    "Steps": {
      "$id": "36",
      "$values": [
        {
          "$ref": "9"
        },
        {
          "$ref": "9"
        },
        {
          "$ref": "9"
        }
      ]
    },
    "Entity": {
      "$id": "37",
      "PK": 1
    },
    "Validation": {
      "$ref": "20"
    },
    "PageAccess": {
      "$ref": "24"
    },
    "UserRole": 0
  },
  "ApplicationTypeSHRLovId": 1,
  "PrepareRecommendationToListStepConfigId": 1,
  "PrepareMinisterialBriefingPackageStepConfigId": 1,
  "Entity": {
    "$id": "38",
    "SubsequentStepFlagNullable": true,
    "PK": 1
  },
  "Validation": {
    "$ref": "20"
  },
  "PageAccess": {
    "$ref": "24"
  },
  "UserRole": 0
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ReportBuilderTemplateViewModel'.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "Validation": {
    "$id": "2",
    "SuccessOutput": {
      "$id": "3"
    },
    "Success": true,
    "ErrorMessages": null,
    "WarningMessages": {
      "$id": "4",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "InfoMessages": {
      "$id": "5",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "DatabaseErrorMessage": "sample string 3",
    "SuccessMessage": "sample string 4",
    "RelatedKeyId": "sample string 5"
  },
  "PageAccess": {
    "$id": "6",
    "PageCode": "sample string 1",
    "StepAccesses": {
      "$id": "7",
      "$values": [
        {
          "$id": "8",
          "StageCode": "sample string 1",
          "StepCode": "sample string 2"
        },
        {
          "$ref": "8"
        },
        {
          "$ref": "8"
        }
      ]
    },
    "Positions": {
      "$id": "9",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    }
  },
  "UserRole": 0
}