Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.13 KB

effectorsGet.rst

File metadata and controls

49 lines (32 loc) · 1.13 KB
Raw

effectorsGet

GET /users/{uid}/deployments/{deploymentId}/entities/{entityId}/effectors

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.8fp13

Returns a list of effector for a given user, deployment and entity.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user-object
  • deploymentId (required): deployment id of the deployment
  • entityId (required): entity id of the entity

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/deployments/{deploymentId}/entities/{entityId}/effectors" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
  • deploymentEffector-object
  • deploymentEffectors-object
  • user-object