GET api/Configuration/Systems?Offset={Offset}&Limit={Limit}&Sort={Sort}&Filter={Filter}&IncludeAllParents={IncludeAllParents}

List all Systems

Request Information

URI Parameters

Name

Description

Type

Additional information

Offset	Number of items to skip from the start	integer	Equal or above: 0
Limit	Maximum number of items to return	integer	Equal or above: 1
Sort	Field to sort by	string	None.

Filter

JSON formated filter (see using filters), see SystemFilterParams

string

None.

IncludeAllParents

if true, then all parent Systems are included, even if the user does not have access to them

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of System

Name	Description	Type	Additional information
Parent		string	None.
Selectable	if true, the user has access to this System	boolean	None.
Code		string	None.
Description		string	None.

Response Formats

Sample:

[
  {
    "Parent": "sample string 1",
    "Selectable": true,
    "Code": "sample string 2",
    "Description": "sample string 3"
  },
  {
    "Parent": "sample string 1",
    "Selectable": true,
    "Code": "sample string 2",
    "Description": "sample string 3"
  }
]

Sample:

<ArrayOfSystem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.Parametrizacao">
  <System>
    <Code xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.ManWinWin">sample string 2</Code>
    <Description xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.ManWinWin">sample string 3</Description>
    <Parent>sample string 1</Parent>
    <Selectable>true</Selectable>
  </System>
  <System>
    <Code xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.ManWinWin">sample string 2</Code>
    <Description xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.ManWinWin">sample string 3</Description>
    <Parent>sample string 1</Parent>
    <Selectable>true</Selectable>
  </System>
</ArrayOfSystem>

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Parent"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Selectable"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Code"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Description"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Parent"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Selectable"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Code"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Description"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e--

Sample:

Returns an excel file