Action resource attributes

>>>

PUT //v1/requests/<requestId>/actions/<actionId>/resource_attributes
Create/update/delete all resource attributes for an action

Also see PUT and DELETE for individual attributes.

For requests that have many attributes, managing them with the individual endpoints can be slow, particularly during creation. This endpoint provides a way to set them all at once.

Accepts a JSON body like the following:

{
  "resourceAttributes": [
    {"resourceAttributeId": 500667, "attributeValue": "Lorem ipsum dolor est..."},
    {"resourceAttributeId": 500705, "attributeValue": null},
    {"resourceAttributeId": 532908, "attributeValue": "2020-01-01"}
  ]
}

  • New attributes will be created.

  • Existing attributes will be updated if the attributeValue has changed.

  • Existing attributes absent in the body will be deleted.

That last point is important to note. If using this endpoint for bulk updates, the full set of resource attributes for an action must be sent.

Params

Param name Description
requestId
required

The requestId of the request

Validations:

  • Must be a Integer
actionId
required

The actionId of the specific action

Validations:

  • Must be a Integer
resourceAttributes
optional

Array of Resource Attributes

Validations:

  • Must be a Hash
resourceAttributes[resourceAttributeId]
required

Validations:

  • Must be a Integer
resourceAttributes[attributeValue]
optional

Validations:

  • Must be one of: String, nil.

Returns

Code: 200

Description:

OK

Param name Description
>>>

PUT //v1/requests/<requestId>/actions/<actionId>/resource_attributes/<resourceAttributeId>
Set resource attribute for an action

Params

Param name Description
resourceAttributeId
required

Validations:

  • Must be a Integer
attributeValue
required

Validations:

  • Must be a String

Returns

Code: 200

Description:

OK

Param name Description
>>>

DELETE //v1/requests/<requestId>/actions/<actionId>/resource_attributes/<resourceAttributeId>
Delete resource attribute from an action

Params

Param name Description
resourceAttributeId
required

Validations:

  • Must be a Integer

Returns

Code: 200

Description:

OK

Param name Description