POST DMS/CreateDocument
Request Information
URI Parameters
None.
Body Parameters
DMSUploadDocumentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| IsNavigationFromCommonSearch | boolean |
None. |
|
| DocumentDetails | DMSUploadDocumentDTO |
None. |
|
| DMSFileDetails | DMSFileDTO |
None. |
|
| DocumentVersionList | Collection of DMSFileDTO |
None. |
|
| PendingRequest | SearchResultModel |
None. |
|
| DMSAddNewReference | DMSAddNewReferenceDTO |
None. |
|
| AttachmentId | integer |
None. |
|
| UploadedFile | SearchResultModel |
None. |
|
| ActionMethodName | string |
None. |
|
| DocumentMasterId | string |
None. |
|
| DocumentReference | string |
None. |
|
| LoggedInUserId | integer |
None. |
|
| OnBackDocumentId | integer |
None. |
|
| IsViewDocCalledFromPendingRequest | boolean |
None. |
|
| IsViewDocCalledFromReference | boolean |
None. |
|
| ChangeCreatorDTO | DMSChangeCreatorDTO |
None. |
Request Formats
application/json, text/json
Sample:
{
"IsNavigationFromCommonSearch": true,
"DocumentDetails": {
"DocumentId": 1,
"DocumentNumber": "sample string 2",
"levelId": 3,
"verticalIds": [
1,
2
],
"RegionIds": [
1,
2
],
"ProjectIds": [
1,
2
],
"FunctionIds": [
1,
2
],
"PositionIds": [
1,
2
],
"UploadedBy": 4,
"UploadedByName": "sample string 5",
"UploadedOn": "2024-11-15T11:14:57.1408584+05:30",
"UploadedOnDateString": "sample string 7",
"UploadedOnTimeString": "sample string 8",
"LastUpdatedBy": 9,
"LastUpdatedByName": "sample string 10",
"LastUpdatedOn": "2024-11-15T11:14:57.1408584+05:30",
"LastUpdatedOnDateString": "sample string 12",
"LastUpdatedOnTimeString": "sample string 13",
"Title": "sample string 14",
"MasterKeywords": [
"sample string 1",
"sample string 2"
],
"CustomKeywords": [
"sample string 1",
"sample string 2"
],
"ContentInformation": "sample string 15",
"DocumentDate": "2024-11-15T11:14:57.1408584+05:30",
"DocumentDateString": "sample string 16",
"DocumentDateTimeString": "sample string 17",
"SharedWithRestricteduser": true,
"Files": [
{
"ProvisionalDocumentId": 1,
"FileId": 2,
"DocumentId": 3,
"GUIDFileName": "sample string 4",
"FileName": "sample string 5",
"FileSize": "sample string 6",
"FileVersion": 7.0,
"UploadedBy": 8,
"UploadedByName": "sample string 9",
"UploadedOn": "2024-11-15T11:14:57.1408584+05:30",
"comments": "sample string 11",
"FilePath": "sample string 12",
"Extention": "sample string 13",
"UploadedOnDateString": "sample string 14",
"sessionDto": {
"DepartmentName": "sample string 1",
"DepartmentId": 2,
"RoleId": 3,
"CurrentRoleName": "sample string 4",
"FirstName": "sample string 5",
"LastName": "sample string 6",
"UserId": 7,
"ObservationId": 8,
"IsElevated": true,
"IncidentId": 10,
"InjuredWorkerId": 11,
"InjuryCauseId": 12,
"CorrectiveActions": "sample string 13",
"HandSkillTrainingId": 14,
"CheckListId": 15,
"CheckListResponseId": 16,
"CustomerComplaintId": 17,
"WorkPermitId": 18,
"WorkPermitTypeId": 19,
"ProjectId": 20,
"WorkPermitStatus": "sample string 21",
"InspectionId": 22,
"ObservationIdlist": [
1,
2
],
"ClosedRemark": "sample string 23",
"WorkPermitDefinationId": 24,
"IsOfflineData": true,
"DataCreationDate": "sample string 26",
"IsFromMobile": true,
"CancelledByHSEOfficerId": 28,
"DocumentId": 29,
"Title": "sample string 30",
"_userAccessPermissions": [
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
},
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
}
],
"UserAccessPermissions": [
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
},
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
}
]
}
},
{
"ProvisionalDocumentId": 1,
"FileId": 2,
"DocumentId": 3,
"GUIDFileName": "sample string 4",
"FileName": "sample string 5",
"FileSize": "sample string 6",
"FileVersion": 7.0,
"UploadedBy": 8,
"UploadedByName": "sample string 9",
"UploadedOn": "2024-11-15T11:14:57.1408584+05:30",
"comments": "sample string 11",
"FilePath": "sample string 12",
"Extention": "sample string 13",
"UploadedOnDateString": "sample string 14",
"sessionDto": {
"DepartmentName": "sample string 1",
"DepartmentId": 2,
"RoleId": 3,
"CurrentRoleName": "sample string 4",
"FirstName": "sample string 5",
"LastName": "sample string 6",
"UserId": 7,
"ObservationId": 8,
"IsElevated": true,
"IncidentId": 10,
"InjuredWorkerId": 11,
"InjuryCauseId": 12,
"CorrectiveActions": "sample string 13",
"HandSkillTrainingId": 14,
"CheckListId": 15,
"CheckListResponseId": 16,
"CustomerComplaintId": 17,
"WorkPermitId": 18,
"WorkPermitTypeId": 19,
"ProjectId": 20,
"WorkPermitStatus": "sample string 21",
"InspectionId": 22,
"ObservationIdlist": [
1,
2
],
"ClosedRemark": "sample string 23",
"WorkPermitDefinationId": 24,
"IsOfflineData": true,
"DataCreationDate": "sample string 26",
"IsFromMobile": true,
"CancelledByHSEOfficerId": 28,
"DocumentId": 29,
"Title": "sample string 30",
"_userAccessPermissions": [
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
},
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
}
],
"UserAccessPermissions": [
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
},
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
}
]
}
}
],
"FilesData": "sample string 19",
"MasterKeywordString": "sample string 20",
"CustomKeywordString": "sample string 21",
"LevelsString": "sample string 22",
"VerticalsString": "sample string 23",
"RegionsString": "sample string 24",
"ProjectsString": "sample string 25",
"FunctionsString": "sample string 26",
"PositionsString": "sample string 27",
"Levels": [
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
},
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
}
],
"Verticals": [
{
"Key": 1,
"Value": "sample string 2",
"FilterArray": [
1,
2
]
},
{
"Key": 1,
"Value": "sample string 2",
"FilterArray": [
1,
2
]
}
],
"Regions": [
{
"Key": 1,
"Value": "sample string 2",
"FilterArray": [
1,
2
]
},
{
"Key": 1,
"Value": "sample string 2",
"FilterArray": [
1,
2
]
}
],
"Projects": [
{
"Key": 1,
"Value": "sample string 2",
"FilterArray": [
1,
2
]
},
{
"Key": 1,
"Value": "sample string 2",
"FilterArray": [
1,
2
]
}
],
"Functions": [
{
"Key": 1,
"Value": "sample string 2",
"FilterArray": [
1,
2
]
},
{
"Key": 1,
"Value": "sample string 2",
"FilterArray": [
1,
2
]
}
],
"Positions": [
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
},
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
}
],
"levelIds": [
1,
2
],
"isCreator": true,
"isSpecialUser": true,
"isPreviousVersionAdded": true,
"Edit": true,
"AddKeyword": true,
"RemoveKeyword": true,
"Share": true,
"RevokeShare": true,
"View": true,
"Download": true,
"Upload": true,
"ProcessRequest": true,
"DownloadHistory": true,
"AddReference": true,
"DeleteReference": true,
"DeleteDocument": true,
"DeleteDocumentVersion": true,
"ChangeCreator": true,
"NoAccess": true
},
"DMSFileDetails": {
"ProvisionalDocumentId": 1,
"FileId": 2,
"DocumentId": 3,
"GUIDFileName": "sample string 4",
"FileName": "sample string 5",
"FileSize": "sample string 6",
"FileVersion": 7.0,
"UploadedBy": 8,
"UploadedByName": "sample string 9",
"UploadedOn": "2024-11-15T11:14:57.1408584+05:30",
"comments": "sample string 11",
"FilePath": "sample string 12",
"Extention": "sample string 13",
"UploadedOnDateString": "sample string 14",
"sessionDto": {
"DepartmentName": "sample string 1",
"DepartmentId": 2,
"RoleId": 3,
"CurrentRoleName": "sample string 4",
"FirstName": "sample string 5",
"LastName": "sample string 6",
"UserId": 7,
"ObservationId": 8,
"IsElevated": true,
"IncidentId": 10,
"InjuredWorkerId": 11,
"InjuryCauseId": 12,
"CorrectiveActions": "sample string 13",
"HandSkillTrainingId": 14,
"CheckListId": 15,
"CheckListResponseId": 16,
"CustomerComplaintId": 17,
"WorkPermitId": 18,
"WorkPermitTypeId": 19,
"ProjectId": 20,
"WorkPermitStatus": "sample string 21",
"InspectionId": 22,
"ObservationIdlist": [
1,
2
],
"ClosedRemark": "sample string 23",
"WorkPermitDefinationId": 24,
"IsOfflineData": true,
"DataCreationDate": "sample string 26",
"IsFromMobile": true,
"CancelledByHSEOfficerId": 28,
"DocumentId": 29,
"Title": "sample string 30",
"_userAccessPermissions": [
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
},
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
}
],
"UserAccessPermissions": [
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
},
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
}
]
}
},
"DocumentVersionList": [
{
"ProvisionalDocumentId": 1,
"FileId": 2,
"DocumentId": 3,
"GUIDFileName": "sample string 4",
"FileName": "sample string 5",
"FileSize": "sample string 6",
"FileVersion": 7.0,
"UploadedBy": 8,
"UploadedByName": "sample string 9",
"UploadedOn": "2024-11-15T11:14:57.1408584+05:30",
"comments": "sample string 11",
"FilePath": "sample string 12",
"Extention": "sample string 13",
"UploadedOnDateString": "sample string 14",
"sessionDto": {
"DepartmentName": "sample string 1",
"DepartmentId": 2,
"RoleId": 3,
"CurrentRoleName": "sample string 4",
"FirstName": "sample string 5",
"LastName": "sample string 6",
"UserId": 7,
"ObservationId": 8,
"IsElevated": true,
"IncidentId": 10,
"InjuredWorkerId": 11,
"InjuryCauseId": 12,
"CorrectiveActions": "sample string 13",
"HandSkillTrainingId": 14,
"CheckListId": 15,
"CheckListResponseId": 16,
"CustomerComplaintId": 17,
"WorkPermitId": 18,
"WorkPermitTypeId": 19,
"ProjectId": 20,
"WorkPermitStatus": "sample string 21",
"InspectionId": 22,
"ObservationIdlist": [
1,
2
],
"ClosedRemark": "sample string 23",
"WorkPermitDefinationId": 24,
"IsOfflineData": true,
"DataCreationDate": "sample string 26",
"IsFromMobile": true,
"CancelledByHSEOfficerId": 28,
"DocumentId": 29,
"Title": "sample string 30",
"_userAccessPermissions": [
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
},
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
}
],
"UserAccessPermissions": [
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
},
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
}
]
}
},
{
"ProvisionalDocumentId": 1,
"FileId": 2,
"DocumentId": 3,
"GUIDFileName": "sample string 4",
"FileName": "sample string 5",
"FileSize": "sample string 6",
"FileVersion": 7.0,
"UploadedBy": 8,
"UploadedByName": "sample string 9",
"UploadedOn": "2024-11-15T11:14:57.1408584+05:30",
"comments": "sample string 11",
"FilePath": "sample string 12",
"Extention": "sample string 13",
"UploadedOnDateString": "sample string 14",
"sessionDto": {
"DepartmentName": "sample string 1",
"DepartmentId": 2,
"RoleId": 3,
"CurrentRoleName": "sample string 4",
"FirstName": "sample string 5",
"LastName": "sample string 6",
"UserId": 7,
"ObservationId": 8,
"IsElevated": true,
"IncidentId": 10,
"InjuredWorkerId": 11,
"InjuryCauseId": 12,
"CorrectiveActions": "sample string 13",
"HandSkillTrainingId": 14,
"CheckListId": 15,
"CheckListResponseId": 16,
"CustomerComplaintId": 17,
"WorkPermitId": 18,
"WorkPermitTypeId": 19,
"ProjectId": 20,
"WorkPermitStatus": "sample string 21",
"InspectionId": 22,
"ObservationIdlist": [
1,
2
],
"ClosedRemark": "sample string 23",
"WorkPermitDefinationId": 24,
"IsOfflineData": true,
"DataCreationDate": "sample string 26",
"IsFromMobile": true,
"CancelledByHSEOfficerId": 28,
"DocumentId": 29,
"Title": "sample string 30",
"_userAccessPermissions": [
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
},
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
}
],
"UserAccessPermissions": [
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
},
{
"LevelId": 1,
"LevelName": "sample string 2",
"DepartmentId": 3,
"DepartmentName": "sample string 4",
"DepartmentType": "sample string 5",
"PositionId": 6,
"PositionName": "sample string 7",
"PositionImportance": 8
}
]
}
}
],
"PendingRequest": {
"PageTitle": "sample string 1",
"CurrentPageNumber": 2,
"SearchData": {},
"TotalDataCount": 4,
"DepartmentName": "sample string 5",
"DepartmentId": 6,
"CMContractConditions": [
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
},
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
}
],
"IsCallFromCMS": true,
"CMContractConditionsId": 8,
"CMCCKeywordType": [
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
},
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
}
],
"CMCCKeywordTypeId": 9,
"MeetingType": "sample string 10",
"SortOrder": "sample string 11",
"SortColumn": "sample string 12",
"PageSize": 13,
"SelectedPageNumber": 14,
"FormName": "sample string 15"
},
"DMSAddNewReference": {
"FromDocumentId": 1,
"ToDocumentNo": "sample string 2",
"Remark": "sample string 3",
"DocUploadAccess": true
},
"AttachmentId": 2,
"UploadedFile": {
"PageTitle": "sample string 1",
"CurrentPageNumber": 2,
"SearchData": {},
"TotalDataCount": 4,
"DepartmentName": "sample string 5",
"DepartmentId": 6,
"CMContractConditions": [
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
},
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
}
],
"IsCallFromCMS": true,
"CMContractConditionsId": 8,
"CMCCKeywordType": [
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
},
{
"Key": 1,
"Value": "sample string 2",
"FilterId": 1,
"SortSequence": 3,
"ValueConstant": "sample string 4"
}
],
"CMCCKeywordTypeId": 9,
"MeetingType": "sample string 10",
"SortOrder": "sample string 11",
"SortColumn": "sample string 12",
"PageSize": 13,
"SelectedPageNumber": 14,
"FormName": "sample string 15"
},
"ActionMethodName": "sample string 3",
"DocumentMasterId": "sample string 4",
"DocumentReference": "sample string 5",
"LoggedInUserId": 6,
"OnBackDocumentId": 7,
"IsViewDocCalledFromPendingRequest": true,
"IsViewDocCalledFromReference": true,
"ChangeCreatorDTO": {
"DocumentId": 1,
"NewCreatorId": 2,
"CurrentCreatorId": 3,
"Reason": "sample string 4",
"isCallFromSearchScreen": true,
"SelectedCreatorName": "sample string 6",
"SelectedEmployeeName": "sample string 7",
"CreatorUserList": [
{
"Key": 1,
"Value": "sample string 2",
"Category": "sample string 3",
"SortSequence": 4,
"SortOrderByFirstName": "sample string 5",
"Status": "sample string 6"
},
{
"Key": 1,
"Value": "sample string 2",
"Category": "sample string 3",
"SortSequence": 4,
"SortOrderByFirstName": "sample string 5",
"Status": "sample string 6"
}
],
"DMSChangeCreatorHistoryList": [
{
"CreatorLogId": 1,
"CreatorId": 2,
"CreatorName": "sample string 3",
"ChangedOn": "2024-11-15T11:14:57.1408584+05:30",
"ChangedOnDateString": "sample string 5",
"Reason": "sample string 6",
"isLastChangeCreatorRecord": true
},
{
"CreatorLogId": 1,
"CreatorId": 2,
"CreatorName": "sample string 3",
"ChangedOn": "2024-11-15T11:14:57.1408584+05:30",
"ChangedOnDateString": "sample string 5",
"Reason": "sample string 6",
"isLastChangeCreatorRecord": true
}
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.