Update a resource operation

put https://{hostname}/api-definitions/v2/endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations/{operationId}

Update details about a resource operation. You can change the operation's name, method, purpose, and more.

Path Params

endpointId

integer

required

Identifies an endpoint.

versionNumber

integer

required

The endpoint's version.

apiResourceId

integer

required

Identifies a resource.

operationId

string

required

length between 36 and 36

Identifies an operation.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

apiResourceId

integer

required

Identifies the API resource.

conditions

array of objects | null

Specify the parameter values to match with.

conditions

failureConditions

array of objects or null | null

Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation type except SEARCH and ADD_TO_CART.

failureConditions

method

string

required

HTTP method used to call the resource. Choose either HEAD, GET, POST, PUT, DELETE, PATCH, or OPTIONS.

multiFactorAuthentication

boolean | null

Identifies multifactor authenticated operations. It's valid only for PASSWORD_RESET and LOGIN operations.

multistepGroupId

string | null

Identifies the multistep group.

operationName

string

required

length ≥ 1

The name of the operation. Use the same name you gave to the resource if you only specify one operation.

operationParameter

object | null

Collects data for operation parameters defined when the resource was created.

operationPurpose

string

required

The task this operation serves. Choose either LOGIN, ACCOUNT_UPDATE, ACCOUNT_VERIFICATION, ACCOUNT_CREATION, PASSWORD_CHANGE, PASSWORD_RESET, PAYMENT, GIFTCARD_BALANCE_CHECK, LOYALTY_POINTS, SEARCH, or ADD_TO_CART. See Operation purposes for details.

originUserIdCondition

object | null

Collects data for response conditions.

stepSuccessConditions

array of objects or null | null

Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation type except SEARCH and ADD_TO_CART. This is allowed only for operations in a multistep group.

stepSuccessConditions

successConditions

array of objects or null | null

Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation type except SEARCH and ADD_TO_CART.

successConditions

Responses

Response body

object

apiResourceId

integer

required

Identifies the API resource.

conditions

array of objects | null

Specify the parameter values to match with.

conditions

object

apiParameterId

integer

required

Identifies the API parameter.

arrayIndexes

array of objects

Indexes for corresponding array parameters to find the data parameter.

arrayIndexes

object

apiParameterId

int64

required

Identifies the parameter.

index

integer

required

The location of the parameter's data within the array.

positiveMatch

boolean | null

Indicates if the value matches the specified parameter value.

value

string | null

deprecated

The parameter value to match with.

values

array of strings | null

The parameter values to match with.

values

failureConditions

array of objects or null | null

Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation type except SEARCH and ADD_TO_CART.

failureConditions

object | null

headerName

string

Specify the header's name. Only applicable for HEADER_* types.

positiveMatch

boolean | null

Enable to match on the condition.

suppressFromClientResponse

boolean

Enable to not send the response header to the requesting client. Only applicable for HEADER_* types.

type

string

required

Specify the type of condition you want to match on. These conditions capture data on successful and unsuccessful attempts to use the resource. Choose COOKIE_NAME, HEADER_VALUE, HEADER_VALUE_GREATER_THAN, HEADER_VALUE_LESS_THAN, HEADER_VALUE_BETWEEN, HTTP_STATUS, HEADER_NAME, BODY_XPATH, or BODY_XPATH_JSON.

COOKIE_NAME HEADER_VALUE HEADER_VALUE_GREATER_THAN HEADER_VALUE_LESS_THAN HEADER_VALUE_BETWEEN HTTP_STATUS HEADER_NAME BODY_XPATH BODY_XPATH_JSON

valueCase

boolean | null

Whether to consider the case sensitivity of the provided values. Only applicable for HEADER_VALUE, COOKIE_NAME, BODY_XPATH and BODY_XPATH_JSON.

valueWildcard

boolean | null

Whether to interpret * and ? as wildcards. Only applicable for HEADER_VALUE, BODY_XPATH and BODY_XPATH_JSON.

values

array of strings | null

Values to match on. The list length can't exceed 1, unless the type is either HTTP_STATUS, COOKIE_NAME, or HEADER_VALUE_BETWEEN. If the type is HEADER_VALUE_BETWEEN, the length needs to be 2.

values

xPath

string | null

A path in the response body to search at for a match. Only applicable for BODY_XPATH and BODY_XPATH_JSON.

method

string

required

HTTP method used to call the resource. Choose either HEAD, GET, POST, PUT, DELETE, PATCH, or OPTIONS.

HEAD GET POST PUT DELETE PATCH OPTIONS

multiFactorAuthentication

boolean | null

Identifies multifactor authenticated operations. It's valid only for PASSWORD_RESET and LOGIN operations.

multistepGroupId

string | null

Identifies the multistep group.

operationId

string

Read-only Identifies the operation.

operationName

string

required

length ≥ 1

The name of the operation. Use the same name you gave to the resource if you only specify one operation.

operationParameter

object | null

Collects data for operation parameters defined when the resource was created.

userEmail

object

If the operationPurpose is ACCOUNT_CREATION or PAYMENT, specify the apiParameterId you defined when you created the resource.

Has additional fields

userFirstName

object

If the operationPurpose is ACCOUNT_CREATION, specify the apiParameterId you defined when you created the resource.

Has additional fields

userLastName

object

If the operationPurpose is ACCOUNT_CREATION, specify the apiParameterId you defined when you created the resource.

Has additional fields

userOtherId

object

If the operationPurpose is ACCOUNT_CREATION, specify the apiParameterId you defined when you created the resource.

Has additional fields

userPhoneNumber

object

If the operationPurpose is ACCOUNT_CREATION or PAYMENT, specify the apiParameterId you defined when you created the resource.

Has additional fields

username

object

If the operationPurpose supports a username, specify the apiParameterId you defined when you created the resource. Required for LOGIN, ACCOUNT_VERIFICATION, and PASSWORD RESET.

Has additional fields

operationPurpose

string

required

LOGIN ACCOUNT_UPDATE ACCOUNT_VERIFICATION ACCOUNT_CREATION PASSWORD_CHANGE PASSWORD_RESET PAYMENT GIFTCARD_BALANCE_CHECK LOYALTY_POINTS SEARCH ADD_TO_CART CHECK_STATUS

originUserIdCondition

object | null

Collects data for response conditions.

headerName

string

Specify the header's name. Only applicable for HEADER_* types.

positiveMatch

boolean | null

Enable to match on the condition.

suppressFromClientResponse

boolean

Enable to not send the response header to the requesting client. Only applicable for HEADER_* types.

type

string

required

COOKIE_NAME HEADER_VALUE HEADER_VALUE_GREATER_THAN HEADER_VALUE_LESS_THAN HEADER_VALUE_BETWEEN HTTP_STATUS HEADER_NAME BODY_XPATH BODY_XPATH_JSON

valueCase

boolean | null

Whether to consider the case sensitivity of the provided values. Only applicable for HEADER_VALUE, COOKIE_NAME, BODY_XPATH and BODY_XPATH_JSON.

valueWildcard

boolean | null

Whether to interpret * and ? as wildcards. Only applicable for HEADER_VALUE, BODY_XPATH and BODY_XPATH_JSON.

values

array of strings | null

values

xPath

string | null

A path in the response body to search at for a match. Only applicable for BODY_XPATH and BODY_XPATH_JSON.

stepSuccessConditions

array of objects or null | null

stepSuccessConditions

object | null

headerName

string

Specify the header's name. Only applicable for HEADER_* types.

positiveMatch

boolean | null

Enable to match on the condition.

suppressFromClientResponse

boolean

Enable to not send the response header to the requesting client. Only applicable for HEADER_* types.

type

string

required

COOKIE_NAME HEADER_VALUE HEADER_VALUE_GREATER_THAN HEADER_VALUE_LESS_THAN HEADER_VALUE_BETWEEN HTTP_STATUS HEADER_NAME BODY_XPATH BODY_XPATH_JSON

valueCase

boolean | null

Whether to consider the case sensitivity of the provided values. Only applicable for HEADER_VALUE, COOKIE_NAME, BODY_XPATH and BODY_XPATH_JSON.

valueWildcard

boolean | null

Whether to interpret * and ? as wildcards. Only applicable for HEADER_VALUE, BODY_XPATH and BODY_XPATH_JSON.

values

array of strings | null

values

xPath

string | null

A path in the response body to search at for a match. Only applicable for BODY_XPATH and BODY_XPATH_JSON.

successConditions

array of objects or null | null

Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation type except SEARCH and ADD_TO_CART.

successConditions

object | null

headerName

string

Specify the header's name. Only applicable for HEADER_* types.

positiveMatch

boolean | null

Enable to match on the condition.

suppressFromClientResponse

boolean

Enable to not send the response header to the requesting client. Only applicable for HEADER_* types.

type

string

required

COOKIE_NAME HEADER_VALUE HEADER_VALUE_GREATER_THAN HEADER_VALUE_LESS_THAN HEADER_VALUE_BETWEEN HTTP_STATUS HEADER_NAME BODY_XPATH BODY_XPATH_JSON

valueCase

boolean | null

Whether to consider the case sensitivity of the provided values. Only applicable for HEADER_VALUE, COOKIE_NAME, BODY_XPATH and BODY_XPATH_JSON.

valueWildcard

boolean | null

Whether to interpret * and ? as wildcards. Only applicable for HEADER_VALUE, BODY_XPATH and BODY_XPATH_JSON.

values

array of strings | null

values

xPath

string | null

A path in the response body to search at for a match. Only applicable for BODY_XPATH and BODY_XPATH_JSON.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
10
1
curl --request PUT \
2
     --url https://hostname/api-definitions/v2/endpoints/endpointId/versions/versionNumber/resources/apiResourceId/operations/operationId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "method": "HEAD",
8
  "operationPurpose": "LOGIN"
9
}
10
'


xxxxxxxxxx
44
}
1
{
2
  "apiResourceId": 4102124,
3
  "conditions": [
4
    {
5
      "apiParameterId": 3828246
6
    }
7
  ],
8
  "method": "GET",
9
  "operationId": "e03cf501-b09b-49fa-b3c8-c3fa6787a359",
10
  "operationName": "test purpose 5",
11
  "operationParameter": {
12
    "userEmail": {
13
      "parameterId": 1234567,
14
      "usedForLogin": true
15
    },
16
    "userFirstName": {
17
      "parameterId": 1234567
18
    },
19
    "userLastName": {
20
      "parameterId": 1234567
21
    },
22
    "userOtherId": {
23
      "parameterId": 1234567,
24
      "usedForLogin": true
25
    },

200Successful response.

400Bad request. The request body has invalid fields.

403Forbidden. You don't have permission to access the resource.

404Not found. The requested resource operation doesn't exist.