GET api/v1/Segments?folderId={folderId}

Returns an list of segments based on folderId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
folderId

Id of the folder

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of SegmentDto
NameDescriptionTypeAdditional information
Id

Id of Segment

integer

None.

Name

Name of Segment

string

None.

FolderId

Id of the folder where the segment is placed

integer

None.

Type

Type of Segment

SegmentType

None.

Description

Description of Segment

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "FolderId": 3,
    "Type": "VisualBuilder",
    "Description": "sample string 4"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "FolderId": 3,
    "Type": "VisualBuilder",
    "Description": "sample string 4"
  }
]