POST api/Relic

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:
{
  "FinishLater": true,
  "RelicAssociatedApplicationType": "sample string 2",
  "CoordinatesTypes": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "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": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "GISDatumTypes": {
    "$id": "4",
    "$values": [
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "ZoneTypes": {
    "$id": "5",
    "$values": [
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "IgnoreSiteAssociationValidation": true,
  "SitecoreContents": {
    "$id": "6",
    "$values": [
      {
        "$id": "7",
        "RowId": 1,
        "SitecoreContentId": 2,
        "ItemId": "61672782-4f61-4801-84c1-29a6a6941602",
        "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": "7"
      },
      {
        "$ref": "7"
      }
    ]
  },
  "RelicUploadedStatementFile": {
    "$id": "8",
    "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": "9",
      "$values": [
        {
          "$ref": "3"
        },
        {
          "$ref": "3"
        },
        {
          "$ref": "3"
        }
      ]
    },
    "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": "10",
      "$values": [
        {
          "$id": "11",
          "ApplicationId": 1,
          "ItemId": 2,
          "Address": "sample string 3",
          "ModifiedDate": "2024-11-29T01:31:32.5909358+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": "11"
        },
        {
          "$ref": "11"
        }
      ]
    },
    "Entity": {
      "$id": "12",
      "PK": 1
    },
    "Validation": {
      "$id": "13",
      "SuccessOutput": {
        "$id": "14"
      },
      "Success": true,
      "ErrorMessages": null,
      "WarningMessages": {
        "$id": "15",
        "$values": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ]
      },
      "InfoMessages": {
        "$id": "16",
        "$values": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ]
      },
      "DatabaseErrorMessage": "sample string 3",
      "SuccessMessage": "sample string 4",
      "RelatedKeyId": "sample string 5"
    },
    "PageAccess": {
      "$id": "17",
      "PageCode": "sample string 1",
      "StepAccesses": {
        "$id": "18",
        "$values": [
          {
            "$id": "19",
            "StageCode": "sample string 1",
            "StepCode": "sample string 2"
          },
          {
            "$ref": "19"
          },
          {
            "$ref": "19"
          }
        ]
      },
      "Positions": {
        "$id": "20",
        "$values": [
          "sample string 1",
          "sample string 2",
          "sample string 3"
        ]
      }
    },
    "UserRole": 0
  },
  "RelicUploadedStatementFiles": {
    "$id": "21",
    "$values": [
      {
        "$ref": "8"
      },
      {
        "$ref": "8"
      },
      {
        "$ref": "8"
      }
    ]
  },
  "RelicUploadedPhotographFile": {
    "$ref": "8"
  },
  "RelicUploadedPhotographFiles": {
    "$id": "22",
    "$values": [
      {
        "$ref": "8"
      },
      {
        "$ref": "8"
      },
      {
        "$ref": "8"
      }
    ]
  },
  "Photograph": {
    "$id": "23",
    "ImageUploadedFile": {
      "$ref": "8"
    },
    "ImageUploadedFiles": {
      "$id": "24",
      "$values": [
        {
          "$ref": "8"
        },
        {
          "$ref": "8"
        },
        {
          "$ref": "8"
        }
      ]
    },
    "ApplicationId": 1,
    "StepConfigId": 2,
    "ItemId": 3,
    "RelicId": 4,
    "ImageId": 5,
    "StepId": 6,
    "StageCode": "sample string 7",
    "StepCode": "sample string 8",
    "ScreenType": "sample string 9",
    "ButtonText": "sample string 10",
    "ImageDisplayStepConfig": {
      "$id": "25",
      "IsCurrent": true,
      "IsOpen": true,
      "IsBeingSaved": true,
      "IsUnlocked": true,
      "IsCompleted": true,
      "CanUserAccess": true,
      "CanUserSave": true,
      "TeamPositions": {
        "$id": "26",
        "$values": [
          {
            "$id": "27",
            "TeamPositionId": 1,
            "TeamId": 1,
            "PositionId": 1
          },
          {
            "$ref": "27"
          },
          {
            "$ref": "27"
          }
        ]
      },
      "RowId": 8,
      "WorkflowId": 9,
      "StepConfigId": 10,
      "TeamId": 1,
      "PositionId": 1,
      "TeamPositionId": 1,
      "Stage": "sample string 11",
      "StageCode": "sample string 12",
      "StageSequence": 13,
      "Step": "sample string 14",
      "StepCode": "sample string 15",
      "StepSequence": 16,
      "WorkflowStepSequence": 17,
      "ApplicationType": "sample string 18",
      "PortalType": "sample string 19",
      "Team": "sample string 20",
      "Position": "sample string 21",
      "LinkedStepConfigId": 1,
      "CurrentWorkflowFlag": true,
      "SeniorTeamLeaderAllocatedFlag": true,
      "IsPrepareStep": true,
      "IsReviewStep": true,
      "LockStepToTeamFlag": true,
      "LinkedWorkflowStepSequence": 1,
      "PK": true
    },
    "ReadOnly": true,
    "CanUserAccess": true,
    "IsShrNomImages": true,
    "IsMaintainItemImage": true,
    "ApplicationOnlyItems": true,
    "UserRole": 0,
    "DamAssetId": 1,
    "AssetPreviewUrl": "sample string 16",
    "ImageRequest": {
      "$id": "28",
      "Filters": {
        "$id": "29",
        "$values": [
          {
            "$id": "30",
            "<Field>k__BackingField": "sample string 1",
            "<Operator>k__BackingField": "sample string 2",
            "<Value>k__BackingField": {
              "$id": "31"
            },
            "<Logic>k__BackingField": "sample string 4",
            "<Filters>k__BackingField": {
              "$id": "32",
              "$values": [
                {
                  "$ref": "30"
                },
                {
                  "$ref": "30"
                },
                {
                  "$ref": "30"
                }
              ]
            }
          },
          {
            "$ref": "30"
          },
          {
            "$ref": "30"
          }
        ]
      },
      "Page": 1,
      "PageSize": 2,
      "Sort": {
        "$id": "33",
        "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
    },
    "DisplaySequenceList": {
      "$id": "34",
      "$values": [
        1,
        2,
        3
      ]
    },
    "ImageTypes": {
      "$id": "35",
      "$values": [
        {
          "$ref": "3"
        },
        {
          "$ref": "3"
        },
        {
          "$ref": "3"
        }
      ]
    },
    "Entity": {
      "$id": "36",
      "PK": 1
    },
    "Validation": {
      "$ref": "13"
    },
    "PageAccess": {
      "$ref": "17"
    }
  },
  "RelicDisplayStepConfig": {
    "$ref": "25"
  },
  "Entity": {
    "$id": "37",
    "PK": 1
  },
  "Validation": {
    "$ref": "13"
  },
  "PageAccess": {
    "$ref": "17"
  },
  "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 'RelicViewModel'.

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
}