POST api/Note
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:
{
"IsAdminScreen": true,
"NoteUploadedFile": {
"$id": "2",
"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": "3",
"$values": [
{
"$id": "4",
"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": "4"
},
{
"$ref": "4"
}
]
},
"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": "5",
"$values": [
{
"$id": "6",
"ApplicationId": 1,
"ItemId": 2,
"Address": "sample string 3",
"ModifiedDate": "2024-11-29T01:41:44.3391095+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": "6"
},
{
"$ref": "6"
}
]
},
"Entity": {
"$id": "7",
"PK": 1
},
"Validation": {
"$id": "8",
"SuccessOutput": {
"$id": "9"
},
"Success": true,
"ErrorMessages": null,
"WarningMessages": {
"$id": "10",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"InfoMessages": {
"$id": "11",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"DatabaseErrorMessage": "sample string 3",
"SuccessMessage": "sample string 4",
"RelatedKeyId": "sample string 5"
},
"PageAccess": {
"$id": "12",
"PageCode": "sample string 1",
"StepAccesses": {
"$id": "13",
"$values": [
{
"$id": "14",
"StageCode": "sample string 1",
"StepCode": "sample string 2"
},
{
"$ref": "14"
},
{
"$ref": "14"
}
]
},
"Positions": {
"$id": "15",
"$values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
}
},
"UserRole": 0
},
"NoteCategoryLookupCodes": {
"$id": "16",
"$values": [
{
"$ref": "4"
},
{
"$ref": "4"
},
{
"$ref": "4"
}
]
},
"ReadOnly": true,
"NoteUploadedFiles": {
"$id": "17",
"$values": [
{
"$ref": "2"
},
{
"$ref": "2"
},
{
"$ref": "2"
}
]
},
"NoteRequest": {
"$id": "18",
"Filters": {
"$id": "19",
"$values": [
{
"$id": "20",
"<Field>k__BackingField": "sample string 1",
"<Operator>k__BackingField": "sample string 2",
"<Value>k__BackingField": {
"$id": "21"
},
"<Logic>k__BackingField": "sample string 4",
"<Filters>k__BackingField": {
"$id": "22",
"$values": [
{
"$ref": "20"
},
{
"$ref": "20"
},
{
"$ref": "20"
}
]
}
},
{
"$ref": "20"
},
{
"$ref": "20"
}
]
},
"Page": 1,
"PageSize": 2,
"Sort": {
"$id": "23",
"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
},
"NoteDisplayStepConfig": {
"$id": "24",
"IsCurrent": true,
"IsOpen": true,
"IsBeingSaved": true,
"IsUnlocked": true,
"IsCompleted": true,
"CanUserAccess": true,
"CanUserSave": true,
"TeamPositions": {
"$id": "25",
"$values": [
{
"$id": "26",
"TeamPositionId": 1,
"TeamId": 1,
"PositionId": 1
},
{
"$ref": "26"
},
{
"$ref": "26"
}
]
},
"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
},
"PageSectionName": "sample string 3",
"Entity": {
"$id": "27",
"PK": 1
},
"Validation": {
"$ref": "8"
},
"PageAccess": {
"$ref": "12"
},
"UserRole": 0
}
application/x-www-form-urlencoded
Sample:
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
}