GET api/Projects?projectId={projectId}&isDataLake={isDataLake}

Retrieves a list of subcontract close-out records for the specified project, filtered by the provided criteria.

Request Information

URI Parameters

Name	Description	Type	Additional information
projectId	The unique identifier of the project for which subcontract close-out records are requested.	integer	Required
isDataLake		boolean	Required

Body Parameters

An object containing the filtering criteria to apply when retrieving the subcontract close-out records.

SubcontractCloseOutsFilter

Name	Type	Additional information
SubcontractorCode	string	None.
SubcontractorName	string	None.
SubcontractCode	string	None.
SubcontractTitle	string	None.
SubcontractStatusId	SubcontractStatusId	None.
SubcontractType	SubcontractTypeId	None.
IsOperative	boolean	None.
CurrentPo	Collection of decimal number	None.
Page	Page	None.
SortedColumns	Collection of Order	None.

Request Formats

application/json, text/json

Sample:

{
  "subcontractorCode": "sample string 2",
  "subcontractorName": "sample string 3",
  "subcontractCode": "sample string 4",
  "subcontractTitle": "sample string 5",
  "subcontractStatusId": 1,
  "subcontractType": 1,
  "isOperative": true,
  "currentPo": [
    1.0,
    1.0
  ],
  "page": {
    "number": 1,
    "size": 2,
    "skip": 0
  },
  "sortedColumns": [
    {
      "name": "sample string 1",
      "descending": true
    },
    {
      "name": "sample string 1",
      "descending": true
    }
  ]
}

text/html

Sample:

{"subcontractorCode":"sample string 2","subcontractorName":"sample string 3","subcontractCode":"sample string 4","subcontractTitle":"sample string 5","subcontractStatusId":1,"subcontractType":1,"isOperative":true,"currentPo":[1.0,1.0],"page":{"number":1,"size":2,"skip":0},"sortedColumns":[{"name":"sample string 1","descending":true},{"name":"sample string 1","descending":true}]}

application/xml, text/xml

Sample:

<SubcontractCloseOutsFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.ProjectAgg">
  <Page xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities">
    <Number>1</Number>
    <Size>2</Size>
  </Page>
  <SortedColumns xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities">
    <Order>
      <Descending>true</Descending>
      <Name>sample string 1</Name>
    </Order>
    <Order>
      <Descending>true</Descending>
      <Name>sample string 1</Name>
    </Order>
  </SortedColumns>
  <CurrentPo xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>1</d2p1:decimal>
  </CurrentPo>
  <IsOperative>true</IsOperative>
  <SubcontractCode>sample string 4</SubcontractCode>
  <SubcontractStatusId>Draft</SubcontractStatusId>
  <SubcontractTitle>sample string 5</SubcontractTitle>
  <SubcontractType>Both</SubcontractType>
  <SubcontractorCode>sample string 2</SubcontractorCode>
  <SubcontractorName>sample string 3</SubcontractorName>
</SubcontractCloseOutsFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A task that represents the asynchronous operation. The task result contains an representing the HTTP response, which includes the filtered list of subcontract close-out records.

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.