Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchPutAttributesMetadata

Writes the attribute metadata.

Request Syntax


PUT /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/attributes-metadata HTTP/1.1
Content-type: application/json

{
   "attributes": [ 
      { 
         "attributeIdentifier": "string",
         "forms": [ 
            { 
               "content": "string",
               "formName": "string",
               "typeIdentifier": "string",
               "typeRevision": "string"
            }
         ]
      }
   ],
   "clientToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The domain ID where you want to write the attribute metadata.

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

Required: Yes

entityIdentifier

The entity ID for which you want to write the attribute metadata.

Pattern: [a-zA-Z0-9_-]{1,36}

Required: Yes

entityType

The entity type for which you want to write the attribute metadata.

Valid Values: ASSET | LISTING

Required: Yes

Request Body

The request accepts the following data in JSON format.

attributes

The attributes of the metadata.

Type: Array of AttributeInput objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: Yes

clientToken

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\x21-\x7E]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "attributes": [ 
      { 
         "attributeIdentifier": "string"
      }
   ],
   "errors": [ 
      { 
         "attributeIdentifier": "string",
         "code": "string",
         "message": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

attributes

The results of the BatchPutAttributeMetadata action.

Type: Array of BatchPutAttributeOutput objects

errors

The errors generated when the BatchPutAttributeMetadata action is invoked.

Type: Array of AttributeError objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400