Connector API
Search…
Business segments

Get all business segments

Returns all business segments of the default service provided by the enterprise.

Request

[PlatformAddress]/api/connector/v1/businessSegments/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"ServiceIds": [
6
"bd26d8db-86da-4f96-9efc-e5a4654a4a94"
7
]
8
}
Copied!
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ServiceIds
array of string
required
Unique identifiers of the Services from which the business segments are requested.

Response

1
{
2
"BusinessSegments": [
3
{
4
"Id": "7760b5cb-a666-41bb-9758-76bf5d1df399",
5
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
6
"IsActive": true,
7
"Name": "Business"
8
},
9
{
10
"Id": "54ec08b6-e6fc-48e9-b8ae-02943e0ac693",
11
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
12
"IsActive": true,
13
"Name": "Leisure"
14
}
15
]
16
}
Copied!
Property
Type
Contract
Description
BusinessSegments
array of Business segment
required
Business segments of the default service.

Business segment

Property
Type
Contract
Description
Id
string
required
Unique identifier of the segment.
ServiceId
string
required
Unique identifier of the Service.
IsActive
boolean
required
Whether the business segment is still active.
Name
string
required
Name of the segment.
Last modified 3mo ago