List Segments in Environment

Retrieve the segments in an FME environment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Access requirements

The Authorization Bearer (Admin API Key authorizing the request) must have one of the following roles and scopes:

Admin API Key roles accepted

  • API_ALL_GRANTED
  • API_SEGMENT_VIEWER
  • API_SEGMENT_EDITOR

Admin API Key scopes accepted

  • GLOBAL
  • WORKSPACE
  • ENVIRONMENT

To learn more about Admin API Key roles and scopes, see API keys overview.


JSON Received

{
    "objects": [ SEGMENT_IN_ENVIRONMENT ], // Array of Segments returned
    "offset": Number, // Offset received
    "limit": Number, // Limit received
    "totalCount": Number // Total number of Segments for the environment
}
Path Params
string
required

The ID of the project (workspace) for the FME environment. After migration to Harness, get this value using the Get Projects (Workspaces) endpoint and the Harness project name.

string
required

The ID or case-sensitive name of the FME environment to get a list of segments from

Query Params
int32
Defaults to 0

The offset to retrieve. Useful for pagination

int32
Defaults to 20

The maximum segments to return per call. Default=20. Max=50.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json