POST api/GUI/EditingPages

Get all fields that should be displayed on the editing pages

Request Information

URI Parameters

None.

Body Parameters

EditingPageFieldsBinder
NameDescriptionTypeAdditional information
ProjectId

integer

None.
TaskId

integer

None.
ForwardAction

If not perform a forward action, omit it(set it to be null)

 ForwardIdObject

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProjectId": 1,
  "TaskId": 2,
  "ForwardAction": {
    "TransitionId": 1,
    "NextStatusId": 2
  }
}

application/xml, text/xml

Sample: 
<EditingPageFieldsBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <ForwardAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
    <d2p1:NextStatusId>2</d2p1:NextStatusId>
    <d2p1:TransitionId>1</d2p1:TransitionId>
  </ForwardAction>
  <ProjectId>1</ProjectId>
  <TaskId>2</TaskId>
</EditingPageFieldsBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get all fields that should be displayed on the editing pages

API_Data_EditingPageFielsResponse
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.
Data

EditingPageFielsResponse

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": {
    "TabOption": {
      "EnableSingleTab": true,
      "SingleTabName": "sample string 2"
    },
    "Pages": [
      {
        "PageId": 1,
        "PageName": "sample string 2",
        "ParentPageId": 3,
        "Customizable": false
      },
      {
        "PageId": 1,
        "PageName": "sample string 2",
        "ParentPageId": 3,
        "Customizable": false
      }
    ],
    "FieldValues": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "Value": "sample string 3",
        "ChoiceId": {}
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "Value": "sample string 3",
        "ChoiceId": {}
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<API_Data_EditingPageFielsResponse 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.Project.GUI">
    <d2p1:FieldValues xmlns:d3p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Task">
      <d3p1:TFieldValue>
        <d3p1:ChoiceId />
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:TFieldValue>
      <d3p1:TFieldValue>
        <d3p1:ChoiceId />
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:TFieldValue>
    </d2p1:FieldValues>
    <d2p1:Pages>
      <d2p1:PageControl>
        <d2p1:Fields i:nil="true" />
        <d2p1:NotCustomizable>true</d2p1:NotCustomizable>
        <d2p1:PageId>1</d2p1:PageId>
        <d2p1:PageName>sample string 2</d2p1:PageName>
        <d2p1:ParentPageId>3</d2p1:ParentPageId>
      </d2p1:PageControl>
      <d2p1:PageControl>
        <d2p1:Fields i:nil="true" />
        <d2p1:NotCustomizable>true</d2p1:NotCustomizable>
        <d2p1:PageId>1</d2p1:PageId>
        <d2p1:PageName>sample string 2</d2p1:PageName>
        <d2p1:ParentPageId>3</d2p1:ParentPageId>
      </d2p1:PageControl>
    </d2p1:Pages>
    <d2p1:TabOption>
      <d2p1:EnableSingleTab>true</d2p1:EnableSingleTab>
      <d2p1:SingleTabName>sample string 2</d2p1:SingleTabName>
    </d2p1:TabOption>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_EditingPageFielsResponse>