POST api/SubProject/Create

Create a SubProject

Request Information

URI Parameters

None.

Body Parameters

SubProjectCreateBinder
NameDescriptionTypeAdditional information
ProjectId

integer

None.
Position

Indicate where the subproject will be inserted to

 InsertPosition

None.
GeneralInfo

TSubProjectInfo

None.
CustomFieldValues

Four custom fields are supported by SubProject, their field id are follows: 1001, 1002, 1003, 1004

 Collection of FieldValueBinder

None.
Members

Collection of MemberIdObject

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProjectId": 1,
  "Position": {
    "Option": 1,
    "RelatedId": 2
  },
  "GeneralInfo": {
    "StatusId": 1,
    "PrimaryManagerId": 1,
    "PriorityId": 1,
    "PlanStartDate": "2024-12-21 18:42:58",
    "PlanFinishDate": "2024-12-21 18:42:58",
    "SupportReleaseBacklog": 1,
    "SupportSubReleaseOption": 1,
    "TeamSupportOption": 1,
    "PSTypeId": 1,
    "DelayStatus": 1,
    "ProgressDescription": "sample string 5",
    "DelayDays": 1,
    "DelayReason": "sample string 6",
    "Description": "sample string 7",
    "ReleaseId": 1,
    "AccessOption": 1,
    "AccessInheritanceOption": 1,
    "SyncOptionForPPMTitle": 1,
    "SyncOptionForPPMReleaseInfo": 1,
    "MilestoneId": 1,
    "ProjectHierarchyId": 1,
    "SubProjectName": "sample string 8",
    "SubProjectType": 1,
    "DevelopmentMethod": 1
  },
  "CustomFieldValues": [
    {
      "FieldId": 1,
      "Option": 1,
      "FieldValue": {}
    },
    {
      "FieldId": 1,
      "Option": 1,
      "FieldValue": {}
    }
  ],
  "Members": [
    {
      "Id": 1,
      "Option": 2
    },
    {
      "Id": 1,
      "Option": 2
    }
  ]
}

application/xml, text/xml

Sample: 
<SubProjectCreateBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <CustomFieldValues>
    <FieldValueBinder>
      <FieldId>1</FieldId>
      <FieldValue />
      <Option>1</Option>
    </FieldValueBinder>
    <FieldValueBinder>
      <FieldId>1</FieldId>
      <FieldValue />
      <Option>1</Option>
    </FieldValueBinder>
  </CustomFieldValues>
  <GeneralInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.SubProject">
    <d2p1:DevelopmentMethod>1</d2p1:DevelopmentMethod>
    <d2p1:SubProjectName>sample string 8</d2p1:SubProjectName>
    <d2p1:SubProjectType>1</d2p1:SubProjectType>
    <d2p1:AccessInheritanceOption>1</d2p1:AccessInheritanceOption>
    <d2p1:AccessOption>1</d2p1:AccessOption>
    <d2p1:CustomField1>sample string 1</d2p1:CustomField1>
    <d2p1:CustomField2>sample string 2</d2p1:CustomField2>
    <d2p1:CustomField3>sample string 3</d2p1:CustomField3>
    <d2p1:CustomField4>sample string 4</d2p1:CustomField4>
    <d2p1:DelayDays>1</d2p1:DelayDays>
    <d2p1:DelayReason>sample string 6</d2p1:DelayReason>
    <d2p1:DelayStatus>1</d2p1:DelayStatus>
    <d2p1:Description>sample string 7</d2p1:Description>
    <d2p1:MilestoneId>1</d2p1:MilestoneId>
    <d2p1:PSTypeId>1</d2p1:PSTypeId>
    <d2p1:PlanFinishDate>2024-12-21T18:42:58.8725213-08:00</d2p1:PlanFinishDate>
    <d2p1:PlanStartDate>2024-12-21T18:42:58.8725213-08:00</d2p1:PlanStartDate>
    <d2p1:PrimaryManagerId>1</d2p1:PrimaryManagerId>
    <d2p1:PriorityId>1</d2p1:PriorityId>
    <d2p1:ProgressDescription>sample string 5</d2p1:ProgressDescription>
    <d2p1:ProjectHierarchyId>1</d2p1:ProjectHierarchyId>
    <d2p1:ReleaseId>1</d2p1:ReleaseId>
    <d2p1:StatusId>1</d2p1:StatusId>
    <d2p1:SupportReleaseBacklog>1</d2p1:SupportReleaseBacklog>
    <d2p1:SupportSubReleaseOption>1</d2p1:SupportSubReleaseOption>
    <d2p1:SyncOptionForPPMReleaseInfo>1</d2p1:SyncOptionForPPMReleaseInfo>
    <d2p1:SyncOptionForPPMTitle>1</d2p1:SyncOptionForPPMTitle>
    <d2p1:TeamSupportOption>1</d2p1:TeamSupportOption>
  </GeneralInfo>
  <Members xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
    <d2p1:MemberIdObject>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Option>2</d2p1:Option>
    </d2p1:MemberIdObject>
    <d2p1:MemberIdObject>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Option>2</d2p1:Option>
    </d2p1:MemberIdObject>
  </Members>
  <Position xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.SubProject">
    <d2p1:Option>1</d2p1:Option>
    <d2p1:RelatedId>2</d2p1:RelatedId>
  </Position>
  <ProjectId>1</ProjectId>
</SubProjectCreateBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Create a SubProject

API_Data_Int32
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.
Data

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": 2
}

application/xml, text/xml

Sample: 
<API_Data_int xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Data>2</Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_int>