PATCH /v1.0/myorg/capacities/{capacityId}/Workloads/{workloadName}

Patch Workload

Changes the state of a specific workload to Enabled or Disabled. When enabling a workload the maximum memory percentage that the workload can consume must be set.

Required scope: Capacity.ReadWrite.All
To set the permissions scope, see Register an app.

Servers

Path parameters

Name Type Required Description
capacityId String Yes
workloadName String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
maxMemoryPercentageSetByUser String No
state String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.