POST Api/MainDocuments/Search
Pobiera odfiltrowaną listę obiektów Document
Request Information
URI Parameters
None.
Body Parameters
ustawienia filtrowania i sortowania wyników
DocumentFilterName | Description | Type | Additional information |
---|---|---|---|
TextFilter |
Filtrowanie w zależności od tekstu. Jeśli null to brak filtrowania. |
string |
None. |
SortOrder |
Określa sposób sortowania wyników |
DocumentSortEnum |
Required |
TypeOfDocumentId |
Filtruje listę wyników według identyfikatora obiektu TypeOfDocument. Jeśli null to filtr jest pomijany. |
integer |
None. |
DocumentStatusId |
Filtruje listę wyników według identyfikatora obiektu DocumentStatus. Jeśli null to filtr jest pomijany. |
integer |
None. |
VersionOfDocumentId |
Filtruje listę wyników według identyfikatora obiektu VersionOfDocument. Jeśli null to filtr jest pomijany. |
integer |
None. |
OrganizationalUnitId |
Filtruje listę wyników według identyfikatora obiektu OrganizationalUnit. Jeśli null to filtr jest pomijany. |
integer |
None. |
WorkPositionId |
Filtruje listę wyników według identyfikatora obiektu WorkPosition. Jeśli null to filtr jest pomijany. |
integer |
None. |
RecruitmentProjectId |
Filtruje listę wyników według identyfikatora obiektu RecruitmentProject. Jeśli null to filtr jest pomijany. |
integer |
None. |
ContractStatusIds |
Filtruje listę wyników według identyfikatora obiektu ContractStatus. Jeśli null to filtr jest pomijany. |
Collection of integer |
None. |
FromStartDate | date |
None. |
|
ToStartDate | date |
None. |
|
FromEndDate | date |
None. |
|
ToEndDate | date |
None. |
|
FromCreationDate | date |
None. |
|
ToCreationDate | date |
None. |
|
FromLastUpdate | date |
None. |
|
ToLastUpdate | date |
None. |
|
ItemsPerPage |
Ilość obiektów na stronę |
integer |
None. |
CurrentPage |
Obecna strona |
integer |
None. |
Request Formats
application/json, text/json
{ "textFilter": "sample string 1", "sortOrder": 0, "typeOfDocumentId": 1, "documentStatusId": 1, "versionOfDocumentId": 1, "organizationalUnitId": 1, "workPositionId": 1, "recruitmentProjectId": 1, "contractStatusIds": [ 1, 2 ], "fromStartDate": "2024-05-18T06:16:05.6845087+00:00", "toStartDate": "2024-05-18T06:16:05.6845087+00:00", "fromEndDate": "2024-05-18T06:16:05.6845087+00:00", "toEndDate": "2024-05-18T06:16:05.6845087+00:00", "fromCreationDate": "2024-05-18T06:16:05.6845087+00:00", "toCreationDate": "2024-05-18T06:16:05.6845087+00:00", "fromLastUpdate": "2024-05-18T06:16:05.6845087+00:00", "toLastUpdate": "2024-05-18T06:16:05.6845087+00:00", "itemsPerPage": 2, "currentPage": 3 }
multipart/form-data
{"textFilter":"sample string 1","sortOrder":0,"typeOfDocumentId":1,"documentStatusId":1,"versionOfDocumentId":1,"organizationalUnitId":1,"workPositionId":1,"recruitmentProjectId":1,"contractStatusIds":[1,2],"fromStartDate":"2024-05-18T06:16:05.6845087+00:00","toStartDate":"2024-05-18T06:16:05.6845087+00:00","fromEndDate":"2024-05-18T06:16:05.6845087+00:00","toEndDate":"2024-05-18T06:16:05.6845087+00:00","fromCreationDate":"2024-05-18T06:16:05.6845087+00:00","toCreationDate":"2024-05-18T06:16:05.6845087+00:00","fromLastUpdate":"2024-05-18T06:16:05.6845087+00:00","toLastUpdate":"2024-05-18T06:16:05.6845087+00:00","itemsPerPage":2,"currentPage":3}
application/xml, text/xml
<DocumentFilter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ItemsPerPage>2</ItemsPerPage> <CurrentPage>3</CurrentPage> <TextFilter>sample string 1</TextFilter> <SortOrder>DocumentIdAsc</SortOrder> <TypeOfDocumentId>1</TypeOfDocumentId> <DocumentStatusId>1</DocumentStatusId> <VersionOfDocumentId>1</VersionOfDocumentId> <OrganizationalUnitId>1</OrganizationalUnitId> <WorkPositionId>1</WorkPositionId> <RecruitmentProjectId>1</RecruitmentProjectId> <ContractStatusIds> <int>1</int> <int>2</int> </ContractStatusIds> <FromStartDate>2024-05-18T06:16:05.6845087+00:00</FromStartDate> <ToStartDate>2024-05-18T06:16:05.6845087+00:00</ToStartDate> <FromEndDate>2024-05-18T06:16:05.6845087+00:00</FromEndDate> <ToEndDate>2024-05-18T06:16:05.6845087+00:00</ToEndDate> <FromCreationDate>2024-05-18T06:16:05.6845087+00:00</FromCreationDate> <ToCreationDate>2024-05-18T06:16:05.6845087+00:00</ToCreationDate> <FromLastUpdate>2024-05-18T06:16:05.6845087+00:00</FromLastUpdate> <ToLastUpdate>2024-05-18T06:16:05.6845087+00:00</ToLastUpdate> </DocumentFilter>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
lista obiektów Document zgodna z ustawieniem filtrowania oraz całkowita liczba wszystkich elementów w bazie spełniających kryteria (całkowita liczba obiektów jest obliczana tylo dla pierwszej strony CurrentPage == 0)
Collection of DocumentDtoName | Description | Type | Additional information |
---|---|---|---|
DocumentId | integer |
None. |
|
ProfileId | string |
Required |
|
AuthorId | string |
None. |
|
ApprovedBy | string |
None. |
|
TypeOfDocumentId | integer |
Required |
|
IsValid | boolean |
None. |
|
IsActive | boolean |
None. |
|
CreationDate | date |
None. |
|
DocumentNumber | string |
None. |
|
NumberOfDaysLimit | integer |
None. |
|
LastUpdate | date |
None. |
|
StartDate | date |
Required |
|
EndDate | date |
None. |
|
Comments | string |
None. |
|
Files | Collection of string |
None. |
|
FilesToUpload | Collection of IdentityDocDto |
None. |
|
DocumentStatusId | integer |
None. |
|
VersionOfDocumentId | integer |
None. |
|
OrganizationalUnitId | integer |
None. |
|
WorkPositionId | integer |
None. |
|
RecruitmentProjectId | integer |
None. |
|
IsPaid | boolean |
None. |
|
ProviderId | integer |
None. |
|
DkrSettings | string |
None. |
|
SigningDate | date |
None. |
|
ProfileName | string |
None. |
|
ProfileSurname | string |
None. |
|
ProfilePassportNumber | string |
None. |
|
AssignedTypeOfDocumentAttributes | Collection of AssignedTypeOfDocumentAttributeDto |
None. |
|
OrganizationalUnitName | string |
None. |
|
RecruitmentProjectName | string |
None. |
Response Formats
application/json, text/json
[ { "documentId": 1, "profileId": "sample string 2", "authorId": "sample string 3", "approvedBy": "sample string 4", "typeOfDocumentId": 5, "isValid": true, "isActive": true, "creationDate": "2024-05-18T06:16:05.7001375+00:00", "documentNumber": "sample string 9", "numberOfDaysLimit": 1, "lastUpdate": "2024-05-18T06:16:05.7001375+00:00", "startDate": "2024-05-18T06:16:05.7001375+00:00", "endDate": "2024-05-18T06:16:05.7001375+00:00", "comments": "sample string 11", "files": [ "sample string 1", "sample string 2" ], "filesToUpload": [ { "fileName": "sample string 1", "content": "sample string 2" }, { "fileName": "sample string 1", "content": "sample string 2" } ], "documentStatusId": 1, "versionOfDocumentId": 1, "organizationalUnitId": 1, "workPositionId": 1, "recruitmentProjectId": 1, "isPaid": true, "providerId": 1, "dkrSettings": "sample string 13", "signingDate": "2024-05-18T06:16:05.7001375+00:00", "profileName": "sample string 14", "profileSurname": "sample string 15", "profilePassportNumber": "sample string 16", "assignedTypeOfDocumentAttributes": [ { "assignedTypeOfDocumentAttributeId": 1, "typeOfDocumentAttributeId": 2, "documentId": 3, "value": "sample string 4" }, { "assignedTypeOfDocumentAttributeId": 1, "typeOfDocumentAttributeId": 2, "documentId": 3, "value": "sample string 4" } ], "organizationalUnitName": "sample string 17", "recruitmentProjectName": "sample string 18" }, { "documentId": 1, "profileId": "sample string 2", "authorId": "sample string 3", "approvedBy": "sample string 4", "typeOfDocumentId": 5, "isValid": true, "isActive": true, "creationDate": "2024-05-18T06:16:05.7001375+00:00", "documentNumber": "sample string 9", "numberOfDaysLimit": 1, "lastUpdate": "2024-05-18T06:16:05.7001375+00:00", "startDate": "2024-05-18T06:16:05.7001375+00:00", "endDate": "2024-05-18T06:16:05.7001375+00:00", "comments": "sample string 11", "files": [ "sample string 1", "sample string 2" ], "filesToUpload": [ { "fileName": "sample string 1", "content": "sample string 2" }, { "fileName": "sample string 1", "content": "sample string 2" } ], "documentStatusId": 1, "versionOfDocumentId": 1, "organizationalUnitId": 1, "workPositionId": 1, "recruitmentProjectId": 1, "isPaid": true, "providerId": 1, "dkrSettings": "sample string 13", "signingDate": "2024-05-18T06:16:05.7001375+00:00", "profileName": "sample string 14", "profileSurname": "sample string 15", "profilePassportNumber": "sample string 16", "assignedTypeOfDocumentAttributes": [ { "assignedTypeOfDocumentAttributeId": 1, "typeOfDocumentAttributeId": 2, "documentId": 3, "value": "sample string 4" }, { "assignedTypeOfDocumentAttributeId": 1, "typeOfDocumentAttributeId": 2, "documentId": 3, "value": "sample string 4" } ], "organizationalUnitName": "sample string 17", "recruitmentProjectName": "sample string 18" } ]
multipart/form-data
[{"documentId":1,"profileId":"sample string 2","authorId":"sample string 3","approvedBy":"sample string 4","typeOfDocumentId":5,"isValid":true,"isActive":true,"creationDate":"2024-05-18T06:16:05.7001375+00:00","documentNumber":"sample string 9","numberOfDaysLimit":1,"lastUpdate":"2024-05-18T06:16:05.7001375+00:00","startDate":"2024-05-18T06:16:05.7001375+00:00","endDate":"2024-05-18T06:16:05.7001375+00:00","comments":"sample string 11","files":["sample string 1","sample string 2"],"filesToUpload":[{"fileName":"sample string 1","content":"sample string 2"},{"fileName":"sample string 1","content":"sample string 2"}],"documentStatusId":1,"versionOfDocumentId":1,"organizationalUnitId":1,"workPositionId":1,"recruitmentProjectId":1,"isPaid":true,"providerId":1,"dkrSettings":"sample string 13","signingDate":"2024-05-18T06:16:05.7001375+00:00","profileName":"sample string 14","profileSurname":"sample string 15","profilePassportNumber":"sample string 16","assignedTypeOfDocumentAttributes":[{"assignedTypeOfDocumentAttributeId":1,"typeOfDocumentAttributeId":2,"documentId":3,"value":"sample string 4"},{"assignedTypeOfDocumentAttributeId":1,"typeOfDocumentAttributeId":2,"documentId":3,"value":"sample string 4"}],"organizationalUnitName":"sample string 17","recruitmentProjectName":"sample string 18"},{"documentId":1,"profileId":"sample string 2","authorId":"sample string 3","approvedBy":"sample string 4","typeOfDocumentId":5,"isValid":true,"isActive":true,"creationDate":"2024-05-18T06:16:05.7001375+00:00","documentNumber":"sample string 9","numberOfDaysLimit":1,"lastUpdate":"2024-05-18T06:16:05.7001375+00:00","startDate":"2024-05-18T06:16:05.7001375+00:00","endDate":"2024-05-18T06:16:05.7001375+00:00","comments":"sample string 11","files":["sample string 1","sample string 2"],"filesToUpload":[{"fileName":"sample string 1","content":"sample string 2"},{"fileName":"sample string 1","content":"sample string 2"}],"documentStatusId":1,"versionOfDocumentId":1,"organizationalUnitId":1,"workPositionId":1,"recruitmentProjectId":1,"isPaid":true,"providerId":1,"dkrSettings":"sample string 13","signingDate":"2024-05-18T06:16:05.7001375+00:00","profileName":"sample string 14","profileSurname":"sample string 15","profilePassportNumber":"sample string 16","assignedTypeOfDocumentAttributes":[{"assignedTypeOfDocumentAttributeId":1,"typeOfDocumentAttributeId":2,"documentId":3,"value":"sample string 4"},{"assignedTypeOfDocumentAttributeId":1,"typeOfDocumentAttributeId":2,"documentId":3,"value":"sample string 4"}],"organizationalUnitName":"sample string 17","recruitmentProjectName":"sample string 18"}]
application/xml, text/xml
<ArrayOfDocumentDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <DocumentDto> <DocumentId>1</DocumentId> <ProfileId>sample string 2</ProfileId> <AuthorId>sample string 3</AuthorId> <ApprovedBy>sample string 4</ApprovedBy> <TypeOfDocumentId>5</TypeOfDocumentId> <IsValid>true</IsValid> <IsActive>true</IsActive> <CreationDate /> <DocumentNumber>sample string 9</DocumentNumber> <NumberOfDaysLimit>1</NumberOfDaysLimit> <LastUpdate /> <StartDate /> <EndDate /> <Comments>sample string 11</Comments> <Files> <string>sample string 1</string> <string>sample string 2</string> </Files> <FilesToUpload> <IdentityDocDto> <FileName>sample string 1</FileName> <Content>sample string 2</Content> </IdentityDocDto> <IdentityDocDto> <FileName>sample string 1</FileName> <Content>sample string 2</Content> </IdentityDocDto> </FilesToUpload> <DocumentStatusId>1</DocumentStatusId> <VersionOfDocumentId>1</VersionOfDocumentId> <OrganizationalUnitId>1</OrganizationalUnitId> <WorkPositionId>1</WorkPositionId> <RecruitmentProjectId>1</RecruitmentProjectId> <IsPaid>true</IsPaid> <ProviderId>1</ProviderId> <DkrSettings>sample string 13</DkrSettings> <SigningDate /> <ProfileName>sample string 14</ProfileName> <ProfileSurname>sample string 15</ProfileSurname> <ProfilePassportNumber>sample string 16</ProfilePassportNumber> <AssignedTypeOfDocumentAttributes> <AssignedTypeOfDocumentAttributeDto> <AssignedTypeOfDocumentAttributeId>1</AssignedTypeOfDocumentAttributeId> <TypeOfDocumentAttributeId>2</TypeOfDocumentAttributeId> <DocumentId>3</DocumentId> <Value>sample string 4</Value> </AssignedTypeOfDocumentAttributeDto> <AssignedTypeOfDocumentAttributeDto> <AssignedTypeOfDocumentAttributeId>1</AssignedTypeOfDocumentAttributeId> <TypeOfDocumentAttributeId>2</TypeOfDocumentAttributeId> <DocumentId>3</DocumentId> <Value>sample string 4</Value> </AssignedTypeOfDocumentAttributeDto> </AssignedTypeOfDocumentAttributes> <OrganizationalUnitName>sample string 17</OrganizationalUnitName> <RecruitmentProjectName>sample string 18</RecruitmentProjectName> </DocumentDto> <DocumentDto> <DocumentId>1</DocumentId> <ProfileId>sample string 2</ProfileId> <AuthorId>sample string 3</AuthorId> <ApprovedBy>sample string 4</ApprovedBy> <TypeOfDocumentId>5</TypeOfDocumentId> <IsValid>true</IsValid> <IsActive>true</IsActive> <CreationDate /> <DocumentNumber>sample string 9</DocumentNumber> <NumberOfDaysLimit>1</NumberOfDaysLimit> <LastUpdate /> <StartDate /> <EndDate /> <Comments>sample string 11</Comments> <Files> <string>sample string 1</string> <string>sample string 2</string> </Files> <FilesToUpload> <IdentityDocDto> <FileName>sample string 1</FileName> <Content>sample string 2</Content> </IdentityDocDto> <IdentityDocDto> <FileName>sample string 1</FileName> <Content>sample string 2</Content> </IdentityDocDto> </FilesToUpload> <DocumentStatusId>1</DocumentStatusId> <VersionOfDocumentId>1</VersionOfDocumentId> <OrganizationalUnitId>1</OrganizationalUnitId> <WorkPositionId>1</WorkPositionId> <RecruitmentProjectId>1</RecruitmentProjectId> <IsPaid>true</IsPaid> <ProviderId>1</ProviderId> <DkrSettings>sample string 13</DkrSettings> <SigningDate /> <ProfileName>sample string 14</ProfileName> <ProfileSurname>sample string 15</ProfileSurname> <ProfilePassportNumber>sample string 16</ProfilePassportNumber> <AssignedTypeOfDocumentAttributes> <AssignedTypeOfDocumentAttributeDto> <AssignedTypeOfDocumentAttributeId>1</AssignedTypeOfDocumentAttributeId> <TypeOfDocumentAttributeId>2</TypeOfDocumentAttributeId> <DocumentId>3</DocumentId> <Value>sample string 4</Value> </AssignedTypeOfDocumentAttributeDto> <AssignedTypeOfDocumentAttributeDto> <AssignedTypeOfDocumentAttributeId>1</AssignedTypeOfDocumentAttributeId> <TypeOfDocumentAttributeId>2</TypeOfDocumentAttributeId> <DocumentId>3</DocumentId> <Value>sample string 4</Value> </AssignedTypeOfDocumentAttributeDto> </AssignedTypeOfDocumentAttributes> <OrganizationalUnitName>sample string 17</OrganizationalUnitName> <RecruitmentProjectName>sample string 18</RecruitmentProjectName> </DocumentDto> </ArrayOfDocumentDto>