Business segments
Get all business segments
Returns all business segments of the default service provided by the enterprise. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/businessSegments/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| string | optional, max 1000 items | Unique identifiers of the requested Bussiness segment. |
| array of string | required | Unique identifiers of the Services from which the business segments are requested. |
| optional, max length 3 months | Interval in which Business segment was updated. | |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Business segment | required | Business segments of the default service. |
| string | optional | Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned. |
Business segment
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the segment. |
| string | required | Unique identifier of the Service. |
| boolean | required | Whether the business segment is still active. |
| string | required | Name of the segment. |
| string | required | Creation date and time of the business segment in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the business segment in UTC timezone in ISO 8601 format. |
Last updated