POST api/WorkObjective/Query

Query work objective

Request Information

URI Parameters

None.

Body Parameters

QueryWorkObjectiveBinder
NameDescriptionTypeAdditional information
ProjectId

integer

None.
SprintId

integer

None.
Condition

WorkObjectiveQueryCondition

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProjectId": 1,
  "SprintId": 2,
  "Condition": {
    "WorkObjectiveId": [
      1,
      2
    ],
    "OwnerId": [
      1,
      2
    ]
  }
}

application/xml, text/xml

Sample: 
<QueryWorkObjectiveBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <Condition>
    <OwnerId xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </OwnerId>
    <WorkObjectiveId xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </WorkObjectiveId>
  </Condition>
  <ProjectId>1</ProjectId>
  <SprintId>2</SprintId>
</QueryWorkObjectiveBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Query work objective

API_Data_ListOfWorkObjectiveListItem
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.
Data

Collection of WorkObjectiveListItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": [
    {
      "ProjectBaseID": 1,
      "WorkObjectiveID": 2,
      "Title": "sample string 3",
      "ParentSubProjectId": 4,
      "ParentSubProjectName": "sample string 5",
      "StateID": 1,
      "StateName": "sample string 6",
      "OwnerID": 1,
      "OwnerName": "sample string 7",
      "PlanedStartDate": "2024-12-21",
      "PlanedEndDate": "2024-12-21",
      "Points": 1,
      "SystemWorkType": 1,
      "WorkType": 1,
      "WorkTypeName": "sample string 8",
      "Achieved": 9,
      "ActualPoints": 10.1,
      "StandardWorkTemplateProjectID": 1,
      "StandardWorkTemplateID": 1
    },
    {
      "ProjectBaseID": 1,
      "WorkObjectiveID": 2,
      "Title": "sample string 3",
      "ParentSubProjectId": 4,
      "ParentSubProjectName": "sample string 5",
      "StateID": 1,
      "StateName": "sample string 6",
      "OwnerID": 1,
      "OwnerName": "sample string 7",
      "PlanedStartDate": "2024-12-21",
      "PlanedEndDate": "2024-12-21",
      "Points": 1,
      "SystemWorkType": 1,
      "WorkType": 1,
      "WorkTypeName": "sample string 8",
      "Achieved": 9,
      "ActualPoints": 10.1,
      "StandardWorkTemplateProjectID": 1,
      "StandardWorkTemplateID": 1
    }
  ]
}

application/xml, text/xml

Sample: 
<API_Data_ArrayOfWorkObjectiveListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Entities">
    <d2p1:WorkObjectiveListItem>
      <d2p1:Achieved>9</d2p1:Achieved>
      <d2p1:ActualPoints>10.1</d2p1:ActualPoints>
      <d2p1:OwnerID>1</d2p1:OwnerID>
      <d2p1:OwnerName>sample string 7</d2p1:OwnerName>
      <d2p1:ParentSubProjectId>4</d2p1:ParentSubProjectId>
      <d2p1:ParentSubProjectName>sample string 5</d2p1:ParentSubProjectName>
      <d2p1:PlanedEndDate>2024-12-21T19:26:40.205084-08:00</d2p1:PlanedEndDate>
      <d2p1:PlanedStartDate>2024-12-21T19:26:40.205084-08:00</d2p1:PlanedStartDate>
      <d2p1:Points>1</d2p1:Points>
      <d2p1:ProjectBaseID>1</d2p1:ProjectBaseID>
      <d2p1:StandardWorkTemplateID>1</d2p1:StandardWorkTemplateID>
      <d2p1:StandardWorkTemplateProjectID>1</d2p1:StandardWorkTemplateProjectID>
      <d2p1:StateID>1</d2p1:StateID>
      <d2p1:StateName>sample string 6</d2p1:StateName>
      <d2p1:SystemWorkType>1</d2p1:SystemWorkType>
      <d2p1:Title>sample string 3</d2p1:Title>
      <d2p1:WorkObjectiveID>2</d2p1:WorkObjectiveID>
      <d2p1:WorkType>1</d2p1:WorkType>
      <d2p1:WorkTypeName>sample string 8</d2p1:WorkTypeName>
    </d2p1:WorkObjectiveListItem>
    <d2p1:WorkObjectiveListItem>
      <d2p1:Achieved>9</d2p1:Achieved>
      <d2p1:ActualPoints>10.1</d2p1:ActualPoints>
      <d2p1:OwnerID>1</d2p1:OwnerID>
      <d2p1:OwnerName>sample string 7</d2p1:OwnerName>
      <d2p1:ParentSubProjectId>4</d2p1:ParentSubProjectId>
      <d2p1:ParentSubProjectName>sample string 5</d2p1:ParentSubProjectName>
      <d2p1:PlanedEndDate>2024-12-21T19:26:40.205084-08:00</d2p1:PlanedEndDate>
      <d2p1:PlanedStartDate>2024-12-21T19:26:40.205084-08:00</d2p1:PlanedStartDate>
      <d2p1:Points>1</d2p1:Points>
      <d2p1:ProjectBaseID>1</d2p1:ProjectBaseID>
      <d2p1:StandardWorkTemplateID>1</d2p1:StandardWorkTemplateID>
      <d2p1:StandardWorkTemplateProjectID>1</d2p1:StandardWorkTemplateProjectID>
      <d2p1:StateID>1</d2p1:StateID>
      <d2p1:StateName>sample string 6</d2p1:StateName>
      <d2p1:SystemWorkType>1</d2p1:SystemWorkType>
      <d2p1:Title>sample string 3</d2p1:Title>
      <d2p1:WorkObjectiveID>2</d2p1:WorkObjectiveID>
      <d2p1:WorkType>1</d2p1:WorkType>
      <d2p1:WorkTypeName>sample string 8</d2p1:WorkTypeName>
    </d2p1:WorkObjectiveListItem>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_ArrayOfWorkObjectiveListItem>