Read API Service Operation

GET {{apiPath}}/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}

The GET /environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}} request returns data for the API service operation resource, identified by its ID in the request URL.

This operation supports the use of the expand query parameter. If the server operation defines group or scope requirements, the expand query parameter can be used to obtain information about the related resources. When used, additional data is included in the response's _embedded field.

If the server operation defines application permission access requirements, each member of _embedded.operations will include a permission HAL link in the response's _links field.

Query parameterDescriptionValue
expandShows additional information from related resources in the response data.
  • groups
  • scopes
Multiple values can be separated by commas. For example, expand=groups,scopes.

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers/c43c112c-5835-457e-af92-f77aa192fabe/operations/40eed306-a15c-4c8f-9d5f-4ed2e5bd441d"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"apiServer":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers/c43c112c-5835-457e-af92-f77aa192fabe"},"permission":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationResources/c43c112c-5835-457e-af92-f77aa192fabe/permissions/0d2be05d-9ca4-4f98-8c0c-50af0ae5019d"}},"_embedded":{"groups":[{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups/66feb0da-1181-4d3c-af58-6ba8dac61706"}},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"id":"66feb0da-1181-4d3c-af58-6ba8dac61706"}],"scopes":[{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/25169e5b-15a3-41be-b481-1f94779e1b35"},"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/25169e5b-15a3-41be-b481-1f94779e1b35/scopes/814c9751-b8ca-4f05-b8f1-b820c11ab050"}},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"resource":{"id":"25169e5b-15a3-41be-b481-1f94779e1b35"},"id":"814c9751-b8ca-4f05-b8f1-b820c11ab050"}]},"id":"40eed306-a15c-4c8f-9d5f-4ed2e5bd441d","name":"Accounts","methods":["POST","PUT"],"paths":[{"type":"EXACT","pattern":"/accounts"}],"accessControl":{"group":{"groups":[{"id":"66feb0da-1181-4d3c-af58-6ba8dac61706"}]},"scope":{"matchType":"ANY","scopes":[{"id":"814c9751-b8ca-4f05-b8f1-b820c11ab050"}]},"permission":{"id":"0d2be05d-9ca4-4f98-8c0c-50af0ae5019d"}}}