POST api/Help/GenerateScript

Request Information

URI Parameters

None.

Body Parameters

Collection of PageHelpCollection

Name	Description	Type	Additional information
Key		string	None.
Items		Collection of PageHelp	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "Key": "sample string 1",
    "Items": [
      {
        "Key": "sample string 1",
        "Title": "sample string 2",
        "Abstract": "sample string 3",
        "Sections": [
          {
            "Topic": "sample string 1",
            "Content": "sample string 2"
          },
          {
            "Topic": "sample string 1",
            "Content": "sample string 2"
          }
        ],
        "FieldTooltip": true
      },
      {
        "Key": "sample string 1",
        "Title": "sample string 2",
        "Abstract": "sample string 3",
        "Sections": [
          {
            "Topic": "sample string 1",
            "Content": "sample string 2"
          },
          {
            "Topic": "sample string 1",
            "Content": "sample string 2"
          }
        ],
        "FieldTooltip": true
      }
    ]
  },
  {
    "Key": "sample string 1",
    "Items": [
      {
        "Key": "sample string 1",
        "Title": "sample string 2",
        "Abstract": "sample string 3",
        "Sections": [
          {
            "Topic": "sample string 1",
            "Content": "sample string 2"
          },
          {
            "Topic": "sample string 1",
            "Content": "sample string 2"
          }
        ],
        "FieldTooltip": true
      },
      {
        "Key": "sample string 1",
        "Title": "sample string 2",
        "Abstract": "sample string 3",
        "Sections": [
          {
            "Topic": "sample string 1",
            "Content": "sample string 2"
          },
          {
            "Topic": "sample string 1",
            "Content": "sample string 2"
          }
        ],
        "FieldTooltip": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPageHelpCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common">
  <PageHelpCollection>
    <Items>
      <PageHelp>
        <Abstract>sample string 3</Abstract>
        <FieldTooltip>true</FieldTooltip>
        <Key>sample string 1</Key>
        <Sections>
          <HelpPageSection>
            <Content>sample string 2</Content>
            <Topic>sample string 1</Topic>
          </HelpPageSection>
          <HelpPageSection>
            <Content>sample string 2</Content>
            <Topic>sample string 1</Topic>
          </HelpPageSection>
        </Sections>
        <Title>sample string 2</Title>
      </PageHelp>
      <PageHelp>
        <Abstract>sample string 3</Abstract>
        <FieldTooltip>true</FieldTooltip>
        <Key>sample string 1</Key>
        <Sections>
          <HelpPageSection>
            <Content>sample string 2</Content>
            <Topic>sample string 1</Topic>
          </HelpPageSection>
          <HelpPageSection>
            <Content>sample string 2</Content>
            <Topic>sample string 1</Topic>
          </HelpPageSection>
        </Sections>
        <Title>sample string 2</Title>
      </PageHelp>
    </Items>
    <Key>sample string 1</Key>
  </PageHelpCollection>
  <PageHelpCollection>
    <Items>
      <PageHelp>
        <Abstract>sample string 3</Abstract>
        <FieldTooltip>true</FieldTooltip>
        <Key>sample string 1</Key>
        <Sections>
          <HelpPageSection>
            <Content>sample string 2</Content>
            <Topic>sample string 1</Topic>
          </HelpPageSection>
          <HelpPageSection>
            <Content>sample string 2</Content>
            <Topic>sample string 1</Topic>
          </HelpPageSection>
        </Sections>
        <Title>sample string 2</Title>
      </PageHelp>
      <PageHelp>
        <Abstract>sample string 3</Abstract>
        <FieldTooltip>true</FieldTooltip>
        <Key>sample string 1</Key>
        <Sections>
          <HelpPageSection>
            <Content>sample string 2</Content>
            <Topic>sample string 1</Topic>
          </HelpPageSection>
          <HelpPageSection>
            <Content>sample string 2</Content>
            <Topic>sample string 1</Topic>
          </HelpPageSection>
        </Sections>
        <Title>sample string 2</Title>
      </PageHelp>
    </Items>
    <Key>sample string 1</Key>
  </PageHelpCollection>
</ArrayOfPageHelpCollection>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

sqlResult

Name	Description	Type	Additional information
Script		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Script": "sample string 1"
}

application/xml, text/xml

Sample:

<HelpController.sqlResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POLiConsoleAPI.External.Controllers">
  <Script>sample string 1</Script>
</HelpController.sqlResult>