Update API Service Operation

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

The PUT /environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}} request updates an API service operation associated with the environment and API service specified in the request URL.

Prerequisites

For property descriptions, see API server operations data model

PropertyType?Required?
accessControlObjectOptional
accessControl.customObjectOptional
accessControl.custom.enabledBooleanOptional
accessControl.groupObjectOptional
accessControl.group.groupsArrayRequired
accessControl.group.groups.elementRelationshipRequired
accessControl.group.groups.element.idStringRequired
accessControl.permissionObjectOptional
accessControl.permission.idObjectOptional
accessControl.scopeObjectOptional
accessControl.scope.matchTypeStringOptional
accessControl.scope.scopesArrayRequired
accessControl.scope.scopes.elementObjectRequired
accessControl.scope.scopes.element.idStringRequired
methodsArrayOptional
nameStringRequired
pathsArrayRequired
paths.typeStringRequired
paths.patternStringRequired

Request Body

{"name"=>"Accounts", "paths"=>[{"type"=>"EXACT", "pattern"=>"/accounts"}], "methods"=>["POST", "PUT"], "accessControl"=>{"group"=>{"groups"=>[{"id"=>"{endUserGroupId}"}]}, "scope"=>{"matchType"=>"ANY", "scopes"=>[{"id"=>"{scopeId}"}, {"id"=>"{secondScopeId}"}]}}}

RESPONSES

status: Created

{"_links":{"self":{"href":".../environments/{envId}/apiServers/{serverId}/operations/{id}"},"apiServer":{"href":".../environments/{envId}/apiServers/{serverId}"}},"name":"Accounts","id":"{operationId}","paths":[{"type":"EXACT","pattern":"/accounts"}],"methods":["POST","PUT"],"accessControl":{"group":{"groups":[{"id":"{endUserGroupId}"}]},"scope":{"matchType":"ANY","scopes":[{"id":"{scopeId}"},{"id":"{secondScopeId}"}]}}}